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 2048x2048px. 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
})
})
});
- See also:
Constructors
-
new ImageElement(properties)
-
Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
HTMLImageElement|HTMLCanvasElement|ImageData | more details The image content referenced in the image element instance. | more details | ImageElement | |
String | more details The name of the class. | more details | Accessor | |
ExtentAndRotationGeoreference|CornersGeoreference | more details The geographic location of the image or video element to be placed on the map. | more details | ImageElement | |
String|HTMLImageElement|HTMLCanvasElement|ImageData | more details The image element to be added to the media layer's source. | more details | ImageElement | |
Number | more details The opacity of the element. | more details | ImageElement | |
String | more details The element type. | more details | ImageElement |
Property Details
-
-
The image content referenced in the image element instance. The content matches the image referenced in image parameter.
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
-
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, or corner points of the bounding box.
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({ type: "image", image: "https://arcgis.github.io/arcgis-samples-javascript/sample-data/media-layer/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, spatialReference: { wkid: 4326 } }), bottomLeft: new Point({ x: -122.363, y: 45.061, spatialReference: { wkid: 4326 } }), topRight: new Point({ x: -121.369, y: 45.678, spatialReference: { wkid: 4326 } }), topLeft: new Point({ x: -122.363, y: 45.678, spatialReference: { wkid: 4326 } }) }) });
-
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] = 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 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 Stringreadonly
-
The element type.
For ImageElement the type is always "image".