Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

initialized

initialized: boolean

layers

A collection of ElevationLayers that define the elevation or terrain that makes up the ground surface.

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 instance has loaded.

Read more...

navigationConstraint

navigationConstraint: GroundNavigationConstraint

Specifies the user navigation constraints relative to the ground surface.

Read more...

opacity

opacity: number

Opacity of the ground, including surface default color and the basemap (without reference layers).

Read more...

surfaceColor

surfaceColor: Color

The color of the ground surface, displayed underneath the basemap.

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): Ground
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Ground

cancelLoad

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

    Read more...

    Returns void

clone

  • Creates a deep clone of this object.

    Read more...

    Returns Ground

createElevationSampler

  • Creates an elevation sampler for the given extent by querying the ground layers for elevation data and caching it so values may be sampled quickly afterwards.

    Read more...

    Parameters

    Returns Promise<ElevationSampler>

destroy

  • destroy(): void
  • Destroys the ground and its layers.

    Read more...

    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

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>

loadAll

  • Loads all the externally loadable resources associated with the ground.

    Read more...

    Returns Promise<Ground>

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

queryElevation

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns Ground

  • Parameters

    Returns Ground

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

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