Skip To ContentArcGIS for DevelopersSign In Dashboard

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.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
Number

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

more details
more detailsBuildingSublayer
String

Indicates how the layer should display in the LayerList widget.

more details
more detailsBuildingGroupSublayer
String

The modelName is a standard name for each sublayer.

more details
more detailsBuildingSublayer
Number

Opacity of the sublayer.

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

A Collection of sublayers.

more details
more detailsBuildingGroupSublayer
String

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

more details
more detailsBuildingSublayer
String

The type for this sublayer is always building-group.

more details
more detailsBuildingGroupSublayer
Boolean

Indicates if the sublayer is visible in the view.

more details
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.

listMode String
Since: ArcGIS API for JavaScript 4.11

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
hide-childrenHide the children layers from the table of contents.
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 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

The type for this sublayer 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

NameReturn TypeSummaryClass
Promise<BuildingSceneLayer>

Loads all contained sublayers.

more details
more detailsBuildingGroupSublayer

Method Details

Since: ArcGIS API for JavaScript 4.11

Loads all contained sublayers.

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

API Reference search results

NameTypeModule
Loading...