ChartMediaInfoValueSeries | API Reference | ArcGIS Maps SDK for JavaScript 4.31

The ChartMediaInfoValueSeries class is a read-only support class that represents information specific to how data should be plotted in a chart. It helps provide a consistent API for plotting charts used by the Popup widget.

See also

ChartMediaInfoValue

Constructors

ChartMediaInfoValueSeries Constructor new ChartMediaInfoValueSeries(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

Type	Summary	Class
Color	The Color representing the field for a series.	ChartMediaInfoValueSeries
String	The name of the class.	Accessor
String	String value indicating the field's name for a series.	ChartMediaInfoValueSeries
String	String value indicating the tooltip for a series.	ChartMediaInfoValueSeries
Number	Numerical value for the chart series.	ChartMediaInfoValueSeries

Property Details

color Property color Colorreadonly Since: ArcGIS Maps SDK for JavaScript 4.28 ChartMediaInfoValueSeries since 4.11, color added at 4.28.

The Color representing the field for a series.

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

fieldName Property fieldName Stringreadonly Since: ArcGIS Maps SDK for JavaScript 4.24 ChartMediaInfoValueSeries since 4.11, fieldName added at 4.24.

String value indicating the field's name for a series.

tooltip Property tooltip Stringreadonly

String value indicating the tooltip for a series.

value Property value Numberreadonly

Numerical value for the chart series.

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
ChartMediaInfoValueSeries	Creates a deep clone of the ChartMediaInfoValueSeries class.	ChartMediaInfoValueSeries
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor

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.

clone Method clone(){ChartMediaInfoValueSeries}

Creates a deep clone of the ChartMediaInfoValueSeries class.

Returns

Type	Description
ChartMediaInfoValueSeries	A deep clone of the ChartMediaInfoValueSeries instance.

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");