BuildingSceneLayerView
esri/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 | |
---|---|---|---|---|
String | The name of the class. more details | more details | Accessor | |
BuildingSceneLayer | The layer being viewed. more details | more details | BuildingSceneLayerView | |
Collection<BuildingComponentSublayerView> | Collection of sublayer views for all the component sublayers of the BuildingSceneLayer. more details | more details | BuildingSceneLayerView | |
Boolean | Value is | more details | LayerView | |
Boolean | Value is | more details | LayerView | |
Boolean | When | more details | 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.
Example:view.whenLayerView(buildingSceneLayer).then(function(buildingSceneLayerView) { console.log(buildingSceneLayerView.sublayerViews); });
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. Set this property tofalse
to hide the layer from the view.- Default Value:true
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
Handle | Highlights the given feature(s). more details | more details | BuildingSceneLayerView | |
Boolean |
| more details | LayerView | |
Boolean |
| more details | LayerView | |
Boolean |
| more details | LayerView | |
Promise |
| more details | LayerView |
Method Details
- highlight(target){Handle}
Highlights the given feature(s).
Parameter:optional The feature(s) to highlight. The graphics that are passed to this function must originate from one of the component sublayers of the BuildigSceneLayer.
Returns:Type 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.Returns:Type 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.Returns:Type 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.Returns:Type Description Boolean Indicates whether creating an instance of the class has been resolved.
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.Parameters:callback FunctionoptionalThe function to call when the promise resolves.
errback FunctionoptionalThe 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 var 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 });