AuthoringInfoVisualVariable

AMD: require(["esri/renderers/support/AuthoringInfoVisualVariable"], (AuthoringInfoVisualVariable) => { /* code goes here */ });
ESM: import AuthoringInfoVisualVariable from "@arcgis/core/renderers/support/AuthoringInfoVisualVariable.js";
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

AuthoringInfoVisualVariable

Constructor
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

The name of the class.

Accessor

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

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

Only applicable when theme is reference-size.

AuthoringInfoVisualVariable

Only applicable when theme is reference-size.

AuthoringInfoVisualVariable

Only applicable when theme is reference-size.

AuthoringInfoVisualVariable

Only applicable when theme is reference-size.

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

The type of visual variable generated.

AuthoringInfoVisualVariable

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

AuthoringInfoVisualVariable

Property Details

declaredClass

Inherited
Property
declaredClass Stringreadonly
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

endTime

Property
endTime String |Number

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

field

Property
field String |null

Indicates the field name used for generating the data-driven visualization. Applies to age renderer or reference size visualizations (i.e. when theme is reference-size). This property is used for UI purposes only.

maxSliderValue

Property
maxSliderValue Number

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

minSliderValue

Property
minSliderValue Number

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

normalizationField

Property
normalizationField String |null
Since: ArcGIS Maps SDK for JavaScript 4.30 AuthoringInfoVisualVariable since 4.6, normalizationField added at 4.30.

Only applicable when theme is reference-size. Indicates the attribute field the user chose in the Smart Mapping gallery for normalizing data in the selected field. This property is used for UI purposes only.

referenceSizeScale

Property
referenceSizeScale Number |null
Since: ArcGIS Maps SDK for JavaScript 4.30 AuthoringInfoVisualVariable since 4.6, referenceSizeScale added at 4.30.

Only applicable when theme is reference-size. This value indicates the reference scale used in a reference size visualization and must be generated as part of the size.createContinuousRenderer or size.updateRendererWithReferenceSize methods.

When defined, the reference scale ensures the reference size symbols scale in size as the user zooms in and out in the view. This ensures symbols remain coincident to one another and avoid overlapping.

referenceSizeSymbolStyle

Property
referenceSizeSymbolStyle String |null
Since: ArcGIS Maps SDK for JavaScript 4.30 AuthoringInfoVisualVariable since 4.6, referenceSizeSymbolStyle added at 4.30.

Only applicable when theme is reference-size. This value specifies the style (or shape) of the symbols generated with a reference line. Typically, a reference line is used to visualize the maximum possible size (i.e. data value) of a data-driven proportional symbol. Visualizations with a reference size must be defined in a ClassBreaksRenderer or UniqueValueRenderer with a CIMSymbol containing two symbol layers: one visualizing the maximum size of the symbol as a hollow ring, and the other as a solid shape whose size is driven by a data value set in the renderer's field property, and configured in a primitive override of the CIMSymbol. These renderers must not contain size visual variables, but may contain other visual variable types. This property is used for UI purposes only. When defined, sizeStops must also be defined for the legend to properly represent the visualization.

Possible Values:"circle" |"diamond" |"hexagon-flat" |"hexagon-pointy" |"square"

sizeStops

Property
sizeStops SizeStop[] |null
Since: ArcGIS Maps SDK for JavaScript 4.30 AuthoringInfoVisualVariable since 4.6, sizeStops added at 4.30.

Only applicable when theme is reference-size. An array of objects that defines the thematic size ramp for reference-size visualization. At least two stops are required. The stops must be listed in ascending order based on the value of the value property in each stop. This property is required when theme is reference-size for the legend to properly render the size reference symbol style along with its labels.

startTime

Property
startTime String |Number

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

style

Property
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

Property
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" |"reference-size"

type

Property
type String

The type of visual variable generated.

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

units

Property
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.

Accessor

Creates a deep clone of the instance.

AuthoringInfoVisualVariable
*

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

AuthoringInfoVisualVariable

Returns true if a named group of handles exist.

Accessor

Removes a group of handles owned by the object.

Accessor

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

AuthoringInfoVisualVariable

Method Details

addHandles

Inherited
Method
addHandles(handleOrHandles, groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 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 }
);

this.addHandles(handle);

// Destroy the object
this.destroy();
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.

clone

Method
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
let authInfoVV = layer.renderer.authoringInfo.visualVariables.find(function(vv){
  return vv.type === "color";
}).clone();

fromJSON

Method
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

Inherited
Method
hasHandles(groupKey){Boolean}
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 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

Inherited
Method
removeHandles(groupKey)
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 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

Method
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.