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 Maps SDK 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
String

The name of the class.

more details
Accessor
String|Number

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

more details
AuthoringInfoVisualVariable
String

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

more details
AuthoringInfoVisualVariable
Number

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

more details
AuthoringInfoVisualVariable
Number

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

more details
AuthoringInfoVisualVariable
String|Number

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

more details
AuthoringInfoVisualVariable
String

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

more details
AuthoringInfoVisualVariable
String

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

more details
AuthoringInfoVisualVariable
String

The type of visual variable generated.

more details
AuthoringInfoVisualVariable
String

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

more details
AuthoringInfoVisualVariable

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS Maps SDK 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

Show inherited methods Hide inherited methods
Name Return Type Summary Class

Adds one or more handles which are to be tied to the lifecycle of the object.

more details
Accessor
AuthoringInfoVisualVariable

Creates a deep clone of the instance.

more details
AuthoringInfoVisualVariable
*

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

more details
AuthoringInfoVisualVariable
Boolean

Returns true if a named group of handles exist.

more details
Accessor

Removes a group of handles owned by the object.

more details
Accessor
Object

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

more details
AuthoringInfoVisualVariable

Method Details

addHandles(handleOrHandles, groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);
Parameters
handleOrHandles WatchHandle|WatchHandle[]

Handles marked for removal once the object is destroyed.

groupKey *
optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

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.
hasHandles(groupKey){Boolean}inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Returns true if a named group of handles exist.

Parameter
groupKey *
optional

A group key.

Returns
Type Description
Boolean Returns true if a named group of handles exist.
Example
// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}
removeHandles(groupKey)inherited
Since: ArcGIS Maps SDK for JavaScript 4.25

Removes a group of handles owned by the object.

Parameter
groupKey *
optional

A group key or an array or collection of group keys to remove.

Example
obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
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.