@arcgis/map-components 5.1.0-next.3 → 5.1.0-next.30

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

@@ -1,11 +1,10 @@
 /// <reference path="../../index.d.ts" />
-import type ClassBreakInfo from "@arcgis/core/renderers/support/ClassBreakInfo";
+import type ClassBreakInfo from "@arcgis/core/renderers/support/ClassBreakInfo.js";
 import type { PublicLitElement as LitElement } from "@arcgis/lumina";
-import type { IconName } from "../../utils/action-utils.js";
-import type { ClassBreaksRendererResult } from "@arcgis/core/smartMapping/renderers/size";
-import type { HistogramResult } from "@arcgis/core/smartMapping/statistics/types";
-import type { ArcgisReferenceElement } from "../../utils/component-utils.js";
-import type { ThumbDragEvent, ThumbChangeEvent } from "@arcgis/core/widgets/Slider/types";
+import type { ClassBreaksRendererResult } from "@arcgis/core/smartMapping/renderers/size.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.js";
 import type { SizeBreak, HistogramConfig } from "@arcgis/core/widgets/smartMapping/types.js";
 import type { LabelFormatFunction, InputParseFunction } from "@arcgis/core/widgets/types.js";
 import type { ClassedSizeSliderStyle } from "@arcgis/core/widgets/smartMapping/ClassedSizeSlider.js";
@@ -16,25 +15,24 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * >
  * > 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 Classed Size Slider component is designed for authoring and exploring data-driven visualizations in any
- * layer that can be rendered with size in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html).
+ * layer that can be rendered with size in a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/).
  *
- * <span id="image-annotations"></span>
  * See the image below for a summary of the configurable options available on this slider.
  *
- * ![Classed Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/classedsizeslider-labels.png "Classed Size Slider with annotations")
+ * ![Classed Size Slider with annotations](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/classedsizeslider-labels.png "Classed Size Slider with annotations")
  *
