require(["esri/renderers/support/UniqueValue"], (UniqueValue) => { /* code goes here */ });
import UniqueValue from "@arcgis/core/renderers/support/UniqueValue.js";
esri/renderers/support/UniqueValue
Defines combinations of values to expect from up to three fields of categorical data in a UniqueValueRenderer. This value (or combination of values) is used to define the underlying data for a UniqueValueClass (i.e. a category) within a UniqueValueRenderer.
- See also
// Features with only the combination values below from
// field, field2, and field3 in the renderer
// will be represented with the symbol defined in the class.
uniqueValueClass.values = {
value: 10,
value2: "Republican",
value3: "18-25"
};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 |
|---|---|---|---|
The name of the class. | Accessor | ||
Defines a value (possibly in combination with value2 and value3) returned from the field referenced in UniqueValueRenderer.field or returned from an Arcade expression defined in UniqueValueRenderer.valueExpression to be categorized in a UniqueValueClass. | UniqueValue | ||
Defines a value returned from the field referenced in UniqueValueRenderer.field2 to be categorized in combination with value (and possibly value3) in a UniqueValueClass. | UniqueValue | ||
Defines a value returned from the field referenced in UniqueValueRenderer.field3 to be categorized in combination with value and value2 in a UniqueValueClass. | UniqueValue |
Property Details
-
Defines a value (possibly in combination with value2 and value3) returned from the field referenced in UniqueValueRenderer.field or returned from an Arcade expression defined in UniqueValueRenderer.valueExpression to be categorized in a UniqueValueClass.
-
Defines a value returned from the field referenced in UniqueValueRenderer.field2 to be categorized in combination with value (and possibly value3) in a UniqueValueClass.
-
Defines a value returned from the field referenced in UniqueValueRenderer.field3 to be categorized in combination with value and value2 in a UniqueValueClass.
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | UniqueValue | |
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. | UniqueValue |
Method Details
-
Inherited from Accessor
-
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.
-
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
jsonparameter 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 Accessor -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns trueif 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
-
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
MethodtoJSON(){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.