ChartMediaInfoValue | References | ArcGIS Maps SDK for JavaScript

import ChartMediaInfoValue from "@arcgis/core/popup/content/support/ChartMediaInfoValue.js";

Inheritance:: ChartMediaInfoValue→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.11

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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ChartMediaInfoValueProperties`

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`colors`	`Color[] \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`fields`	`string[]`
`normalizeField`	`string \| null \| undefined`
`series`	`ChartMediaInfoValueSeries[]`
`tooltipField`	`string \| null \| undefined`

colors

autocast Property

Type: 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

readonlyinherited Property

Type: string

Inherited from: Accessor

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

fields

Property

Type: 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

Type: 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

autocast Property

Type: ChartMediaInfoValueSeries[]

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

tooltipField

Property

Type: 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.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): ChartMediaInfoValue`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): ChartMediaInfoValue

Creates a deep clone of the ChartMediaInfoValue class.

Returns: ChartMediaInfoValue

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.