require(["esri/renderers/support/UniqueValueClass"], (UniqueValueClass) => { /* code goes here */ });
import UniqueValueClass from "@arcgis/core/renderers/support/UniqueValueClass.js";
esri/renderers/support/UniqueValueClass
Defines a category within a UniqueValueGroup. This includes the symbol and label used to represent one or more values of a field or set of fields. A UniqueValueClass instance should be provided to the UniqueValueGroup.classes property.
- See also
const lowDensityCommercialClass = new UniqueValueClass({
label: "C-2 | Community Commercial",
symbol: {
type: "simple-fill",
color: [255,179,219]
},
values: ["C-1", "C-2"]
});
Constructors
-
new UniqueValueClass(properties)
-
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. more details | Accessor | |
String | Describes the values represented by the symbol in the Legend. more details | UniqueValueClass | |
Symbol | Defines the symbol used to represent features containing the given values. more details | UniqueValueClass | |
UniqueValue[] | An array of unique values that should be rendered with the same symbol. more details | UniqueValueClass |
Property Details
-
The name of the class. The declared class name is formatted as
esri.folder.className
.
-
label String
-
Describes the values represented by the symbol in the Legend. If no label is provided, then a list of each value is displayed in the legend.
ExamplelowDensityCommercialClass.label = "C-2 | Community Commercial";
-
Defines the symbol used to represent features containing the given values.
ExamplelowDensityCommercialClass.symbol = { type: "simple-fill", color: [255,179,219] };
-
values UniqueValue[]autocast
-
An array of unique values that should be rendered with the same symbol. This can be autocast from a single value (or an array of raw data values) if the values come only from a UniqueValueRenderer.field or UniqueValueRenderer.valueExpression. If values originate from UniqueValueRenderer.field2 or UniqueValueRenderer.field3, then this may be autocast from an object or an array of objects specifying the combinations of valid values from each field.
Examples// Features with the value of "High" in the renderer's field // will be represented with the symbol defined in the class. uniqueValueClass.values = "High";
// Features with any of the values below in the renderer's field // will be represented with the symbol defined in the class. uniqueValueClass.values = ["R-1", "R-2", "R-3", "R-4", "R-5"];
// 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: "50,000-75,000", value2: "Republican", value3: "18-25" };
// Features with any the combinations of values below from // field and field2 in the renderer // will be represented with the symbol defined in the class. uniqueValueClass.values = [{ value: "Low", value2: "Low" }, { value: "Low", value2: "High" }, { value: "High", value2: "Low" }, { value: "High", value2: "High" }];
Method Overview
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. more details | Accessor | ||
this | Creates a deep clone of this object. more details | UniqueValueClass | |
* | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. more details | UniqueValueClass | |
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 | UniqueValueClass |
Method Details
-
addHandles(handleOrHandles, groupKey)inherited
-
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(){this}
-
Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.
ReturnsType Description this A deep clone of the class instance that invoked this 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.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.
-
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"); }
-
removeHandles(groupKey)inherited
-
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(){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.