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)

Properties

$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.

$sublayerType?: string

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

defaultVisibility?: boolean

Default visibility of the layers in the map service.

definitionEditor?: DefinitionEditorJson

An object that provides interactive filters.

disablePopup?: boolean

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

featureSet?: FeatureSetJson

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

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.

id?: number

Identifies the sublayer inside the building scene layer.

layerDefinition?: LayerDefinitionJson

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

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.

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.

maxScale?: number

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

minScale?: number

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

name?: string

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

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.

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.

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.

popupInfo?: PopupInfoJson

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

showLegend?: boolean

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

subLayerIds?: number[]

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

title?: string

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

visibility?: boolean

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

visible?: boolean

Visibility of the sublayer.