ClassBreakInfo | References | ArcGIS Maps SDK for JavaScript

import ClassBreakInfo from "@arcgis/core/renderers/support/ClassBreakInfo.js";

Inheritance:: ClassBreakInfo→Accessor

Since: ArcGIS Maps SDK 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

Constructor

Parameters

Parameter	Type	Description	Required
properties	`ClassBreakInfoProperties`

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

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
`declaredClass` readonly inherited	`string`	Accessor
`label`	`string \| null \| undefined`
`maxValue`	`number`
`minValue`	`number`
`symbol`	`SymbolUnion`

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

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

label

Property

Type: string | null | undefined

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

maxValue

Property

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

Default value: 0

minValue

Property

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

symbol

autocast Property

Type: SymbolUnion

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

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone`	`clone(): ClassBreakInfo`
`toJSON` inherited	`toJSON(): any`	JSONSupportMixin

fromJSON

inheritedstatic Method

Signature: fromJSON (json: any): any

Inherited from: JSONSupportMixin

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.

Parameters

Parameter	Type	Description	Required
json	`any`	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: any
Returns a new instance of this class.

clone

Method

Signature: clone (): ClassBreakInfo

Creates a deep clone of the class break info object.

Returns: 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();

toJSON

inherited Method

Signature: toJSON (): any

Inherited from: JSONSupportMixin

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

Returns: any
The ArcGIS portal JSON representation of an instance of this class.