Analysis | References | ArcGIS Maps SDK for JavaScript

import Analysis from "@arcgis/core/analysis/Analysis.js";

Inheritance:: Analysis→Accessor

Subclasses:: AreaMeasurementAnalysis, DimensionAnalysis, DirectLineMeasurementAnalysis, DistanceMeasurementAnalysis, ElevationProfileAnalysis, LineOfSightAnalysis, ShadowCastAnalysis, SliceAnalysis, ViewshedAnalysis, VolumeMeasurementAnalysis

Since: ArcGIS Maps SDK for JavaScript 4.33

Abstract base class for all analysis objects.

Properties

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

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`id` readonly	`string`
`origin`	`AnalysisOriginWebScene \| null \| undefined`
`type` readonly	`AnalysisType`
`uid` readonly inherited	`string`	IdentifiableMixin

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

id

readonly Property

Type: string

A user settable identifier for the analysis. A unique value is automatically generated when the analysis is created if it is not set explicitly during construction.

origin

autocast Property

Type: AnalysisOriginWebScene | null | undefined

The origin of the analysis. The origin can be of type web-scene when the analysis was applied from the WebScene.initialViewProperties or a Slide.

type

readonly Property

Type: AnalysisType

Identifier for the analysis type.

uid

readonlyinherited Property

Type: string

Inherited from: IdentifiableMixin

An automatically generated unique identifier assigned to the instance. The unique id is generated each time the application is loaded.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`equals`	`equals(other: this): boolean`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameters

Parameter	Type	Description	Required
json	`any`	A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns: any
Returns a new instance of this class.

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.

equals

Method

Signature: equals (other: this): boolean

Since: ArcGIS Maps SDK for JavaScript 5.0

Compares this analysis with another analysis to determine whether they are equivalent.

Parameters

Parameter	Type	Description	Required
other	`this`	The other analysis to compare against.

Returns: boolean
true if the analyses are equivalent and false otherwise.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns: any
The ArcGIS portal JSON representation of an instance of this class.