require(["esri/support/ContentElement/Media/Image"], function(MediaImageContentElement) { /* code goes here */ });
Class: esri/support/ContentElement/Media/Image
Inheritance: Image Media Accessor
Since: ArcGIS API for JavaScript 4.10

A MediaImageContentElement represents images to display within a popup.

popuptemplate-media-imageelement

See also:
Example:
// Create the ImageValue
let imageValue = new ImageValue({
  sourceURL: "<insert URL>"
});

// Create the ImageContentElement
let imageElement = new ImageContentElement({
  title: "<b>Mexican Fan Palm</b>",
  caption: "tree species",
  value: imageValue
});

// Create the MediaContentElement
let mediaElement = new MediaContentElement({
  mediaInfos: [ imageElement ]
});

Constructors

new Image(properties)
Parameter:
properties Object
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 Working with Properties topic.
NameTypeSummaryClass
String

Defines a caption for the media.

more details
more detailsMedia
String

The name of the class.

more details
more detailsAccessor
Number

Refresh interval of the layer in minutes.

more details
more detailsImage
String

The title of the media element.

more details
more detailsMedia
String

The type of popup element.

more details
more detailsImage
Value

Defines the value format of the image media element and how the images should be retrieved.

more details
more detailsImage

Property Details

Defines a caption for the media.

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

refreshIntervalNumber

Refresh interval of the layer in minutes. Non-zero value indicates automatic layer refresh at the specified interval. Value of 0 indicates auto refresh is not enabled. If the property does not exist, it is equivalent to having a value of 0.

The title of the media element.

typeStringreadonly

The type of popup element.

Default Value:image

Defines the value format of the image media element and how the images should be retrieved.

Method Overview

NameReturn TypeSummaryClass
Image

Creates a deep clone of the MediaImageContentElement class.

more details
more detailsImage
*

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform.

more details
more detailsImage
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsImage

Method Details

clone(){Image}

Creates a deep clone of the MediaImageContentElement class.

Returns:
TypeDescription
ImageA deep clone of the MediaImageContentElement instance.
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. The object passed into the input json parameter often comes from a response to a query operation in the REST API or a toJSON() method from another ArcGIS product. See the Using fromJSON() topic in the Guide for details and examples of when and how to use this function.

Parameter:
json Object

A JSON representation of the instance in the ArcGIS format. See the ArcGIS REST API documentation for examples of the structure of various input JSON objects.

Returns:
TypeDescription
*Returns a new instance of this class.
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...