UniqueValueInfo | API Reference | ArcGIS Maps SDK for JavaScript 4.31

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

UniqueValueInfo Constructor new UniqueValueInfo(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
String	The name of the class.	Accessor
String	Describes the value represented by the symbol.	UniqueValueInfo
Symbol	Defines the symbol used to render features with the provided value.	UniqueValueInfo
String\|Number	Features with this value will be rendered with the given symbol.	UniqueValueInfo

Property Details

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.7 Accessor since 4.0, declaredClass added at 4.7.

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

label Property label String

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

symbol Property symbol Symbolautocast

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

See also

value Property value String |Number

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

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
UniqueValueInfo	Creates a deep clone of the unique value info object.	UniqueValueInfo
*	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	UniqueValueInfo
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.	UniqueValueInfo

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, addHandles added at 4.25.

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(){UniqueValueInfo}

Creates a deep clone of the unique value info object.

Returns

Type	Description
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();

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

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 Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

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.