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
Property | Attribute | Type |
---|---|---|
auto-destroy-disabled | boolean | |
effectiveUnits readonly |
| |
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
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
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.
hideSettingsButton
hideSettingsButton: boolean
- Attribute
- hide-settings-button
- Default value
- false
hideUniformChartScalingToggle
hideUniformChartScalingToggle: boolean
- Attribute
- hide-uniform-chart-scaling-toggle
- Default value
- false
highlightEnabled
highlightEnabled: boolean
Whether the graphic used as input is highlighted.
- Attribute
- highlight-enabled
- Default value
- true
hoveredChartPosition
hoveredChartPosition: number
The position, in the range [0, 1], being hovered in the graph.
- Attribute
- hovered-chart-position
icon
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
input: Graphic
The input line graphic along which elevation will be queried in order to generate an elevation profile.
- Default value
- null
position
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
profiles: Collection<ElevationProfileLineGround | ElevationProfileLineInput | ElevationProfileLineQuery | ElevationProfileLineView>
Collection of elevation profile lines which are to be generated and displayed in the widget's chart.
progress
progress: number
The progress, between 0 and 1 of generating all the configured elevation profiles.
referenceElement
referenceElement: ArcgisLinkChart | ArcgisMap | ArcgisScene | string
- Attribute
- reference-element
state
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.
- Attribute
- state
- Default value
- "disabled"
uniformChartScaling
uniformChartScaling: boolean
Whether the chart should use a uniform scale for the X and Y axes.
- Attribute
- uniform-chart-scaling
- Default value
- false
unit
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.
- Attribute
- unit
unitOptions
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.
Methods
Method | Signature |
---|---|
componentOnReady(): Promise<void> | |
destroy(): Promise<void> | |
start(): Promise<void> | |
stop(): Promise<void> |
componentOnReady
componentOnReady(): Promise<void>
Create a promise that resolves once component is fully loaded.
- Returns
- Promise<void>
Events
Event | Type |
---|---|
{ name: "input" | "state" | "progress" | "effectiveUnits"; } | |
undefined |