PieChartMediaInfo

AMD: require(["esri/popup/content/PieChartMediaInfo"], (PieChartMediaInfo) => { /* code goes here */ });
ESM: import PieChartMediaInfo from "@arcgis/core/popup/content/PieChartMediaInfo.js";
Class: esri/popup/content/PieChartMediaInfo
Inheritance: PieChartMediaInfo Accessor
Since: ArcGIS Maps SDK 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.
Show inherited properties Hide inherited properties
Name Type Summary Class
String

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

more details
PieChartMediaInfo
String

Defines a caption for the media.

more details
PieChartMediaInfo
String

The name of the class.

more details
Accessor
String

The title of the media element.

more details
PieChartMediaInfo
String

Indicates the type of chart.

more details
PieChartMediaInfo
ChartMediaInfoValue

Defines the chart value.

more details
PieChartMediaInfo

Property Details

altText String
Since: ArcGIS Maps SDK 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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
PieChartMediaInfo

Creates a deep clone of the PieChartMediaInfo class.

more details
PieChartMediaInfo
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
PieChartMediaInfo
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
PieChartMediaInfo

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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 an ArcGIS product. 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
Type Description
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.