AnalysisOriginWebScene

ESM: import AnalysisOriginWebScene from "@arcgis/core/analysis/support/AnalysisOriginWebScene.js";
CDN: const AnalysisOriginWebScene = await $arcgis.import("@arcgis/core/analysis/support/AnalysisOriginWebScene.js");
Class: @arcgis/core/analysis/support/AnalysisOriginWebScene
Inheritance: AnalysisOriginWebSceneAccessor
Since: ArcGIS Maps SDK for JavaScript 4.33

An analysis origin indicating that the analysis was created or applied from a web scene. Analyses in web scenes are either stored in the initial view properties, or in slides in the web scene presentation.

Analyses in the SceneView.analyses collection that have an origin of type "web-scene" are replaced with the analyses stored in a Slide when it is applied to a SceneView with applyTo().

Using WebScene.updateFrom to update the scene initial view properties, or Slide.updateFrom to update a slide, will automatically set the origin of the analyses in the SceneView.analyses to type "web-scene" as they are being captured.

Constructors

AnalysisOriginWebScene

Constructor
new AnalysisOriginWebScene(properties)
Parameter
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Watch for changes topic.
Show inherited properties Hide inherited properties
Name Type Summary Class

The name of the class.

Accessor

The type of the analysis origin.

AnalysisOriginWebScene

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor

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

type

Property
type Stringreadonly

The type of the analysis origin. This is always web-scene for this class.

For AnalysisOriginWebScene the type is always "web-scene".

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor
this

Creates a deep clone of this object.

AnalysisOriginWebScene

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

clone

Method
clone(){this}

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
Type Description
this A deep clone of the class instance that invoked this method.

hasHandles

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

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