Elevation Profile

1
import "@arcgis/map-components/components/arcgis-elevation-profile";

The Elevation Profile component is used to generate and display an elevation profile from an input line graphic.

Demo

Properties

PropertyAttributeType
auto-destroy-disabled
boolean
hide-chart
boolean
hide-clear-button
boolean
hide-legend
boolean
hide-select-button
boolean
hide-settings-button
boolean
hide-sketch-button
boolean
hide-uniform-chart-scaling-toggle
boolean
hide-unit-selector
boolean
highlight-enabled
boolean
hovered-chart-position
number
icon
string
label
string
position
"bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
progress
readonly
number
reference-element
ArcgisLinkChart | ArcgisMap | ArcgisScene | string
state
readonly
state
"created" | "creating" | "disabled" | "ready" | "selected" | "selecting"
uniform-chart-scaling
boolean
unit
"centimeters" | "decimeters" | "feet" | "imperial" | "inches" | "kilometers" | "meters" | "metric" | "miles" | "millimeters" | "nautical-miles" | "us-feet" | "yards"
Array<"metric" | "imperial" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet">

autoDestroyDisabled

Property
autoDestroyDisabled: boolean

If true, the component will not be destroyed automatically when it is disconnected from the document. This is useful when you want to move the component to a different place on the page, or temporarily hide it. If this is set, make sure to call the `destroy` method when you are done to prevent memory leaks.

Attribute
auto-destroy-disabled
Default value
false

effectiveUnits

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

hideChart

Property
hideChart: boolean
Attribute
hide-chart
Default value
false

hideClearButton

Property
hideClearButton: boolean
Attribute
hide-clear-button
Default value
false

hideLegend

Property
hideLegend: boolean
Attribute
hide-legend
Default value
false

hideSelectButton

Property
hideSelectButton: boolean
Attribute
hide-select-button
Default value
false

hideSettingsButton

Property
hideSettingsButton: boolean
Attribute
hide-settings-button
Default value
false

hideSketchButton

Property
hideSketchButton: boolean
Attribute
hide-sketch-button
Default value
false

hideUniformChartScalingToggle

Property
hideUniformChartScalingToggle: boolean
Attribute
hide-uniform-chart-scaling-toggle
Default value
false

hideUnitSelector

Property
hideUnitSelector: boolean
Attribute
hide-unit-selector
Default value
false

highlightEnabled

Property
highlightEnabled: boolean

Whether the graphic used as input is highlighted.

Read more...

Attribute
highlight-enabled
Default value
true

hoveredChartPosition

Property
hoveredChartPosition: number

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

Read more...

Attribute
hovered-chart-position

icon

Property
icon: string

Icon which represents the component. Typically used when the component is controlled by another component (e.g. by the Expand component). Search Calcite Icons for possible values.

Attribute
icon
Default value
"altitude"

input

Property
input: Graphic

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

Read more...

Default value
null

label

Property
label: string

The component's default label.

Attribute
label

position

Property
position: "bottom-leading" | "bottom-left" | "bottom-right" | "bottom-trailing" | "manual" | "top-leading" | "top-left" | "top-right" | "top-trailing"
Attribute
position
Default value
"bottom-left"

profiles

Property

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

Read more...

progress

readonlyProperty
progress: number

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

Read more...

referenceElement

Property
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
Attribute
reference-element

state

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

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

Read more...

Attribute
state
Default value
"disabled"

uniformChartScaling

Property
uniformChartScaling: boolean

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

Read more...

Attribute
uniform-chart-scaling
Default value
false

unit

Property
unit: "centimeters" | "decimeters" | "feet" | "imperial" | "inches" | "kilometers" | "meters" | "metric" | "miles" | "millimeters" | "nautical-miles" | "us-feet" | "yards"

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

Read more...

Attribute
unit

unitOptions

Property
unitOptions: Array<"metric" | "imperial" | "millimeters" | "centimeters" | "decimeters" | "meters" | "kilometers" | "inches" | "feet" | "yards" | "miles" | "nautical-miles" | "us-feet">

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

Read more...

Methods

MethodSignature
componentOnReady(): Promise<void>
destroy(): Promise<void>
start(): Promise<void>
stop(): Promise<void>

componentOnReady

Method
componentOnReady(): Promise<void>

Create a promise that resolves once component is fully loaded.

Returns
Promise<void>

destroy

Method
destroy(): Promise<void>

Permanently destroy the component

Returns
Promise<void>

start

Method
start(): Promise<void>
Returns
Promise<void>

stop

Method
stop(): Promise<void>
Returns
Promise<void>

Events

EventType
{ name: "input" | "state" | "progress" | "effectiveUnits"; }
undefined

arcgisPropertyChange

Event
arcgisPropertyChange: { name: "input" | "state" | "progress" | "effectiveUnits"; }

Fired when the value of a property is changed. Use this to listen to changes to properties.

arcgisReady

Event
arcgisReady: undefined

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.

You can no longer sign into this site. Go to your ArcGIS portal or the ArcGIS Location Platform dashboard to perform management tasks.

Your ArcGIS portal

Create, manage, and access API keys and OAuth 2.0 developer credentials, hosted layers, and data services.

Your ArcGIS Location Platform dashboard

Manage billing, monitor service usage, and access additional resources.

Learn more about these changes in the What's new in Esri Developers June 2024 blog post.

Close