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 |
---|---|---|---|
String | The name of the class. more details | Accessor | |
BuildingSceneLayer | The layer being viewed. more details | BuildingSceneLayerView | |
Collection<BuildingComponentSublayerView> | Collection of sublayer views for all the component sublayers of the BuildingSceneLayer. more details | BuildingSceneLayerView | |
Boolean | Value is | BuildingSceneLayerView | |
Boolean | Value is | LayerView | |
Boolean | When | LayerView |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
layer BuildingSceneLayerreadonly
-
The layer being viewed.
-
sublayerViews 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); });
-
suspended Booleanreadonly
-
Value is
true
if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).
-
Value is
true
when the layer is updating; for example, if it is in the process of fetching data.- Default Value:false
-
When
true
, the layer is visible in the view. Value of this property is inherited from thelayer.visible
unless the developer overrides it. ThelayerView.visible
will take precedence overlayer.visible
if both properties are set.- Default Value:true
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Handle | Highlights the given feature(s). more details | BuildingSceneLayerView | |
Boolean |
| LayerView | |
Boolean |
| LayerView | |
Boolean |
| LayerView | |
Removes a group of handles owned by the object. more details | Accessor | ||
Promise |
| LayerView |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(target){Handle}
-
Highlights the given feature(s).
Parameteroptional The feature(s) to highlight. The graphics that are passed to this function must originate from one of the component sublayers of the BuildigSceneLayer.
ReturnsType Description Handle Returns a highlight handler with a remove()
method that can be called to remove the highlight.Example// 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); } }); });
-
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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected()
may be used to verify if creating an instance of the class is rejected. If it is rejected,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved()
may be used to verify if creating an instance of the class is resolved. If it is resolved,true
will be returned.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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");
-
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.Parameterscallback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe function to execute when the promise fails.
ReturnsType 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 });