SceneLayerView

Class: esri/views/layers/SceneLayerView
Inheritance: SceneLayerView LayerView Accessor
Since: ArcGIS Maps SDK for JavaScript 4.3

Represents the LayerView of a SceneLayer after it has been added to a Map in a SceneView.

The SceneLayerView is responsible for streaming and rendering a SceneLayer's features in the SceneView. The methods in the SceneLayerView provide developers with the ability to query loaded features. See the code snippets in the methods below for examples of how to access client-side graphics from the view.

Features in a SceneLayer are loaded progressively, starting from coarse representations that are refined to higher levels of detail as necessary for close-up views.

Queries on the SceneLayerView will be executed against features that have been loaded for the current view. This means that only visible features are guaranteed to be available once the layer has finished updating. At lower levels of detail, features may be omitted from rendering by the SceneLayerView, and will therefore not be included in the results of queries. This means that the query methods on the SceneLayerView should not be used when the intention is to query or search within the whole dataset, instead the query methods on the SceneLayer should be used.

If the SceneLayer has an associated feature layer and Query.outFields is specified in SceneLayerView.queryFeatures() then the query results will be retrieved from the associated feature layer. Read more about SceneLayers with associated feature layer in the Publishing section of Working with scene layers guide topic.

To only execute a query once the loading of features has completed, applications can wait until the updating property of the SceneLayerView is false. Batched Queries with num and start should only be used when this SceneLayerView is not updating, otherwise the result is undefined.

See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String[]

A list of attribute fields fetched for each feature including fields required for layer rendering and additional fields defined on the SceneLayer.outFields.

SceneLayerView
String

The name of the class.

Accessor
FeatureFilter

Applies a client-side FeatureFilter to the displayed data.

SceneLayerView
SceneLayer

The scene layer being viewed.

SceneLayerView
Number

The maximum number of features that can be displayed at a time.

SceneLayerView
Boolean

Signifies whether the maximum number of features has been exceeded.

SceneLayerView
Boolean

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

SceneLayerView
Boolean

Indicates if the layer view is making any updates that will impact what is displayed on the map.

LayerView
MapView|SceneView

A reference to the MapView or SceneView associated with the layer view.

LayerView
Boolean

When true, the layer is visible in the view.

LayerView

Property Details

availableFields

Property
availableFields String[]readonly
Since: ArcGIS Maps SDK for JavaScript 4.12 SceneLayerView since 4.3, availableFields added at 4.12.

A list of attribute fields fetched for each feature including fields required for layer rendering and additional fields defined on the SceneLayer.outFields. The availableFields is populated when the layer view is finished updating. Use this list when querying features on the client-side.

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

filter

Property
filter FeatureFilterautocast
Since: ArcGIS Maps SDK for JavaScript 4.11 SceneLayerView since 4.3, filter added at 4.11.

Applies a client-side FeatureFilter to the displayed data. Only the features that satisfy the filter are displayed. The fields to be used for the filter must be present in the layer view's availableFields list.

Known Limitations

  • The timeExtent property is not supported on a SceneLayerView filter.
  • For 3D object scene layers, only spatial filters with spatialRelationship set to contains, intersects or disjoint are supported.

layer

Property
layer SceneLayerreadonly

The scene layer being viewed.

maximumNumberOfFeatures

Property
maximumNumberOfFeatures Number
Since: ArcGIS Maps SDK for JavaScript 4.11 SceneLayerView since 4.3, maximumNumberOfFeatures added at 4.11.

The maximum number of features that can be displayed at a time. This setting currently only applies to point scene layers. By default, the maximum number of features is estimated automatically depending on the symbology, geometry complexity, memory consumption and display quality profile.

Changing this setting to a higher value may lead to a significant decrease in performance and increase in memory usage.

maximumNumberOfFeaturesExceeded

Property
maximumNumberOfFeaturesExceeded Boolean
Since: ArcGIS Maps SDK for JavaScript 4.11 SceneLayerView since 4.3, maximumNumberOfFeaturesExceeded added at 4.11.

Signifies whether the maximum number of features has been exceeded. Not all features could be displayed when this value is true. This setting currently only applies to point scene layers.

suspended

Property
suspended Booleanreadonly

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

updating

Inherited
Property
updating Booleanreadonly
Inherited from LayerView

