@arcgis/core/rest/support/DateBinTimeInterval.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

import type { ClonableMixin } from "../../core/Clonable.js";
import type { JSONSupport } from "../../core/JSONSupport.js";
import type { DateBinTimeUnit } from "./types.js";

export interface DateBinTimeIntervalProperties extends Partial<Pick<DateBinTimeInterval, "unit" | "value">> {}

/**
 * DateBinTimeInterval describes a length of time for a bin query in one of the temporal units such as `days`, `weeks`, or `years`.
 * DateBinTimeInterval is used to generate bins for temporal data when the binning is based on [DateBinParameters](https://developers.arcgis.com/javascript/latest/references/core/rest/support/DateBinParameters/).
 *
 * @since 4.32
 */
export default class DateBinTimeInterval extends DateBinTimeIntervalSuperclass {
  constructor(properties?: DateBinTimeIntervalProperties);
  /**
   * Temporal unit used to generate bins or defines and an offset. It defines a length of time such as `years` or `months`.
   * The unit value is defined via [value](https://developers.arcgis.com/javascript/latest/references/core/rest/support/DateBinTimeInterval/#value) property.
   */
  unit: DateBinTimeUnit;
  /** The numerical value of the time extent. This property works along with [unit](https://developers.arcgis.com/javascript/latest/references/core/rest/support/DateBinTimeInterval/#unit) to define the time interval or time offset to generate date bins. */
  accessor value: number;
}
declare const DateBinTimeIntervalSuperclass: typeof JSONSupport & typeof ClonableMixin