AuthoringInfo
require(["esri/renderers/support/AuthoringInfo"], function(AuthoringInfo) { /* code goes here */ });
esri/renderers/support/AuthoringInfo
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.
Constructors
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class | |
---|---|---|---|---|
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. more details | more details | AuthoringInfo |
declaredClass | String | The name of the class. more details | more details | Accessor |
field1 | Object | field for relationship. more details | more details | AuthoringInfo |
field2 | Object | field for relationship. more details | more details | AuthoringInfo |
fields | String[] | An array of string values representing field names used for creating predominance renderers. more details | more details | AuthoringInfo |
focus | String | focus for relationship. more details | more details | AuthoringInfo |
lengthUnit | String | Only applicable to renderer used in web scenes. more details | more details | AuthoringInfo |
numClasses | Number | numClasses for relationship. more details | more details | AuthoringInfo |
standardDeviationInterval | Number | Indicates the standard deviation interval for each stop in a classed color or classed size renderer that was generated using the | more details | AuthoringInfo |
type | String | Indicates the renderer type generated from one of the Smart Mapping functions. more details | more details | AuthoringInfo |
visualVariables | AuthoringInfoVisualVariable[] | Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders. more details | more details | AuthoringInfo |
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.
Possible Values: equal-interval | manual | natural-breaks | quantile | standard-deviation
- Since: ArcGIS API for JavaScript 4.7
The name of the class. The declared class name is formatted as
esri.folder.className
.
- field1Object
field for relationship.
- field2Object
field for relationship.
- fieldsString[]
An array of string values representing field names used for creating predominance renderers.
- focusString
focus for relationship.
- lengthUnitString
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
- numClassesNumber
numClasses for relationship.
- 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.Possible Values: 0.25 | 0.33 | 0.5 | 1
- typeString
Indicates the renderer type generated from one of the Smart Mapping functions.
Possible Values: class-breaks-size | class-breaks-color | predominance | univariate-color-size
- visualVariablesAuthoringInfoVisualVariable[]autocastAutocasts from Object[]
Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders.
Method Overview
Name | Return Type | Summary | Class | |
---|---|---|---|---|
clone() | AuthoringInfo | Creates a deep clone of the instance. more details | more details | AuthoringInfo |
fromJSON() | * | 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 | AuthoringInfo |
toJSON() | Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | AuthoringInfo |
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();
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 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.
API Reference search results
Name | Type | Module |
---|