Skip To ContentArcGIS for DevelopersSign In Dashboard

ImageMediaInfo

require(["esri/popup/content/ImageMediaInfo"], function(ImageMediaInfo) { /* code goes here */ });
Class: esri/popup/content/ImageMediaInfo
Since: ArcGIS API for JavaScript 4.11

An ImageMediaInfo is a type of media element that represents images to display within a popup.

popuptemplate-media-imageelement

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

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

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

Constructors

new ImageMediaInfo(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

Provides an alternate text for an image if the image cannot be displayed.

more details
more detailsImageMediaInfo
String

Defines a caption for the media.

more details
more detailsImageMediaInfo
Number

Refresh interval of the layer in minutes.

more details
more detailsImageMediaInfo
String

The title of the media element.

more details
more detailsImageMediaInfo
String

The type of popup element.

more details
more detailsImageMediaInfo
ImageMediaInfoValue

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

more details
more detailsImageMediaInfo

Property Details

altText String
Since: ArcGIS API for JavaScript 4.16

Provides an alternate text for an image if the image cannot be displayed.

caption String

Defines a caption for the media.

refreshInterval Number

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.

title String

The title of the media element.

type Stringreadonly

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
ImageMediaInfo

Creates a deep clone of the ImageMediaInfo class.

more details
more detailsImageMediaInfo
*

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 detailsImageMediaInfo
Object

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

more details
more detailsImageMediaInfo

Method Details

Creates a deep clone of the ImageMediaInfo class.

Returns:
TypeDescription
ImageMediaInfoA deep clone of the ImageMediaInfo 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() guide topic for more information.

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

API Reference search results

NameTypeModule
Loading...