ElevationProfileLineGround | References | ArcGIS Maps SDK for JavaScript

import ElevationProfileLineGround from "@arcgis/core/analysis/ElevationProfile/ElevationProfileLineGround.js";

Inheritance:: ElevationProfileLineGround→ElevationProfileLine→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.34

Represents a profile line that samples elevation from the Ground of the Map currently set in the View.

The elevation profile is automatically recomputed whenever layers are added to or removed from the Ground, or when their visibility changes.

See also

ElevationProfileAnalysis

Example

// Create an elevation profile analysis with a ground profile line
const analysis = new ElevationProfileAnalysis({
  profiles: [{
    type: "ground",
    title: "World elevation" // Optional custom label
  }]
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ElevationProfileLineGroundProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`chartOptions` inherited	`ElevationProfileLineChartOptions`	ElevationProfileLine
`color`	`Color`
`declaredClass` readonly inherited	`string`	Accessor
`enabled` inherited	`boolean`	ElevationProfileLine
`id` inherited	`string`	ElevationProfileLine
`title` inherited	`string \| null \| undefined`	ElevationProfileLine
`type` readonly	`"ground"`
`viewOptions` inherited	`ElevationProfileLineViewOptions`	ElevationProfileLine

chartOptions

autocast inherited Property

Type: ElevationProfileLineChartOptions

Inherited from: ElevationProfileLine

Options for visualizing the profile line in a chart.

color

autocast Property

Type: Color

Color of the line on the chart and in the view.

Default value: "#ff7f00"

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

The name of the class. The declared class name is formatted as esri.folder.className.

enabled

inherited Property

Type: boolean

Inherited from: ElevationProfileLine

Indicates whether the line should be computed and displayed in the chart and view.

Default value: true

id

inherited Property

Type: string

Inherited from: ElevationProfileLine

Unique identifier for the profile line. This value is automatically generated unless specified.

title

inherited Property

Type: string | null | undefined

Inherited from: ElevationProfileLine

Title of the line, shown in the chart tooltip and legend.

type

readonly Property

Type: "ground"

The line type.

viewOptions

autocast inherited Property

Type: ElevationProfileLineViewOptions

Inherited from: ElevationProfileLine

Options for visualizing the profile line in the view.

Methods

Method	Signature	Class
`clone` inherited	`clone(): this`	ClonableMixin

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.