Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ElevationProfileViewModel

Hierarchy

Index

Properties

declaredClass

declaredClass: string

destroyed

destroyed: boolean

Readonly effectiveUnits

effectiveUnits: EffectiveUnits

Units which have been selected according to the magnitude of the elevations and distances that are to be displayed in the widget, according to the selected unit or unit system.

Read more...

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

highlightEnabled

highlightEnabled: boolean

Whether the graphic used as input is highlighted.

Read more...

hoveredChartPosition

hoveredChartPosition: number

The position, in the range [0, 1], being hovered in the graph.

Read more...

initialized

initialized: boolean

input

input: Graphic

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

Read more...

profiles

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

Read more...

Readonly progress

progress: number

The progress, between 0 and 1 of generating all the configured elevation profiles.

Read more...

Readonly state

state: "disabled" | "ready" | "created" | "creating" | "selecting" | "selected"

The current state of the view model that can be used for rendering the UI of the widget.

Read more...

uniformChartScaling

uniformChartScaling: boolean

Whether the chart should use a uniform scale for the X and Y axes.

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 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 ElevationProfileViewModel

cancel

  • cancel(): void
  • Stops a creation/selection operation and restores the previously configured input path.

    Read more...

    Returns void

clear

  • clear(): void
  • Clears the existing profile and stops any interaction.

    Read more...

    Returns void

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

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns ElevationProfileViewModel

  • Parameters

    Returns ElevationProfileViewModel

start

  • If mode is "sketch" (the default), switches to the "creating" state in which the user can draw a new line.

    Read more...

    Parameters

    Returns void

stop

  • stop(): void
  • Stops a creation/selection operation.

    Read more...

    Returns void

watch

  • Parameters

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

    Returns WatchHandle

Generated using TypeDoc