BuildingGroupSublayer | References | ArcGIS Maps SDK for JavaScript

import BuildingGroupSublayer from "@arcgis/core/layers/buildingSublayers/BuildingGroupSublayer.js";

Inheritance:: BuildingGroupSublayer→BuildingSublayer→Accessor

Since: ArcGIS Maps SDK 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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`BuildingGroupSublayerProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`id` readonly inherited	`number`	BuildingSublayer
`isEmpty` readonly inherited	`boolean \| null \| undefined`	BuildingSublayer
`listMode`	`"hide" \| "show" \| "hide-children"`
`modelName` readonly inherited	`string \| null \| undefined`	BuildingSublayer
`opacity` inherited	`number`	BuildingSublayer
`sublayers` readonly	`Collection<BuildingSublayerUnion>`
`title` inherited	`string \| null \| undefined`	BuildingSublayer
`type` readonly	`"building-group"`
`uid` readonly inherited	`string`	IdentifiableMixin
`visible`	`boolean`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

id

readonlyinherited Property

Type: number

Inherited from: BuildingSublayer

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

Default value: -1

isEmpty

readonlyinherited Property

Type: boolean | null | undefined

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

Type: "hide" | "show" | "hide-children"

Since: ArcGIS Maps SDK 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.

Default value: "show"

modelName

readonlyinherited Property

Type: string | null | undefined

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

Type: number

Inherited from: BuildingSublayer

Opacity of the sublayer.

Default value: 1

sublayers

readonly Property

Type: Collection<BuildingSublayerUnion>

A Collection of sublayers.

title

inherited Property

Type: string | null | undefined

Inherited from: BuildingSublayer

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

Default value: ""

type

readonly Property

Type: "building-group"

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

Since: ArcGIS Maps SDK for JavaScript 4.33

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

visible

Property

Type: boolean

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

Methods

Method	Signature	Class
`loadAll`	`loadAll(): Promise<this>`

loadAll

Method

Signature: loadAll (): Promise<this>

Since: ArcGIS Maps SDK for JavaScript 4.11

Loads all contained sublayers.

See also

BuildingComponentSublayer.load()

Returns: Promise<this>
Resolves when all sublayers have been loaded. Rejects if at least one of the sublayers failed to 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");
  });