UniqueValueClass | References | ArcGIS Maps SDK for JavaScript

import UniqueValueClass from "@arcgis/core/renderers/support/UniqueValueClass.js";

Inheritance:: UniqueValueClass→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.25

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

UniqueValueGroup.classes

Example

const lowDensityCommercialClass = new UniqueValueClass({
  label: "C-2 | Community Commercial",
  symbol: {
    type: "simple-fill",
    color: [255,179,219]
  },
  values: ["C-1", "C-2"]
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`UniqueValueClassProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`label`	`string \| null \| undefined`
`symbol`	`SymbolUnion \| null \| undefined`
`values`	`UniqueValue[] \| null \| undefined`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

label

Property

Type: string | null | undefined

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.

Example

lowDensityCommercialClass.label = "C-2 | Community Commercial";

symbol

autocast Property

Type: SymbolUnion | null | undefined

Defines the symbol used to represent features containing the given values.

Example

lowDensityCommercialClass.symbol = {
  type: "simple-fill",
  color: [255,179,219]
};

values

autocast Property

Type: UniqueValue[] | null | undefined

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

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

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: this
A deep clone of the class instance that invoked this method.

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.