ClassBreakInfo

AMD: require(["esri/renderers/support/ClassBreakInfo"], (ClassBreakInfo) => { /* code goes here */ });
ESM: import ClassBreakInfo from "@arcgis/core/renderers/support/ClassBreakInfo";
Class: esri/renderers/support/ClassBreakInfo
Inheritance: ClassBreakInfo Accessor
Since: ArcGIS API for JavaScript 4.0

Defines a class break for a ClassBreaksRenderer. A class break defines a symbol for a range of numeric values. The ClassBreaksRenderer determines the field or expression from which to request data used to drive the rendering. Each feature's value is then used to assign the feature a symbol based on the break (or range) in which the value falls.

See also:

Constructors

new ClassBreakInfo(properties)
Parameter:
properties Object
optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.
Show inherited properties Hide inherited properties
Name Type Summary Class
Stringmore details

The name of the class.

more detailsAccessor
Stringmore details

Describes the data represented by the class break.

more detailsClassBreakInfo
Numbermore details

Sets the maximum value for the class break.

more detailsClassBreakInfo
Numbermore details

Sets the minimum value for the class break.

more detailsClassBreakInfo
Symbolmore details

Defines the symbol used to render features with data values that are within the bounds defined for the class break.

more detailsClassBreakInfo

Property Details

declaredClass Stringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

label String

Describes the data represented by the class break. This label will appear in the Legend widget next to the symbol representing the break. If no label is provided, then a default label is derived using the minValue and maxValue.

maxValue Number

Sets the maximum value for the class break. Features with this value or smaller as small as the provided minValue will be rendered with the given symbol.

minValue Number

Sets the minimum value for the class break. Features with this value or greater up to the provided maxValue will be rendered with the given symbol.

Defines the symbol used to render features with data values that are within the bounds defined for the class break. This value may be autocast by specifying the symbol type.

See also:

Method Overview

Name Return Type Summary Class
ClassBreakInfomore details

Creates a deep clone of the class break info object.

more detailsClassBreakInfo
*more details

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.

more detailsClassBreakInfo
Objectmore details

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

more detailsClassBreakInfo

Method Details

clone(){ClassBreakInfo}

Creates a deep clone of the class break info object.

Returns:
Type Description
ClassBreakInfo A deep clone of the class break that invoked this method.
Example:
// Creates a deep clone of the first class break in the renderer
let firstClassBreak = renderer.classBreaks[0].clone();
fromJSON(json){*}static

Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product. 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:
Type Description
* Returns a new instance of this class.
toJSON(){Object}

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

Returns:
Type Description
Object The ArcGIS portal JSON representation of an instance of this class.

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.