Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SceneLayerView

Hierarchy

Index

Properties

Readonly availableFields

availableFields: string[]

A list of attribute fields fetched for each feature including fields required for layer rendering and additional fields defined on the SceneLayer.outFields.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

filter

Applies a client-side FeatureFilter to the displayed data.

Read more...

initialized

initialized: boolean

Readonly layer

layer: SceneLayer

The scene layer being viewed.

Read more...

maximumNumberOfFeatures

maximumNumberOfFeatures: number

The maximum number of features that can be displayed at a time.

Read more...

maximumNumberOfFeaturesExceeded

maximumNumberOfFeaturesExceeded: boolean

Signifies whether the maximum number of features has been exceeded.

Read more...

Readonly suspended

suspended: boolean

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

Read more...

Readonly updating

updating: boolean

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Read more...

visible

visible: boolean

When true, 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

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SceneLayerView

createQuery

  • Creates query parameter object that can be used to fetch features as they are being displayed.

    Read more...

    Returns supportQuery

destroy

  • destroy(): void
  • Returns void

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

highlight

  • Highlights the given feature(s).

    Read more...

    Parameters

    Returns Handle

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

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

queryExtent

  • Executes a Query against features in the layer view and returns the 3D Extent of features that satisfy the query.

    Executes a Query against features in the layer view and returns the 3D Extent of features that satisfy the query. If query parameters are not provided, the extent and count of all loaded features are returned. Read more about queries in the Query section of the SceneLayer class description. To query for the extent of features directly from a Scene Service rather than those loaded for the current view, you must use the SceneLayer.queryExtent() method. For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client. Read more...

    Parameters

    Returns Promise<any>

queryFeatureCount

  • Executes a Query against features in the layer view and returns the number of features that satisfy the query.

    Executes a Query against features in the layer view and returns the number of features that satisfy the query. If query parameters are not provided, the count of all loaded features is returned. Read more about queries in the Query section of the SceneLayer class description. To query for the count of features directly from a Scene Service rather than those loaded for the current view, you must use the SceneLayer.queryFeatureCount() method. For making attribute based queries on a SceneLayerView you need to specify the required fields in the outFields property of the SceneLayer to ensure that attribute values are available on the client for querying. You can use availableFields to inspect which fields are available on the client. Read more...

    Parameters

    Returns Promise<number>

queryFeatures

queryObjectIds

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SceneLayerView

  • Parameters

    Returns SceneLayerView

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