require(["esri/layers/buildingSublayers/BuildingGroupSublayer"], (BuildingGroupSublayer) => { /* code goes here */ });
import BuildingGroupSublayer from "@arcgis/core/layers/buildingSublayers/BuildingGroupSublayer.js";
esri/layers/buildingSublayers/BuildingGroupSublayer
Hierarchical group of BuildingSceneLayer sublayers. It is used to group BuildingComponentSublayers into disciplines. If a BuildingSceneLayer has a Full Model sublayer, then this is also represented as a BuildingGroupSublayer.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
The name of the class. | Accessor | ||
The sublayer's layer id as defined by the Scene Service. | BuildingSublayer | ||
Indicates if this sublayer is empty. | BuildingSublayer | ||
Indicates how the sublayer should display in the LayerList widget. | BuildingGroupSublayer | ||
The modelName is a standard name for each sublayer. | BuildingSublayer | ||
Opacity of the sublayer. | BuildingSublayer | ||
A Collection of sublayers. | BuildingGroupSublayer | ||
The title of the sublayer used to identify it in places such as the LayerList and Legend widgets. | BuildingSublayer | ||
For BuildingGroupSublayer the type is always "building-group". | BuildingGroupSublayer | ||
Indicates if the sublayer is visible in the view. | BuildingGroupSublayer |
Property Details
-
id
InheritedPropertyid Numberreadonly
Inherited from BuildingSublayer -
The sublayer's layer id as defined by the Scene Service.
-
isEmpty
InheritedPropertyisEmpty Booleanreadonly
Inherited from BuildingSublayer -
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.
-
listMode
listMode String
Since: ArcGIS Maps SDK for JavaScript 4.11BuildingGroupSublayer since 4.10, listMode added at 4.11. -
Indicates how the sublayer should display in the LayerList widget. The possible values are listed below.
Value Description show The sublayer is visible in the table of contents. hide The sublayer is hidden in the table of contents. hide-children Hide the children layers from the table of contents. Possible Values:"show" |"hide" |"hide-children"
- Default Value:show
-
modelName
InheritedPropertymodelName Stringreadonly
Inherited from BuildingSublayer -
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
InheritedPropertyopacity Number
Inherited from BuildingSublayer -
Opacity of the sublayer.
- Default Value:1
-
sublayers
sublayers Collection<(BuildingGroupSublayer|BuildingComponentSublayer)>readonly
-
A Collection of sublayers.
-
title
InheritedPropertytitle String
Inherited from BuildingSublayer -
-
type
type Stringreadonly
-
For BuildingGroupSublayer the type is always "building-group".
-
visible
visible Boolean
-
Indicates if the sublayer is visible in the view. Can be used to toggle the visibility of all nested sublayers.
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 | ||
Loads all contained sublayers. | BuildingGroupSublayer | ||
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 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"); }
-
loadAll
loadAll(){Promise<BuildingSceneLayer>}
Since: ArcGIS Maps SDK for JavaScript 4.11BuildingGroupSublayer since 4.10, loadAll added at 4.11. -
Loads all contained sublayers.
ReturnsType Description Promise<BuildingSceneLayer> Resolves when all sublayers have been loaded. Rejects if at least one of the sublayers failed to load. - See also
Example// Load all contained sublayers but ignore if one or more of them failed to load buildingGroupSublayer.loadAll() .catch(function(error) { // Ignore any failed resources }) .then(function() { console.log("All loaded"); });
-
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");