Indicates if the layer view is making any updates that will impact what is displayed on the map. For example, this value is true when renderer, definitionExpression, filter or effect is changed or if the layer view is in the process of the fetching data.

Watch dataUpdating property instead to only know when the data has been updated (e.g. to run statistics query on all feature available in the layer view).

Default Value:false
Example
// Check for the first time layerView.updating becomes false. Then query for
// features that are visible within the view associated with the layer view.
await reactiveUtils.whenOnce(() => !layerView.updating);
const query = layerView.createQuery();
query.geometry = layerView.view.extent;
const result = layerView.queryFeatures(query);

view

Inherited
Property
view MapView|SceneViewreadonly
Inherited from LayerView
Since: ArcGIS Maps SDK for JavaScript 4.28 LayerView since 4.0, view added at 4.28.

A reference to the MapView or SceneView associated with the layer view.

Example
// Check for the first time layerView.updating becomes false. Then query for
// features that are visible within the view associated with the layer view.
await reactiveUtils.whenOnce(() => !layerView.updating);
const query = layerView.createQuery();
query.geometry = layerView.view.extent;
const result = layerView.queryFeatures(query);

visible

Inherited
Property
visible Boolean
Inherited from LayerView

When true, the layer is visible in the view. Value of this property is inherited from the layer.visible unless the developer overrides it. The layerView.visible will take precedence over layer.visible if both properties are set.

Default Value:true

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
Query

Creates query parameter object that can be used to fetch features as they are being displayed.

SceneLayerView
Boolean

Returns true if a named group of handles exist.

Accessor
Handle

Highlights the given feature(s).

SceneLayerView
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

LayerView
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

LayerView
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

LayerView
Promise<object>

Executes a Query against features in the layer view and returns the 3D Extent of features that satisfy the query.

SceneLayerView
Promise<number>

Executes a Query against features in the layer view and returns the number of features that satisfy the query.

SceneLayerView
Promise<FeatureSet>

Executes a Query against features in the layer view and returns a FeatureSet.

SceneLayerView
Promise<number[]>

Executes a Query against features in the layer view and returns an array of the ObjectIDs of features that satisfy the input query.

SceneLayerView

Removes a group of handles owned by the object.

Accessor
Promise

when() may be leveraged once an instance of the class is created.

LayerView

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

createQuery

Method
createQuery(){Query}

Creates query parameter object that can be used to fetch features as they are being displayed. It sets the query parameter's outFields property to ["*"] and returnGeometry to true. The output spatial reference is set to the spatial reference of the view. The filter that currently applies to the layerview is also incorporated in the returned query object.

Returns
Type Description
Query The query object

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

highlight

Method
highlight(target){Handle}
Since: ArcGIS Maps SDK for JavaScript 4.4 SceneLayerView since 4.3, highlight added at 4.4.

Highlights the given feature(s).

Parameter
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
Handle Returns a highlight handler with a remove() method that can be called to remove the highlight.
Examples
// highlight features based on a layer query result
// this workflow is valid only if the scene layer has an associated feature layer
let highlight;
view.whenLayerView(sceneLayer).then(function(layerView){
 let 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]) {
     let graphic = response.results[0].graphic;
     view.whenLayerView(graphic.layer).then(function(layerView){
       layerView.highlight(graphic);
     })
   }
 })
});

isFulfilled

Inherited
Method
isFulfilled(){Boolean}
Inherited from LayerView

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

Inherited
Method
isRejected(){Boolean}
Inherited from LayerView

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

Inherited
Method
isResolved(){Boolean}
Inherited from LayerView

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

Method
queryExtent(query, options){Promise<object>}

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.

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.

For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client.

Known Limitations

  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries on 3D Object SceneLayerView use the Extent of the feature and not the footprint when calculating the spatial relationship with the query geometry. This means that a feature might be returned from the query, even though its footprint is not in a spatial relationship with the geometry.
  • Currently only intersects, contains, and disjoint spatialRelationships are supported on spatial queries.
  • Spatial queries are not currently supported if the SceneLayerView has any of the following SpatialReferences:
    • GDM 2000 (4742) - Malaysia
    • Gsterberg (Ferro) (8042) - Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters
query Query autocast
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned.

options Object
optional

An object with the following properties.

Specification
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

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
let layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

