Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BuildingComponentSublayerView

Hierarchy

  • Accessor
    • BuildingComponentSublayerView

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 BuildingComponentSublayer.outFields or BuildingSceneLayer.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 sublayer

The sublayer being viewed.

Read more...

Readonly suspended

suspended: boolean

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

Read more...

Readonly updating

updating: boolean

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

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 BuildingComponentSublayerView

createQuery

  • Creates a 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

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 BuildingSceneLayer 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 BuildingComponentSublayer.queryExtent() method. For making attribute based queries on a BuildingComponentSublayerView you need to specify the required fields in the outFields property of the BuildingComponentSublayer 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. To query for the count of features directly from a Scene Service rather than those loaded for the current view, you must use the BuildingComponentSublayer.queryFeatureCount() method. For making attribute based queries on a BuildingSceneLayerView you need to specify the required fields in the outFields property of the BuildingComponentSublayer 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 about queries in the Query section of the BuildingSceneLayer class description. Read more...

    Parameters

    Returns Promise<number>

queryFeatures

queryObjectIds

set

watch

  • Parameters

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

    Returns WatchHandle

Generated using TypeDoc