require(["esri/renderers/support/AuthoringInfo"], function(AuthoringInfo) { /* code goes here */ });
Class: esri/renderers/support/AuthoringInfo
Inheritance: AuthoringInfo Accessor
Since: ArcGIS API 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

new AuthoringInfo(properties)
Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
String

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

more details
more detailsAuthoringInfo
ColorRamp

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

more details
more detailsAuthoringInfo
String

The name of the class.

more details
more detailsAccessor
Object

A numeric field used for generating a relationship renderer along with field2.

more details
more detailsAuthoringInfo
Object

A numeric field used for generating a relationship renderer along with field1.

more details
more detailsAuthoringInfo
String[]

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

more details
more detailsAuthoringInfo
String

The focus of a relationship renderer.

more details
more detailsAuthoringInfo
String

Only applicable to renderer used in web scenes.

more details
more detailsAuthoringInfo
Number

The number of classes used to classify each field of a relationship renderer.

more details
more detailsAuthoringInfo
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.

more details
more detailsAuthoringInfo
String

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

more details
more detailsAuthoringInfo
AuthoringInfoVisualVariable[]

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

more details
more detailsAuthoringInfo

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:
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.

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.

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.

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.

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

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

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

Autocasts from Object[]

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

Method Overview

NameReturn TypeSummaryClass
AuthoringInfo

Creates a deep clone of the instance.

more details
more detailsAuthoringInfo
*

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 detailsAuthoringInfo
Object

Converts an instance of this class to its ArcGIS portal JSON representation.

more details
more detailsAuthoringInfo

Method Details

clone(){AuthoringInfo}

Creates a deep clone of the instance.

Returns:
TypeDescription
AuthoringInfoA 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:
TypeDescription
*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:
TypeDescription
ObjectThe ArcGIS portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule
Loading...