UniqueValueInfo

AMD: require(["esri/renderers/support/UniqueValueInfo"], (UniqueValueInfo) => { /* code goes here */ });
ESM: import UniqueValueInfo from "@arcgis/core/renderers/support/UniqueValueInfo";
Class: esri/renderers/support/UniqueValueInfo
Inheritance: UniqueValueInfo Accessor
Since: ArcGIS API for JavaScript 4.0

Defines the symbols to use in 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 from which to request data used to drive the rendering. Each feature's value is then used to assign the feature a symbol based on the value of the unique value info object.

See also:

Constructors

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 Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

Describes the value represented by the symbol.

more detailsUniqueValueInfo
Symbolmore details

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

more detailsUniqueValueInfo
String|Numbermore details

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

more detailsUniqueValueInfo

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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.

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

See also:
value String|Number

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

Method Overview

Name Return Type Summary Class
UniqueValueInfomore details

Creates a deep clone of the unique value info object.

more detailsUniqueValueInfo
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsUniqueValueInfo
Objectmore details

Converts an instance of this class to its ArcGIS portal JSON representation.

more detailsUniqueValueInfo

Method Details

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

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.