BuildingComponentSublayer

Class: esri/layers/buildingSublayers/BuildingComponentSublayer
Inheritance: BuildingComponentSublayer BuildingSublayer Accessor
Since: ArcGIS API 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 filters can be applied by setting a definitionExpression.

See also:

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

The name of the class.

more details
more detailsAccessor
String

The SQL where clause used to filter features on the client.

more details
more detailsBuildingComponentSublayer
Number

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

more details
more detailsBuildingSublayer
String

Indicates how the layer should display in the LayerList widget.

more details
more detailsBuildingComponentSublayer
Error

The Error object returned if an error occurred while loading.

more details
more detailsBuildingComponentSublayer
String

Represents the status of a load operation.

more details
more detailsBuildingComponentSublayer
Object[]

A list of warnings which occurred while loading.

more details
more detailsBuildingComponentSublayer
String

The modelName is a standard name for each sublayer.

more details
more detailsBuildingSublayer
Number

Opacity of the sublayer.

more details
more detailsBuildingSublayer
Boolean

Indicates whether to display popups when features in the layer are clicked.

more details
more detailsBuildingComponentSublayer
PopupTemplate

The popup template for the sublayer.

more details
more detailsBuildingComponentSublayer
Renderer

The renderer assigned to the sublayer.

more details
more detailsBuildingComponentSublayer
String

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

more details
more detailsBuildingSublayer
String

The type for this sublayer is always building-component.

more details
more detailsBuildingComponentSublayer
Boolean

Indicates if the sublayer is visible in the view.

more details
more detailsBuildingSublayer

Property Details

declaredClass Stringreadonly inherited

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

definitionExpression String

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.

Important to note is 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. As a result all features need to be downloaded always for filter evaluation.

This property is evaluated on the client using the cached attributes and it only supports standardized SQL.

id Numberreadonly inherited

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

listMode String
Since: ArcGIS API for JavaScript 4.11

Indicates how the layer should display in the LayerList widget. The possible values are listed below.

ValueDescription
showThe layer is visible in the table of contents.
hideThe layer is hidden in the table of contents.
Default Value:show
loadError Errorreadonly

The Error object returned if an error occurred while loading.

Default Value:null
loadStatus Stringreadonly

Represents the status of a load operation.

ValueDescription
not-loadedThe object's resources have not loaded.
loadingThe object's resources are currently loading.
loadedThe object's resources have loaded without errors.
failedThe object's resources failed to load. See loadError for more details.
Default Value:not-loaded
loadWarnings Object[]readonly

A list of warnings which occurred while loading.

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 of the sublayer.

Default Value:1
popupEnabled 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
See also:
popupTemplate PopupTemplateautocast

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.

See also:

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.

See also:
Example:
// all features in the layer will be visualized with
// a blue color
sublayer.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" }
    }]
  }
};

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

type Stringreadonly

The type for this sublayer is always building-component.

Indicates if the sublayer is visible in the view.

Default Value:true

Method Overview

NameReturn TypeSummaryClass

Cancels a load() operation if it is already in progress.

more details
more detailsBuildingComponentSublayer
PopupTemplate

Creates a default popup template for the layer, populated with all the fields of the layer.

more details
more detailsBuildingComponentSublayer
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
more detailsBuildingComponentSublayer
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
more detailsBuildingComponentSublayer
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
more detailsBuildingComponentSublayer
Promise

Loads the resources referenced by this class.

more details
more detailsBuildingComponentSublayer
Promise

when() may be leveraged once an instance of the class is created.

more details
more detailsBuildingComponentSublayer

Method Details

cancelLoad()

Cancels a load() operation if it is already in progress.

createPopupTemplate(options){PopupTemplate}
Since: ArcGIS API for JavaScript 4.11

Creates a default popup template for the layer, populated with all the fields of the layer.

Parameters:
Specification:
options Object
optional

Options for creating the popup template.

Specification:
maximumFields Number
optional
Default Value: 75

The maximum number of fields to include in the popup template.

ignoreFieldTypes String[]
optional

Field types to ignore when creating the popup. By default the geometry, blob, raster, guid and xml field types are ignored.

Returns:
TypeDescription
PopupTemplateThe popup template, or null if the layer does not have any fields.
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:
TypeDescription
BooleanIndicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
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:
TypeDescription
BooleanIndicates whether creating an instance of the class has been rejected.
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:
TypeDescription
BooleanIndicates whether creating an instance of the class has been resolved.
load(){Promise}

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.

Returns:
TypeDescription
PromiseResolves when the resources have loaded.
when(callback, errback){Promise}

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
TypeDescription
PromiseReturns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses MapView, any class instance that is a promise may use then() in the same way
var 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
});

API Reference search results

NameTypeModule
Loading...