PieChartMediaInfo
require(["esri/popup/content/PieChartMediaInfo"], function(PieChartMediaInfo) { /* code goes here */ });
esri/popup/content/PieChartMediaInfo
A PieChartMediaInfo
is a type of chart media element that represents a pie chart displayed within a popup.
- See also:
// Create a new PieChart to display within the PopupTemplate
// Create the ChartMediaInfoValue
let pieChartValue = new ChartMediaInfoValue({
fields: ["<array of strings indicating fields>"],
normalizeField: null,
tooltipField: "<field name>"
});
// Create the PieChartMediaInfo media type
let pieChart = new PieChartMediaInfo({
title: "<b>Count by type</b>",
caption: "Per block",
value: pieChartValue
});
// Create the MediaContent
let mediaElement = new MediaContent({
mediaInfos: [pieChart]
});
Constructors
- new PieChartMediaInfo(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 | PieChartMediaInfo | |
String | The title of the media element. more details | more details | PieChartMediaInfo | |
String | Indicates the type of chart. more details | more details | PieChartMediaInfo | |
ChartMediaInfoValue | Defines the chart value. more details | more details | PieChartMediaInfo |
Property Details
- caption String
Defines a caption for the media.
- title String
The title of the media element.
- type Stringreadonly
Indicates the type of chart.
- Default Value:pie-chart
Defines the chart value.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
PieChartMediaInfo | Creates a deep clone of the PieChartMediaInfo class. more details | more details | PieChartMediaInfo | |
* | 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 | PieChartMediaInfo | |
Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | PieChartMediaInfo |
Method Details
- clone(){PieChartMediaInfo}
Creates a deep clone of the PieChartMediaInfo class.
Returns:Type Description PieChartMediaInfo A deep clone of the PieChartMediaInfo 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.