ClassBreaksRenderer

require(["esri/renderers/ClassBreaksRenderer"], function(ClassBreaksRenderer) { /* code goes here */ });
Class: esri/renderers/ClassBreaksRenderer
Inheritance: ClassBreaksRenderer Renderer Accessor
Since: ArcGIS API for JavaScript 4.0

ClassBreaksRenderer defines the symbol of each feature in a Layer based on the value of a numeric attribute. Symbols are assigned based on classes or ranges of data. Each feature is assigned a symbol based on the class break in which the value of the attribute falls.

Supported layers

ClassBreaksRenderer may only be used to create visualizations for the following layer types:

A numeric attribute field from which to define the class breaks must be specified. Each break and its associated symbol must also be defined using the addClassBreakInfo() method or the classBreakInfos property in the constructor.

In the example below a FeatureLayer representing block groups is rendered with a ClassBreaksRenderer. Features where fewer than 35% of the population have a college degree are rendered with a deep green color. Features where between 35% and 50% of the population have a college degree are rendered with a pale green symbol. The other features are similarly rendered based on the value of the attribute of interest.

renderer-classbreaks-basic

Autocasting support

As of version 4.5 of the ArcGIS API for JavaScript, autocasting is universally supported for all renderers, symbols, and symbol layers in the API. So there is no need to include this module in the require() and define() module loaders of your application unless you intend to use the static method(s) of this module.

See also:
Example:
var renderer = {
  type: "class-breaks",  // autocasts as new ClassBreaksRenderer()
  // attribute of interest - Earthquake magnitude
  field: "MAGNITUDE"
};
// All features with magnitude between 0 - 4.0
renderer.addClassBreakInfo({
  minValue: 0,
  maxValue: 4.0,
  symbol: {
    type: "point-3d",  // autocasts as new PointSymbol3D()
    symbolLayers: [{
      type: "object",  // autocasts as new ObjectSymbol3DLayer()
      resource: { primitive: "cone" },
      material: { color: [0, 169, 230] },
      height: 200000,
      width: 50000
    }]
  }
});
// All features with magnitude between 4.1 - 7.0
renderer.addClassBreakInfo({
  minValue: 4.1,
  maxValue: 7.0,
  symbol: {
    type: "point-3d",  // autocasts as new PointSymbol3D()
    symbolLayers: [{
      type: "object",  // autocasts as new ObjectSymbol3DLayer()
      resource: { primitive: "cone" },
      material: { color: [230, 230, 0] },
      height: 800000,
      width: 90000
    }]
  }
});
// All features with magnitude between 7.1 - 10.0
renderer.addClassBreakInfo({
  minValue: 7.1,
  maxValue: 10.0,
  symbol: {
    type: "point-3d",  // autocasts as new PointSymbol3D()
    symbolLayers: [{
      type: "object",  // autocasts as new ObjectSymbol3DLayer()
      resource: { primitive: "cone" },
      material: { color: [230, 0, 0] },
      height: 3200000,
      width: 130000
    }]
  }
});

var layer = new FeatureLayer({
  url: "http://url.to.service",
  renderer: renderer
});

Constructors

new ClassBreaksRenderer(properties)

Parameter:
properties Object
optional

See the properties for a list of all the properties that may be passed into the constructor.

Example:
// Typical usage
var renderer = {
  type: "class-breaks",  // autocasts as new ClassBreaksRenderer()
  field: "fieldName",
  classBreakInfos: [ ... ]
};

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
NameTypeSummaryClass
AuthoringInfo

Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as sizeRendererCreator.createContinuousRenderer() or colorRendererCreator.createContinuousRenderer().

more details
more detailsRenderer
FillSymbol

When symbolizing polygon features with graduated symbols, set a FillSymbol on this property to visualize the boundaries of each feature.

more details
more detailsClassBreaksRenderer
Object[]

Each element in the array is an object that provides information about a class break associated with the renderer.

more details
more detailsClassBreaksRenderer
String

The name of the class.

more details
more detailsAccessor
Symbol

