Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BuildingComponentSublayer

Hierarchy

Index

Properties

declaredClass

declaredClass: string

definitionExpression

definitionExpression: string

The SQL where clause used to filter features on the client.

Read more...

destroyed

destroyed: boolean

Readonly id

id: number

The sublayer's layer id as defined by the Scene Service.

Read more...

initialized

initialized: boolean

Readonly isEmpty

isEmpty: boolean

Indicates if this sublayer is empty.

Read more...

listMode

listMode: "show" | "hide"

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 modelName

modelName: string

The modelName is a standard name for each sublayer.

Read more...

opacity

opacity: number

Opacity of the sublayer.

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

Read more...

renderer

renderer: Renderer

The renderer assigned to the sublayer.

Read more...

title

title: string

The title of the sublayer used to identify it in places such as the LayerList and Legend widgets.

Read more...

Readonly type

type: "building-component"

visible

visible: boolean

Indicates if the sublayer 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 BuildingComponentSublayer

cancelLoad

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

    Read more...

    Returns void

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 component sublayer's current definition expression.

    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

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

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

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

    Parameters

    Returns Promise<number[]>

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns BuildingComponentSublayer

  • Parameters

    Returns BuildingComponentSublayer

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