# Interface BuildingSublayerProperties

Properties that can be specified for the `BuildingSublayer.sublayer` property.

interface BuildingSublayerProperties {
$ref?: string | number | SublayerReference;
$sublayerType?: string;
defaultVisibility?: boolean;
definitionEditor?: DefinitionEditorJson;
disablePopup?: boolean;
featureSet?: FeatureSetJson;
field?: FieldJson;
id?: number;
layerDefinition?: LayerDefinitionJson;
layerUrl?: string;
listMode?: LayerListMode;
maxScale?: number;
minScale?: number;
name?: string;
nextObjectId?: number;
opacity?: number;
parentLayerId?: number;
popupInfo?: PopupInfoJson;
showLegend?: boolean;
subLayerIds?: number[];
title?: string;
visibility?: boolean;
visible?: boolean;
}

#### Hierarchy (view full)

- BuildingSceneSublayerJson
- Omit<SublayerProperties, "id">
  - BuildingSublayerProperties

#####
Index

### Properties

$ref?
$sublayerType?
defaultVisibility?
definitionEditor?
disablePopup?
featureSet?
field?
id?
layerDefinition?
layerUrl?
listMode?
maxScale?
minScale?
name?
nextObjectId?
opacity?
parentLayerId?
popupInfo?
showLegend?
subLayerIds?
title?
visibility?
visible?

##
Properties

### `Optional`$ref

$ref?: string | number | SublayerReference

A reference to an existing sublayer, which is the ID or title of the sublayer (or both). In this case, the sublayer extension will attempt to find an existing sublayer instead of creating one.

Inherited from Omit.$ref

### `Optional`$sublayerType

$sublayerType?: string

The type of sublayer. This property is required when calling mapping/_SublayerExtension!SublayerExtension.create.

Inherited from Omit.$sublayerType

### `Optional` defaultVisibility

defaultVisibility?: boolean

Default visibility of the layers in the map service.

Inherited from Omit.defaultVisibility

### `Optional` definitionEditor

definitionEditor?: DefinitionEditorJson

An object that provides interactive filters.

Inherited from Omit.definitionEditor

### `Optional` disablePopup

disablePopup?: boolean

Allows a client to ignore popups defined by the service item.

Inherited from BuildingSceneSublayerJson.disablePopup

### `Optional` featureSet

featureSet?: FeatureSetJson

A featureSet object containing the geometry and attributes of the features in the layer. Used with feature collections only.

Inherited from Omit.featureSet

### `Optional` field

field?: FieldJson

Information about each field in a layer.

NOTE: This is how it's typed and documented in the web map spec, but is almost certainly total nonsense.

Inherited from Omit.field

### `Optional` id

id?: number

Identifies the sublayer inside the building scene layer.

Inherited from BuildingSceneSublayerJson.id

### `Optional` layerDefinition

layerDefinition?: LayerDefinitionJson

Additional properties that can define drawing information and a definition expression for the sublayer. See layerDefinition properties table.

Inherited from BuildingSceneSublayerJson.layerDefinition

### `Optional` layerUrl

layerUrl?: string

A URL to a service that should be used for all queries against the layer. Used with hosted tiled map services on ArcGIS Online when there is an associated feature service that allows for queries.

Inherited from Omit.layerUrl

### `Optional` listMode

listMode?: LayerListMode

To show or hide the sublayer in the layer list. If property is present, must be one of the following values: show, hide.

Inherited from BuildingSceneSublayerJson.listMode

### `Optional` maxScale

maxScale?: number

Represents the maximum scale at which the layer definition will be applied.

Inherited from Omit.maxScale

### `Optional` minScale

minScale?: number

Represents the minimum scale at which the layer definition will be applied.

Inherited from Omit.minScale

### `Optional` name

name?: string

(Deprecated, use title instead.) A name for the layer.

Inherited from Omit.name

### `Optional` nextObjectId

nextObjectId?: number

Iterates within a feature set. Number objectId value is incremented +1 based on last Object ID defined for the feature in a feature set.

Inherited from Omit.nextObjectId

### `Optional` opacity

opacity?: number

The degree of transparency applied to the sublayer on the client side, where 0 is full transparency and 1 is no transparency. This is multiplied with the opacity of the containing layers.

Inherited from BuildingSceneSublayerJson.opacity

### `Optional` parentLayerId

parentLayerId?: number

If working with nested layers, this is the numeric value indicating the layer id of the next layer (parent) directly above the current referenced layer.

Inherited from Omit.parentLayerId

### `Optional` popupInfo

popupInfo?: PopupInfoJson

A popupInfo object defining the content of pop-up windows when you click or query a feature.

Inherited from BuildingSceneSublayerJson.popupInfo

### `Optional` showLegend

showLegend?: boolean

Indicates whether to allow map authors the ability to control what layers should be shown in a client's legend.

Inherited from Omit.showLegend

### `Optional` subLayerIds

subLayerIds?: number[]

If the layer is a parent layer, it will have one or more sub layers included in an array.

Inherited from Omit.subLayerIds

### `Optional` title

title?: string

A user-friendly string title for the sublayer that can be used in a table of contents.

Inherited from BuildingSceneSublayerJson.title

### `Optional` visibility

visibility?: boolean

Boolean property determining whether the sublayer is initially visible in the web scene.

Inherited from BuildingSceneSublayerJson.visibility

### `Optional` visible

visible?: boolean

Visibility of the sublayer.

Inherited from Omit.visible