Property Overview

Property Details

classificationMethod String

Indicates which classification method was used if a classed color or classed size renderer was generated using one of the Smart Mapping functions.

Possible Values:"equal-interval"|"manual"|"natural-breaks"|"quantile"|"standard-deviation"

See also:

• colorRendererCreator.createClassBreaksRenderer()
• sizeRendererCreator.createClassBreaksRenderer()

colorRamp ColorRamp

Indicates the color ramp was used to create the symbols for Unique Value or Class Breaks renderer for Imagery Layer.

declaredClass Stringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

field1 Object

A numeric field used for generating a relationship renderer along with field2. In the default visualization, the values of this field are rendered along the vertical axis of the Legend.

Properties:

field String The name of a numeric field.

normalizationField String optional The name of a numeric field used to normalize the given field. In choropleth visualizations it is best practice to normalize your data values if they haven't already been normalized.

classBreakInfos Object[] optional Describes the class breaks generated for this field. Specification: maxValue Number optional The maximum bound of values to visualize in the given field. If a feature's value is greater than this value, then it will be assigned the default symbol of the renderer. minValue Number optional The minimum bound of values to visualize in the given field. If a feature's value is less than this value, then it will be assigned the default symbol of the renderer.

label String optional The label used to describe the field or variable in the legend.

field2 Object

A numeric field used for generating a relationship renderer along with field1. In the default visualization, the values of this field are rendered along the horizontal axis of the Legend.

Properties:

field String The name of a numeric field.

normalizationField String optional The name of a numeric field used to normalize the given field. In choropleth visualizations it is best practice to normalize your data values if they haven't already been normalized.

classBreakInfos Object[] optional Describes the class breaks generated for this field. Specification: maxValue Number optional The maximum bound of values to visualize in the given field. If a feature's value is greater than this value, then it will be assigned the default symbol of the renderer. minValue Number optional The minimum bound of values to visualize in the given field. If a feature's value is less than this value, then it will be assigned the default symbol of the renderer.

label String optional The label used to describe the field or variable in the legend.

fields String[]

An array of string values representing field names used for creating a predominance renderer.

focus String

The focus of a relationship renderer. This determines the orientation of the legend.

lengthUnit String

Only applicable to renderer used in web scenes. Indicates the unit used in real-world sizes.

Possible Values:"inches"|"feet"|"yards"|"miles"|"nautical-miles"|"millimeters"|"centimeters"|"decimeters"|"meters"|"kilometers"|"decimal-degrees"

maxSliderValue Number

Indicates the value of the upper handle if a slider was used to generate the dot value for dot density renderer.

minSliderValue Number

Indicates the value of the lower handle if a slider was used to generate the dot value for dot density renderer.

numClasses Number

The number of classes used to classify each field of a relationship renderer. This determines the number of categories in the legend.

standardDeviationInterval Number

Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the standard-deviation classification method.

Possible Values: 0.25 | 0.33 | 0.5 | 1

statistics Object

Since: ArcGIS API for JavaScript 4.18

Only for renderers of type univariate-color-size with an above-and-below univariateTheme. Contains summary statistics about the data represented by the renderer. The Legend can use this information to avoid displaying values beyond the min and max data values of the layer.

Properties:

max Number The maximum data value of the attribute represented by the renderer. Legends displaying above-and-below themed data will not display values greater than this number.

min Number The minimum data value of the attribute represented by the renderer. Legends displaying above-and-below themed data will not display values smaller than this number.

type String

Indicates the renderer type generated from one of the Smart Mapping functions.

Possible Values:"class-breaks-size"|"class-breaks-color"|"classed-color"|"classed-size"|"predominance"|"relationship"|"univariate-color-size"

univariateSymbolStyle String

Since: ArcGIS API for JavaScript 4.18

Only applicable to univariateColorSize renderers with an above-and-below univariateTheme. Indicates if the above and below renderer uses a predefined symbol pair provided by the API.

The custom style indicates the renderer was authored with custom symbols not provided as a predefined symbol pair in the renderer creator.

Possible Values:"caret"|"circle-caret"|"arrow"|"circle-arrow"|"plus-minus"|"circle-plus-minus"|"square"|"circle"|"triangle"|"happy-sad"|"thumb"|"custom"

univariateTheme String

Since: ArcGIS API for JavaScript 4.18

Only applicable to univariateColorSize renderers. Indicates the theme of the univariate color and size renderer.

Possible Values:"high-to-low"|"above"|"below"|"above-and-below"

visualVariables AuthoringInfoVisualVariable[]autocast

Autocasts from Object[]

Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders.

Method Overview

Method Details

clone(){AuthoringInfo}

Creates a deep clone of the instance.

Returns:

Type	Description
AuthoringInfo	A deep clone of the object that invoked this method.

Example:

// Creates a deep clone of the layer's authoring info
var authInfo = layer.renderer.authoringInfo.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 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.

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.