Property Overview

Property Details

declaredClassStringreadonly inherited

Since: ArcGIS API for JavaScript 4.7

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

endTimeString|Number

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

fieldString

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

maxSliderValueNumber

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

minSliderValueNumber

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

startTimeString|Number

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

styleString

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

themeString

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

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

typeString

The type of visual variable generated.

Possible Values: color | size | opacity

unitsString

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

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

Method Overview

Method Details

clone(){AuthoringInfoVisualVariable}

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

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.