Hide Table of Contents
esri
esri/arcgis
esri/dijit
esri/dijit/analysis
esri/dijit/geoenrichment
esri/dijit/geoenrichment/ReportPlayer
esri/geometry
esri/layers
esri/renderers
esri/symbols
esri/tasks
esri/tasks/datareviewer
esri/tasks/geoenrichment
esri/tasks/locationproviders
Class: GenerateRendererParameters
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/GenerateRendererParameters"], function(GenerateRendererParameters) { /* code goes here */ });
Description
(Added at v2.6)
Define the classification definition and optional where clause for the GenerateRendererTask operation.Samples
Search for samples that use this class.Constructors
| Name | Summary |
|---|---|
| new GenerateRendererParameters() | Creates a new GenerateRendererParameters object. |
Properties
| Name | Type | Summary |
|---|---|---|
| classificationDefinition | ClassificationDefinition | A ClassBreaksDefinition or UniqueValueDefinition classification definition used to generate the data classes. |
| formatLabel | Boolean | Indicate if the label should be formatted. |
| precision | Number | Round values for the renderer. |
| prefix | String | The label in the legend will have this prefix. |
| unitLabel | String | The label in the legend will have this at the end of each label. |
| where | String | A where clause used to generate the data classes. |
Constructor Details
Creates a new GenerateRendererParameters object.
Sample:
require([
"esri/tasks/GenerateRendererParameters", ...
], function(GenerateRendererParameters, ... ) {
var params = new GenerateRendererParameters();
params.classificationDefinition = classDef;
params.where = layerDef;
...
});
Property Details
<ClassificationDefinition
ClassificationDefinitionA ClassBreaksDefinition or UniqueValueDefinition classification definition used to generate the data classes.
Sample:
require([
"esri/tasks/ClassBreaksDefinition", "esri/tasks/AlgorithmicColorRamp", "esri/Color",
"esri/tasks/GenerateRendererParameters", ...
], function(ClassBreaksDefinition, AlgorithmicColorRamp, Color, GenerateRendererParameters, ... ) {
var classDef = new ClassBreaksDefinition();
classDef.classificationField = currentAttribute;
classDef.classificationMethod = "quantile";
classDef.breakCount = 5;
classDef.baseSymbol = sfs;
var colorRamp = new AlgorithmicColorRamp();
colorRamp.fromColor = Color.fromHex("#998ec3");
colorRamp.toColor = Color.fromHex("#f1a340");
colorRamp.algorithm = "hsv";
classDef.colorRamp = colorRamp;
var params = new GenerateRendererParameters();
params.classificationDefinition = classDef;
...
});
<Boolean
BooleanIndicate if the label should be formatted (Added at v3.7)
Known values:
true | false<Number
NumberRound values for the renderer. It should only work with classBreaksRenderer (Added at v3.7)
<String
StringThe label in the legend will have this prefix (Added at v3.7)
<String
StringThe label in the legend will have this at the end of each label (Added at v3.7)
<String
StringA where clause used to generate the data classes. Any legal SQL where clause operating on the fields in the layer/table is allowed.
Sample:
params.where = "STATE_NAME = 'Washington'";