UniqueValueInfo
require(["esri/renderers/support/UniqueValueInfo"], function(UniqueValueInfo) { /* code goes here */ });esri/renderers/support/UniqueValueInfoDefines 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.
Constructors
- new UniqueValueInfo(properties)
- Parameter:properties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
| Name | Type | Summary | Class | |
|---|---|---|---|---|
| String | The name of the class. more details | more details | Accessor | |
| String | Describes the value represented by the symbol. more details | more details | UniqueValueInfo | |
| Symbol | Defines the symbol used to render features with the provided value. more details | more details | UniqueValueInfo | |
| String|Number | Features with this value will be rendered with the given symbol. more details | more details | UniqueValueInfo |
Property Details
- 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.
Features with this value will be rendered with the given symbol.
Method Overview
| Name | Return Type | Summary | Class | |
|---|---|---|---|---|
| UniqueValueInfo | Creates a deep clone of the unique value info object. more details | more details | UniqueValueInfo | |
| * | Creates a new instance of this class and initializes it with values from a JSON object generated from a product in the ArcGIS platform. more details | more details | UniqueValueInfo | |
| Object | Converts an instance of this class to its ArcGIS portal JSON representation. more details | more details | UniqueValueInfo |
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 var 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 a product in the ArcGIS platform. The object passed into the input
jsonparameter 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 ObjectA 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() topic in the Guide for more information.
Returns:Type Description Object The ArcGIS portal JSON representation of an instance of this class.