Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ElevationProfile

Hierarchy

Index

Properties

container

container: string | HTMLElement

The ID or node representing the DOM element containing the widget.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

geodesicDistanceThreshold

geodesicDistanceThreshold: number

When the spatial reference is projected (other than web mercator) and the path is shorter than this threshold, distances will be computed planimetrically.

Read more...

iconClass

iconClass: string

The widget's default CSS icon class.

Read more...

id

id: string

The unique ID assigned to the widget when the widget is created.

Read more...

initialized

initialized: boolean

input

input: Graphic

The input line graphic along which elevation will be queried in order to generate an elevation profile.

Read more...

label

label: string

The widget's label.

Read more...

profiles

Collection of elevation profile lines which are to be generated and displayed in the widget's chart.

Read more...

unit

Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.

Read more...

unitOptions

unitOptions: SystemOrLengthUnit[]

List of available units and unit systems (imperial, metric) for displaying the elevation and distance values.

Read more...

view

A reference to the SceneView or the MapView.

Read more...

viewModel

The view model for this widget.

Read more...

visible

visible: boolean

Indicates whether the widget is visible.

Read more...

visibleElements

This property provides the ability to display or hide the individual elements of the widget.

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 ElevationProfile

classes

  • classes(...classNames: any[]): string
  • A utility method used for building the value for a widget's class property.

    Read more...

    Parameters

    • Rest ...classNames: any[]

    Returns string

destroy

  • destroy(): void
  • Destroys the widget instance.

    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

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: 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

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Registers an event handler on the instance.

    Read more...

    Parameters

    Returns IHandle

own

  • Widget teardown helper.

    Read more...

    Parameters

    Returns void

postInitialize

  • postInitialize(): void
  • This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

    Read more...

    Returns void

render

  • render(): any
  • This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

    Read more...

    Returns any

renderNow

  • renderNow(): void
  • Renders widget to the DOM immediately.

    Read more...

    Returns void

scheduleRender

  • scheduleRender(): void
  • This method is primarily used by developers when implementing custom widgets. Schedules widget rendering.

    Read more...

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ElevationProfile

  • Parameters

    Returns ElevationProfile

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