view.whenLayerView(layer).then(function(layerView){
  reactiveUtils.whenOnce(() => !layerView.updating)
  .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

Method
queryFeatureCount(query, options){Promise<number>}

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.

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.

For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client.

Known Limitations

  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries on 3D Object SceneLayerView use the Extent of the feature and not the footprint when calculating the spatial relationship with the query geometry. This means that a feature might be returned from the query, even though its footprint is not in a spatial relationship with the geometry.
  • Currently only intersects, contains, and disjoint spatialRelationships are supported on spatial queries.
  • Spatial queries are not currently supported if the SceneLayerView has any of the following SpatialReferences:
    • GDM 2000 (4742) - Malaysia
    • Gsterberg (Ferro) (8042) - Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters
query Query autocast
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned. To only return features visible in the view, set the geometry parameter in the query object to the view's extent.

options Object
optional

An object with the following properties.

Specification
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns
Type Description
Promise<number> When resolved, returns the number of features satisfying the query.
Example
let layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

view.whenLayerView(layer).then(function(layerView){
  reactiveUtils.whenOnce(() => !layerView.updating)
  .then(function() {
    return layerView.queryFeatureCount();
  })
  .then(function(count) {
    console.log(count); // prints the number of client-side graphics that are currently loaded
  });
});

queryFeatures

Method
queryFeatures(query, options){Promise<FeatureSet>}

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

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.

For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client.

Known Limitations

  • Spatial queries have the same limitations as those listed in the projection engine documentation.
  • Spatial queries on 3D Object SceneLayerView use the Extent of the feature and not the footprint when calculating the spatial relationship with the query geometry. This means that a feature might be returned from the query, even though its footprint is not in a spatial relationship with the geometry.
  • Currently only intersects, contains, and disjoint spatialRelationships are supported on spatial queries.
  • Spatial queries are not currently supported if the SceneLayerView has any of the following SpatialReferences:
    • GDM 2000 (4742) - Malaysia
    • Gsterberg (Ferro) (8042) - Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters
query Query autocast
optional
Autocasts from Object

Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features in the client are returned along with their attributes specified in availableFields. To only return features visible in the view, set the geometry parameter in the query object to the view's extent.

options Object
optional

An object with the following properties.

Specification
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns
Type Description
Promise<FeatureSet> When resolved, a FeatureSet is returned. The set will be empty if zero results are found.
Examples
let layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

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

view.whenLayerView(layer).then(function(layerView){
  reactiveUtils.whenOnce(() => !layerView.updating)
  .then(function() {
    return layerView.queryFeatures(query);
  })
  .then(function(result) {
    console.log(result.features); // prints the client-side graphics to the console
  });
});
let layer = new SceneLayer({
  url: ssUrl  // points to a Scene Service layer url
});

const layerView = await view.whenLayerView(layer);
await reactiveUtils.whenOnce(() => !layerView.updating);

// returns all loaded features from the layer view
const result = await layerView.queryFeatures()
console.log(result.features);  // prints all loaded client-side graphics to the console

queryObjectIds

Method
queryObjectIds(query, options){Promise<number[]>}

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.

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.

For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client.

Known Limitations

  • Spatial queries have the limitations listed in the projection engine documentation.
  • Spatial queries on 3D Object SceneLayerView use the Extent of the feature and not the footprint when calculating the spatial relationship with the query geometry. This means that a feature might be returned from the query, even though its footprint is not in a spatial relationship with the geometry.
  • Currently only intersects, contains, and disjoint spatialRelationships are supported on spatial queries.
  • Spatial queries are not currently supported if the SceneLayerView has any of the following SpatialReferences:
    • GDM 2000 (4742) - Malaysia
    • Gsterberg (Ferro) (8042) - Austria/Czech Republic
    • ISN2016 (8086) - Iceland
    • SVY21 (4757) - Singapore
Parameters
query Query autocast
optional
Autocasts from Object

Specifies the attributes of the query. If query parameters are not provided, all loaded features are returned.

options Object
optional

An object with the following properties.

Specification
signal AbortSignal
optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns
Type Description
Promise<number[]> When resolved, returns an array of numbers representing the ObjectIDs of the features satisfying the query.
Example
let 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
});

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

when

Inherited
Method
when(callback, errback){Promise}
Inherited from LayerView
Since: ArcGIS Maps SDK for JavaScript 4.6 LayerView since 4.0, when added at 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 when() in the same way
let 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
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.