require(["esri/renderers/support/AttributeColorInfo"], (AttributeColorInfo) => { /* code goes here */ });
import AttributeColorInfo from "@arcgis/core/renderers/support/AttributeColorInfo.js";
esri/renderers/support/AttributeColorInfo
Defines colors for dots in a DotDensityRenderer, or colors for pie chart slices in a PieChartRenderer.
- See also
renderer.attributes = [{
field: "POPULATION",
label: "Population (2019)",
color: "gray"
}];Constructors
-
Parameterproperties Objectoptional
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
| Name | Type | Summary | Class |
|---|---|---|---|
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. | AttributeColorInfo | ||
The name of the class. | Accessor | ||
The name of the numeric attribute field represented by the given color. | AttributeColorInfo | ||
The label used to describe the field or attribute in the Legend widget. | AttributeColorInfo | ||
An Arcade expression following the specification defined by the Arcade Visualization Profile. | AttributeColorInfo | ||
The title identifying and describing the associated Arcade expression as defined in the valueExpression property. | AttributeColorInfo |
Property Details
-
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.
-
The name of the numeric attribute field represented by the given color.
-
The label used to describe the field or attribute in the Legend widget.
-
An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions in DotDensityRenderer may reference field values using the
$featureprofile 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
-
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
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
Creates a deep clone of this object. | AttributeColorInfo | ||
Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | AttributeColorInfo | ||
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. | AttributeColorInfo |
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.
-
clone
Methodclone(){AttributeColorInfo} -
Creates a deep clone of this object.
ReturnsType 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();
-
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
jsonparameter 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.
Returns
-
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 trueif 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
MethodtoJSON(){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.