Hide Table of Contents
esri/dijit/util
esri/layer/pixelFilters
esri/process
esri/workers
Class: ClassBreaksDefinition

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

NameSummary
new ClassBreaksDefinition()Creates a new ClassBreaksDefinition object.

Properties

NameTypeSummary
baseSymbolSymbolDefine a default symbol for the classification.
breakCountNumberThe number of class breaks.
classificationFieldStringThe name of the field used to match values.
classificationMethodStringThe name of the classification method.
colorRampColorRampDefine a color ramp for the classification.
normalizationFieldStringThe name of the field that contains the values used to normalize class breaks when normalizationType is set to 'field'.
normalizationTypeStringThe type of normalization used to normalize class breaks.
standardDeviationIntervalNumberThe standard deviation interval.
typeStringThe type of classification definition.

Methods

NameReturn typeSummary
toJson()ObjectReturns an easily serializable object representation of the class breaks definition.
Constructor Details

new ClassBreaksDefinition()

Creates a new ClassBreaksDefinition object
Sample:
require([
  "esri/tasks/ClassBreaksDefinition", ... 
], function(ClassBreaksDefinition, ... ) {
  var classDef = new ClassBreaksDefinition();
  ...
});
Property Details

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

<Number> breakCount

The number of class breaks.
Sample:
classDef.breakCount = 5;

<String> classificationField

The name of the field used to match values.
Sample:
classDef.classificationField = "POP2007";

<String> classificationMethod

The name of the classification method.
Known values: natural-breaks | equal-interval | quantile | standard-deviation | geometrical-interval
Sample:

classDef.classificationMethod = "quantile";

<ColorRamp> colorRamp

Define a color ramp for the classification. If a &lt;code>colorRamp&lt;/code> is not defined then a default color ramp will be used to assign a color to each class.

<String> normalizationField

The name of the field that contains the values used to normalize class breaks when normalizationType is set to 'field'.

<String> normalizationType

The type of normalization used to normalize class breaks.
Known values: field | log | percent-of-total

<Number> standardDeviationInterval

The 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.25

<String> type

The type of classification definition.
Known values: uniqueValueDef | classBreaksDef
Method Details

toJson()

Returns an easily serializable object representation of the class breaks definition.
Return type: Object