@arcgis/core/views/layers/BuildingSceneLayerView
Represents the LayerView of a BuildingSceneLayer after it has been added to a Map in a SceneView. BuildingSceneLayerView is responsible for streaming and rendering a BuildingSceneLayer's features in the SceneView.
The BuildingSceneLayerView contains a list of sublayer views for all the component sublayers of a BuildingSceneLayer. The BuildingSceneLayerView doesn't have query methods. To query the features loaded on the client, use the query methods on the component sublayer views:
// query all the loaded features
view.whenLayerView(buildingSceneLayer).then(function(buildingSceneLayerView) {
buildingSceneLayerView.sublayerViews.forEach(function(sublayerView) {
const query = sublayerView.createQuery();
sublayerView.queryFeatures(query).then(function(result) {
console.log(result.features);
});
});
});
The BuildingSceneLayerView can be used to highlight features in any of the component sublayers. The highlight method takes as arguments the features that should be highlighted:
// on user click, select the first feature in the BuildingSceneLayer
let highlight = null;
view.on("click", function (event) {
view.hitTest(event.screenPoint, {include: buildingSceneLayer}).then((hitTestResult) => {
if (highlight) {
highlight.remove();
highlight = null;
}
if (hitTestResult.results.length) {
highlight = bslv.highlight(hitTestResult.results[0].graphic);
}
});
});
- See also
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
The name of the class. | Accessor | ||
The layer being viewed. | BuildingSceneLayerView | ||
Collection of sublayer views for all the component sublayers of the BuildingSceneLayer. | BuildingSceneLayerView | ||
Value is | LayerView | ||
An automatically generated unique identifier assigned to the instance. | LayerView | ||
Indicates if the layer view is making any updates that will impact what is displayed on the map. | LayerView | ||
A reference to the MapView or SceneView associated with the layer view. | LayerView | ||
When | LayerView | ||
When | LayerView | ||
When | LayerView |
Property Details
-
layer
Propertylayer BuildingSceneLayerreadonly -
The layer being viewed.
-
sublayerViews
PropertysublayerViews Collection<BuildingComponentSublayerView>readonly -
Collection of sublayer views for all the component sublayers of the BuildingSceneLayer.
Exampleview.whenLayerView(buildingSceneLayer).then(function(buildingSceneLayerView) { console.log(buildingSceneLayerView.sublayerViews); });
-
updating
InheritedPropertyupdating BooleanreadonlyInherited 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
truewhen 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);
-
Inherited from LayerView
Since: ArcGIS Maps SDK for JavaScript 4.28LayerView since 4.0, view added at 4.28. -
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
InheritedPropertyvisible BooleanInherited from LayerView -
When
true, the layer is visible in the view. Value of this property is inherited from thelayer.visibleunless the developer overrides it. ThelayerView.visiblewill take precedence overlayer.visibleif both properties are set.- Default Value:true
-
visibleAtCurrentScale
InheritedPropertyvisibleAtCurrentScale BooleanreadonlyInherited from LayerViewSince: ArcGIS Maps SDK for JavaScript 4.30LayerView 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 haveminScaleandmaxScaleproperties set.Known Limitations
- This property is not supported in 3D SceneView tiled layers.
- Default Value:true
- See also
-
visibleAtCurrentTimeExtent
InheritedPropertyvisibleAtCurrentTimeExtent BooleanreadonlyInherited from LayerViewSince: ArcGIS Maps SDK for JavaScript 4.30LayerView 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.- Default Value:true
- See also
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Returns true if a named group of handles exist. | Accessor | ||
Highlights the given feature(s). | BuildingSceneLayerView | ||
| LayerView | ||
| LayerView | ||
| LayerView | ||
Removes a group of handles owned by the object. | Accessor | ||
Promise |
| LayerView |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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
Methodhighlight(target, options){Handle} -
Highlights the given feature(s).
ParametersThe feature(s) to highlight. The graphics that are passed to this function must originate from one of the component sublayers of the BuildigSceneLayer.
options ObjectoptionalAn object with the following properties.
Specificationname StringoptionalThe name of the highlight options from the view's highlights collection. If a
nameis provided, the corresponding highlight options will be applied to the feature(s). Otherwise, thedefaulthighlight options will be used.ReturnsType Description Handle Returns a highlight handler with a remove()method that can be called to remove the highlight.Example// On user click, highlight the first feature selected in the BuildingSceneLayer // Add a new set of highlight options to the view's highlights collection view.highlights.push({name: "selection", color: "red"}); // A handler can be used to remove any previous highlight when applying a new one let highlight; view.on("click", function (event) { // Idenitfy the first feature in the BuildingSceneLayer at the clicked location view.hitTest(event.screenPoint, {include: buildingSceneLayer}).then((hitTestResult) => { if (hitTestResult.results[0]) { const graphic = hitTestResult.results[0].graphic; view.whenLayerView(graphic.layer).then((layerView) => { // Remove any previous highlight, if it exists highlight?.remove(); // Highlight the selected feature with the specified highlight options highlight = layerView.highlight(graphic, { name: "selection" } ); }); } }); });
-
isFulfilled
InheritedMethodisFulfilled(){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,truewill be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}Inherited from LayerView -
isRejected()may be used to verify if creating an instance of the class is rejected. If it is rejected,truewill be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}Inherited from LayerView -
isResolved()may be used to verify if creating an instance of the class is resolved. If it is resolved,truewill be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from LayerView
-
when()may be leveraged once an instance of the class is created. This method takes two input parameters: aonFulfilledfunction and anonRejectedfunction. TheonFulfilledexecutes when the instance of the class loads. TheonRejectedexecutes if the instance of the class fails to load.ParametersReturnsType Description Promise 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 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 });