Media
require(["esri/support/ContentElement/Media"], function(MediaContentElement) { /* code goes here */ });esri/support/ContentElement/MediaA MediaContentElement represents an individual or array of Media elements to display within a popup's content. Examples of these types of media are charts and/or images.
- See also:
layer.popupTemplate.content = [{
// The following creates a piechart in addition to an image. The chart is
// also set up to work with related tables.
// Autocast
type: "media",
// Autocasted
mediaInfos: [{
title: "<b>Count by type</b>",
type: "pie-chart",
caption: "",
value: {
fields: ["relationships/0/Point_Count_COMMON"],
normalizeField: null,
tooltipField: "relationships/0/COMMON"
}
}, {
title: "<b>Mexican Fan Palm</b>",
type: "image",
caption: "tree species",
value: {
sourceURL: ""https://www.sunset.com/wp-content/uploads/96006df453533f4c982212b8cc7882f5-800x0-c-default.jpg""
}
}]
}];Constructors
- new Media(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 | The name of the class. more details | more details | Accessor | |
| BarChart|ColumnChart|Image|LineChart|PieChart|Array | Contains the media elements representing images or charts to display within the PopupTemplate. more details | more details | Media | |
| String | The type of popup element displayed. more details | more details | Media |
Property Details
The name of the class. The declared class name is formatted as
esri.folder.className.
Contains the media elements representing images or charts to display within the PopupTemplate. This can be an individual chart or image element, or an array containing a combination of any of these types.
- typeStringreadonly
The type of popup element displayed.
- Default Value:media
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| Media | Creates a deep clone of the MediaContentElement class. more details | more details | Media | |
| * | 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 | Media | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | Media |
Method Details
- clone(){Media}
Creates a deep clone of the MediaContentElement class.
Returns:Type Description Media A deep clone of the MediaContentElement 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.