DimensionLayerView | API Reference | ArcGIS Maps SDK for JavaScript 4.33

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.

It allows to create new dimensions interactively using the place() method, query measured results, or to make existing dimensions selectable and editable by enabling the interactive property. To select a dimension, hover and click on its offset manipulator.

The view for the layer can be retrieved using SceneView.whenLayerView.

// create new layer and add it to the map
const dimensionLayer = new DimensionLayer();
view.map.add(dimensionLayer);

// retrieve layer view for the layer
const dimensionLayerView = await view.whenLayerView(dimensionLayer);

Things to consider:

Snapping is enabled by default. This can be temporarily disabled by holding the CTRL key.
Layer types currently supported for snapping are: FeatureLayer, GraphicsLayer (except Mesh geometries), GeoJSONLayer, WFSLayer, CSVLayer, 3D Object SceneLayer, and BuildingSceneLayer.

See also

Property Overview

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

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
Boolean	Enables interactivity for the layer.	DimensionLayerView
DimensionLayer	The layer being viewed.	DimensionLayerView
Collection<LengthDimensionResult>	Results for each dimension in the layer source.	DimensionLayerView
LengthDimension\|null\|undefined	The selected dimension.	DimensionLayerView
Boolean	Value is `true` if the layer is suspended (i.e., layer will not redraw or update itself when the extent changes).	DimensionLayerView
String	An automatically generated unique identifier assigned to the instance.	LayerView
Boolean	Indicates if the layer view is making any updates that will impact what is displayed on the map.	LayerView
MapView\|SceneView	A reference to the MapView or SceneView associated with the layer view.	LayerView
Boolean	When `true`, the layer is visible in the view.	LayerView
Boolean	When `true`, the layer is visible in the view at the current scale.	LayerView
Boolean	When `true`, the layer is visible in the view's timeExtent.	LayerView

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.

interactive Property interactive Boolean

Enables interactivity for the layer. When set to true and the layer's source includes any valid dimensions, they become selectable and editable.

Default Value:false

layer Property layer DimensionLayerreadonly

The layer being viewed.

results Property results Collection<LengthDimensionResult>readonly

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 Property selectedDimension LengthDimension |null |undefined

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 Property suspended Booleanreadonly

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

uid Inherited Property uid Stringreadonly Inherited from LayerView Since: ArcGIS Maps SDK for JavaScript 4.33 LayerView since 4.0, uid added at 4.33.

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

updating Inherited Property updating Booleanreadonly Inherited from LayerView

Indicates if the layer view is making any updates that will impact what is displayed on the map. For example, this value is true when renderer, definitionExpression, filter or effect is changed or if the layer view is in the process of the fetching data.

Watch dataUpdating property instead to only know when the data has been updated (e.g. to run statistics query on all feature available in the layer view).

Default Value:false

Example

// Check for the first time layerView.updating becomes false. Then query for
// features that are visible within the view associated with the layer view.
await reactiveUtils.whenOnce(() => !layerView.updating);
const query = layerView.createQuery();
query.geometry = layerView.view.extent;
const result = layerView.queryFeatures(query);

view Inherited Property view MapView |SceneViewreadonly Inherited from LayerView Since: ArcGIS Maps SDK for JavaScript 4.28 LayerView since 4.0, view added at 4.28.

A reference to the MapView or SceneView associated with the layer view.

Example

// Check for the first time layerView.updating becomes false. Then query for
// features that are visible within the view associated with the layer view.
await reactiveUtils.whenOnce(() => !layerView.updating);
const query = layerView.createQuery();
query.geometry = layerView.view.extent;
const result = layerView.queryFeatures(query);

visible Inherited Property visible Boolean Inherited from LayerView

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

visibleAtCurrentScale Inherited Property visibleAtCurrentScale Booleanreadonly Inherited from LayerView Since: ArcGIS Maps SDK for JavaScript 4.30 LayerView since 4.0, visibleAtCurrentScale added at 4.30.

When true, the layer is visible in the view at the current scale. This applies to layers that have minScale and maxScale properties set.

Known Limitations

This property is not supported in 3D SceneView tiled layers.

Default Value:true

See also

visibleAtCurrentTimeExtent
suspended

visibleAtCurrentTimeExtent Inherited Property visibleAtCurrentTimeExtent Booleanreadonly Inherited from LayerView Since: ArcGIS Maps SDK for JavaScript 4.30 LayerView since 4.0, visibleAtCurrentTimeExtent added at 4.30.

When true, the layer is visible in the view's timeExtent. This applies to layers that have a visibilityTimeExtent.

Default Value:true

See also

visibleAtCurrentScale
suspended

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
Promise<void>	Starts the interactive creation of new dimensions and adds them to the layer's source.	DimensionLayerView
Boolean	Returns true if a named group of handles exist.	Accessor
Boolean	`isFulfilled()` may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).	LayerView
Boolean	`isRejected()` may be used to verify if creating an instance of the class is rejected.	LayerView
Boolean	`isResolved()` may be used to verify if creating an instance of the class is resolved.	LayerView
Promise<DimensionPlacementResult>	Starts the interactive placement of a single dimension, adding it to the layer's source.	DimensionLayerView
	Removes a group of handles owned by the object.	Accessor
Promise	`when()` may be leveraged once an instance of the class is created.	LayerView

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.

createLengthDimensions Method createLengthDimensions(options){Promise<void>}

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

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

This method is similar to the place() method, but it allows to create multiple dimensions in a row.

Calling this method sets interactive to true.

Parameters

options Object|null

optional

An object specifying additional options.

Specification

signal AbortSignal|null|undefined

optional

Abort signal which can be used to cancel creation.

Returns

Type	Description
Promise<void>	A promise which resolves when creation is completed successfully or rejected if it is canceled.

Example

const abortController = new AbortController();

try {
  await layerView.createLengthDimensions({ signal: abortController.signal });
} catch (error) {
  if (error.name === "AbortError") {
    console.log("Creation operation was cancelled.");
  }
}

// cancel the placement operation at some later point
abortController.abort();

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

isFulfilled Inherited Method isFulfilled(){Boolean} Inherited from LayerView

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 Inherited Method isRejected(){Boolean} Inherited from LayerView

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 Inherited Method isResolved(){Boolean} Inherited from LayerView

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.

place Method place(options){Promise<DimensionPlacementResult>} Since: ArcGIS Maps SDK for JavaScript 4.33 DimensionLayerView since 4.25, place added at 4.33.

Starts the interactive placement of a single dimension, adding it to the layer's source.

The first click places start point and the second sets end point.

The placement operation will finish when the user presses the escape key. To stop the placing programmatically, pass an abort signal as an argument when calling the method.

Calling this method sets interactive to true.

Parameters

options Object|null|undefined

optional

An object specifying additional options.

Specification

signal AbortSignal|null|undefined

optional

Abort signal which can be used to cancel creation.

Returns

Type	Description
Promise<DimensionPlacementResult>	A promise which resolves when the operation is completed successfully or rejected if it is canceled.

Example

const abortController = new AbortController();

try {
  await layerView.place({ signal: abortController.signal });
} catch (error) {
  if (error.name === "AbortError") {
    console.log("Placement operation was cancelled.");
  }
}

// cancel the placement operation at some later point
abortController.abort();

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

when Inherited Method when(callback, errback){Promise} Inherited from LayerView

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