Property Overview

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

sublayers Collection<(BuildingGroupSublayer|BuildingComponentSublayer)>readonly

A Collection of sublayers.

title String inherited

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

Method Details

loadAll(){Promise<BuildingSceneLayer>}

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:

• load

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