RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-support-ImageElement.html below:

ImageElement | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import ImageElement from "@arcgis/core/layers/support/ImageElement.js";

CDN: const ImageElement = await $arcgis.import("@arcgis/core/layers/support/ImageElement.js");

Class: @arcgis/core/layers/support/ImageElement

Since: ArcGIS Maps SDK for JavaScript 4.24

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

See also

Constructors

ImageElement Constructor new ImageElement(properties)

Parameter

optional

See the properties for a list of all the properties that may be passed into the constructor.

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

Show inherited properties Hide inherited properties

Property Details

Since: ArcGIS Maps SDK for JavaScript 4.28 ImageElement 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.

Example

imageElement.animationOptions = {
  playing: true,
  duration: 10,
  repeatType: "loop",
  repeatDelay: 0
};

: The image content referenced in the image element instance. The content matches the image referenced in image parameter.

declaredClass Inherited Property declaredClass Stringreadonly: 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, 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
});

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

: The Error object returned if an error occurred while loading.

loadStatus Property loadStatus Stringreadonly

Represents the status of a load operation.

Value Description not-loaded The object's resources have not loaded. loading The object's resources are currently loading. loaded The object's resources have loaded without errors. failed The object's resources failed to load. See loadError for more details.

Possible Values:"not-loaded" |"loading" |"failed" |"loaded"

Default Value:"not-loaded"

loadWarnings Property loadWarnings Object[]readonly: A list of warnings which occurred while loading.

opacity Property 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.

type Property type Stringreadonly

The element type.

For ImageElement the type is always "image".

Method Overview

Show inherited methods Hide inherited methods

Name Return Type Summary Class addHandles()

Adds one or more handles which are to be tied to the lifecycle of the object.

Accessor cancelLoad()

Cancels a load() operation if it is already in progress.

ImageElement hasHandles() Boolean

Returns true if a named group of handles exist.

Accessor isFulfilled() Boolean

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

ImageElement isRejected() Boolean

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

ImageElement isResolved() Boolean

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

ImageElement load() Promise

Loads the resources referenced by this class.

ImageElement removeHandles()

Removes a group of handles owned by the object.

Accessor when() Promise

when() may be leveraged once an instance of the class is created.

ImageElement Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

Parameters

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.

cancelLoad Method cancelLoad(): Cancels a load() operation if it is already in progress.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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 Method isFulfilled(){Boolean}

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

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

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.

load Method load(options){Promise}

Loads the resources referenced by this class. This method automatically executes for a View and all of the resources it references in Map if the view is constructed with a map instance.

This method must be called by the developer when accessing a resource that will not be loaded in a View.

The load() method only triggers the loading of the resource the first time it is called. The subsequent calls return the same promise.

It's possible to provide a signal to stop being interested into a Loadable instance load status. When the signal is aborted, the instance does not stop its loading process, only cancelLoad can abort it.

Parameters

optional

Additional options.

Specification

optional

Signal object that can be used to abort the asynchronous task. The returned promise will be rejected with an Error named AbortError when an abort is signaled. See also AbortController for more information on how to construct a controller that can be used to deliver abort signals.

Returns

Type Description Promise Resolves when the resources have loaded.

removeHandles Inherited Method removeHandles(groupKey) Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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 Method when(callback, errback){Promise}

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

optional

The function to call when the promise resolves.

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

Type Definitions

AnimationOptions Type Definition AnimationOptions Object Since: ArcGIS Maps SDK for JavaScript 4.28 ImageElement 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

optional

Indicates whether the animated image should play its animation.

optional

Represents the number of seconds it takes to play through the layer's animation once.

optional

Determines how to repeat the animation of a layer when the animation cycle ends.

Possible Values:"none"|"loop"|"oscillate"

optional

Represents the number of seconds to delay before repeating an animation cycle.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4