require(["esri/renderers/support/UniqueValueGroup"], (UniqueValueGroup) => { /* code goes here */ });
import UniqueValueGroup from "@arcgis/core/renderers/support/UniqueValueGroup.js";
esri/renderers/support/UniqueValueGroup
UniqueValueGroup represents a group of unique value classes (i.e. categories). This is used to group a subset of categories under a heading.
At least one group must also be used if you want to represent multiple unique values with a single symbol.
// This example groups categories under three headings:
// Commercial, Residential, and Other
layer.renderer = {
type: "unique-value",
field: "zonecode",
uniqueValueGroups: [{
heading: "Commercial",
classes: [{
label: "C-2 | Community Commercial",
symbol: createSymbol([255,179,219]),
values: ["C-1", "C-2"]
}, {
label: "C-3 | Major Commercial",
symbol: createSymbol([255,0,0]),
values: "C-3"
}]
}, {
heading: "Residential",
classes: [{
label: "R-1 | Low-Density Residential",
symbol: createSymbol([255,255,224]),
values: "R-1"
}, {
label: "R-3 | Limited High-Density Residential",
symbol: createSymbol([255,214,0]),
values: "R-3"
}, {
label: "R-4 | High-Density Residential",
symbol: createSymbol([255,166,0]),
values: "R-4",
}]
}, {
heading: "Other",
classes: [{
label: "S | Special Area",
symbol: createSymbol([161,237,237]),
values: ["S-DW", "S-DR", "S-RP", "S-JW", "S-RN", "S-WS"]
}]
}]
};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 |
|---|---|---|---|
| UniqueValueClass[] | Specifies the classes (or unique categories) to group under a heading. | UniqueValueGroup | |
| String | The name of the class. | Accessor | |
| String | The heading to be displayed for the group of unique classes in the Legend. | UniqueValueGroup |
Property Details
-
classes
Propertyclasses UniqueValueClass[]autocast -
Specifies the classes (or unique categories) to group under a heading. Classes may be included without a heading when representing multiple values with a single symbol.
ExamplecommercialGroup.classes = [{ label: "C-2 | Community Commercial", symbol: { type: "simple-fill", color: [255,179,219] }, values: ["C-1", "C-2"] }, { label: "C-3 | Major Commercial", symbol: { type: "simple-fill", color: 255,0,0 }, values: "C-3" }];
Method Overview
| Name | Return Type | Summary | Class |
|---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
| this | Creates a deep clone of this object. | UniqueValueGroup | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. | UniqueValueGroup | |
| 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. | UniqueValueGroup |
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 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.
-
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.