import AuthoringInfo from "@arcgis/core/renderers/support/AuthoringInfo.js";const AuthoringInfo = await $arcgis.import("@arcgis/core/renderers/support/AuthoringInfo.js");- Inheritance:
- AuthoringInfo→
Accessor
- 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.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
| | ||
| | ||
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
fadeRatio
- 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
- 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
- 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
An array of string values representing field names used for creating a predominance renderer.
flowTheme
- 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
- Type
- RelationshipFocus | null | undefined
The focus of a relationship renderer. This determines the orientation of the legend.
isAutoGenerated
- 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
- Type
- AuthoringInfoLengthUnits | null | undefined
Only applicable to renderer used in web scenes. Indicates the unit used in real-world sizes.
numClasses
- 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
- 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
- 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
- Type
- AuthoringInfoTypes
Indicates the renderer type generated from one of the Smart Mapping functions.
univariateSymbolStyle
- 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
- 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
- Type
- AuthoringInfoVisualVariable[]
Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders.
Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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
| Parameter | Type | Description | Required |
|---|---|---|---|
| json | 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
- 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 infolet authInfo = layer.renderer.authoringInfo.clone(); toJSON
- Signature
-
toJSON (): any
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.