Hide Table of Contents
esri
arcgis
dijit
geometry
layers
renderer
symbols
tasks
Class: UniqueValueDefinition
[ AMD Module Require | Legacy Module Require ]
Module Require
require(["esri/tasks/UniqueValueDefinition", ... ], function(UniqueValueDefinition, ... ){ ... });
Description
Class added 2.6
Define a unique value classification scheme used by the GenerateDataTask to generate a renderer that groups values based on a unique combination of one or more fields. Typically features are rendered based on the unique values of one attribute field. However up to three fields can be combined to generate a unique value.
Define a unique value classification scheme used by the GenerateDataTask to generate a renderer that groups values based on a unique combination of one or more fields. Typically features are rendered based on the unique values of one attribute field. However up to three fields can be combined to generate a unique value.
Samples
Search for samples that use this class.Class hierarchy
esri.tasks.UniqueValueDefinition
Constructors
| Constructor | Description |
|---|---|
| new UniqueValueDefinition() | Creates a new UniqueValueDefinition object. |
Properties
| Property | Type | Description |
|---|---|---|
| attributeField | String | Attribute field renderer uses to match values. At version 3.0 the Unique Value renderer can be used to render feature layer tracks. Specify the layer's trackIdField as the attribute field. |
| attributeField2 | String | The name of the field that contains unique values when combined with the values specified by attributeField. |
| attributeField3 | String | The name of the field that contains unique values when combined with the values specified by attributeField and attributeField2. |
| baseSymbol | Symbol | Define a default symbol for the classification. If a baseSymbol is not defined then a default symbol is created based on the geometryType of the layer. |
| colorRamp | AlgorithmicColorRamp || MultiFieldColorRamp | Define a color ramp for the classification. If a colorRamp is not defined then a default color ramp will be used to assign a color to each class. |
Methods
| Method | Return Value | Description |
|---|---|---|
| toJson() | Object | Returns an easily serializable object representation of the unique value definition. |
Constructor Details
Creates a new UniqueValueDefinition object.
Code Snippet:
require([
"esri/tasks/UniqueValueDefinition", ...
], function(UniqueValueDefinition, ... ) {
var classificationDefinition = new UniqueValueDefinition();
...
});
Property Details
Attribute field renderer uses to match values. At version 3.0 the Unique Value renderer can be used to render feature layer tracks. Specify the layer's trackIdField as the attribute field.
Code Snippet:
classificationDefinition.attributeField = "SUB_REGION";
The name of the field that contains unique values when combined with the values specified by
attributeField.The name of the field that contains unique values when combined with the values specified by
attributeField and attributeField2.<Symbol> baseSymbol
Define a default symbol for the classification. If a
baseSymbol is not defined then a default symbol is created based on the geometryType of the layer.Define a color ramp for the classification. If a colorRamp is not defined then a default color ramp will be used to assign a color to each class.
Method Details