UniqueValueGroup | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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.

See also

UniqueValueRenderer.uniqueValueGroups

Example

// 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

UniqueValueGroup Constructor new UniqueValueGroup(properties)

Parameter

properties Object

optional

See the properties for a list of all the properties that may be passed into the constructor.

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties

Hide inherited properties

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 Property classes 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.

Example

commercialGroup.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"
}];

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

heading Property heading String

The heading to be displayed for the group of unique classes in the Legend.

Example

commercialGroup.heading = "Commercial";

Method Overview

Show inherited methods

Hide inherited methods

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

addHandles Inherited Method addHandles(handleOrHandles, groupKey) 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();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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 Method 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.

Returns

Type	Description
this	A deep clone of the class instance that invoked this method.

fromJSON 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.

Parameter

json Object

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

Type	Description
*	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	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 Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method toJSON(){Object}

Converts an instance of this class to its ArcGIS portal JSON representation. See the Using fromJSON() guide topic for more information.

Returns

Type	Description
Object	The ArcGIS portal JSON representation of an instance of this class.