Skip to content
import AuthoringInfo from "@arcgis/core/renderers/support/AuthoringInfo.js";
Inheritance:
AuthoringInfoAccessor
Since
ArcGIS Maps SDK for JavaScript 4.6

Authoring information related to generating renderers and visual variables with the Smart Mapping methods. This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save settings so that their selections can be remembered.

See also

Constructors

Constructor

Constructor
Parameters
ParameterTypeDescriptionRequired
properties
See the properties table for a list of all the properties that may be passed into the constructor.

Properties

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

classificationMethod

Property
Type
AuthoringInfoClassificationMethods | null | undefined

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

See also

colorRamp

autocast Property
Type
ColorRamp | null | undefined

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

declaredClass

readonlyinherited Property
Type
string
Inherited from: Accessor
Since
ArcGIS Maps SDK for JavaScript 4.7

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

fadeRatio

Property
Type
number | null | undefined
Since
ArcGIS Maps SDK for JavaScript 4.25

Only applicable to HeatmapRenderer created with the heatmap renderer creator. Indicates how much the user opted to fade the edges of the heatmap to transparent.

field1

autocast Property
Type
AuthoringInfoFieldInfo | null | undefined

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.

field2

autocast Property
Type
AuthoringInfoFieldInfo | null | undefined

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.

fields

Property
Type
string[] | null | undefined

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

flowTheme

Property
Type
FlowTheme | null | undefined
Since
ArcGIS Maps SDK for JavaScript 4.23

Only applicable to FlowRenderer renderers. Indicates the user-selected theme of the generated renderer.

Known Limitations

The wave-front flow theme is not supported in 3D SceneView.

focus

Property
Type
RelationshipFocus | null | undefined

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

isAutoGenerated

Property
Type
boolean

Indicates whether the renderer was created internally by the JS API's rendering engine for default FeatureReductionCluster visualizations. You should avoid setting or changing this value.

Default value
false

lengthUnit

Property
Type
AuthoringInfoLengthUnits | null | undefined

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

maxSliderValue

Property
Type
number | null | undefined

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

minSliderValue

Property
Type
number | null | undefined

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

numClasses

Property
Type
RelationshipNumClasses | null | undefined

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

standardDeviationInterval

Property
Type
StandardDeviationInterval | null | undefined

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

autocast Property
Type
AuthoringInfoStatistics | null | undefined
Since
ArcGIS Maps SDK 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.

type

Property
Type
AuthoringInfoTypes

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

univariateSymbolStyle

Property
Type
UnivariateSymbolStyle | null | undefined
Since
ArcGIS Maps SDK 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.

univariateTheme

Property
Type
UnivariateTheme | null | undefined
Since
ArcGIS Maps SDK for JavaScript 4.18

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

visualVariables

autocast Property
Type
AuthoringInfoVisualVariable[]

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

Methods

MethodSignatureClass
fromJSON
inherited static
fromJSON(json: any): any
clone(): AuthoringInfo
toJSON
inherited
toJSON(): any

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
ParameterTypeDescriptionRequired
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 (): AuthoringInfo

Creates a deep clone of the instance.

Returns
AuthoringInfo

A deep clone of the object that invoked this method.

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