UniqueValueInfo | References | ArcGIS Maps SDK for JavaScript

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

Inheritance:: UniqueValueInfo→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.0

Defines the categories of a UniqueValueRenderer. Each unique value info defines a symbol that should be used to represent features with a specific value.

The UniqueValueRenderer determines the field or expression containing categorical data used for the rendering. Each feature is categorized with a symbol based on the value of its field as defined in the unique value info object.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`UniqueValueInfoProperties`

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`
`value`	`string \| number`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

label

Property

Type: string | null | undefined

Describes the value represented by the symbol. This label will appear in the Legend next to the symbol representing the value. If no label is provided, then the raw value is displayed in the legend.

symbol

autocast Property

Type: SymbolUnion | null | undefined

Defines the symbol used to render features with the provided value.

See also

value

Property

Type: string | number

Features with this value will be rendered with the given symbol.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): UniqueValueInfo`
`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

Method

Signature: clone (): UniqueValueInfo

Creates a deep clone of the unique value info object.

Returns: UniqueValueInfo
A deep clone of the unique value info object that invoked this method.

Example

// Creates a deep clone of the first unique value info in the renderer
let firstInfo = renderer.uniqueValueInfos[0].clone();

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.