AttributeColorInfo

AMD: require(["esri/renderers/support/AttributeColorInfo"], (AttributeColorInfo) => { /* code goes here */ });
ESM: import AttributeColorInfo from "@arcgis/core/renderers/support/AttributeColorInfo";
Class: esri/renderers/support/AttributeColorInfo
Inheritance: AttributeColorInfo Accessor
Since: ArcGIS API for JavaScript 4.11

Defines colors for dots in a DotDensityRenderer, or colors for pie chart slices in a PieChartRenderer.

See also
Example
renderer.attributes = [{
  field: "POPULATION",
  label: "Population (2019)",
  color: "gray"
}];

Constructors

new AttributeColorInfo(properties)
Parameter
properties Object
optional

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

Example
// Typical usage in a dot density renderer
renderer.attributes = [{
  field: "Population",
  color: "black"
}];

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Color

The color used to render dots representing the given field in a DotDensityRenderer or the color used to represent a pie chart slice in a PieChartRenderer.

more details
AttributeColorInfo
String

The name of the class.

more details
Accessor
String

The name of the numeric attribute field represented by the given color.

more details
AttributeColorInfo
String

The label used to describe the field or attribute in the Legend widget.

more details
AttributeColorInfo
String

An Arcade expression following the specification defined by the Arcade Visualization Profile.

more details
AttributeColorInfo
String

The title identifying and describing the associated Arcade expression as defined in the valueExpression property.

more details
AttributeColorInfo

Property Details

Autocasts from Number[]|String|Object

The color used to render dots representing the given field in a DotDensityRenderer or the color used to represent a pie chart slice in a PieChartRenderer.

declaredClass Stringreadonly inherited

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

field String

The name of the numeric attribute field represented by the given color.

label String

The label used to describe the field or attribute in the Legend widget.

valueExpression String

An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions in DotDensityRenderer may reference field values using the $feature profile variable and must return a number equal to the number of units represented by each dot. Expressions in PieChartRenderer must return a number representing the size of the pie chart slice.

This takes precedence over field. Therefore, this property is typically used as an alternative to field.

See also
valueExpressionTitle String

The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the label of the attribute in the Legend in the absence of one provided in the label property.

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
AttributeColorInfo

Creates a deep clone of this object.

more details
AttributeColorInfo
*

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more details
AttributeColorInfo
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
AttributeColorInfo

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS API 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 }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
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.

Creates a deep clone of this object.

Returns
Type Description
AttributeColorInfo A deep clone of the object that invoked this method.
Example
// Creates a deep clone of the renderer's first attribute object.
let attributeColorInfo = renderer.attributes[0].clone();
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.

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
* Returns a new instance of this class.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS API for JavaScript 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(groupKey)inherited
Since: ArcGIS API for JavaScript 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(){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.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.