Skip To ContentArcGIS for DevelopersSign In Dashboard

PieChartMediaInfo

require(["esri/popup/content/PieChartMediaInfo"], function(PieChartMediaInfo) { /* code goes here */ });
Class: esri/popup/content/PieChartMediaInfo
Inheritance: PieChartMediaInfo Accessor
Since: ArcGIS API for JavaScript 4.11

A PieChartMediaInfo is a type of chart media element that represents a pie chart displayed within a popup.

popuptemplate-media-piechart

See also:
Example:
// 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 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

Provides an alternate text for an image if the image cannot be displayed.

more details
more detailsPieChartMediaInfo
String

Defines a caption for the media.

more details
more detailsPieChartMediaInfo
String

The name of the class.

more details
more detailsAccessor
String

The title of the media element.

more details
more detailsPieChartMediaInfo
String

Indicates the type of chart.

more details
more detailsPieChartMediaInfo
ChartMediaInfoValue

Defines the chart value.

more details
more detailsPieChartMediaInfo

Property Details

altText String
Since: ArcGIS API for JavaScript 4.16

Provides an alternate text for an image if the image cannot be displayed.

caption String

Defines a caption for the media.

declaredClass Stringreadonly inherited

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

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

NameReturn TypeSummaryClass
PieChartMediaInfo

Creates a deep clone of the PieChartMediaInfo class.

more details
more detailsPieChartMediaInfo
*

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

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

more details
more detailsPieChartMediaInfo

Method Details

Creates a deep clone of the PieChartMediaInfo class.

Returns:
TypeDescription
PieChartMediaInfoA 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 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() guide topic for more information.

Returns:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...