DimensionLayerView

AMD: require(["esri/views/layers/DimensionLayerView"], (DimensionLayerView) => { /* code goes here */ });
ESM: import DimensionLayerView from "@arcgis/core/views/layers/DimensionLayerView";
Class: esri/views/layers/DimensionLayerView
Inheritance: DimensionLayerView LayerView Accessor
Since: ArcGIS API for JavaScript 4.25

Represents the LayerView of a DimensionLayer after it has been added to a Map in a SceneView.

The dimension layer view controls whether the dimensions in its associated DimensionLayer.source can be created or edited interactively.

// create new layer and add it to the scene view
const dimensionLayer = new DimensionLayer();
view.map.add(dimensionLayer);
// retrieve layer view for the layer
view.whenLayerView(dimensionLayer).then(dimensionLayerView => {
   // allow existing dimensions in the layer to be edited by selecting them
   dimensionLayerView.interactive = true;
   // start adding new dimensions interactively
   dimensionLayerView.createLengthDimensions();
});

The layer view also allows the length measured by each dimension to be retrieved.

// retrieve measured results from the layer view
view.whenLayerView(dimensionLayer).then(dimensionLayerView => {
   const results = dimensionLayerView.results;
});
See also

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

The name of the class.

more details
Accessor
Boolean

Set to true to enable interactivity for the layer.

more details
DimensionLayerView
DimensionLayer

The layer being viewed.

more details
DimensionLayerView
Collection<LengthDimensionResult>

Results for each dimension in the layer source.

more details
DimensionLayerView
LengthDimension

The selected dimension.

more details
DimensionLayerView
Boolean

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

more details
DimensionLayerView
Boolean

Value is true when the layer is updating; for example, if it is in the process of fetching data.

more details
LayerView
Boolean

When true, the layer is visible in the view.

more details
LayerView

Property Details

declaredClass Stringreadonly inherited

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

interactive Boolean

Set to true to enable interactivity for the layer. If the layer's source includes any dimensions, they become selectable and editable.

Default Value:false
layer DimensionLayerreadonly

The layer being viewed.

Results for each dimension in the layer source.

Given a dimension object, the results collection can be searched:

const result = dimensionLayerView.results.find((result) => result.dimension === dimensionObject);
selectedDimension LengthDimension

The selected dimension. If interactive is true, any dimension in the layer can be selected by clicking on it in the view. As long as interactive remains true, the properties of the selected dimension can be edited by interacting with manipulators in the view.

suspended Booleanreadonly

Value is true if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).

updating Booleanreadonly inherited

Value is true when the layer is updating; for example, if it is in the process of fetching data.

Default Value:false
visible Boolean inherited

When true, the layer is visible in the view. Value of this property is inherited from the layer.visible unless the developer overrides it. The layerView.visible will take precedence over layer.visible if both properties are set.

Default Value:true

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.

more details
Accessor
Promise

Starts the interactive creation of new dimensions and adds them to the layer source.

more details
DimensionLayerView
Boolean

Returns true if a named group of handles exist.

more details
Accessor
Boolean

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more details
LayerView
Boolean

isRejected() may be used to verify if creating an instance of the class is rejected.

more details
LayerView
Boolean

isResolved() may be used to verify if creating an instance of the class is resolved.

more details
LayerView

Removes a group of handles owned by the object.

more details
Accessor
Promise

when() may be leveraged once an instance of the class is created.

more details
LayerView

Method Details

addHandles(handleOrHandles, groupKey)inherited

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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

createLengthDimensions(options){Promise}

Starts the interactive creation of new dimensions and adds them to the layer source.

The creation process will finish when the user double-clicks the mouse or presses the escape key. In order to otherwise stop the creation process, pass an abort signal as an argument when calling the method.

let abortController;
view.whenLayerView(dimensionLayer).then(dimensionLayerView => {
   // create a new controller
   abortController = new AbortController();
   // pass the controller as an argument to the interactive creation method
   dimensionLayerView.createLengthDimensions(abortController);
   // abort the controller to stop the creation process
   abortController.abort();
});

Calling this method sets interactive to true.

Parameters
options Object
optional

An object specifying additional options.

Specification
signal AbortSignal
optional

Abort signal which can be used to cancel creation.

Returns
Type Description
Promise A promise which resolves when creation is completed, or rejects if creation is cancelled.
hasHandles(groupKey){Boolean}inherited

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");
}
isFulfilled(){Boolean}inherited

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
removeHandles(groupKey)inherited

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");
when(callback, errback){Promise}inherited

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example
// Although this example uses MapView, any class instance that is a promise may use when() in the same way
let view = new MapView();
view.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

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