The ChartMediaInfoValue
class contains information for popups regarding how charts should be constructed.
- See also
Constructors
-
new ChartMediaInfoValue(properties)
-
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 |
---|---|---|---|
String | The name of the class. more details | Accessor | |
String[] | An array of strings, with each string containing the name of a field to display in the chart. more details | ChartMediaInfoValue | |
String | A string containing the name of a field. more details | ChartMediaInfoValue | |
ChartMediaInfoValueSeries[] | An array of ChartMediaInfoValueSeries objects which provide information of x/y data that is plotted in a chart. more details | ChartMediaInfoValue | |
String | String value indicating the tooltip for a chart specified from another field. more details | ChartMediaInfoValue |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
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 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.
-
An array of ChartMediaInfoValueSeries objects which provide information of x/y data that is plotted in a chart.
-
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. more details | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | ChartMediaInfoValue | |
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 | ChartMediaInfoValue |
Method Details
-
addHandles(handleOrHandles, groupKey)inheritedSince: 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();
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.
-
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.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.
-
Since: ArcGIS Maps SDK for JavaScript 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"); }
-
removeHandles(groupKey)inheritedSince: ArcGIS Maps SDK for JavaScript 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(){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.