MediaLayerView

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

Represents the LayerView of a MediaLayer after it has been added to a Map in a MapView or SceneView.

Keyboard shortcuts

Various keyboard shortcuts are available when enabling interactive manipulation of media elements in the layer view.

Shortcut Action
Z Incrementally undo actions recorded in the stack. The undo/redo stack is for an individual operation, meaning you can redo/undo actions while updating a single element.
R Incrementally redo actions recorded in the stack. The undo/redo stack is for an individual operation, meaning you can redo/undo actions while updating a single element.
Shift (resize) Enable uniform scaling when resizing an element.
Shift (rotate) Enable rotation with 5 degree increments.
Shift+Arrow Move an element by a single pixel.
Shift+Primary+Arrow Move an element by 10 pixels. The primary key is the Cmd key on macos or Ctrl on other OS.
T Toggle transparency of the element.
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

The name of the class.

Accessor

Options for when the layer view is interactive.

MediaLayerView

Set to true to enable interactivity for the layer.

MediaLayerView

The layer being viewed.

MediaLayerView

The selected element.

MediaLayerView

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

MediaLayerView

Indicates if the layer view is making any updates that will impact what is displayed on the map.

LayerView

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

LayerView

When true, the layer is visible in the view.

LayerView

When true, the layer is visible in the view at the current scale.

LayerView

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.

interactionOptions

Property
interactionOptions Accessor

Options for when the layer view is interactive.

Known Limitations

  • Interactivity is not supported in 2D MapViews
Property
tool String
optional

The type of tool to use to interact with media elements.

Value Description
transform The media element can be moved, scaled and rotated as a whole (default).
reshape The four corners of the media element can be moved individually.

Possible Values:"transform"|"reshape"

See also

interactive

Property
interactive Boolean

Set to true to enable interactivity for the layer. Any elements in the layer's source become selectable and editable.

Known Limitations

  • Interactivity is not supported in 2D MapViews
Default Value:false
See also
Example
view.whenLayerView(mediaLayer).then((mediaLayerView) => {
  // Enable interactivity and select first element
  mediaLayerView.interactive = true;

  mediaLayerView.selectedElement = mediaLayer.source.elements.at(0);
});

layer

Property
layer MediaLayerreadonly

The layer being viewed.

selectedElement

Property
selectedElement ImageElement |VideoElement

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

Known Limitations

  • Interactivity is not supported in 2D MapViews
See also
Example
view.whenLayerView(mediaLayer).then((mediaLayerView) => {
  // Enable interactivity and select first element
  mediaLayerView.interactive = true;

  mediaLayerView.selectedElement = mediaLayer.source.elements.at(0);
});

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).

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

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

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

Inherited
Property
visibleAtCurrentTimeExtent Booleanreadonly
Inherited from LayerView

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

Default Value:true
See also

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

Returns true if a named group of handles exist.

Accessor

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

LayerView

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

LayerView

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

LayerView

Removes a group of handles owned by the object.

Accessor

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.

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.

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

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