- * The [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) method can be used to intelligently populate slider properties including
- * [max](#max), [min](#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos) configuration,
- * and the slider's histogram after the renderer has been created from the result of the [createClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer)
+ * The [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-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-classed-size-legacy/#max), [min](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#min), the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos) configuration,
+ * and the slider's histogram after the renderer has been created from the result of the [createClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)
  * method.
  *
  * ```js
  * const sizeRendererCreator = await import("@arcgis/core/smartMapping/renderers/size.js");
  * const viewElement = document.querySelector("arcgis-map")!;
- * const classedSizeSlider = document.querySelector("arcgis-slider-classed-size")!;
+ * const classedSizeSlider = document.querySelector("arcgis-slider-classed-size-legacy")!;
  *
  * const featureLayer = new FeatureLayer({
  *   url: "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/ACS_Median_Income_by_Race_and_Age_Selp_Emp_Boundaries/FeatureServer/1",
@@ -62,7 +60,7 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * await classedSizeSlider?.updateFromRendererResult(rendererResult, histogramResult);
  * ```
  *
- * This slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)
+ * This slider should be used to update the [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)
  * in a ClassBreaksRenderer. It is the responsibility of the app developer
  * to set up event listeners on this slider that update the breaks of the appropriate renderer.
  *
@@ -72,7 +70,7 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  *   if (!renderer || !("classBreakInfos" in renderer) || !renderer.classBreakInfos?.[0]) {
  *     return;
  *   }
- *   renderer.classBreakInfos = (await classedSizeSlider.updateClassBreakInfos(renderer.classBreakInfos)) as any;
+ *   renderer.classBreakInfos = (await classedSizeSlider.updateClassBreakInfos(renderer.classBreakInfos);
  *   featureLayer.renderer = renderer;
  * };
  *
@@ -81,10 +79,9 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * classedSizeSlider.addEventListener("arcgisPropertyChange", updateRendererFromSlider);
  * ```
  *
- * @since 5.0.0
- * @see [ClassedSizeSliderViewModel](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider-ClassedSizeSliderViewModel.html)
- * @see [sizeRendererCreator](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html)
- * @see [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html)
+ * @since 5.0
+ * @see [sizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/)
+ * @see [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/)
  */
 export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
   /**
@@ -113,11 +110,9 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    */
   accessor breaks: Array<SizeBreak>;
   /**
-   * The [Histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html) associated with the data represented on the slider. The bins are typically
-   * generated using the [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html) statistics function.
+   * 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/api-reference/esri-smartMapping-statistics-histogram.html)
-   * @see [Histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Histogram.html)
    * @example
    * ```js
    * const histogramResult = await histogram({
@@ -126,10 +121,11 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   * classedSizeSlider.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;
   /**
@@ -140,33 +136,34 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    */
   accessor icon: IconName;
   /**
-   * A function used to format user inputs. As opposed to [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#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-classed-size-legacy/#labelFormatFunction), which formats
    * thumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins
    * to edit them.
    *
    * The image below demonstrates how slider input values resemble corresponding slider values by default
    * and won't match the formatting set in `labelFormatFunction`.
    *
-   * ![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-no-input-formatter.png "Slider without input formatter")
+   * ![Slider without input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/widgets/sliders/slider-no-input-formatter.png "Slider without input formatter")
    *
    * If you want to format slider input values so they match thumb labels, you can pass the same function set in `labelFormatFunction` to
    * `inputFormatFunction` for consistent formatting.
    *
-   * ![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/sliders/slider-input-formatter.png "Slider with input formatter")
+   * ![Slider with input formatter](https://developers.arcgis.com/javascript/latest/assets/references/core/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/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#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/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#labelFormatFunction) to the same value
+   * [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-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-classed-size-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/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputParseFunction)
+   * @see [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-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
-   * classedSizeSlider.inputFormatFunction = (value: number): string => {
+   * slider.inputFormatFunction = (value: number): string => {
    *   if (value >= 1000000) {
    *     return (value / 1000000).toPrecision(3) + "m";
    *   }
@@ -178,24 +175,24 @@ export abstract class ArcgisSliderClassedSizeLegacy 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/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction).
+   * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-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/api-reference/esri-widgets-smartMapping-SmartMappingSliderBase.html#inputFormatFunction)
+   * @see [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#inputFormatFunction)
    * @example
    * ```js
    * // Parses the slider input (a string value) to a number value understandable to the slider
    * // This assumes the slider was already configured with an inputFormatFunction
    * // For example, if the input is 1.5k this function will parse
    * // it to a value of 1500
-   * classedSizeSlider.inputParseFunction = (value: string): number => {
+   * colorSlider.inputParseFunction = (value: string): number => {
    *   const charLength = value.length;
    *   const valuePrefix = parseFloat(value.substring(0, charLength - 1));
    *   const finalChar = value.substring(charLength - 1);
@@ -211,27 +208,23 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    *   }
    *   return parseFloat(value);
    * };
-   * ```
+   *           ```
    */
   accessor inputParseFunction: InputParseFunction | null | undefined;
   /**
-   * A modified version of
-   * [Slider#labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Slider.html#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
-   * classedSizeSlider.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-classed-size-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 breaks of the appropriate renderer.
    *
@@ -242,7 +235,7 @@ export abstract class ArcgisSliderClassedSizeLegacy 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-classed-size-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 breaks of the appropriate renderer.
    *
@@ -256,13 +249,13 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    * 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/api-reference/esri-widgets-smartMapping-SmartMappingSliderViewModel.html#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
-   * classedSizeSlider.precision = 7;
+   * // Rounds slider thumb values to 7 decimal places
+   * slider.precision = 7;
    * ```
    */
   accessor precision: number;
@@ -273,10 +266,10 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    */
   accessor referenceElement: ArcgisReferenceElement | string | undefined;
   /**
-   * Exposes various properties of the widget that can be styled. The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer)
+   * Exposes various properties of the component that can be styled. The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)
    * method can be used to match the `trackFillColor` to the current layer symbology.
    *
-   * @see [Color](https://developers.arcgis.com/javascript/latest/api-reference/esri-Color.html)
+   * @see [Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)
    * @example
    * ```js
    * classedSizeSlider.sliderStyle = {
@@ -287,20 +280,20 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
    */
   accessor sliderStyle: ClassedSizeSliderStyle;
   /** The current state of the component. */
-  accessor state: SmartMappingSliderBaseState;
+  get state(): SmartMappingSliderBaseState;
   /** Permanently destroy the component. */
   destroy(): Promise<void>;
   /**
    * A convenience function used to update the
-   * [classBreakInfos](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html#classBreakInfos)
-   * of a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) associated with this slider.
+   * [classBreakInfos](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/#classBreakInfos)
+   * of a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) associated with this slider.
    *
    * The number of breaks from the renderer must match the number of breaks in the slider.
    * Generally, the input breaks for this method should come from the same renderer as one
-   * used to create the slider with the [fromRendererResult()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-smartMapping-ClassedSizeSlider.html#fromRendererResult) method.
+   * used to create the slider with the [updateFromRendererResult()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-classed-size-legacy/#updateFromRendererResult) method.
    *
    * @param breakInfos - The classBreakInfos
-   *   from a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/api-reference/esri-renderers-ClassBreaksRenderer.html) instance to update based on
+   *   from a [ClassBreaksRenderer](https://developers.arcgis.com/javascript/latest/references/core/renderers/ClassBreaksRenderer/) instance to update based on
    *   the properties of the slider.
    * @returns The updated classBreakInfos to set
    *   on a ClassBreaksRenderer object.
@@ -314,13 +307,13 @@ export abstract class ArcgisSliderClassedSizeLegacy extends LitElement {
   updateClassBreakInfos(breakInfos: ClassBreakInfo[]): Promise<ClassBreakInfo[] | null | undefined>;
   /**
    * A convenience function used to update the properties a ClassedSizeSlider from the result
-   * of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer) method.
+   * of the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer) method.
    * This method is used to configure an empty ClassedSizeSlider to be used with the layer data, and is useful for cases when the app allows the end user to switch data variables.
    * Note that this method always expects `rendererResult` to be defined for the slider to function, but `histogramResult` is optional.
    *
-   * @param rendererResult - The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-renderers-size.html#createClassBreaksRenderer)
+   * @param rendererResult - The result object from the [createClassBreaksRenderer()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/#createClassBreaksRenderer)
    *   method.
-   * @param histogramResult - The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html#histogram)
+   * @param histogramResult - The result histogram object from the [histogram()](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/#histogram)
    *   method.
    * @example
    * ```js

package/dist/components/arcgis-slider-classed-size-legacy/customElement.js

@@ -12,7 +12,7 @@ class h extends l {
     super(...arguments), this.widget = _(this), this.viewModel = this.widget.viewModel, this.label = this.widget.label, this.autoDestroyDisabled = !1, this.breaks = this.widget.breaks, this.histogramConfig = this.widget.histogramConfig, this.icon = this.widget.icon, this.inputFormatFunction = this.widget.inputFormatFunction, this.inputParseFunction = this.widget.inputParseFunction, this.labelFormatFunction = this.widget.labelFormatFunction, this.max = this.widget.max, this.min = this.widget.min, this.precision = this.widget.precision, this.sliderStyle = this.widget.style, this.state = this.widget.state, this.arcgisPropertyChange = d()("breaks", "histogramConfig", "max", "min", "precision", "sliderStyle", "state"), this.arcgisReady = a(), this.arcgisThumbChange = i(() => this.widget, "thumb-change"), this.arcgisThumbDrag = i(() => this.widget, "thumb-drag");
   }
   static {
-    this.properties = { label: 16, autoDestroyDisabled: 5, breaks: 0, histogramConfig: 0, icon: 1, inputFormatFunction: 0, inputParseFunction: 0, labelFormatFunction: 0, max: 9, min: 9, precision: 9, referenceElement: 1, sliderStyle: 0, state: 1 };
+    this.properties = { label: 16, autoDestroyDisabled: 5, breaks: 0, histogramConfig: 0, icon: 1, inputFormatFunction: 0, inputParseFunction: 0, labelFormatFunction: 0, max: 9, min: 9, precision: 9, referenceElement: 1, sliderStyle: 0, state: 32 };
   }
   static {
     this.styles = c;