@arcgis/map-components 5.1.0-next.10 → 5.1.0-next.12

package/dist/components/arcgis-slider-color-legacy/customElement.d.ts

@@ -1,10 +1,10 @@
 /// <reference path="../../index.d.ts" />
 import type ColorStop from "@arcgis/core/renderers/visualVariables/support/ColorStop.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { ContinuousRendererResult } from "@arcgis/core/smartMapping/renderers/color";
-import type { HistogramResult } from "@arcgis/core/smartMapping/statistics/types";
+import type { ContinuousRendererResult } from "@arcgis/core/smartMapping/renderers/color.js";
+import type { HistogramResult } from "@arcgis/core/smartMapping/statistics/types.js";
 import type { ArcgisReferenceElement, IconName } from "../types.js";
-import type { ThumbDragEvent, ThumbChangeEvent } from "@arcgis/core/widgets/Slider/types";
+import type { ThumbDragEvent, ThumbChangeEvent } from "@arcgis/core/widgets/Slider/types.js";
 import type { HistogramConfig, ZoomOptions } from "@arcgis/core/widgets/smartMapping/types.js";
 import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widgets/types.js";
 
@@ -13,7 +13,7 @@ import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widge
  * >
  * > This is a **legacy component**. It relies on an underlying widget as part of our migration to native web components.
  * >
- * > A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, new development should use the native component.
+ * > A fully native replacement for this component is in development. Once it reaches feature parity, the legacy component will be deprecated and no longer maintained. At that point, development should use the native component.
  *
  * The Color Slider component is intended for authoring and exploring data-driven visualizations in any
  * layer that can be rendered with a [ColorVariable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/).
@@ -23,8 +23,8 @@ import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widge
  *
  * ![Color Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/colorslider-2-labels.png "Color Slider with annotations")
  *
