ChartMediaInfoValue | API Reference | ArcGIS Maps SDK for JavaScript 4.33

The ChartMediaInfoValue class contains information for popups regarding how charts should be constructed.

See also

Examples

// Create a ChartMediaInfoValue that customizes the colors of each
// field that will be represented in the chart.
let pieChartValue = new ChartMediaInfoValue({
  colors: [
    new Color([254, 235, 226, 1]),
    new Color([250, 164, 180, 1]),
    new Color([248, 116, 165, 1]),
    new Color([204, 39, 141, 1])
  ],
  fields: [
    "B12001_calc_pctMarriedE",
    "B12001_calc_numMarriedE",
    "B12001_calc_numNeverE",
    "B12001_calc_numDivorcedE"
  ],
  normalizeField: null
});

// Create a ChartMediaInfoValue that customizes the colors of each
// field that will be represented in the chart.
let pieChartValue = new ChartMediaInfoValue({
  // Autocasts each item to a new Color object.
  colors: ["red", "yellow", "green", "blue"],
  fields: [
    "B12001_calc_pctMarriedE",
    "B12001_calc_numMarriedE",
    "B12001_calc_numNeverE",
    "B12001_calc_numDivorcedE"
  ],
});

Constructors

ChartMediaInfoValue Constructor new ChartMediaInfoValue(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Color []\|null\|undefined	An optional array of colors where each color corresponds respectively to a field in the fields.	ChartMediaInfoValue
String	The name of the class.	Accessor
String []	An array of strings, with each string containing the name of a field to display in the chart.	ChartMediaInfoValue
String\|null\|undefined	A string containing the name of a field.	ChartMediaInfoValue
ChartMediaInfoValueSeries []	An array of ChartMediaInfoValueSeries objects which provide information of x/y data that is plotted in a chart.	ChartMediaInfoValue
String\|null\|undefined	String value indicating the tooltip for a chart specified from another field.	ChartMediaInfoValue

Property Details

colors Property colors Color[] |null |undefined

An optional array of colors where each color corresponds respectively to a field in the fields. When utilized with line charts, the first color in the array drives the line color. If there are less colors specified than fields or this property is not set, the default color ramp is applied.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

fields Property fields String[]

An array of strings, with each string containing the name of a field to display in the chart.

In order to work with related fields within a chart, the fields must either be set as a fields element in the PopupTemplate's content or as popupTemplate.fieldInfos property outside of the PopupTemplate's content.

Set the popupTemplate.fieldInfos property for any fields that need to have number formatting for chart/text elements.

normalizeField Property normalizeField String |null |undefined

A string containing the name of a field. The values of all fields in the chart will be normalized (divided) by the value of this field.

series Property series ChartMediaInfoValueSeries[]autocast

An array of ChartMediaInfoValueSeries objects which provide information of x/y data that is plotted in a chart.

tooltipField Property tooltipField String |null |undefined

String value indicating the tooltip for a chart specified from another field. It is used for showing tooltips from another field in the same layer or related layer/table.

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	ChartMediaInfoValue
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	ChartMediaInfoValue

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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 Inherited Method removeHandles(groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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 Method 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.