require(["esri/layers/buildingSublayers/BuildingSublayer"], (BuildingSublayer) => { /* code goes here */ });
import BuildingSublayer from "@arcgis/core/layers/buildingSublayers/BuildingSublayer.js";
esri/layers/buildingSublayers/BuildingSublayer
BuildingSublayer is the base class for sublayers of a BuildingSceneLayer. It can be either a BuildingGroupSublayer which contains nested BuildingSublayers or a BuildingComponentSublayer, which is a layer similar to a 3DObject SceneLayer for one component of the building.
Property Overview
| Name | Type | Summary | Class |
|---|---|---|---|
| String | The name of the class. | Accessor | |
| Number | The sublayer's layer id as defined by the Scene Service. | BuildingSublayer | |
| Boolean | Indicates if this sublayer is empty. | BuildingSublayer | |
| String | The modelName is a standard name for each sublayer. | BuildingSublayer | |
| Number | Opacity of the sublayer. | BuildingSublayer | |
| String | The title of the sublayer used to identify it in places such as the LayerList and Legend widgets. | BuildingSublayer | |
| Boolean | Indicates if the sublayer is visible in the view. | BuildingSublayer |
Property Details
-
id
Propertyid Numberreadonly -
The sublayer's layer id as defined by the Scene Service.
-
isEmpty
PropertyisEmpty Booleanreadonly -
Indicates if this sublayer is empty. This property is only read from the service. Empty sublayers are not loaded for rendering and applications can choose to hide them in their UI.
-
modelName
PropertymodelName Stringreadonly -
The modelName is a standard name for each sublayer. For example the sublayer containing the doors in a building has the modelName "Doors". Use this property to retrieve sublayers in a BuildingSceneLayer.
Example// use modelName to identify a sublayer const doorslayer = buildingSceneLayer.allSublayers.find(function(sublayer) { return sublayer.modelName === "Doors"; });
-
opacity
Propertyopacity Number -
Opacity of the sublayer.
- Default Value:1
-
title
Propertytitle String -
-
visible
Propertyvisible Boolean -
Indicates if the sublayer is visible in the view.
- 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. | Accessor | ||
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor |
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"); }
-
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");