require(["esri/popup/content/support/ChartMediaInfoValue"], (ChartMediaInfoValue) => { /* code goes here */ });
import ChartMediaInfoValue from "@arcgis/core/popup/content/support/ChartMediaInfoValue.js";
esri/popup/content/support/ChartMediaInfoValue
The ChartMediaInfoValue
class contains information for popups regarding how charts should be constructed.
- See also
// 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
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
An optional array of colors where each color corresponds respectively to a field in the fields. | ChartMediaInfoValue | ||
The name of the class. | Accessor | ||
An array of strings, with each string containing the name of a field to display in the chart. | ChartMediaInfoValue | ||
A string containing the name of a field. | ChartMediaInfoValue | ||
An array of ChartMediaInfoValueSeries objects which provide information of x/y data that is plotted in a chart. | ChartMediaInfoValue | ||
String value indicating the tooltip for a chart specified from another field. | ChartMediaInfoValue |
Property Details
-
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.
-
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
normalizeField String
-
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
series ChartMediaInfoValueSeries[]autocast
-
An array of ChartMediaInfoValueSeries objects which provide information of x/y data that is plotted in a chart.
-
tooltipField
tooltipField String
-
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | ChartMediaInfoValue | |
Returns true if a named group of handles exist. | Accessor | ||
Removes a group of handles owned by the object. | Accessor | ||
Converts an instance of this class to its ArcGIS portal JSON representation. | ChartMediaInfoValue |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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 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.Parameterjson 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.