ElevationProfileLineScene | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: ElevationProfileLineScene→ElevationProfileLine→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.34

Represents a profile line that samples elevation directly from the SceneView.

All volumetric objects in a SceneView contribute to the resulting profile, including Ground, SceneLayer, IntegratedMeshLayer, IntegratedMesh3DTilesLayer, and FeatureLayers with volumetric 3D symbols (e.g., ObjectSymbol3DLayer, PathSymbol3DLayer).

The profile line is updated automatically to reflect what is currently loaded and visible in the view, including changes to the Camera or scene contents.

Known Limitations

This profile line type is only supported in a SceneView and not in a MapView.
Point cloud scene layers are not supported due to performance considerations.

Example

// Create an elevation profile analysis with a scene profile line
const analysis = new ElevationProfileAnalysis({
  profiles: [{
    type: "scene",
    exclude: [view.map.ground], // Exclude ground from elevation sampling
  }],
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ElevationProfileLineSceneProperties`

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
`exclude`	`IntersectItem[] \| null \| undefined`
`id` inherited	`string`	ElevationProfileLine
`include`	`IntersectItem[] \| null \| undefined`
`title` inherited	`string \| null \| undefined`	ElevationProfileLine
`type` readonly	`"scene"`
`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: "#cf4ccf"

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

exclude

Property

Type: IntersectItem[] | null | undefined

Items which are to be excluded when querying elevation from the view. When specified, these items will not contribute to the resulting profile. When not specified, all layers (including ground) will be taken into account.

Example

const analysis = new ElevationProfileAnalysis({
  profiles: [{
    type: "scene",
    exclude: [view.map.ground], // Exclude ground from elevation sampling for this profile line
  }],
});

id

inherited Property

Type: string

Inherited from: ElevationProfileLine

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

include

Property

Type: IntersectItem[] | null | undefined

Items which are to be included when querying elevation from the view. When specified, only these items will contribute to the resulting profile. When not specified, all layers (including ground) will be taken into account.

Example

const analysis = new ElevationProfileAnalysis({
  profiles: [{
    type: "scene",

    // Only graphics from myGraphicsLayer will be used for elevation sampling of this profile line
    include: [myGraphicsLayer],
  }],
});

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: "scene"

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.

Type definitions

IntersectItem

Type definition

A layer or graphic to be used in SceneView.toMap() and SceneView.hitTest() filter options.

See also

Type: Graphic | Layer | BuildingSublayer | SubtypeSublayer | Ground