import BuildingComponentSublayer from "@arcgis/core/layers/buildingSublayers/BuildingComponentSublayer.js";const BuildingComponentSublayer = await $arcgis.import("@arcgis/core/layers/buildingSublayers/BuildingComponentSublayer.js");- Inheritance:
- BuildingComponentSublayer→
BuildingSublayer→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.10
BuildingComponentSublayers contain 3D Object features representing building components like doors, pipes or AC units. They are sublayers in a BuildingSceneLayer either directly or as part of a BuildingGroupSublayer. This sublayer is similar to a 3D Object SceneLayer, it can be visualized with a specific renderer, popups can be customized using popupTemplate and SQL filters can be applied by setting a definitionExpression.
Starting with version 4.17, BuildingComponentSublayers support attribute or spatial queries if the the BuildingSceneLayer has an associated feature layer.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
fields readonly | Field[] | |
globalIdField readonly | | |
id readonly inherited | ||
isEmpty readonly inherited | ||
"hide" | "show" | | |
loadError readonly inherited | ||
loadStatus readonly inherited | "not-loaded" | "loading" | "failed" | "loaded" | |
loadWarnings readonly inherited | any[] | |
modelName readonly inherited | ||
objectIdField readonly | | |
opacity inherited | ||
| | ||
| | ||
| | ||
| | ||
title inherited | ||
type readonly | "building-component" | |
uid readonly inherited | ||
visible inherited |
definitionExpression
The SQL where clause used to filter features on the client. Only the features that satisfy the definition expression are displayed in the View. Setting a definition expression is useful when only a subset of the data in the layer should be displayed.
Setting the definition expression of a layer automatically updates all layer views.
If the definition expression is set after the layer has been added to the map, the view will automatically refresh itself to display the features that satisfy the new definition expression.
Note that the initial loading time of the features remains unchanged, even if they are filtered. This happens because, as opposed to Feature Layers, feature filtering is done client-side. This means that all features need to be downloaded for filter evaluation.
This property is evaluated on the client using the cached attributes and it only supports standardized SQL.
fields
- Type
- Field[]
- Since
- ArcGIS Maps SDK for JavaScript 4.33
An array of fields in the layer. Each field represents an attribute that may contain a value for each feature in the layer.
id
- Type
- number
The sublayer's layer id as defined by the Scene Service.
- Default value
- -1
isEmpty
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
- Type
- "hide" | "show"
- Since
- ArcGIS Maps SDK for JavaScript 4.11
Indicates how the layer should display in the LayerList widget. The possible values are listed below.
| Value | Description |
|---|---|
| show | The layer is visible in the table of contents. |
| hide | The layer is hidden in the table of contents. |
- Default value
- "show"
loadError
The Error object returned if an error occurred while loading.
loadStatus
- Type
- "not-loaded" | "loading" | "failed" | "loaded"
Represents the status of a load() operation.
| Value | Description |
|---|---|
| not-loaded | The object's resources have not loaded. |
| loading | The object's resources are currently loading. |
| loaded | The object's resources have loaded without errors. |
| failed | The object's resources failed to load. See loadError for more details. |
- Default value
- "not-loaded"
loadWarnings
- Type
- any[]
A list of warnings which occurred while loading.
modelName
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 sublayerconst doorslayer = buildingSceneLayer.allSublayers.find(function(sublayer) { return sublayer.modelName === "Doors";}); opacity
- Type
- number
Opacity of the sublayer.
- Default value
- 1
outFields
- Since
- ArcGIS Maps SDK for JavaScript 4.12
An array of field names from the service to include with each feature.
To fetch the values from all fields in the layer, use ["*"]. Fields specified in
outFields will be requested alongside with required fields for rendering.
To include fields in all sublayers, use the BuildingSceneLayer.outFields property of the parent layer.
popupEnabled
- Type
- boolean
Indicates whether to display popups when features in the layer are clicked. The layer needs to have a popupTemplate to define what
information should be displayed in the popup. Alternatively, a default popup template may be automatically used if
Popup.defaultPopupTemplateEnabled is set to true.
- Default value
- true
popupTemplate
- Type
- PopupTemplate | null | undefined
The popup template for the sublayer. When set, the popupTemplate
allows users to access attributes and display their values in the
view's Popup when a feature is selected
using text and/or charts. See the PopupTemplate sample
for an example of how PopupTemplate interacts with a
FeatureLayer. Setting a PopupTemplate
on this layer type is done in the same way as a FeatureLayer.
A default popup template is automatically used if no popupTemplate has been defined when
Popup.defaultPopupTemplateEnabled
is set to true.
renderer
- Type
- RendererUnion | null | undefined
The renderer assigned to the sublayer. The renderer defines how to visualize each feature in the sublayer. Depending on the renderer type, features may be visualized with the same symbol, or with varying symbols based on the values of provided attribute fields or functions.
Example
// all features in the layer will be visualized with// a blue colorsublayer.renderer = { type: "simple", // autocasts as new SimpleRenderer() symbol: { type: "mesh-3d", // autocasts as new MeshSymbol3D() symbolLayers: [{ type: "fill", // autocasts as new FillSymbol3DLayer() material: { color: "blue" } }] }}; uid
- Type
- string
- 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
- Type
- boolean
Indicates if the sublayer is visible in the view.
- Default value
- true
Methods
| Method | Signature | Class |
|---|---|---|
cancelLoad inherited | cancelLoad(): this | |
createPopupTemplate(options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined | | |
createQuery(): Query | | |
getField(fieldName: string): Field | null | undefined | | |
getFieldDomain(fieldName: string, options?: FieldDomainOptions): DomainUnion | null | undefined | | |
getFieldUsageInfo(fieldName: string): object | | |
isFulfilled inherited | isFulfilled(): boolean | |
isRejected inherited | isRejected(): boolean | |
isResolved inherited | isResolved(): boolean | |
load inherited | load(options?: AbortOptions | null | undefined): Promise<this> | |
queryExtent(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<{
count: number;
extent: Extent | null;
}> | | |
queryFeatureCount(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<number> | | |
queryFeatures(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<FeatureSet> | | |
queryObjectIds(query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<number[]> | | |
when inherited | when<TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2> |
cancelLoad
- Signature
-
cancelLoad (): this
Cancels a load() operation if it is already in progress.
- Returns
- this
createPopupTemplate
- Signature
-
createPopupTemplate (options?: CreatePopupTemplateOptions): PopupTemplate | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.11
Creates a default popup template for the layer, populated with all the fields of the layer.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| options | Options for creating the popup template. | |
- Returns
- PopupTemplate | null | undefined
The popup template, or
nullif the layer does not have any fields.
createQuery
- Signature
-
createQuery (): Query
- Since
- ArcGIS Maps SDK for JavaScript 4.17
Creates a query object that can be used to fetch features that satisfy the component sublayer's current definition expression. The query should only be used on the layer and not on the layer view.
- Returns
- Query
The query object representing the layer's definition expression.
getField
- Signature
-
getField (fieldName: string): Field | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.12
Returns the Field instance for a field name (case-insensitive).
getFieldDomain
- Signature
-
getFieldDomain (fieldName: string, options?: FieldDomainOptions): DomainUnion | null | undefined
- Since
- ArcGIS Maps SDK for JavaScript 4.12
Returns the Domain associated with the given field name. The domain can be either a CodedValueDomain or RangeDomain.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| fieldName | Name of the field. | | |
| options | An object specifying additional options. See the object specification table below for the required properties of this object. | |
- Returns
- DomainUnion | null | undefined
The Domain object associated with the given field name for the given feature.
getFieldUsageInfo
- Signature
-
getFieldUsageInfo (fieldName: string): object
- Since
- ArcGIS Maps SDK for JavaScript 4.17.
Gets field usage information. On building component sub layers, fields can always be used for rendering and popups. Fields can only be used for querying if an associated feature service is available.
The returned object contains the following usage information:
| Property | Type | Description |
|---|---|---|
| supportsRenderer | boolean | Indicates that a field can be used in a renderer (e.g. in visual variables), see renderer. |
| supportsLabelingInfo | boolean | This is always false, labeling is not supported on BuildingSceneLayer. |
| supportsPopupTemplate | boolean | Indicates that a field can be used in a popup template, see popupTemplate. |
| supportsLayerQuery | boolean | Indicates that a field can be used in layer queries, see queryFeatures(). |
isFulfilled
- Signature
-
isFulfilled (): boolean
isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).
If it is fulfilled, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected
- Signature
-
isRejected (): boolean
isRejected() may be used to verify if creating an instance of the class is rejected.
If it is rejected, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been rejected.
isResolved
- Signature
-
isResolved (): boolean
isResolved() may be used to verify if creating an instance of the class is resolved.
If it is resolved, true will be returned.
- Returns
- boolean
Indicates whether creating an instance of the class has been resolved.
load
- Signature
-
load (options?: AbortOptions | null | undefined): Promise<this>
Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.
This method must be called by the developer when accessing a resource that will not be loaded in a View.
The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.
It's possible to provide a signal to stop being interested into a Loadable instance load status.
When the signal is aborted, the instance does not stop its loading process, only cancelLoad() can abort it.
queryExtent
- Signature
-
queryExtent (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<{ count: number; extent: Extent | null; }>
- Since
- ArcGIS Maps SDK for JavaScript 4.17
Executes a Query against the associated feature service and returns the 2D
Extent of features that satisfy the query.
At the moment the 3D Extent can be returned by using
BuildingComponentSublayerView.queryExtent(),
but this will return the 3D extent only for features currently in the view.
The query succeeds only if the BuildingSceneLayer has an associated feature layer.
If an associated feature layer is not available, then an error
with the name buildingscenelayer:query-not-available is thrown. Read more about queries in the
Querying section of the BuildingSceneLayer class description.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the query parameters. | | |
| options | An object with the following properties. | |
- Returns
- Promise<{
count: number;
extent: Extent | null;
}>
When resolved, returns the extent and count of the features that satisfy the input query. See the object specification table below for details.
Property Type Description count Number The number of features that satisfy the input query. extent Extent The extent of the features that satisfy the query.
queryFeatureCount
- Signature
-
queryFeatureCount (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<number>
- Since
- ArcGIS Maps SDK for JavaScript 4.17
Executes a Query against the associated feature service and
returns the number of features that satisfy the query. The query succeeds only if
the layer's supportsLayerQuery capability is enabled. Use the
getFieldUsageInfo() method to check if the layer supports queries.
If querying is not enabled, then an error
with the name buildingscenelayer:query-not-available is thrown. Read more about queries in the
Querying section of the BuildingSceneLayer class description.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the query parameters. | | |
| options | An object with the following properties. | |
queryFeatures
- Signature
-
queryFeatures (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<FeatureSet>
- Since
- ArcGIS Maps SDK for JavaScript 4.17
Executes a Query against the associated feature service and returns a
FeatureSet. The query succeeds only if
the layer's supportsLayerQuery capability is enabled. Use the
getFieldUsageInfo() method to check if the layer supports queries.
If querying is not enabled, then an error
with the name buildingscenelayer:query-not-available is thrown. Read more about queries in the
Querying section of the BuildingSceneLayer class description.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the query parameters. | | |
| options | An object with the following properties. | |
- Returns
- Promise<FeatureSet>
Resolves to a FeatureSet which contains the features satisfying the query.
queryObjectIds
- Signature
-
queryObjectIds (query?: QueryProperties | null | undefined, options?: AbortOptions): Promise<number[]>
- Since
- ArcGIS Maps SDK for JavaScript 4.17
Executes a Query against the associated feature service and returns an array of
ObjectIDs of the features that satisfy the input query. The query succeeds only if
the layer's supportsLayerQuery capability is enabled. Use the
getFieldUsageInfo() method to check if the layer supports queries.
If querying is not enabled, then an error
with the name buildingscenelayer:query-not-available is thrown. Read more about queries in the
Querying section of the SceneLayer class description.
- See also
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| query | Specifies the query parameters. | | |
| options | An object with the following properties. | |
when
- Signature
-
when <TResult1 = this, TResult2 = never>(onFulfilled?: OnFulfilledCallback<this, TResult1> | null | undefined, onRejected?: OnRejectedCallback<TResult2> | null | undefined): Promise<TResult1 | TResult2>
when() may be leveraged once an instance of the class is created. This method takes two input parameters: an onFulfilled function and an onRejected function.
The onFulfilled executes when the instance of the class loads. The
onRejected executes if the instance of the class fails to load.
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| onFulfilled | OnFulfilledCallback<this, TResult1> | null | undefined | The function to call when the promise resolves. | |
| onRejected | The function to execute when the promise fails. | |
- Returns
- Promise<TResult1 | TResult2>
Returns a new promise for the result of
onFulfilledthat may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same waylet view = new MapView();view.when(function(){ // This function will execute once the promise is resolved}, function(error){ // This function will execute if the promise is rejected due to an error});