Image
require(["esri/support/ContentElement/Media/Image"], function(MediaImageContentElement) { /* code goes here */ });esri/support/ContentElement/Media/ImageA MediaImageContentElement represents images to display within a popup.
- See also:
// Create the Image Value
let imageValue = new ImageValue({
sourceURL: "<insert URL>"
});
// Create the Image element
let imageElement1 = new ImageContentElement({
title: "<b>Mexican Fan Palm</b>",
caption: "tree species",
value: imageValue
});
// Create the Media Content Element
let mediaElement = new MediaContentElement({
mediaInfos: [ imageElement ]
});Constructors
- new Image(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 | |
|---|---|---|---|---|
| String | Defines a caption for the media. more details | more details | Media | |
| String | The name of the class. more details | more details | Accessor | |
| Number | Refresh interval of the layer in minutes. more details | more details | Image | |
| String | The title of the media element. more details | more details | Media | |
| String | The type of popup element. more details | more details | Image | |
| Value | Defines the value format of the image media element and how the images should be retrieved. more details | more details | Image |
Property Details
Defines a caption for the media.
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
0indicates auto refresh is not enabled. If the property does not exist, it is equivalent to having a value of0.
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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Image | Creates a deep clone of the MediaImageContentElement class. more details | more details | Image | |
| * | 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 details | Image | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Image |
Method Details
- clone(){Image}
Creates a deep clone of the MediaImageContentElement class.
Returns:Type Description Image A 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
jsonparameter 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 ObjectA 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:Type Description * 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:Type Description Object The ArcGIS portal JSON representation of an instance of this class.