require(["esri/layers/support/ImageElement"], (ImageElement) => { /* code goes here */ });
import ImageElement from "@arcgis/core/layers/support/ImageElement.js";
esri/layers/support/ImageElement
Represents an image element referenced in the MediaLayer's source. MediaLayer can display images that are supported by web browsers. Refer to the common image file types document for supported image types.
Coordinates of the image and video elements can be specified in any spatial reference and are projected to the view's spatial reference. The content is stretched linearly between the coordinates, therefore it’s recommended for the image or video to match the view’s spatial reference to align correctly, especially for content covering large areas like the entire earth.
Note that the maximum size of the image depends on the machine's GPU. The safest maximum size is 2048 x 2048 pixels. The larger the image size, the longer it will take to be fetched and displayed.
// add a new imageElement and use extent and rotation
// to place the element on the map.
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
})
})
});
Constructors
-
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 |
---|---|---|---|
The animation options for the image element. | ImageElement | ||
The image content referenced in the image element instance. | ImageElement | ||
The name of the class. | Accessor | ||
The geographic location of the image or video element to be placed on the map. | ImageElement | ||
The image element to be added to the media layer's source. | ImageElement | ||
The opacity of the element. | ImageElement | ||
The element type. | ImageElement |
Property Details
-
animationOptions
animationOptions AnimationOptions
Since: ArcGIS Maps SDK for JavaScript 4.28ImageElement since 4.28, animationOptions added at 4.28. -
The animation options for the image element. This property is only valid when the image is an animated GIF or APNG.
Known Limitations
- animationOptions is not supported in 3D SceneViews.
ExampleimageElement.animationOptions = { playing: true, duration: 10, repeatType: "loop", repeatDelay: 0 };
-
content
content HTMLImageElement |HTMLCanvasElement |ImageDatareadonly
-
The image content referenced in the image element instance. The content matches the image referenced in image parameter.
-
georeference
georeference ExtentAndRotationGeoreference |CornersGeoreference |ControlPointsGeoreference
-
The geographic location of the image or video element to be placed on the map. The location can be set by either specifying extent and rotation of the element, the corner points of the bounding box, or by defining control points.
Examples// create a new ExtentAndRotationGeoreference const geoReference = new ExtentAndRotationGeoreference({ extent: new Extent({ spatialReference: { wkid: 102100 }, xmin: -10047456.27662979, ymin: 3486722.2723874687, xmax: -10006982.870152846, ymax: 3514468.91365495 }) }); const imageElement = new ImageElement({ image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/new-orleans/neworleans1891.png", georeference: geoReference });
// create a canvas image element by setting its corner points of the bounding box const canvasElement = new ImageElement({ image: canvas, georeference: new CornersGeoreference({ bottomRight: new Point({ x: -121.369, y: 45.061 }), bottomLeft: new Point({ x: -122.363, y: 45.061 }), topRight: new Point({ x: -121.369, y: 45.678 }), topLeft: new Point({ x: -122.363, y: 45.678 }) }) });
// georeference an ImageElement, using ControlPointsGeoreference in the // North American Datum 1927 spatial reference const spatialReference = new SpatialReference({ wkid: 4267 }); const swCorner = { sourcePoint: { x: 80, y: 1732 }, mapPoint: new Point({ x: -107.875, y: 37.875, spatialReference }) }; const nwCorner = { sourcePoint: { x: 75, y: 102 }, mapPoint: new Point({ x: -107.875, y: 38, spatialReference }) }; const neCorner = { sourcePoint: { x: 1353, y: 99 }, mapPoint: new Point({ x: -107.75, y: 38, spatialReference }) }; const seCorner = { sourcePoint: { x: 1361, y: 1721 }, mapPoint: new Point({ x: -107.75, y: 37.875, spatialReference }) }; const controlPoints = [swCorner, nwCorner, neCorner, seCorner]; const georeference = new ControlPointsGeoreference({ controlPoints, width: 1991, height: 2500 }); const imageElement = new ImageElement({ image: "https://jsapi.maps.arcgis.com/sharing/rest/content/items/1a3df04e7d734535a3a6a09dfec5a6b2/data", georeference });
-
image
image String |HTMLImageElement |HTMLCanvasElement |ImageData
-
The image element to be added to the media layer's source. The image element can be URL string pointing the image for example.
Examples// create an image element pointing url of the image file const stHelen = new ImageElement({ image: "https://ubatsukh.github.io/arcgis-js-api-demos/data/nasa/mount_st_helens.jpeg", georeference: new CornersGeoreference({ extent: new Extent({ spatialReference: { wkid: 102100 }, xmax: -13544247.66023844, xmin: -13659744.009977184, ymax: 5858405.227033072, ymin: 5767445.163373847 }) }) });
// create an image element pointing to image data const arr = new Uint8ClampedArray(40000); // Iterate through every pixel for (let i = 0; i < arr.length; i += 4) { arr[i] = 0; // R value arr[i + 1] = 190; // G value arr[i + 2] = 0; // B value arr[i + 3] = 255; // A value } // Initialize a new ImageData object let imageData = new ImageData(arr, 200); // create a new image element pointing to the // image data and set location of the image on the map const imageDataElement = new ImageElement({ image: imageData, georeference: extent });
// create a canvas const canvas = document.createElement("canvas"); const ctx = canvas.getContext("2d"); canvas.width = 200; canvas.height = 200; ctx.fillStyle = "blue"; ctx.fillRect(0, 0, 200, 200); // add the canvas as an image element const canvasElement = new ImageElement({ image: canvas, georeference: extent });
-
opacity
opacity Number
-
The opacity of the element. This value can range between 1 and 0, where 0 is 100 percent transparent and 1 is completely opaque.
- Default Value:1
-
type
type Stringreadonly
-
The element type.
For ImageElement the type is always "image".
Method Overview
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 | ||
Removes a group of handles owned by the object. | Accessor |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 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.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 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
-
AnimationOptions
AnimationOptions Object
Since: ArcGIS Maps SDK for JavaScript 4.28ImageElement since 4.28, AnimationOptions added at 4.28. -
Represents animation options, a collection of properties that apply when the image is an animated GIF or APNG.
- Properties
-
playing Boolean
Indicates whether the animated image should play its animation.
duration NumberRepresents the number of seconds it takes to play through the layer's animation once.
repeatType StringDetermines how to repeat the animation of a layer when the animation cycle ends.
Possible Values:"none"|"loop"|"oscillate"
repeatDelay NumberRepresents the number of seconds to delay before repeating an animation cycle.