Class: @arcgis/core/views/layers/SceneLayerView
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.
Show inherited properties Hide inherited properties
Property Details 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.
Inherited
Property declaredClass Stringreadonly
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.
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
contains, intersects or disjoint are supported.The scene layer being viewed.
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 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 Booleanreadonly
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 layer views.
suspended Booleanreadonly
Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).
Inherited
Property uid Stringreadonly
Since: ArcGIS Maps SDK for JavaScript 4.33 LayerView since 4.0, uid added at 4.33.
An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.
Inherited
Property updating Booleanreadonly
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).
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);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);Inherited
Property visible Boolean
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.
Inherited
Property visibleAtCurrentScale Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.30 LayerView since 4.0, visibleAtCurrentScale added at 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
Inherited
Property visibleAtCurrentTimeExtent Booleanreadonly
Since: ArcGIS Maps SDK for JavaScript 4.30 LayerView since 4.0, visibleAtCurrentTimeExtent added at 4.30.
When true, the layer is visible in the view's timeExtent. This applies to layers that have a visibilityTimeExtent.
Show inherited methods Hide inherited methods
Method DetailsInherited
Method addHandles(handleOrHandles, groupKey)
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
Handles marked for removal once the object is destroyed.
groupKey *
optionalKey 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(){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 layer view is also incorporated in the returned query object.
Returns
Type Description Query The query objectInherited
Method hasHandles(groupKey){Boolean}
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 *
optionalA group key.
Returns
Type Description Boolean Returnstrue 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(target, options){Handle}
Since: ArcGIS Maps SDK for JavaScript 4.4 SceneLayerView since 4.3, highlight added at 4.4.
Highlights the given feature(s).
Parameters
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.
An object with the following properties.
Specification
optionalThe name of the highlight options from the view's highlights collection. If a name is provided, the corresponding highlight options will be applied to the feature(s). Otherwise, the default highlight options will be used.
Returns
Type Description Handle Returns a highlight handler with aremove() 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 collection
view.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 one
let highlight;
// Query for particualar features in the layer and then highlight them with the specified options
view.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 one
let 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" });
})
}
})
});Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been rejected.Inherited
Method 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
Type Description Boolean Indicates whether creating an instance of the class has been resolved. 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
intersects, contains, and disjoint spatialRelationships are supported on spatial queries.Parameters
optionalSpecifies the attributes and spatial filter of the query. When no parameters are passed to this method, all features on the client are returned.
optionalAn object with the following properties.
Specification
optionalSignal 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(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
intersects, contains, and disjoint spatialRelationships are supported on spatial queries.Parameters
optionalSpecifies 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 geometry parameter in the query object to the view's visible area.
An object with the following properties.
Specification
optionalSignal 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(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.
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 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
intersects, contains, and disjoint spatialRelationships are supported on spatial queries.Parameters
optionalSpecifies 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 geometry parameter in the query object to the view's visible area.
An object with the following properties.
Specification
optionalSignal 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(query, options){Promise<Array<(number|string)>>}
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
intersects, contains, and disjoint spatialRelationships are supported on spatial queries.Parameters
optionalSpecifies the attributes of the query. If query parameters are not provided, all loaded features are returned.
optionalAn object with the following properties.
Specification
optionalSignal 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<Array<(number|string)>> 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
});Inherited
Method removeHandles(groupKey)
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 *
optionalA 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");Inherited
Method when(callback, errback){Promise}
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
optionalThe function to call when the promise resolves.
optionalThe function to execute when the promise fails.
Returns
Type Description Promise Returns a new promise for the result ofcallback 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
});RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4