BuildingGroupSublayer

AMD: require(["esri/layers/buildingSublayers/BuildingGroupSublayer"], (BuildingGroupSublayer) => { /* code goes here */ });
ESM: import BuildingGroupSublayer from "@arcgis/core/layers/buildingSublayers/BuildingGroupSublayer";
Class: esri/layers/buildingSublayers/BuildingGroupSublayer
Inheritance: BuildingGroupSublayer BuildingSublayer Accessor
Since: ArcGIS API for JavaScript 4.10

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.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Numbermore details

The sublayer's layer id as defined by the Scene Service.

more detailsBuildingSublayer
Booleanmore details

Indicates if this sublayer is empty.

more detailsBuildingSublayer
Stringmore details

Indicates how the sublayer should display in the LayerList widget.

more detailsBuildingGroupSublayer
Stringmore details

The modelName is a standard name for each sublayer.

more detailsBuildingSublayer
Numbermore details

Opacity of the sublayer.

more detailsBuildingSublayer
Collection<(BuildingGroupSublayer|BuildingComponentSublayer)>more details

A Collection of sublayers.

more detailsBuildingGroupSublayer
Stringmore details

The title of the sublayer used to identify it in places such as the LayerList and Legend widgets.

more detailsBuildingSublayer
Stringmore details For BuildingGroupSublayer the type is always "building-group". more detailsBuildingGroupSublayer
Booleanmore details

Indicates if the sublayer is visible in the view.

more detailsBuildingGroupSublayer

Property Details

declaredClass Stringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

id Numberreadonly inherited

The sublayer's layer id as defined by the Scene Service.

isEmpty Booleanreadonly inherited

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 String
Since: ArcGIS API for JavaScript 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 Stringreadonly inherited

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 Number inherited

Opacity of the sublayer.

Default Value:1

A Collection of sublayers.

The title of the sublayer used to identify it in places such as the LayerList and Legend widgets.

type Stringreadonly

For BuildingGroupSublayer the type is always "building-group".

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
Promise<BuildingSceneLayer>more details

Loads all contained sublayers.

more detailsBuildingGroupSublayer

Method Details

Since: ArcGIS API for JavaScript 4.11

Loads all contained sublayers.

Returns:
Type 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");
  });

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.