AuthoringInfoVisualVariable

AMD: require(["esri/renderers/support/AuthoringInfoVisualVariable"], (AuthoringInfoVisualVariable) => { /* code goes here */ });
ESM: import AuthoringInfoVisualVariable from "@arcgis/core/renderers/support/AuthoringInfoVisualVariable";
Class: esri/renderers/support/AuthoringInfoVisualVariable
Inheritance: AuthoringInfoVisualVariable Accessor
Since: ArcGIS API for JavaScript 4.6

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

See also:

Constructors

new AuthoringInfoVisualVariable(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.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
String|Numbermore details

If an age or timeline renderer was generated, indicates the end time of the visualization.

more detailsAuthoringInfoVisualVariable
Stringmore details

Indicates the field name used for generating the data-driven visualization.

more detailsAuthoringInfoVisualVariable
Numbermore details

Indicates the value of the upper handle if a slider was used to generate the visual variable.

more detailsAuthoringInfoVisualVariable
Numbermore details

Indicates the value of the lower handle if a slider was used to generate the visual variable.

more detailsAuthoringInfoVisualVariable
String|Numbermore details

If an age or timeline renderer was generated, indicates the start time of the visualization.

more detailsAuthoringInfoVisualVariable
Stringmore details

If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made.

more detailsAuthoringInfoVisualVariable
Stringmore details

Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions.

more detailsAuthoringInfoVisualVariable
Stringmore details

The type of visual variable generated.

more detailsAuthoringInfoVisualVariable
Stringmore details

If an age or timeline renderer was generated, indicates the time units used.

more detailsAuthoringInfoVisualVariable

Property Details

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.

endTime String|Number

If an age or timeline renderer was generated, indicates the end time of the visualization.

field String

Indicates the field name used for generating the data-driven visualization.

maxSliderValue Number

Indicates the value of the upper handle if a slider was used to generate the visual variable.

minSliderValue Number

Indicates the value of the lower handle if a slider was used to generate the visual variable.

startTime String|Number

If an age or timeline renderer was generated, indicates the start time of the visualization.

style String

If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made.

Possible Values:"percent"|"percent-of-total"|"ratio"

theme String

Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions.

Possible Values:"above"|"below"|"above-and-below"|"centered-on"|"extremes"|"high-to-low"

type String

The type of visual variable generated.

Possible Values:"color"|"size"|"opacity"

units String

If an age or timeline renderer was generated, indicates the time units used.

Possible Values:"seconds"|"minutes"|"hours"|"days"|"months"|"years"

Method Overview

Name Return Type Summary Class
AuthoringInfoVisualVariablemore details

Creates a deep clone of the instance.

more detailsAuthoringInfoVisualVariable
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsAuthoringInfoVisualVariable
Objectmore details

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

more detailsAuthoringInfoVisualVariable

Method Details

Creates a deep clone of the instance.

Returns:
Type Description
AuthoringInfoVisualVariable A deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the authoring info visual variable
let authInfoVV = layer.renderer.authoringInfo.visualVariables.find(function(vv){
  return vv.type === "color";
}).clone();
fromJSON(json){*}static

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.

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:
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() guide topic for more information.

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.