The default symbol assigned to features with a value not matched to a given break.

more details
more detailsClassBreaksRenderer
String | Function

The name of the attribute field the renderer uses to render data.

more details
more detailsClassBreaksRenderer
Boolean

If true, graphics with attribute values equal to the max value of a class will be included in that class.

more details
more detailsClassBreaksRenderer
Object

An object providing options for displaying the renderer in the Legend.

more details
more detailsClassBreaksRenderer
String

When normalizationType is field, this property contains the attribute field name used for normalization.

more details
more detailsClassBreaksRenderer
Number

When normalizationType is percent-of-total, this property contains the total of all data values.

more details
more detailsClassBreaksRenderer
String

Indicates how the data is normalized.

more details
more detailsClassBreaksRenderer
String

The type of renderer.

more details
more detailsClassBreaksRenderer
String

An Arcade expression evaluating to a number.

more details
more detailsClassBreaksRenderer
String

The title identifying and describing the associated Arcade expression as defined in the valueExpression property.

more details
more detailsClassBreaksRenderer
Object[]

Visual variables define the parameters for data-driven geographic visualizations of numeric data.

more details
more detailsClassBreaksRenderer

Property Details

Authoring metadata only included in renderers generated from one of the Smart Mapping creator methods, such as sizeRendererCreator.createContinuousRenderer() or colorRendererCreator.createContinuousRenderer(). This includes information from UI elements such as sliders and selected classification methods and themes. This allows the authoring clients to save specific overridable settings so that next time it is accessed via the UI, their selections can be remembered.

backgroundFillSymbolFillSymbol

When symbolizing polygon features with graduated symbols, set a FillSymbol on this property to visualize the boundaries of each feature. Use a FillSymbol of varying sizes in the classBreakInfos to indicate the quantity.

classBreakInfosObject[]

Each element in the array is an object that provides information about a class break associated with the renderer. Each object has the following specification:

Properties:
minValue Number

The minimum value of the break.

maxValue Number

The maximum value of the break.

symbol Symbol

The symbol used to style features whose values are between the minValue and maxValue of the break. This value may be autocast by specifying the symbol type.

label String
optional

The label used to describe features in the break in the Legend.

Example:
var renderer = {
  type: "class-breaks",  // autocasts as new ClassBreaksRenderer()
  field: "HARVESTED_ACRES",
  classBreakInfos: [
    {
      minValue: 0,  // 0 acres
      maxValue: 200000,  // 200,000 acres
      symbol: sym1,  // will be assigned sym1
      label: "fewer than 200,000 acres"
    }, {
      minValue: 200001,  // 200,001 acres
      maxValue: 500000,  // 500,000 acres
      symbol: sym2,  // will be assigned sym2
      label: "200,000 - 500,000 acres"
    }, {
      minValue: 500001,  // 500,001 acres
      maxValue: 750000,  // 750,000 acres
      symbol: sym3,  // will be assigned sym2
      label: "more than 500,000 acres"
    }
  ]
};

declaredClassStringreadonly inherited

The name of the class. The declared class name is formatted as esri.folder.className.

defaultSymbolSymbol autocast

The default symbol assigned to features with a value not matched to a given break. If null, unmatched features will not be assigned a symbol.

Known Limitations

SceneLayers with a mesh geometryType will display unmatching features with a generic symbol even if the defaultSymbol is null.

The name of the attribute field the renderer uses to render data. A function may also be used to return a numeric value if the data does not already explicitly exist in a field.

Example:
// function used to return total crop harvest within each feature
// field for this use case (total crop harvest in acres) doesn't exist
function calculateTotalAcres(feature){
  // a number field representing total wheat harvest in acres
  var wheat = feature.attributes.WHEAT_ACRES;
  // a number field representing total cotton harvest in acres
  var cotton = feature.attributes.COTTON_ACRES;
  // a number field representing total soybeans harvest in acres
  var soybeans = feature.attributes.SOYBEANS_ACRES;
  // a number field representing total corn harvest in acres
  var corn = feature.attributes.CORN_ACRES;
  // a number field representing total vegetables harvest in acres
  var vegetables = feature.attributes.VEGETABLES_ACRES;

  // var used to add up total harvestable acres
  var totalHarvest = wheat + cotton + soybeans + corn + vegetables;

  return totalHarvest;
}

