The LocalMediaElementSource is the default source for the MediaLayer. It contains a collection of image and video elements referenced in the MediaLayer's source. Image and video elements can be added or removed from elements collection at runtime.
Constructors
-
new LocalMediaElementSource(properties)
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. more details | Accessor | |
Collection<MediaElement> | Image and video elements referenced in the MediaLayer. more details | LocalMediaElementSource |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
elements Collection<MediaElement>autocastAutocasts from MediaElement[]
-
Image and video elements referenced in the MediaLayer. Image and video elements can be added or removed from elements collection at runtime.
Examples// add a new imageElement to the media layer at runtime const imageElement = new ImageElement({ image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/neworleans1891.png", georeference: new ExtentAndRotationGeoreference({ extent: new Extent({ spatialReference: { wkid: 102100 }, xmin: -10047456.27662979, ymin: 3486722.2723874687, xmax: -10006982.870152846, ymax: 3514468.91365495 }) }) }); layer.source.elements.add(imageElement);
// remove image element from the media layer at runtime layer.source.elements.remove(selectedImageElement);
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
Boolean | Returns true if a named group of handles exist. more details | Accessor | |
Removes a group of handles owned by the object. more details | Accessor |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
Since: ArcGIS Maps SDK for JavaScript 4.25
-
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 4.25
-
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
Type Definitions
-
-
Image and video elements referenced in the MediaLayer.
- See also