import DateBinParameters from "@arcgis/core/rest/support/DateBinParameters.js";const DateBinParameters = await $arcgis.import("@arcgis/core/rest/support/DateBinParameters.js");- Inheritance:
- DateBinParameters→
BinParametersBase→ Accessor
- Since
- ArcGIS Maps SDK for JavaScript 4.32
DateBinParameters specifies AttributeBinsQuery.binParameters on AttributeBinsQuery object. For date bins, the intervals are based on calendar units. For example, with monthly intervals, each bin corresponds to the full month. Date bins always start at the beginning of the calendar unit, not at the first item in the dataset.
When dates are binned, they start at the beginning of the temporal unit as follows:
- An hour starts at minute 00.
- A day starts at 12 a.m.
- A week starts on Sunday
- A month starts on the first day of the month
- A quarter starts on the first month of the quarter (January, April, July, or October).
- A year starts on January 1st.
For example, if you want to get the total number of accidents in the USA by month for the year 2021, you can use the following bin parameters:
// Query total accidents in the USA by month for the year 2021.// TSODate field values are used to bin the data into monthly intervals.// Request the binning results in pacific time zone.const binQuery = new AttributeBinsQuery({ binParameters: new DateBinParameters({ field: "TSODate", // timestamp-offset field containing the date of each accident start: "2021-01-01T00:00:00+00:00", // the lower boundary of the first bin end: "2021-12-31T00:00:00+00:00", // the upper boundary of the last bin interval: { // the interval size for each bin. One month value: 1, units: "months" } }), outTimeZone: "America/Los_Angeles", // Get the binning results in pacific time zone});
Total accidents in the USA by month for the year 2021. Each bin represents the number of accidents that occurred during each month. The results are presented in Pacific time zone. The chart is based on the results of the binQuery shown above.
Constructors
Constructor
Parameters
| Parameter | Type | Description | Required |
|---|---|---|---|
| properties | | |
Properties
| Property | Type | Class |
|---|---|---|
declaredClass readonly inherited | ||
| | ||
expression inherited | ||
expressionValueType inherited | ||
field inherited | ||
firstDayOfWeek inherited | ||
hideUpperBound inherited | ||
| | ||
| | ||
| | ||
| | ||
splitBy inherited | ||
stackBy inherited | ||
| | ||
type readonly | "date" | |
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
firstDayOfWeek
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.
hideUpperBound
If true, the upperBoundary and bin fields will not be included in the attributes.
interval
- Type
- DateBinTimeInterval
Defines a length of time in one of the temporal units such as days, weeks, or years.
offset
- Type
- DateBinTimeInterval | null | undefined
Defines an offset to the bin's starting position. For example, with a bin unit of day and an offset of 12 hours, bins run from noon to noon. The offset can be positive or negative.
returnFullIntervalBin
- Type
- boolean
Indicates whether the last bin should match the specified interval size exactly. When set to false, the last bin may have a different interval size than the others.
For example, if the bins are set to a monthly interval, the last bin could be shorter than a full month if the end date doesn’t align with the end of the month.
When set to true, all bins will have the same interval size, including the first and last bins. For example, if the bins are set to a monthly interval and
returnFullIntervalBin is set to true, the first and last bins will have a full month interval. This means that even if the first or last date doesn’t align perfectly
with the start or end of the month, the first bin will start from the beginning of the month, and the last bin will cover the full month, potentially extending beyond the
actual data range to ensure consistent bin sizes.
- Default value
- false
snapToData
This property determines how the bins are aligned relative to the data points. It can be set to either the first or last data point.
When set to first, the binning will start from the earliest date in your dataset and move forward in time.
When set to last, the binning will start from the most recent date and move backward in time.
For example, if the bins are set to a monthly interval and the data starts on January 18th:
- When
snapToDatais set tofirst: The binning starts from the earliest date in the dataset and progresses forward in time. Each bin will cover a full month. However, the last bin may not be a full month if the end date does not align perfectly with the interval. - When
snapToDatais set tolast: The binning starts from the most recent date in the dataset and moves backward in time. Each bin will cover a full month. However, the first bin may not be a full month if the start date does not align perfectly with the interval.
- 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.