var renderer = {
  type: "class-breaks",  // autocasts as new ClassBreaksRenderer()
  field: calculateTotalAcres,  // values returned by this function will
                               // be used to render features
  classBreakInfos: [
    {
      minValue: 0,  // 0 acres
      maxValue: 200000,  // 200,000 acres
      symbol: sym1  // will be assigned sym1
    }, {
      minValue: 200001,  // 200,001 acres
      maxValue: 500000,  // 500,000 acres
      symbol: sym2  // will be assigned sym2
    }, {
      minValue: 500001,  // 500,001 acres
      maxValue: 750000,  // 750,000 acres
      symbol: sym3  // will be assigned sym2
    }
  ]
};

isMaxInclusiveBoolean

If true, graphics with attribute values equal to the max value of a class will be included in that class. Set this property to false if the desired behavior is to make a class include values less than, but not equal to the max value.

Default Value: true

legendOptionsObject

An object providing options for displaying the renderer in the Legend.

Property:
title String

Describes the variable driving the visualization. This is displayed as the title of the corresponding renderer in the Legend and takes precedence over a field alias or valueExpressionTitle.

Example:
renderer.legendOptions = {
  title: "Population density"
};

normalizationFieldString

When normalizationType is field, this property contains the attribute field name used for normalization.

normalizationTotalNumber

When normalizationType is percent-of-total, this property contains the total of all data values.

normalizationTypeString

Indicates how the data is normalized. If this property is defined, then the class breaks contain a normalized min/max value instead of the value in the given field. The data value obtained from the field is normalized in one of the following ways before it is compared with the class breaks. See the table below for a list of possible values.

Possible ValueDescription
fieldDivides the data value using the attribute value of the field specified in the normalizationField property. This value is set by default if the normalizationField is provided.
logComputes the base 10 logarithm of the data value. This can be a useful approach for some data distributions because it reduces the influence of very large data values.
percent-of-totalDivides the data value by the sum of all data values then multiplies by 100. Use normalizationTotal to define the total value by which to normalize. This value is set by default if the normalizationTotal is provided.

With the exception of log normalization, data normalization creates a ratio by dividing two values. When comparing attribute values between features, normalization minimizes the effect of varying map areas and the number of observations.

For example, dividing the 18 to 30 year old population by the area of a polygon feature yields a density value that can be compared evenly with other features, regardless of their size.

typeString

The type of renderer. For ClassBreaksRenderer this value is always class-breaks.

valueExpressionString

An Arcade expression evaluating to a number. This expression can reference field values using the $feature global variable and perform mathematical calculations and logical evaluations at runtime.

This property is typically used as an alternative to field for data-driven visualizations.

Example:
// expression calculating voter turnout based on two field values
var renderer = {
  type: "class-breaks",  // autocasts as new ClassBreaksRenderer()
  valueExpression: "( $feature.TOT_VOTES / $feature.REG_VOTERS ) * 100",
  classBreakInfos: [ ... ],  // assigns symbols to manual class breaks
  // e.g. 0-20, 20-40, 40-60, 60-80, 80-100
};

valueExpressionTitleString

The title identifying and describing the associated Arcade expression as defined in the valueExpression property. This is displayed as the title of the corresponding renderer in the Legend in the absence of a provided title in the legendOptions property.

Example:
renderer.valueExpression = "$feature.POP / $feature.SQ_MI * 100";
renderer.valueExpressionTitle = "Population per square mile";

visualVariablesObject[]

Visual variables define the parameters for data-driven geographic visualizations of numeric data. They allow you to easily map continuous ramps of color, size, opacity, and/or rotation to minimum and maximum data values of one of the layer's numeric attribute fields.

Visual variables can primarily be used in two ways.

1. Thematic mapping

