AttributeColorInfo | References | ArcGIS Maps SDK for JavaScript

import AttributeColorInfo from "@arcgis/core/renderers/support/AttributeColorInfo.js";

const AttributeColorInfo = await $arcgis.import("@arcgis/core/renderers/support/AttributeColorInfo.js");

Inheritance: AttributeColorInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.11

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

See also

Example

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

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	AttributeColorInfoProperties

See the properties table 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"
}];

Properties

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

Property	Type	Class
color	Color \| null \| undefined
declaredClass readonly inherited	string	Accessor
field	string \| null \| undefined
label	string \| null \| undefined
valueExpression	string \| null \| undefined
valueExpressionTitle	string \| null \| undefined

color

autocast Property

Type: Color | null | undefined

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

readonlyinherited Property

Type: string

Inherited from: Accessor

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

field

Property

Type: string | null | undefined

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

label

Property

Type: string | null | undefined

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

valueExpression

Property

Type: string | null | undefined

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

Arcade Visualization Profile

valueExpressionTitle

Property

Type: string | null | undefined

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.

Methods

Method	Signature	Class
fromJSON inherited static	fromJSON(json: any): any	JSONSupportMixin
clone	clone(): AttributeColorInfo
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 (): AttributeColorInfo

Creates a deep clone of this object.

Returns: 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();

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.