import SceneLayerView from "@arcgis/core/views/layers/SceneLayerView.js";const SceneLayerView = await $arcgis.import("@arcgis/core/views/layers/SceneLayerView.js");- 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.
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.
Properties
| Property | Type | Class |
|---|---|---|
availableFields readonly | string[] | |
declaredClass readonly inherited | ||
| | ||
layer readonly | | |
| | ||
maximumNumberOfFeaturesExceeded readonly | | |
spatialReferenceSupported readonly inherited | ||
suspended readonly inherited | ||
uid readonly inherited | ||
updating readonly inherited | ||
view readonly inherited | ||
visible inherited | ||
visibleAtCurrentScale readonly inherited | ||
visibleAtCurrentTimeExtent readonly inherited |
availableFields
- Type
- string[]
- Since
- ArcGIS Maps SDK for JavaScript 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.
- See also
filter
- Type
- FeatureFilter | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 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 FeatureFilter.timeExtent property is not supported on a SceneLayerView filter.
For 3D object scene layers, only spatial filters with FeatureFilter.spatialRelationship
set to contains, intersects or disjoint are supported.
maximumNumberOfFeatures
- Type
- number
- Since
- ArcGIS Maps SDK for JavaScript 4.11
The maximum number of features that can be displayed at a time. This setting currently only applies to point scene layer views. 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
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 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 layer views.
spatialReferenceSupported
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.23
Indicates if the spatialReference of the MapView or
Map component is supported by the layer view.
When false layer view will be suspended.
Known Limitations
This property is not supported for layer views of a 3D SceneView or Scene component.
- See also
uid
- Type
- string
- Since
- ArcGIS Maps SDK for JavaScript 4.33
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
updating
- Type
- boolean
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 FeatureLayerView.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
- Type
- MapViewOrSceneView
- Since
- ArcGIS Maps SDK for JavaScript 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); visibleAtCurrentScale
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
When true, the layer is visible in the view at the current scale. This applies to layers that have minScale and maxScale properties set.
Known Limitations
This property isn’t supported for tiled layers in 3D SceneView or in the Scene component
- Default value
- true
visibleAtCurrentTimeExtent
- Type
- boolean
- Since
- ArcGIS Maps SDK for JavaScript 4.30
When true, the layer is visible in the view's View.timeExtent. This applies to layers that have a Layer.visibilityTimeExtent.
- See also
- Default value
- true
Methods
| Method | Signature | Class |
|---|---|---|
createQuery(): Query | | |
emit inherited | emit<Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean | |
hasEventListener inherited | hasEventListener<Type extends EventNames<this>>(type: Type): boolean | |
highlight(target: Graphic | Graphic[] | number | number[], options?: LayerViewHighlightOptions): ResourceHandle | | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
on inherited | on<Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle | |
queryExtent(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<{
count: number;
extent: Extent | null;
}> | | |
queryFeatureCount(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<number> | | |
queryFeatures(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<FeatureSet> | | |
queryObjectIds(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<ObjectId[]> | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
createQuery
- Signature
-
createQuery (): Query
Creates query parameter object that can be used to fetch features as they are being
displayed. It sets the query parameter's Query.outFields
property to ["*"] and Query.returnGeometry to true.
The output spatial reference is set to the spatial reference of the view. The filter that currently
applies to the layer view is also incorporated in the returned query object.
- Returns
- Query
The query object
emit
- Signature
-
emit <Type extends EventNames<this>>(type: Type, event?: this["@eventTypes"][Type]): boolean
- Type parameters
- <Type extends EventNames<this>>
- Since
- ArcGIS Maps SDK for JavaScript 4.5
Emits an event on the instance. This method should only be used when creating subclasses of this class.
hasEventListener
- Signature
-
hasEventListener <Type extends EventNames<this>>(type: Type): boolean
- Type parameters
- <Type extends EventNames<this>>
Indicates whether there is an event listener on the instance that matches the provided event name.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | The name of the event. | |
- Returns
- boolean
Returns true if the class supports the input event.
highlight
- Signature
-
highlight (target: Graphic | Graphic[] | number | number[], options?: LayerViewHighlightOptions): ResourceHandle
- Since
- ArcGIS Maps SDK for JavaScript 4.4
Highlights the given feature(s).
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| target | The feature(s) to highlight. When passing a graphic or array of graphics, each feature must
have a valid | | |
| options | An object with the following properties. | |
- Returns
- ResourceHandle
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
// Add a new set of highlight options to the view's highlights collectionview.highlights.push({ name: "oaks", color: "forestgreen", haloOpacity: 0.8, fillOpacity: 0.3});
// A handler can be used to remove any previous highlight when applying a new onelet highlight;
// Query for particualar features in the layer and then highlight them with the specified optionsview.whenLayerView(sceneLayer).then((layerView) => { let query = sceneLayer.createQuery(); query.where = "type = 'Quercus'";
sceneLayer.queryFeatures(query).then((result) => { // Remove any previous highlight, if it exists highlight?.remove(); // Apply the "oaks" highlight options to the corresponding tree features highlight = layerView.highlight(result.features, { name: "oaks" }); })});// Use the default highlights collection to apply a highlight to features when you hover over them
// A handler can be used to remove any previous highlight when applying a new onelet hoverHighlight;
view.on("pointer-move", (event) => { // Search for the first feature in the layer at the hovered location view.hitTest(event).then((response) => { if (response.results[0]) { const graphic = response.results[0].graphic; view.whenLayerView(graphic.layer).then((layerView) => { // Remove any previous highlight, if it exists hoverHighlight?.remove(); // Highlight the hit features with the temporary highlight options, which are pre-configured for this use case hoverHighlight = layerView.highlight(graphic, { name: "temporary" }); }) } })}); isFulfilled
- Signature
-
isFulfilled (): boolean
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
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
on
- Signature
-
on <Type extends EventNames<this>>(type: Type, listener: EventedCallback<this["@eventTypes"][Type]>): ResourceHandle
- Type parameters
- <Type extends EventNames<this>>
Registers an event handler on the instance. Call this method to hook an event with a listener.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| type | Type | An event or an array of events to listen for. | |
| listener | EventedCallback<this["@eventTypes"][Type]> | The function to call when the event fires. | |
- Returns
- ResourceHandle
Returns an event handler with a
remove()method that should be called to stop listening for the event(s).Property Type Description remove Function When called, removes the listener from the event.
Example
view.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint);}); queryExtent
- Signature
-
queryExtent (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<{ count: number; extent: Extent | null; }>
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 SceneLayer.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 projectOperator
documentation.
Spatial queries on 3D Object scene layer views 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
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features on the client are returned. | | |
| options | An object with the following properties. | |
- Returns
- Promise<{
count: number;
extent: Extent | null;
}>
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
- Signature
-
queryFeatureCount (query?: QueryProperties | null | undefined, options?: AbortOptions): 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 SceneLayer.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 projectOperator
documentation.
Spatial queries on 3D Object scene layer views 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
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the attributes and spatial filter of the query.
When no parameters are passed to this method, all features on the client are returned. To only return features
visible in the view, set the | | |
| options | An object with the following properties. | |
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
- Signature
-
queryFeatures (query?: QueryProperties | null | undefined, options?: AbortOptions): 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 SceneLayer.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.
Feature queries support returning Mesh geometries when returnGeometry is set to true in the query
(the default). The returned geometries are initially not loaded to avoid unnecessary memory consumption. They
need to be loaded using Mesh.load() before their vertex attributes are available. Unloaded Mesh
geometries do have an Mesh.extent property that can be used to determine the bounding box of the
geometry before loading it fully. The Mesh load() will fail if the data being referenced by the Mesh is no
longer available, for example if it is no longer in the view.
Known Limitations
Spatial queries have the same limitations as those listed in the
projectOperator documentation.
Spatial queries on 3D Object scene layer views 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 Returned mesh geometries only contain vertex positions and do not have normals, texture coordinates or materials.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the attributes and spatial filter of the query.
When no parameters are passed to this method, all features on the client are returned along with their attributes
specified in availableFields. To only return features
visible in the view, set the | | |
| options | An object with the following properties. | |
- Returns
- 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 querylet 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 viewconst result = await layerView.queryFeatures()console.log(result.features); // prints all loaded client-side graphics to the console queryObjectIds
- Signature
-
queryObjectIds (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<ObjectId[]>
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 SceneLayer.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 projectOperator
documentation.
Spatial queries on 3D Object scene layer views 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
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the attributes of the query. If query parameters are not provided, all loaded features are returned. | | |
| options | An object with the following properties. | |
Example
let layer = new SceneLayer({ url: ssUrl // points to a Scene Service layer url});
// returns all the Ids from the features in the layer viewview.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
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
- Since
- ArcGIS Maps SDK for JavaScript 4.6
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat 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 waylet 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});