AttributeColorInfo
require(["esri/renderers/support/AttributeColorInfo"], function(AttributeColorInfo) { /* code goes here */ });esri/renderers/support/AttributeColorInfoDefines the symbology for a DotDensityRenderer in the renderer's attributes property.
Autocasting support
As of version 4.5 of the ArcGIS API for JavaScript, [autocasting](../guide/programming-patterns/#autocasting is universally supported for all renderers, symbols, and symbol layers in the API. So there is no need to include this module in the require() and define() module loaders of your application unless you intend to use the static method(s) of this module.
- See also:
renderer.attributes = [{
field: "POPULATION",
label: "Population (2019)",
color: "gray"
}];Constructors
- new AttributeColorInfo(properties)
- Parameter:properties 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 | |
|---|---|---|---|---|
| Color | The color used to render dots representing the given field. more details | more details | AttributeColorInfo | |
| String | The name of the class. more details | more details | Accessor | |
| String | The name of the numeric attribute field to represent with dots with the reference dot value provided to the DotDensityRenderer. more details | more details | AttributeColorInfo | |
| String | The label used to describe the field or attribute in the Legend widget. more details | more details | AttributeColorInfo | |
| String | An Arcade expression evaluating to a number. more details | more details | AttributeColorInfo | |
| String | The title identifying and describing the associated Arcade expression as defined in the valueExpression property. more details | more details | AttributeColorInfo |
Property Details
The color used to render dots representing the given field.
The name of the class. The declared class name is formatted as
esri.folder.className.
- field String
The name of the numeric attribute field to represent with dots with the reference dot value provided to the DotDensityRenderer.
- valueExpression String
An Arcade expression evaluating to a number. This expression can reference field values using the
$featureglobal variable and perform mathematical calculations and logical evaluations at runtime. The values returned from this expression are the data used to drive the visualization. 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
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| AttributeColorInfo | Creates a deep clone of this object. more details | more details | AttributeColorInfo | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | AttributeColorInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | AttributeColorInfo |
Method Details
- clone(){AttributeColorInfo}
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. var 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 a product in the ArcGIS platform. 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.Parameter:json 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:Type Description * Returns a new instance of this class.
- toJSON(){Object}
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.