Building
A layer that may be used to visualize building models exported from Building Information Modeling (BIM) projects. This layer is used to visualize and interact with 3D building models developed using Building Information Modeling tools. The data in a building scene layer may represent building features such as walls, light fixtures, mechanical ductwork, and so forth. This layer is supported when used with LocalSceneView.
The data in a BuildingSceneLayer is organized into a hierarchy of BuildingSublayer. The sublayers of the building scene layer are a Full Model sublayer, which contains all building components, organized into a hierarchy of sublayers, grouped by discipline (such as Architectural, Mechanical, or Structural). The building scene layer may also contain an Overview sublayer, which may be loaded to display the exterior shell of the building. The Overview sublayer provides a means to quickly visualize a building's exterior, in cases where visualization of interior features is not required. Sublayers are available through LayerContent.subLayerContents.
Due to its complexity, the data in this layer is organized using BuildingGroupSublayer, which contains BuildingComponentSublayer. Often, the building scene layer contains an Overview BuildingComponentSublayer that can be loaded to display the exterior shell of a building. This provides a preview of the entire building without loading all interior features. This layer might also contain a Full Model building group sublayer with all the features in a building grouped by disciplines. Each discipline is a building group sublayer containing building component sublayers with features such as rooftops, walls, doors, AC units, lighting fixtures, columns, or foundations.
Building scene layers always have a SurfacePlacement mode of absolute.
Since
300.0.0
See also
Constructors
Creates a building scene layer object with a portal item.
Creates a building scene layer object with the URI. If the specified URI is a portal item URL (see PortalItem.PortalItem for the supported URL formats), the underlying PortalItem will be created and accessible through Layer.item.
Properties
The active filter to apply to this layer. If no active filter is set, then no filter is applied. The active filter is not applied to an Overview BuildingComponentSublayer.
The layer altitude offset. This raises or lowers all features in this layer by the given offset. The value is in meters.
A collection of all available filters, including those that were pre-authored from the service or package. To enable a building filter on a layer, specify a BuildingSceneLayer.activeFilter.
True if the child layers should be shown in the map legend, false otherwise.
The hierarchical collection of sublayers in this layer. It usually contains an Overview BuildingComponentSublayer and a Full Model BuildingGroupSublayer. However, some building scene layers may contain only the Full Model BuildingGroupSublayer or the discipline building group sublayers directly inside the layer.
Inherited properties
The API key allows your app to access ArcGIS location services and private portal items. An API key is a unique long-lived access token that is used to authenticate and monitor requests to ArcGIS location services and private portal items. You can create and manage an API key using your portal when you sign in with an ArcGIS Location Platform account or an ArcGIS Online account with administrator access or a custom role that has the Generate API keys privilege. To learn how to create and manage API keys, go to the Create an API Key tutorial. You must ensure that your API key has the correct privileges to access secure resources.
The attribution text for the layer.
A flag indicating whether the layer content's visibility can be changed. A flag indicating whether the layer content visibility can be changed. Will return false if an error occurs.
The description for the layer.
The full extent of this layer, which is the extent where all layer data is contained. You can use this to zoom to all of the data contained in this layer. For feature layers, the extent is retrieved from its FeatureTable.extent.
The unique identifying string for the layer, as specified in a map or scene. The id is used by other parts of this API to refer to a specific Layer, such as in a set of FeatureFenceParameters or a FacilityLayerDefinition. If not supplied, all layers will be assigned a unique id when created.
True if the layer supports identify, false otherwise. The value of this property may not be correct until the layer is in a fully loaded state.
The load status.
The maximum scale for the layer. The maximum scale at which this layer is visible. If the map or scene is zoomed in beyond this scale, the layer will not be visible. A value of 0 means there is no maximum scale threshold and the layer will be visible at the smallest scale available for the map or scene. If the value is nil, there is no maximum scale. All of the connected map and scene views will be updated.
The minimum scale for the layer. The minimum scale at which this layer is visible. If the map or scene is zoomed out beyond this scale, the layer will not be visible. A value of 0 means there is no minimum scale threshold and the layer will be visible at the largest scale available for the map or scene. If the value is nil, there is no minimum scale. All of the connected map and scene views will be updated.
A flag indicating whether the layer content participates in the legend. A flag indicating whether the layer content is shown in the legend.
The spatial reference of the layer.
The sub layer contents of a layer content.
A SharedFlow that emits when the visibility of the layer changes.
Functions
Clones the BuildingSceneLayer.
Fetches available statistics for each attribute defined in this layer. Statistics are stored as a dictionary of key-value pairs, with each key being the attribute's name, and the associated value being a set of relevant statistics. There will be an error if fetching statistics is unsuccessful.
Inherited functions
Cancels loading metadata for the Loadable object.
Fetches the list of legend info.
Returns the layer content's effective visibility at the specified scale. Returns the effective layer content visibility. This effective visibility takes care of the effective visibility of the parents at the specified scale. Will return false if an error occurs.