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

A MediaBarChartContentElement is a type of Chart element that represents a bar chart displayed within a popup.

popuptemplate-media-barchart

See also:
Example:
// Create a new BarChart to display within the PopupTemplate
// Create the BarChartValue
let barChartValue = new BarChartValue({
  fields: ["<array of strings indicating fields>"],
  normalizeField: null,
  tooltipField: "<field name>"
});

// Create the BarChart media type
let barChart = new BarChart({
  title: "<b>Count by type</b>",
  caption: "Per block",
  value: barChartValue
});

// Create the Media Content Element
let mediaElement = new MediaContentElement({
  mediaInfos: [barChart]
});

Constructors

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

Defines a caption for the media.

more details
more detailsMedia
String

The name of the class.

more details
more detailsAccessor
String

The title of the media element.

more details
more detailsMedia
String

Indicates the type of chart.

more details
more detailsBarChart
Value

Defines the chart value.

more details
more detailsChart

Property Details

Defines a caption for the media.

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

The title of the media element.

typeStringreadonly

Indicates the type of chart.

Default Value:bar-chart

Defines the chart value.

Method Overview

NameReturn TypeSummaryClass
BarChart

Creates a deep clone of the MediaBarChartContentElement class.

more details
more detailsBarChart
*

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

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

more details
more detailsBarChart

Method Details

clone(){BarChart}

Creates a deep clone of the MediaBarChartContentElement class.

Returns:
TypeDescription
BarChartA deep clone of the MediaBarChartContentElement 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...