require(["esri/popup/content/ImageMediaInfo"], (ImageMediaInfo) => { /* code goes here */ });
import ImageMediaInfo from "@arcgis/core/popup/content/ImageMediaInfo.js";
esri/popup/content/ImageMediaInfo
An ImageMediaInfo is a type of media element that represents images to display within a popup.
- See also
// Create the ImageMediaInfoValue
let imageMediaInfoValue = new ImageMediaInfoValue({
sourceURL: "<insert URL>"
});
// Create the ImageMediaInfo
let imageElement = new ImageMediaInfo({
title: "<b>Mexican Fan Palm</b>",
caption: "tree species",
value: imageMediaInfoValue
});
// Create the MediaContent
let mediaElement = new MediaContent({
mediaInfos: [ imageElement ]
});Constructors
-
Parameterproperties 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 | Provides an alternate text for an image if the image cannot be displayed. | ImageMediaInfo | |
| String | Defines a caption for the media. | ImageMediaInfo | |
| String | The name of the class. | Accessor | |
| Number | Refresh interval of the layer in minutes. | ImageMediaInfo | |
| String | The title of the media element. | ImageMediaInfo | |
| String | The type of popup element. | ImageMediaInfo | |
| ImageMediaInfoValue | Defines the value format of the image media element and how the images should be retrieved. | ImageMediaInfo |
Property Details
-
altText
PropertyaltText StringSince: ArcGIS Maps SDK for JavaScript 4.16ImageMediaInfo since 4.11, altText added at 4.16. -
Provides an alternate text for an image if the image cannot be displayed.
-
caption
Propertycaption String -
Defines a caption for the media.
-
refreshInterval
PropertyrefreshInterval Number -
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.
-
title
Propertytitle String -
The title of the media element.
-
type
Propertytype Stringreadonly -
The type of popup element.
- Default Value:image
-
value
Propertyvalue ImageMediaInfoValueautocast -
Defines the value format of the image media element and how the images should be retrieved.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| ImageMediaInfo | Creates a deep clone of the ImageMediaInfo class. | ImageMediaInfo | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ImageMediaInfo | |
| Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. | ImageMediaInfo |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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.
-
clone
Methodclone(){ImageMediaInfo} -
Creates a deep clone of the ImageMediaInfo class.
ReturnsType Description ImageMediaInfo A deep clone of the ImageMediaInfo instance.
-
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
MethodtoJSON(){Object} -
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.