BarChart
require(["esri/support/ContentElement/Media/BarChart"], function(MediaBarChartContentElement) { /* code goes here */ });
esri/support/ContentElement/Media/BarChart
A MediaBarChartContentElement
is a type of Chart element that represents a bar chart displayed within a popup.
- See also:
// Create a new BarChart to display within the PopupTemplate
// Create the CoBar Chart Value
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 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 | |
String | The title of the media element. more details | more details | Media | |
String | Indicates the type of chart. more details | more details | BarChart | |
Value | Defines the chart value. more details | more details | Chart |
Property Details
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
Name | Return Type | Summary | Class | |
---|---|---|---|---|
BarChart | Creates a deep clone of the MediaBarChartContentElement class. more details | more details | BarChart | |
* | 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 | BarChart | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | BarChart |
Method Details
- clone(){BarChart}
Creates a deep clone of the MediaBarChartContentElement class.
Returns:Type Description BarChart A 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 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.