# Interface BuildingSceneLayerProperties

Properties that can be specified for the BuildingSceneLayerExtensionProperties.layer property.

interface BuildingSceneLayerProperties {
$portalItem?: PortalItemLike;
$ref?: string | LayerReference;
activeFilterId?: string;
blendMode?:
| "invert"
| "normal"
| "lighter"
| "multiply"
| "color"
| "average"
| "color-burn"
| "color-dodge"
| "darken"
| "destination-atop"
| "destination-in"
| "destination-out"
| "destination-over"
| "difference"
| "exclusion"
| "hard-light"
| "hue"
| "lighten"
| "luminosity"
| "minus"
| "overlay"
| "plus"
| "reflect"
| "saturation"
| "screen"
| "soft-light"
| "source-atop"
| "source-in"
| "source-out"
| "vivid-light"
| "xor";
effect?: EffectJson;
filters?: FilterJson[];
id?: string;
itemId?: string;
layerDefinition?: LayerDefinitionJson;
layerType: "BuildingSceneLayer";
listMode?: "show" | "hide" | "hide-children";
maxScale?: number;
minScale?: number;
opacity?: number;
refreshInterval?: number;
showLegend?: boolean;
sublayers?: BuildingSceneSublayerJson[];
title?: string;
type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType;
url?: string;
visibility?: boolean;
visibilityTimeExtent?: [number, number];
}

#### Hierarchy (view full)

- BuildingSceneLayerJson
- Omit<LayerProperties, "layerType">
  - BuildingSceneLayerProperties

#####
Index

### Properties

$portalItem?
$ref?
activeFilterId?
blendMode?
effect?
filters?
id?
itemId?
layerDefinition?
layerType
listMode?
maxScale?
minScale?
opacity?
refreshInterval?
showLegend?
sublayers?
title?
type?
url?
visibility?
visibilityTimeExtent?

##
Properties

### `Optional`$portalItem

$portalItem?: PortalItemLike

When present, mapping/_LayerExtension!LayerExtension.layer will be loaded from the given web layer in Portal. The web layer can be specified either as a PortalItem object, or simply using the portal item ID.

Inherited from Omit.$portalItem

### `Optional`$ref

$ref?: string | LayerReference

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

Inherited from Omit.$ref

### `Optional` activeFilterId

activeFilterId?: string

Specifies the id of the currently active filter.

Inherited from BuildingSceneLayerJson.activeFilterId

### `Optional` blendMode

blendMode?:
| "invert"
| "normal"
| "lighter"
| "multiply"
| "color"
| "average"
| "color-burn"
| "color-dodge"
| "darken"
| "destination-atop"
| "destination-in"
| "destination-out"
| "destination-over"
| "difference"
| "exclusion"
| "hard-light"
| "hue"
| "lighten"
| "luminosity"
| "minus"
| "overlay"
| "plus"
| "reflect"
| "saturation"
| "screen"
| "soft-light"
| "source-atop"
| "source-in"
| "source-out"
| "vivid-light"
| "xor"

Blend modes are used to blend layers together to create an interesting effect in a layer, or even to produce what seems like a new layer.

Inherited from BuildingSceneLayerJson.blendMode

### `Optional` effect

effect?: EffectJson

Effect provides various filter functions to achieve different visual effects similar to how image filters (photo apps) work.

Inherited from BuildingSceneLayerJson.effect

### `Optional` filters

filters?: FilterJson[]

A list of filters available for this layer. Overrides filters defined on the service.

Inherited from BuildingSceneLayerJson.filters

### `Optional` id

id?: string

A unique identifying string for the layer.

Inherited from BuildingSceneLayerJson.id

### `Optional` itemId

itemId?: string

Optional string containing the item ID of the service if it's registered on ArcGIS Online or your organization's portal.

Inherited from BuildingSceneLayerJson.itemId

### `Optional` layerDefinition

layerDefinition?: LayerDefinitionJson

Additional properties that can define an elevation offset for the layer.

Inherited from BuildingSceneLayerJson.layerDefinition

### layerType

layerType

The type of layer.

Inherited from BuildingSceneLayerJson.layerType

### `Optional` listMode

listMode?: "show" | "hide" | "hide-children"

Indicates how the layer should display in the table of contents. The known values are listed below. See support/esri!ListMode.

Inherited from BuildingSceneLayerJson.listMode

### `Optional` maxScale

maxScale?: number

A number representing the maximum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400. A value of 0 indicates that the layer will be visible no matter how far you zoom in.

Inherited from BuildingSceneLayerJson.maxScale

### `Optional` minScale

minScale?: number

A number representing the minimum scale at which the layer will be visible. The number is the scale's denominator; thus, a value of 2400 represents a scale of 1/2,400.

Inherited from BuildingSceneLayerJson.minScale

### `Optional` opacity

opacity?: number

The degree of transparency applied to the layer on the client side, where 0 is full transparency and 1 is no transparency.

Inherited from BuildingSceneLayerJson.opacity

### `Optional` refreshInterval

refreshInterval?: number

When the refresh interval is set on a layer, the client must refresh that layer only, not the entire web map. The default value is '0', meaning the no refresh. You can enable a refresh interval on the following types of layers: ArcGIS Server web service, hosted feature layer, hosted tile layer, OGC WMS, OGS WMTS, tile layer, GeoRSS, Living Atlas layers, basemaps (including Bing Maps basemaps), CSV from the web with latitude and longitude fields, and KML when added to ArcGIS Online through the My Content page. See https://doc.arcgis.com/en/arcgis-online/create-maps/set-refresh-interval.htm.

Inherited from BuildingSceneLayerJson.refreshInterval

### `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 BuildingSceneLayerJson.showLegend

### `Optional` sublayers

sublayers?: BuildingSceneSublayerJson[]

An array of objects specifying overrides for building scene layer sublayers.

Inherited from BuildingSceneLayerJson.sublayers

### `Optional` title

title?: string

A user-friendly title for the layer that can be used in a table of contents. If this is not included, then a title is derived from the service.

Inherited from BuildingSceneLayerJson.title

### `Optional` type

type?: LegacyOperationalLayerJsonType | LegacyBasemapLayerJsonType

(Deprecated, use layerType instead.) If the layer is referenced through a URL, but is not an ArcGIS web service, then this parameter can be supplied to denote the layer type.

Inherited from BuildingSceneLayerJson.type

### `Optional` url

url?: string

The URL to the service.

Inherited from BuildingSceneLayerJson.url

### `Optional` visibility

visibility?: boolean

Determines whether the layer is initially visible in the web map.

Inherited from BuildingSceneLayerJson.visibility

### `Optional` visibilityTimeExtent

visibilityTimeExtent?: [number, number]

Represents time extent that will control when a layer should be visible based on webmap's current time. Visibility time extent only affects the layer visibility and will not filter the data.

Inherited from BuildingSceneLayerJson.visibilityTimeExtent