FixedBoundariesBinParameters | API Reference | ArcGIS Maps SDK for JavaScript 4.32

FixedBoundariesBinParameters specifies binParameters on AttributeBinsQuery object. For the FixedBoundariesBinParameters, the bins strictly follow the specified input values. The first item in the array specifies the lower boundary of the first bin, while the last item specifies the upper boundary of the last bin. Intermediate values represent the lower boundaries of each bin. The fixed boundaries binning works with numeric fields and fields of the date type only. It does not support timestamp-offset, date-only, or time-only field types.

If you have census data on the median income of households in a city and want to categorize this data into specific income groups to analyze income distribution, you could use the income boundaries array [0, 12500, 48000, 85000, 120000, 20000]. Based on these boundaries, the bins are defined as follows:

// Query bins with fixed boundaries bin parameters based on field "income2022" with the specified income boundaries.
// Show the median income distribution of households in the city.
const binQuery = new AttributeBinsQuery({
  binParameters: new FixedBoundariesBinParameters({
    boundaries: [0, 12500, 48000, 85000, 120000, 20000], // the boundaries of each bin
    field: "income2022" // the field to bin, containing the median income data for individual households
  })
});

color-blend — 2022 median household income distribution with each bin representing an income group defined by the fixed boundaries bin as shown above.

See also

AttributeBinsQuery

Constructors

FixedBoundariesBinParameters Constructor new FixedBoundariesBinParameters(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 Watch for changes topic.

Show inherited properties

Hide inherited properties

Type	Summary	Class
Number []\|Date []	Array of values representing bin boundaries.	FixedBoundariesBinParameters
String	The name of the class.	Accessor
String\|null\|undefined	A standardized SQL expression used to calculate the bins, rather than referencing a field.	FixedBoundariesBinParameters
String\|null\|undefined	Specifies the expected data type of the output from the expression, based on the type of value the expression generates.	FixedBoundariesBinParameters
String\|null\|undefined	The field name used to calculate the bins.	FixedBoundariesBinParameters
Number\|null\|undefined	The first day of the week.	FixedBoundariesBinParameters
Boolean\|null\|undefined	If `true`, the `upperBoundary` and `bin` fields will not be included in the attributes.	FixedBoundariesBinParameters
AttributeBinsGrouping\|null\|undefined	The `splitBy` parameter divides data into separate bins for each unique value in the categorical field.	FixedBoundariesBinParameters
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.	FixedBoundariesBinParameters
String	The type of bin parameters.	FixedBoundariesBinParameters

Property Details

boundaries Property boundaries Number[] |Date[]

Array of values representing bin boundaries. The first item in the array specifies the start of the range, and the last item specifies the end, both inclusively. Intermediate values represent the lower boundaries of each bin.

Default Value:null

declaredClass Inherited Property declaredClass Stringreadonly Inherited from Accessor

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

expression Property expression String |null |undefined

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.

Known Limitations

The expression is only supported with server-side FeatureLayers.

See also

expressionValueType

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 Property expressionValueType String |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.

Known Limitations

The expressionValueType is only supported with server-side FeatureLayers.

See also

expression

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 Property field String |null |undefined

The field name used to calculate the bins. The expression property cannot be set when this property is set.

See also

expression

firstDayOfWeek Property firstDayOfWeek Number |null |undefined

The first day of the week. This property is used to determine the start of the week for date-based bins. The default value is 7, representing Sunday, if no value is specified.

Known Limitations

The firstDayOfWeek is only supported with server-side FeatureLayers.

hideUpperBound Property hideUpperBound Boolean |null |undefined

If true, the upperBoundary and bin fields will not be included in the attributes.

Known Limitations

The hideUpperBound is only supported with server-side FeatureLayers.

splitBy Property splitBy AttributeBinsGrouping |null |undefinedautocast

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 Property stackBy AttributeBinsGrouping |null |undefinedautocast

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);

type Property type Stringreadonly

The type of bin parameters.

For FixedBoundariesBinParameters the type is always "fixed-boundaries".

Method Overview

Show inherited methods

Hide inherited methods

Return Type	Summary	Class
	Adds one or more handles which are to be tied to the lifecycle of the object.	Accessor
*\|null\|undefined	Creates a new instance of this class and initializes it with values from a JSON object generated from an ArcGIS product.	FixedBoundariesBinParameters
Boolean	Returns true if a named group of handles exist.	Accessor
	Removes a group of handles owned by the object.	Accessor
Object	Converts an instance of this class to its ArcGIS portal JSON representation.	FixedBoundariesBinParameters

Method Details

addHandles Inherited Method addHandles(handleOrHandles, groupKey) Inherited from Accessor

Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

this.addHandles(handle);

// Destroy the object
this.destroy();

Parameters

handleOrHandles WatchHandle|WatchHandle []

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.

fromJSON Method fromJSON(json){* |null |undefined}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
* \| null \| undefined	Returns a new instance of this class.

hasHandles Inherited Method hasHandles(groupKey){Boolean} Inherited from Accessor

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type	Description
Boolean	Returns `true` if a named group of handles exist.

Example

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

removeHandles Inherited Method removeHandles(groupKey) Inherited from Accessor

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");

toJSON Method 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.