import BinParametersBase from "@arcgis/core/rest/support/BinParametersBase.js";const BinParametersBase = await $arcgis.import("@arcgis/core/rest/support/BinParametersBase.js");- Inheritance:
- BinParametersBase→
Accessor
- Subclasses:
- AutoIntervalBinParameters, DateBinParameters, FixedBoundariesBinParameters, FixedIntervalBinParameters
- Since
- ArcGIS Maps SDK for JavaScript 4.32
A mixin that provides common binning parameters to AutoIntervalBinParameters, DateBinParameters, FixedBoundariesBinParameters, and FixedIntervalBinParameters.
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| | ||
| |
expression
A standardized SQL expression used to calculate the bins, rather than referencing a field. The specified SQL expression must evaluate to a numeric or date type.
Both field and the expression cannot be specified for the same bin. The expressionValueType property must be set to the expected data type
of the output from the expression.
- See also
Example
const binQuery = new AttributeBinsQuery({ binParameters: new AutoIntervalBinParameters({ numBins: 5, // the interval size for each bin // sql expression to calculate the bins based on the product of Quantity and SalesAmount expression: "Quantity * SalesAmount" expressionValueType: "double" })}); expressionValueType
- Type
- BinParameterFieldType | null | undefined
Specifies the expected data type of the output from the expression, based on the type of value the expression generates. The expression property must be set when this property is set.
- See also
Example
const binQuery = new AttributeBinsQuery({ binParameters: new AutoIntervalBinParameters({ numBins: 5, // the interval size for each bin // sql expression to calculate the bins based on the product of Quantity and SalesAmount expression: "Quantity * SalesAmount" expressionValueType: "double" })}); field
The field name used to calculate the bins. The expression property cannot be set when this property is set.
- See also
splitBy
- Type
- AttributeBinsGrouping | null | undefined
The splitBy parameter divides data into separate bins for each unique value in the categorical field. Each category will have different bin boundaries based on the data distribution within that category.
For example, when analyzing sales by region (e.g., Central, Northeast, etc.), splitBy will create separate bin ranges for each region, allowing the boundaries to adjust to the specific data distribution of each region.
The splitBy parameter is useful when the distribution of values within each category (e.g., branch or region) differs significantly, and you want each category’s binning to reflect its unique data range.
Field with many unique values are not appropriate for splitting bins into multiple series.
Example
// create bins based on the SalesTotal field, split by the Branch field.const binQuery = new AttributeBinsQuery({ binParameters: new AutoIntervalBinParameters({ numBins: 5, // the interval size for each bin field: "SalesTotal", splitBy: { // autocasts to AttributeBinsGrouping type: "field", value: "Branch" } })});const result = await layer.queryAttributeBins(binQuery); stackBy
- Type
- AttributeBinsGrouping | null | undefined
The stackBy parameter divides each bin into segments based on unique values from a categorical field, allowing you to compare multiple categories within the same bin
while keeping the bin boundaries consistent across all categories. This enables you to visualize or analyze the distribution of categories stacked together within the same range of values.
For example, with 3 bins based on total sales with ranges like $0 to $5000, $5001 to $10,000, and $10,001 to $15,000, setting stackBy = SalesRep will stack each sales rep's contribution
within the same bin range. The bin boundaries remain the same, and each segment within the bin shows how individual categories contribute to the total frequency or value.
Field with many unique values are not appropriate for splitting bins into multiple series.
Example
// create bins based on the SalesTotal field, stacked by the Month field.const binQuery = new AttributeBinsQuery({ binParameters: new AutoIntervalBinParameters({ numBins: 5, // the interval size for each bin field: "SalesTotal", stackBy: { value: "EXTRACT(MONTH from invoiceDate)", type: "expression", valueType: "double", alias: "Month" } })});const result = await layer.queryAttributeBins(binQuery);Methods
fromJSON
- Signature
-
fromJSON (json: any): any
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 | 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
- Signature
-
clone (): this
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
- Signature
-
toJSON (): any
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
BinParameterFieldType
Specifies the expected data type of the output from the expression, based on the type of value the expression generates. The expression property must be set when this property is set.
- See also
- Type
- "small-integer" | "integer" | "single" | "double" | "long" | "date" | "date-only" | "time-only" | "timestamp-offset"