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: ClassBreaksDefinition
[ AMD Module Require | Legacy Module Require ]
require(["esri/tasks/ClassBreaksDefinition"], function(ClassBreaksDefinition) { /* code goes here */ });
Description
(Added at v2.6)
Define a class breaks classification scheme used by the GenerateRendererTask to generate classes. Class breaks renderers symbolize data based on the value of a numeric attribute. Data with similar values for the attribute use the same symbol.
See also
Samples
Search for samples that use this class.Class hierarchy
esri/tasks/ClassificationDefinition |_esri/tasks/ClassBreaksDefinition
Constructors
| Name | Summary |
|---|---|
| new ClassBreaksDefinition() | Creates a new ClassBreaksDefinition object. |
Properties
| Name | Type | Summary |
|---|---|---|
| baseSymbol | Symbol | Define a default symbol for the classification. |
| breakCount | Number | The number of class breaks. |
| classificationField | String | The name of the field used to match values. |
| classificationMethod | String | The name of the classification method. |
| colorRamp | ColorRamp | Define a color ramp for the classification. |
| normalizationField | String | The name of the field that contains the values used to normalize class breaks when normalizationType is set to 'field'. |
| normalizationType | String | The type of normalization used to normalize class breaks. |
| standardDeviationInterval | Number | The standard deviation interval. |
| type | String | The type of classification definition. |
Methods
| Name | Return type | Summary |
|---|---|---|
| toJson() | Object | Returns an easily serializable object representation of the class breaks definition. |
Constructor Details
Creates a new ClassBreaksDefinition object
Sample:
require([
"esri/tasks/ClassBreaksDefinition", ...
], function(ClassBreaksDefinition, ... ) {
var classDef = new ClassBreaksDefinition();
...
});
Property Details
<Symbol
SymbolDefine 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.<String
StringThe name of the field used to match values.
Sample:
classDef.classificationField = "POP2007";
<String
StringThe name of the classification method.
Known values:
natural-breaks | equal-interval | quantile | standard-deviation | geometrical-intervalSample:
classDef.classificationMethod = "quantile";
<ColorRamp
ColorRampDefine a color ramp for the classification. If a <code>colorRamp</code> is not defined then a default color ramp will be used to assign a color to each class.
<String
StringThe name of the field that contains the values used to normalize class breaks when
normalizationType is set to 'field'.<String
StringThe type of normalization used to normalize class breaks.
Known values:
field | log | percent-of-total<Number
NumberThe standard deviation interval. When
standardDeviationInterval is specified breakCount is ignored. Only valid when the classificationMethod is set to 'standard-deviation'.Known values:
1 | 0.5 | 0.33 | 0.25Method Details
Returns an easily serializable object representation of the class breaks definition.
Return type:
Object