AttributeBinsGrouping | References | ArcGIS Maps SDK for JavaScript

import AttributeBinsGrouping from "@arcgis/core/rest/support/AttributeBinsGrouping.js";

Inheritance:: AttributeBinsGrouping→Accessor

Since: ArcGIS Maps SDK for JavaScript 4.32

AttributeBinsGrouping is a class that defines the stackBy or splitBy parameter in the AttributeBinsQuery.binParameters.

See also

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`AttributeBinsGroupingProperties`

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
`alias`	`string \| null \| undefined`
`declaredClass` readonly inherited	`string`	Accessor
`type`	`"field" \| "expression"`
`value`	`string`
`valueType`	`AttributeBinsGroupingType \| null \| undefined`

alias

Property

Type: string | null | undefined

The alias is the name assigned to the attribute bin. It is required when the type is set to "expression" to provide a custom label for the bin based on the expression.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

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

type

Property

Type: "field" | "expression"

The type specifies how bin series will be created, indicating whether the bin grouping is based on a field, or an expression. When the type is set to expression, the valueType property is required.

value

Property

Type: string

The name of the field or an expression used when the bins are split or stacked.

valueType

Property

Type: AttributeBinsGroupingType | null | undefined

Specifies the expected data type of the output from the stackBy or splitBy parameters. This property is required when the type is set to expression.

Methods

Method	Signature	Class
`fromJSON` inherited static	`fromJSON(json: any): any`	JSONSupportMixin
`clone` inherited	`clone(): this`	ClonableMixin
`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

inherited Method

Signature: clone (): this

Inherited from: ClonableMixin

Creates a deep clone of this object. Any properties that store values by reference will be assigned copies of the referenced values on the cloned instance.

Returns: this
A deep clone of the class instance that invoked this method.

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.

Type definitions

AttributeBinsGroupingType

Type definition

Specifies the expected data type of the output from the stackBy or splitBy parameters. This property is required when the type is set to expression.

Type: "integer" | "string"