- * The [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSlider/#fromRendererResult) method can be used to intelligently populate slider properties including
- * [max](#max), [min](#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration,
+ * The [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method can be used to intelligently populate slider properties including
+ * [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#min), the [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/) configuration,
  * and the slider's histogram after the renderer has been created from the result of the [createContinuousRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/#createContinuousRenderer) method.
  *
  * ```js
@@ -59,8 +59,7 @@ import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widge
  * ```
  *
  * This slider should be used to update a [color visual variable](https://developers.arcgis.com/javascript/latest/references/core/renderers/visualVariables/ColorVariable/)
- * in a layer's renderer. It is the responsibility of the app developer
- * to set up event listeners on this slider that update the color variable of the appropriate renderer.
+ * in a layer's renderer. It is the responsibility of the app developer to set up event listeners on this slider that update the color variable of the appropriate renderer.
  *
  * ```js
  * // when the user slides the handle(s), update the renderer
@@ -86,7 +85,6 @@ import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widge
  * ```
  *
  * @since 5.0
- * @see [ColorSliderViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSlider/ColorSliderViewModel/)
  * @see [colorRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/color/)
  */
 export abstract class ArcgisSliderColorLegacy extends LitElement {
@@ -102,7 +100,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
   accessor autoDestroyDisabled: boolean;
   /**
    * Only applicable when three thumbs (i.e. handles) are set on the
-   * slider (i.e. when [primaryHandleEnabled](#primaryHandleEnabled) is `true`). This property
+   * slider (i.e. when [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#primaryHandleEnabled) is `true`). This property
    * indicates whether the position of the outside handles are synced with the middle, or primary,
    * handle. When enabled, if the primary handle is moved then the outside handle positions are updated
    * while maintaining a fixed distance from the primary handle.
@@ -118,11 +116,9 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    */
   accessor handlesSyncedToPrimary: boolean;
   /**
-   * The [Histogram](https://developers.arcgis.com/javascript/latest/references/core/widgets/Histogram/) associated with the data represented on the slider. The bins are typically
+   * The histogram associated with the data represented on the slider. The bins are typically
    * generated using the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/) statistics function.
    *
-   * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
-   * @see [Histogram](https://developers.arcgis.com/javascript/latest/references/core/widgets/Histogram/)
    * @example
    * ```js
    * const histogramResult = await histogram({
@@ -131,10 +127,11 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   * colorSlider.histogramConfig = {
-   *   bins: histogramResult.bins
-   * };
-   * ```
+   *  slider.histogramConfig = {
+   *    bins: histogramResult.bins
+   *  };
+   *       ```
+   * @see [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
    */
   accessor histogramConfig: HistogramConfig | null | undefined;
   /**
@@ -145,7 +142,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    */
   accessor icon: IconName;
   /**
-   * A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderBase/#labelFormatFunction), which formats
+   * A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#labelFormatFunction), which formats
    * thumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins
    * to edit them.
    *
@@ -160,18 +157,19 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    * ![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-input-formatter.png "Slider with input formatter")
    *
    * However, if an `inputFormatFunction` is specified, you must also write a corresponding
-   * [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderBase/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if
-   * you specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderBase/#labelFormatFunction) to the same value
+   * [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if
+   * you specify an `inputFormatFunction`, you should set the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#labelFormatFunction) to the same value
    * for consistency between labels and inputs.
    *
    * This property overrides the default input formatter, which formats by calling `toString()` on the input value.
+   *       
    *
-   * @see [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderBase/#inputParseFunction)
+   * @see [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputParseFunction)
    * @example
    * ```js
    * // Formats the slider input to abbreviated numbers with units
    * // e.g. a thumb at position 1500 will render with an input label of 1.5k
-   * colorSlider.inputFormatFunction = (value: number): string => {
+   * slider.inputFormatFunction = (value: number): string => {
    *   if (value >= 1000000) {
    *     return (value / 1000000).toPrecision(3) + "m";
    *   }
@@ -183,17 +181,17 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   * ```
+   *            ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
-   * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderBase/#inputFormatFunction).
+   * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputFormatFunction).
    * This property must be set if an `inputFormatFunction` is set. Otherwise the slider values will
    * likely not update to their expected positions.
    *
    * Overrides the default input parses, which is a parsed floating point number.
    *
-   * @see [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderBase/#inputFormatFunction)
+   * @see [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#inputFormatFunction)
    * @example
    * ```js
    * // Parses the slider input (a string value) to a number value understandable to the slider
@@ -216,27 +214,23 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    *   }
    *   return parseFloat(value);
    * };
-   * ```
+   *           ```
    */
   accessor inputParseFunction: InputParseFunction | null | undefined;
   /**
-   * A modified version of
-   * [Slider#labelFormatFunction](https://developers.arcgis.com/javascript/latest/references/core/widgets/Slider/#labelFormatFunction),
-   * which is a custom function used to format labels on the thumbs, min, max, and average
-   * values. Overrides the default label formatter.
-   * This function also supports date formatting.
+   * A function used to format labels on the thumbs, min, max, and average values. Overrides the default label formatter. This function also supports date formatting.
    *
    * @example
    * ```js
    * // For thumb values, rounds each label to whole numbers
-   * colorSlider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
+   * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   * ```
+   *           ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**
-   * The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](#updateFromRendererResult) method,
+   * The maximum value or upper bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,
    * the user may change this property by selecting the label containing the max value on the slider UI. It is the responsibility of the app developer
    * to set up event listeners that update the color variable of the appropriate renderer.
    *
@@ -247,7 +241,7 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    */
   accessor max: number;
   /**
-   * The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](#updateFromRendererResult) method,
+   * The minimum value or lower bound of the slider. Once the slider has rendered with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#updateFromRendererResult) method,
    * the user may change this property by selecting the label containing the min value on the slider UI. It is the responsibility of the app developer
    * to set up event listeners that update the color variable of the appropriate renderer.
    *
@@ -258,32 +252,29 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    */
   accessor min: number;
   /**
-   * Defines how slider thumb values should be rounded. This number indicates the number of decimal places slider thumb _values_ should round to when they have been moved.
+   * Defines how slider thumb values should be rounded. This number indicates the number
+   * of decimal places slider thumb _values_ should round to when they have been moved.
    *
-   * Keep in mind this property rounds thumb
-   * [values](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SmartMappingSliderViewModel/#values) and shouldn't be used exclusively
-   * for formatting purposes.
+   * Keep in mind this property rounds thumb values and shouldn't be used exclusively for formatting purposes.
    *
    * @default 4
    * @example
    * ```js
-   * colorSlider.precision = 7;
+   * // Rounds slider thumb values to 7 decimal places
+   * slider.precision = 7;
    * ```
    */
   accessor precision: number;
   /**
-   * When `true`, the slider will render a third handle between the
-   * two handles already provided by default. This is the primary handle.
-   * Three or five [stops](#stops) must be defined for the primary handle to render.
+   * When `true`, the slider will render a third handle between the two handles already provided by default. This is the primary handle.
+   * Three or five [stops](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#stops) must be defined for the primary handle to render.
    * The primary handle represents the middle stop.
    *
-   * When [handlesSyncedToPrimary](#handlesSyncedToPrimary) is `true`, then
-   * this handle will control the position of the others when moved.
+   * When [handlesSyncedToPrimary](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#handlesSyncedToPrimary) is `true`, then this handle will control the position of the others when moved.
    *
    * This is typically used in diverging, or `above-and-below` renderer configurations.
    *
    * @default false
-   * @see [primaryHandleEnabled](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/ColorSlider/#handlesSyncedToPrimary)
    * @example
    * ```js
    * // enables the primary handles and syncs it with the others
@@ -314,67 +305,55 @@ export abstract class ArcgisSliderColorLegacy extends LitElement {
    */
   accessor stops: Array<ColorStop>;
   /**
-   * Zooms the slider track to the bounds provided in this property.
-   * When min and/or max zoom values are provided, the absolute
-   * [min](#min) and [max](#max) slider values are preserved and
-   * rendered at their typical positions on the slider. However, the
-   * slider track itself is zoomed so that thumbs cannot be moved above or
-   * below the provided min and max zoomed values.
+   * Zooms the slider track to the bounds provided in this property. When min and/or max zoom values are provided, the absolute [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#min) and
+   * [max](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-color-legacy/#max) slider values are preserved and rendered at their typical positions on the slider. However, the
+   *  slider track itself is zoomed so that thumbs cannot be moved above or below the provided min and max zoomed values.
    *
-   * When a slider is in a zoomed state, the zoomed
-   * ends of the track will appear jagged. In the image below, notice how the
-   * top thumb cannot be moved past the zoom max of `31` even though the slider
-   * max is `200`.
+   *  When a slider is in a zoomed state, the zoomed ends of the track will appear jagged. In the image below, notice how the
+   *  top thumb cannot be moved past the zoom max of `31` even though the slider max is `200`.
    *
-   * ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-zoomed.png "Zoomed slider")
+   *  ![slider-zoom](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-zoomed.png "Zoomed slider")
    *
-   * To exit a zoomed state, the user can click the
-   * jagged line or the developer can set the `zoomOptions` to `null`. It
-   * is up to the developer to provide a UI option for end users to
-   * enable zooming on the slider.
+   *  To exit a zoomed state, the user can click the jagged line or the developer can set the `zoomOptions` to `null`. It
+   *  is up to the developer to provide a UI option for end users to enable zooming on the slider.
    *
-   * Setting the `zoomOptions` is useful when the slider is tied to heavily skewed
-   * datasets where the histogram renders only one or two bars because of outliers.
+   *  Setting the `zoomOptions` is useful when the slider is tied to heavily skewed datasets where the histogram renders only one or two bars because of outliers.
    *
-   * ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-skewed-not-zoomed.png "Unzoomed slider")
+   *  ![slider-not-zoomed](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-skewed-not-zoomed.png "Unzoomed slider")
    *
-   * You can remove the influence of outliers by zooming the slider and regenerating
-   * a histogram based on the zoomed min and max. This will provide a better view of the data
-   * and make the slider more useful to the end user.
+   *  You can remove the influence of outliers by zooming the slider and regenerating a histogram based on the zoomed min and max. This will provide a better view of the data
+   *  and make the slider more useful to the end user.
    *
    * @example
    * ```js
-   * // zooms the slider so thumbs can only be moved
-   * // to positions between the values of 10 and 25 while
-   * // maintaining the slider's absolute minimum and maximum values
-   * colorSlider.zoomOptions = {
+   * // zooms the slider so thumbs can only be moved to positions between
+   * // values of 10 and 25 while maintaining the slider's absolute min and max values
+   * slider.zoomOptions = {
    *   min: 10,
    *   max: 25
    * };
-   * ```
+   *           ```
    * @example
    * ```js
    * // disables zooming on the slider
-   * colorSlider.zoomOptions = null;
-   * ```
+   * slider.zoomOptions = null;
+   *           ```
    * @example
    * ```js
-   * // zooms the slider so thumbs can only be moved
-   * // to positions above the value of 10 while maintaining
-   * // the slider's absolute minimum value
-   * colorSlider.zoomOptions = {
+   * // zooms the slider so thumbs can only be moved to positions above
+   * // value of 10 while maintaining the slider's absolute min value
+   * slider.zoomOptions = {
    *   min: 10
    * };
-   * ```
+   *           ```
    * @example
    * ```js
-   * // zooms the slider so thumbs can only be moved
-   * // to positions below the value of 25 while maintaining
-   * // the slider's absolute maximum value
-   * colorSlider.zoomOptions = {
+   * // zooms the slider so thumbs can only be moved to positions below
+   * // value of 25 while maintaining the slider's absolute max value
+   * slider.zoomOptions = {
    *   max: 25
    * };
-   * ```
+   *           ```
    */
   accessor zoomOptions: ZoomOptions | null | undefined;
   /** Permanently destroy the component. */