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. This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save specific overridable 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
String

The name of the class.

more details
more detailsAccessor
String[]

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

more details
more detailsAuthoringInfo
String

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

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

classificationMethodString

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

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

See also:
declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

fieldsString[]

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

lengthUnitString

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

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

standardDeviationIntervalNumber

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.

Known Values: 0.25 | 0.33 | 0.5 | 1

typeString

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

Known Values: class-breaks-size | class-breaks-color | predominance | 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.
Searching...

API Reference search results

NameTypeModule

There were no match results from your search criteria.