@arcgis/map-components 5.2.0-next.137 → 5.2.0-next.139

package/dist/components/slider-legacy/types.d.ts

@@ -0,0 +1,157 @@
+import type Color from "@arcgis/core/Color.js";
+import type { ObjectId } from "@arcgis/core/views/types.js";
+
+/**
+ * Function used to style or attach custom interaction to histogram bars. This function should be set to the
+ * [HistogramConfig](https://developers.arcgis.com/javascript/latest/references/map-components/components/slider-legacy/types#HistogramConfig-barCreatedFunction) property. It fires
+ * for each bar when it is created.
+ *
+ * @param index - The index of the histogram bar. This directly corresponds
+ *   to the index of the associated [bin](https://developers.arcgis.com/javascript/latest/references/map-components/components/slider-legacy/types#HistogramConfig-bins).
+ * @param element - The histogram bar element to style.
+ * @since 5.2
+ */
+export type BarCreatedFunction = (index: number, element: SVGElement) => void;
+
+/** @since 5.2 */
+export interface ColorBreak {
+  /**
+   * Features with values within the provided `min`
+   *   and `max` will be rendered with this color.
+   */
+  color: Color;
+  /**
+   * The max value of the break. The `max` of each break should match the `min`
+   *   value of the break directly above it.
+   */
+  max: number;
+  /**
+   * The min value of the break. The `min` of each break should match the `max`
+   *   value of the break directly below it.
+   */
+  min: number;
+}
+
+/**
+ * Function used to style [HistogramConfig](https://developers.arcgis.com/javascript/latest/references/map-components/components/slider-legacy/types#HistogramConfig-dataLines). This function should be set to the
+ * [HistogramConfig](https://developers.arcgis.com/javascript/latest/references/map-components/components/slider-legacy/types#HistogramConfig-dataLineCreatedFunction) property. It fires
+ * when each data line is created.
+ *
+ * @param lineElement - The SVG element representing the data line rendered
+ *   on the histogram.
+ * @param labelElement - The SVG element representing the label
+ *    rendered on the histogram for the associated line element.
+ * @param index - The index of the data line.
+ * @since 5.2
+ */
+export type DataLineCreatedFunction = (lineElement: SVGElement, labelElement?: SVGElement | null, index?: number | null) => void;
+
+/** @since 5.2 */
+export interface DataLineInfos {
+  /** The label associated with the line. */
+  label?: number | string | null;
+  /** The value on the data axis of the histogram where a line will be rendered. */
+  value: number;
+}
+
+/**
+ * Represents the bin of a histogram. A bin consists of
+ * a minimum and a maximum value and a count. It indicates the
+ * number of values in a dataset that lie between the
+ * min and max values.
+ *
+ * @since 5.2
+ */
+export interface HistogramBin {
+  aggregateIds?: ObjectId[] | null;
+  /**
+   * The number of values in a dataset that are
+   *   contained between the indicated `minValue` and `maxValue`.
+   */
+  count: number;
+  /** The maximum value (or bound) of the bin. */
+  maxValue: number;
+  /** The minimum value (or bound) of the bin. */
+  minValue: number;
+}
+
+/**
+ * Configuration options for defining the slider's histogram.
+ *
+ * @since 5.2
+ */
+export interface HistogramConfig {
+  /**
+   * Indicates the average value of the dataset. When set,
+   *   a solid line on the histogram will render at the location of the average value along
+   *   with a label defaulting to the value set here.
+   */
+  average?: number;
+  /**
+   * Function for styling bars representing histogram bins.
+   *   This can be used to style bins or add custom interaction to them. For
+   *   example, you can use this function to color bins that match the colors on the slider's track.
+   */
+  barCreatedFunction?: BarCreatedFunction;
+  /**
+   * The bins of the histogram. This is
+   *   an array of objects indicating the range and count of data in each bin. This value is
+   *   typically retrieved from the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
+   *   function.
+   */
+  bins?: HistogramBin[];
+  /**
+   * When set, renders lines on the histogram that indicate important or
+   *   meaningful values to the end user.
+   */
+  dataLines?: DataLineInfos[];
+  /**
+   * Function
+   *   that fires each time a data line is created.
+   *   You can use this to style individual dataLines on the data axis.
+   */
+  dataLineCreatedFunction?: DataLineCreatedFunction;
+  dataLineUpdatedFunction?: DataLineCreatedFunction;
+  /**
+   * Indicates the standard deviation of the dataset.
+   *   When set, data lines are on the histogram at the locations of the standard deviations
+   *   above and below the `average`.
+   */
+  standardDeviation?: number;
+  /**
+   * Indicates the standard deviation of the dataset.
+   *   When set, data lines are on the histogram at the locations of the standard deviations
+   *   above and below the `average`.
+   */
+  standardDeviationCount?: number;
+}
+
+/** @since 5.2 */
+export interface SizeBreak {
+  /**
+   * The max value of the break. The `max` of each break should match the `min`
+   *   value of the break directly above it.
+   */
+  max: number;
+  /**
+   * The min value of the break. The `min` of each break should match the `max`
+   *   value of the break directly below it.
+   */
+  min: number;
+  /**
+   * The size in points of the symbol representing features with values within
+   *   the given `min` and `max`.
+   */
+  size: number;
+}
+
+/** @since 5.2 */
+export type SliderState = "disabled" | "ready";
+
+/** @since 5.2 */
+export interface ZoomOptions {
+  /** The upper bound of the zoom. */
+  max?: number | null;
+  /** The lower bound of the zoom. */
+  min?: number | null;
+}