VisualVariable | References | ArcGIS Maps SDK for JavaScript

import VisualVariable from "@arcgis/core/renderers/visualVariables/VisualVariable.js";

Inheritance:: VisualVariable→Accessor

Subclasses:: ColorVariable, OpacityVariable, RotationVariable, SizeVariable

Since: ArcGIS Maps SDK for JavaScript 4.10

The visual variable base class. See each of the subclasses that extend this class to learn how to create continuous data-driven thematic visualizations.

ColorVariable	SizeVariable	OpacityVariable	RotationVariable

See also

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`field`	`string`
`legendOptions`	`VisualVariableLegendOptions \| null \| undefined`
`type` readonly	`VisualVariableType \| null \| undefined`
`valueExpression`	`string \| null \| undefined`
`valueExpressionTitle`	`string \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

field

Property

Type: string

The name of the numeric attribute field that contains the data values used to determine the color/opacity/size/rotation of each feature.

legendOptions

autocast Property

Type: VisualVariableLegendOptions | null | undefined

An object providing options for displaying the visual variable in the Legend.

type

readonly Property

Type: VisualVariableType | null | undefined

The visual variable type.

valueExpression

Property

Type: string | null | undefined

An Arcade expression following the specification defined by the Arcade Visualization Profile. Expressions in visual variables may reference field values using the $feature profile variable and must return a number.

The values returned from this expression are the data used to drive the visualization as defined in the stops. This takes precedence over field. Therefore, this property is typically used as an alternative to field in visual variables.

See also

Arcade - Visualization Profile

valueExpressionTitle

Property

Type: string | null | undefined

The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding visual variable in the Legend in the absence of a provided title in the legendOptions property.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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	`any`	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.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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.