require(["esri/renderers/support/AuthoringInfoVisualVariable"], (AuthoringInfoVisualVariable) => { /* code goes here */ });
import AuthoringInfoVisualVariable from "@arcgis/core/renderers/support/AuthoringInfoVisualVariable.js";
esri/renderers/support/AuthoringInfoVisualVariable
Contains authoring properties of visual variables generated from one of the Smart Mapping methods or sliders.
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
String | The name of the class. | Accessor | |
String|Number | If an age or timeline renderer was generated, indicates the end time of the visualization. | AuthoringInfoVisualVariable | |
String | Indicates the field name used for generating the data-driven visualization. | AuthoringInfoVisualVariable | |
Number | Indicates the value of the upper handle if a slider was used to generate the visual variable. | AuthoringInfoVisualVariable | |
Number | Indicates the value of the lower handle if a slider was used to generate the visual variable. | AuthoringInfoVisualVariable | |
String|Number | If an age or timeline renderer was generated, indicates the start time of the visualization. | AuthoringInfoVisualVariable | |
String | If the UI offers the option to display values based on a ratio or percentage, this indicates which selection was made. | AuthoringInfoVisualVariable | |
String | Indicates the theme selected by the user when generating a renderer or visual variable with one of the Smart Mapping functions. | AuthoringInfoVisualVariable | |
String | The type of visual variable generated. | AuthoringInfoVisualVariable | |
String | If an age or timeline renderer was generated, indicates the time units used. | AuthoringInfoVisualVariable |
Property Details
-
If an age or timeline renderer was generated, indicates the end time of the visualization.
-
field
field String
-
Indicates the field name used for generating the data-driven visualization.
-
maxSliderValue
maxSliderValue Number
-
Indicates the value of the upper handle if a slider was used to generate the visual variable.
-
minSliderValue
minSliderValue Number
-
Indicates the value of the lower handle if a slider was used to generate the visual variable.
-
If an age or timeline renderer was generated, indicates the start time of the visualization.
-
style
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
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
type String
-
The type of visual variable generated.
Possible Values:"color"|"size"|"opacity"
-
units
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 |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
AuthoringInfoVisualVariable | 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 | |
Boolean | Returns true if a named group of handles exist. | Accessor | |
Removes a group of handles owned by the object. | Accessor | ||
Object | Converts an instance of this class to its ArcGIS portal JSON representation. | AuthoringInfoVisualVariable |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor 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();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey 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
clone(){AuthoringInfoVisualVariable}
-
Creates a deep clone of the instance.
ReturnsType 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();
-
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.Parameterjson ObjectA 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.
ReturnsType Description * Returns a new instance of this class.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType 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"); }
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
toJSON
toJSON(){Object}
-
Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.
ReturnsType Description Object The ArcGIS portal JSON representation of an instance of this class.