BuildingGroupSublayer | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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 Watch for changes topic.

Show inherited properties

Hide inherited properties

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	Indicates how the sublayer should display in the LayerList widget.	BuildingGroupSublayer
String	The modelName is a standard name for each sublayer.	BuildingSublayer
Number	Opacity of the sublayer.	BuildingSublayer
Collection<(BuildingGroupSublayer\|BuildingComponentSublayer)>	A Collection of sublayers.	BuildingGroupSublayer
String	The title of the sublayer used to identify it in places such as the LayerList and Legend widgets.	BuildingSublayer
String	For BuildingGroupSublayer the type is always "building-group".	BuildingGroupSublayer
Boolean	Indicates if the sublayer is visible in the view.	BuildingGroupSublayer

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

id Inherited Property id Numberreadonly Inherited from BuildingSublayer

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

isEmpty Inherited Property isEmpty 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 Property listMode String Since: ArcGIS Maps SDK for JavaScript 4.11 BuildingGroupSublayer 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 Inherited Property modelName 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 Inherited Property opacity Number Inherited from BuildingSublayer

Opacity of the sublayer.

Default Value:1

sublayers Property sublayers Collection<(BuildingGroupSublayer|BuildingComponentSublayer)>readonly

A Collection of sublayers.

title Inherited Property title String Inherited from BuildingSublayer

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

type Property type Stringreadonly

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

visible Property visible Boolean

Indicates if the sublayer is visible in the view. Can be used to toggle the visibility of all nested sublayers.

Method Overview

Show inherited methods

Hide inherited methods

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
Promise<BuildingSceneLayer>	Loads all contained sublayers.	BuildingGroupSublayer
	Removes a group of handles owned by the object.	Accessor

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Method loadAll(){Promise<BuildingSceneLayer>} Since: ArcGIS Maps SDK for JavaScript 4.11 BuildingGroupSublayer since 4.10, loadAll added at 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");
  });

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");