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

A 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.

popuptemplate-media-piechart

See also:
Example:
layer.popupTemplate.content = [{
  // The following creates a piechart in addition to an image. The chart is
  // also set  up to work with related tables.
  // Autocasts as new MediaContentElement()
  type: "media",
  // Autocasts as array of Media objects
  mediaInfos: [{
    title: "<b>Count by type</b>",
    type: "pie-chart", // autocasts as new MediaPieChartContentElement
    // Autocasts as new Chart.value object
    value: {
      fields: ["relationships/0/Point_Count_COMMON"],
      normalizeField: null,
      tooltipField: "relationships/0/COMMON"
    }
  }, {
    title: "<b>Mexican Fan Palm</b>",
    type: "image", // Autocasts as new MediaImageContentElement
    caption: "tree species",
    // Autocasts as new Image.value object
    value: {
      sourceURL: "https://www.sunset.com/wp-content/uploads/96006df453533f4c982212b8cc7882f5-800x0-c-default.jpg"
    }
  }]
}];

Constructors

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

The name of the class.

more details
more detailsAccessor
BarChart|ColumnChart|Image|LineChart|PieChart|Array

Contains the media elements representing images or charts to display within the PopupTemplate.

more details
more detailsMedia
String

The type of popup element displayed.

more details
more detailsMedia

Property Details

declaredClassStringreadonly inherited

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

NameReturn TypeSummaryClass
Media

Creates a deep clone of the MediaContentElement class.

more details
more detailsMedia
*

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

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

more details
more detailsMedia

Method Details

clone(){Media}

Creates a deep clone of the MediaContentElement class.

Returns:
TypeDescription
MediaA 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 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...