Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

layerLayerreadonly inherited

The layer being viewed.

suspendedBooleanreadonly inherited

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

updatingBooleanreadonly inherited

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false

visibleBoolean inherited

When true, the layer is visible in the view. Set this property to false to hide the layer from the view.

Default Value:true

Method Overview

Method Details

highlight(target){Object}

Since: ArcGIS API for JavaScript 4.4

Highlights the given feature(s).

Parameter:

target Graphic|Graphic[]|Number|Number[] optional The feature(s) to highlight. When passing a graphic or array of graphics, each feature must have a valid objectID. You may alternatively pass one or more objectIDs as a single number or an array.

Returns:

Type	Description
Object	Returns a highlight handler with a remove() method that can be called to remove the highlight. Property Type Description remove Function When called, removes the highlight of the selected graphics.

See also:

• SceneView.highlightOptions

• Sample: Highlight SceneLayer

Examples:

// highlight features based on a layer query result
// this workflow is valid only if the scene layer has an associated feature layer
var highlight;
view.whenLayerView(sceneLayer).then(function(layerView){
 var query = sceneLayer.createQuery();
 query.where = "type = 'Quercus'";
 sceneLayer.queryFeatures(query).then(function(result){
   if (highlight) {
     highlight.remove();
   }
   highlight = layerView.highlight(result.features);
 })
});

// highlight feature on pointer-move
view.on("pointer-move", function(event){
 view.hitTest(event).then(function(response){
   if (response.results[0]) {
     var graphic = response.results[0].graphic;
     view.whenLayerView(graphic.layer).then(function(layerView){
       layerView.highlight(graphic);
     })
   }
 })
});

isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).

isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been rejected.

isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:

Type	Description
Boolean	Indicates whether creating an instance of the class has been resolved.

queryExtent(params){Promise<Object>}

beta

Executes a Query against features in the layer view and returns the 3D Extent of features that satisfy the query. If query parameters are not provided, the extent and count of all loaded features are returned.

This method is not yet supported when the associated scene layer has a geometryType of point. Read more about queries in the Query section of the SceneLayer class description.

To query for the extent of features directly from a Scene Service rather than those loaded for the current view, you must use the SceneLayer.queryExtent() method.

Parameter:

params Query optional Specifies the attributes of the query. Only theobjectIds, num and start properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned.

Returns:

Type	Description
Promise<Object>	When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details. Property Type Description count Number The number of features that satisfy the input query. extent Extent The extent of the features that satisfy the query.

Example:

var layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

view.whenLayerView(layer).then(function(layerView){
 watchUtils.whenNotOnce(layerView, "updating") // watches when the layer finishes updating the first time
   .then(function() {
     return layerView.queryExtent();
   })
   .then(function(results) {
     view.goTo(results.extent); // go to the extent of all the graphics in the layer view
   });
});

queryFeatureCount(params){Promise<Number>}

beta

Executes a Query against features in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all loaded features is returned. Read more about queries in the Query section of the SceneLayer class description.

This method is not yet supported when the associated scene layer has a geometryType of point.

To query for the count of features directly from a Scene Service rather than those loaded for the current view, you must use the SceneLayer.queryFeatureCount() method.

Parameter:

params Query optional Specifies the attributes of the query. Only theobjectIds, num and start properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned.

Returns:

Type	Description
Promise<Number>	When resolved, returns the number of features satisfying the query.

Example:

var layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

view.whenLayerView(layer).then(function(layerView){
 watchUtils.whenNotOnce(layerView, "updating") // watches when the layer finishes updating the first time
   .then(function() {
     return layerView.queryFeatureCount();
   })
   .then(function(count) {
     console.log(count); // prints the number of client-side graphics that are currently loaded
   });
});

queryFeatures(params){Promise<FeatureSet>}

beta

Executes a Query against features in the layer view and returns a FeatureSet. If query parameters are not provided, all loaded features are returned.

This method is not yet supported when the associated scene layer has a geometryType of point. Read more about queries in the Query section of the SceneLayer class description.

Querying more than 10.000 features returns an error, unless num is specified in the Query.

To execute a query against all the features in a Scene Service rather than only those loaded for the current view, you must use the SceneLayer.queryFeatures() method.

Parameter:

params Query optional Specifies the attributes of the query. Only the outFields, objectIds, num and start properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned.

Returns:

Type	Description
Promise<FeatureSet>	When resolved, a FeatureSet is returned. The set will be empty if zero results are found.

Examples:

var layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

// returns loaded features from the layer view that match the query
var query = new Query();
query.objectIds = [10, 125, 126, 200, 201];
query.outFields = ["NAME", "STATE_ABBR", "POP04"];

view.whenLayerView(layer).then(function(layerView){
 watchUtils.whenNotOnce(layerView, "updating")
   .then(function() {
     return layerView.queryFeatures();
   })
   .then(function(result) {
     console.log(result.features); // prints the client-side graphics to the console
   });
});

var layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

// returns all loaded features from the layer view
view.whenLayerView(layer).then(function(layerView){
  layerView.watch("updating", function(val){
    if(!val){  // wait for the layer view to finish updating
      layerView.queryFeatures().then(function(result){
        console.log(result.features);  // prints all loaded client-side graphics to the console
      });
    }
  });
});

queryObjectIds(params){Promise<Number[]>}

beta

Executes a Query against features in the layer view and returns an array of the ObjectIDs of features that satisfy the input query. If query parameters are not provided, the ObjectIDs of all loaded features are returned.

This method is not yet supported when the associated scene layer has a geometryType of point. Read more about queries in the Query section of the SceneLayer class description.

To query for ObjectIDs of features directly from a Scene Service rather than those loaded for the current view, you must use the SceneLayer.queryObjectIds() method.

Parameter:

params Query optional Specifies the attributes of the query. Only theobjectIds, num and start properties should be specified. Adding any other properties will return an error. If query parameters are not provided, all loaded features are returned.

Returns:

Type	Description
Promise<Number[]>	When resolved, returns an array of numbers representing the ObjectIDs of the features satisfying the query.

Example:

var layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

// returns all the Ids from the features in the layer view
view.whenLayerView(layer).then(function(layerView){
  return layerView.queryObjectIds();
}).then(function(ids){
  console.log(ids);  // prints the ids of all the client-side graphics to the console
});

when(callback, errback){Promise}inherited

Since: ArcGIS API for JavaScript 4.6

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:

callback Function optional The function to call when the promise resolves.

errback Function optional The function to execute when the promise fails.

Returns:

Type	Description
Promise	Returns a new promise for the result of callback that may be used to chain additional functions.

Example:

// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});