Visual variables allow you to easily create stunning visualizations based on thematic attributes (e.g. population, education, rank, money, magnitude, etc.) in either 2D or 3D. This is accomplished by mapping data values from a numeric field attribute to color, size, and/or opacity values. The renderer then takes over and re-sizes or shades features based on the value of the given field and its position relative to the minimum and maximum values. The sample below uses three visual variables (size, color, and opacity).

renderer-unique-vv

2. Mapping real-world sizes

The size visual variable can be used to visualize the true sizes of features (e.g. tree canopy, road width, building height, etc.) based on their size in the real world. This can be particularly powerful when working in a 3D SceneView. The image below shows a layer of building footprints that uses visual variables to extrude each feature to the true height of the buildings based on data stored in an attribute field.

renderer-vv-rw

The visualVariables property of the renderer is an array of objects called "visual variables". Each object must indicate the type of visual variable to apply (e.g. color, size, opacity, rotation), the numeric field from which to drive the visualization, and the ramp of visual values to map to the data. The following list identifies each visual variable type and provides a link to the specification table of each.

TypeObject SpecificationLegend Example
colorColorVisualVariablelegend-color-vv
sizeSizeVisualVariablelegend-color-vv
opacityOpacityVisualVariablelegend-color-vv
rotationRotationVisualVariable-

See the Visualize features with realistic 3D symbols for an example of using multiple visual variables to visualize your data.

See also:

Method Overview

NameReturn TypeSummaryClass

Adds a class break to the renderer.

more details
more detailsClassBreaksRenderer
ClassBreaksRenderer

Creates a deep clone of the renderer.

more details
more detailsClassBreaksRenderer
*

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 detailsRenderer
Object

Returns the classBreakInfo information (as defined by the renderer) associated with the given graphic.

more details
more detailsClassBreaksRenderer

Removes a break from the renderer.

more details
more detailsClassBreaksRenderer
Object

Converts an instance of this class to its ArcGIS Portal JSON representation.

more details
more detailsRenderer

Method Details

addClassBreakInfo(min, max, symbol)

Adds a class break to the renderer. You can provide the minimum, maximum and symbol values as individual arguments or by using the info object. The range of the break is greater than or equal to the minimum value and less than the maximum value.

Parameters:

The minimum value to use in the break. This can be a number or an info object as defined in classBreakInfos.

max Number

The maximum value to use in the break.

symbol Symbol

Symbol to use for the break.

Examples:
// add a class break using an info object
renderer.addClassBreakInfo({
  minValue: 0,  // lower limit of the break
  maxValue: 2,  // upper limit of the break
  symbol: symbol1  // the symbol assigned to features in this break
});
// add a class break using arguments
renderer.addClassBreakInfo(2, 4, symbol2);
// Features with values between 2 - 4 will be assigned symbol2
});

Creates a deep clone of the renderer.

Returns:
TypeDescription
ClassBreaksRendererA deep clone of the object that invoked this method.
Example:
// Creates a deep clone of the first layer's renderer
var renderer = view.map.layers.getItemAt(0).renderer.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 json parameter 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 Object

A 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:
TypeDescription
*Returns a new instance of this class.

getClassBreakInfo(graphic){Object}

Returns the classBreakInfo information (as defined by the renderer) associated with the given graphic.

Parameter:
graphic Graphic

The graphic whose rendering information will be returned.

Returns:
TypeDescription
ObjectReturns an object containing rendering and legend information for the break associated with the graphic.

removeClassBreakInfo(min, max)

Removes a break from the renderer.

Parameters:
min Number

Minimum value in the break to remove

max Number

Maximum value in the break to remove.

Example:
// removes the break defined for values between 2 - 4.
renderer.removeClassBreakInfo(2,4);

toJSON(){Object}inherited

Converts an instance of this class to its ArcGIS Portal JSON representation. See the Using fromJSON() topic in the Guide for more information.

Returns:
TypeDescription
ObjectThe ArcGIS Portal JSON representation of an instance of this class.

API Reference search results

NameTypeModule

There were no match results from your search criteria.