Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SceneLayer

Hierarchy

Index

Properties

Readonly capabilities

Describes the layer's supported capabilities.

Read more...

copyright

copyright: string

The copyright text as defined by the scene service.

Read more...

declaredClass

declaredClass: string

definitionExpression

definitionExpression: string

The SQL where clause used to filter features.

Read more...

destroyed

destroyed: boolean

elevationInfo

Specifies how graphics are placed on the vertical axis (z).

Read more...

featureReduction

featureReduction: FeatureReductionSelection

Configures the method for decluttering overlapping features in the view.

Read more...

Readonly fields

fields: Field[]

An array of fields accessible in the layer.

Read more...

Readonly fieldsIndex

fieldsIndex: FieldsIndex

A convenient property that can be used to make case-insensitive lookups for a field by name.

Read more...

floorInfo

floorInfo: LayerFloorInfo

When a scene layer is configured as floor-aware, it has a floorInfo property defined.

Read more...

fullExtent

fullExtent: Extent

The full extent of the layer.

Read more...

geometryType

geometryType: "point" | "mesh"

The geometry type of features in the layer.

Read more...

id

id: string

The unique ID assigned to the layer.

Read more...

initialized

initialized: boolean

labelingInfo

labelingInfo: LabelClass[]

The label definition for this layer, specified as an array of LabelClass.

Read more...

labelsVisible

labelsVisible: boolean

Indicates whether to display labels for this layer.

Read more...

layerId

layerId: number

The layer ID, or layer index, of a Scene Service layer.

Read more...

legendEnabled

legendEnabled: boolean

Indicates whether the layer will be included in the legend.

Read more...

listMode

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

Indicates how the layer should display in the LayerList widget.

Read more...

Readonly loadError

loadError: Error

The Error object returned if an error occurred while loading.

Read more...

Readonly loadStatus

loadStatus: "not-loaded" | "loading" | "failed" | "loaded"

Represents the status of a load operation.

Read more...

Readonly loadWarnings

loadWarnings: any[]

A list of warnings which occurred while loading.

Read more...

Readonly loaded

loaded: boolean

Indicates whether the layer's resources have loaded.

Read more...

maxScale

maxScale: number

The maximum scale (most zoomed in) at which the layer is visible in the view.

Read more...

minScale

minScale: number

The minimum scale (most zoomed out) at which the layer is visible in the view.

Read more...

objectIdField

objectIdField: string

The name of the field containing each graphic's Object ID.

Read more...

opacity

opacity: number

The opacity of the layer.

Read more...

outFields

outFields: string[]

An array of field names from the service to include with each feature.

Read more...

popupEnabled

popupEnabled: boolean

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

Read more...

popupTemplate

popupTemplate: PopupTemplate

The popup template for the layer.

Read more...

portalItem

portalItem: PortalItem

The portal item from which the layer is loaded.

Read more...

renderer

renderer: Renderer

The renderer assigned to the layer.

Read more...

screenSizePerspectiveEnabled

screenSizePerspectiveEnabled: boolean

Apply perspective scaling to screen-size point symbols in a SceneView.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the layer.

Read more...

title

title: string

The title of the layer used to identify it in places such as the LayerList widget.

Read more...

Readonly type

type: "scene"

url

url: string

The URL of the REST endpoint of the layer or scene service.

Read more...

Readonly version

The version of the scene service specification used for this service.

Read more...

visible

visible: boolean

Indicates if the layer is visible in the View.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): SceneLayer
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SceneLayer

applyEdits

cancelLoad

  • cancelLoad(): void
  • Cancels a load() operation if it is already in progress.

    Read more...

    Returns void

createLayerView

  • Called by the views, such as MapView and SceneView, when the layer is added to the Map.layers collection and a layer view must be created for it.

    Read more...

    Parameters

    Returns Promise<LayerView>

createPopupTemplate

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

    Read more...

    Parameters

    Returns PopupTemplate

createQuery

  • Creates a query object that can be used to fetch features that satisfy the layer's current definition expression.

    Read more...

    Returns supportQuery

destroy

  • destroy(): void
  • Destroys the layer and any associated resources (including its portalItem, if it is a property on the layer).

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

fetchAttributionData

  • fetchAttributionData(): Promise<any>
  • Fetches custom attribution data for the layer when it becomes available.

    Read more...

    Returns Promise<any>

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

getField

  • getField(fieldName: string): Field
  • Returns the Field instance for a field name (case-insensitive).

    Read more...

    Parameters

    • fieldName: string

    Returns Field

getFieldDomain

getFieldUsageInfo

  • getFieldUsageInfo(fieldName: string): any
  • Gets field usage information.

    Read more...

    Parameters

    • fieldName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

isFulfilled

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

    Read more...

    Returns boolean

isRejected

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

    Read more...

    Returns boolean

isResolved

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

    Read more...

    Returns boolean

load

  • load(signal?: AbortSignal): Promise<any>
  • Loads the resources referenced by this class.

    Read more...

    Parameters

    • Optional signal: AbortSignal

    Returns Promise<any>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

  • Parameters

    Returns IHandle

queryCachedStatistics

  • Queries cached statistics from the service for a given field.

    Read more...

    Parameters

    Returns any

queryExtent

  • Executes a Query against the associated feature service and returns the 2D Extent of features that satisfy the query.

    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 SceneLayerView.queryExtent(), but this will return the 3D extent only for features currently in the view. The query succeeds only if the SceneLayer has an associated feature layer. If an associated feature layer is not available, then an error with the name scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above. Read more...

    Parameters

    Returns Promise<any>

queryFeatureCount

  • Executes a Query against the associated feature service and returns the number of features that satisfy the query.

    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 scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above. Read more...

    Parameters

    Returns Promise<number>

queryFeatures

  • Executes a Query against the associated feature service and returns a FeatureSet.

    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 scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above. Read more...

    Parameters

    Returns Promise<supportFeatureSet>

queryObjectIds

  • Executes a Query against the associated feature service and returns an array of ObjectIDs of the features that satisfy the input query.

    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 scenelayer:query-not-available is thrown. Read more about queries in the Querying section of the class description above. Read more...

    Parameters

    Returns Promise<number[]>

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SceneLayer

  • Parameters

    Returns SceneLayer

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

Generated using TypeDoc