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

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

@@ -33,7 +33,7 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * ```js
  * const opacityVariableCreator = await import("@arcgis/core/smartMapping/renderers/opacity.js");
  * const viewElement = document.querySelector("arcgis-map")!;
- * const opacitySlider = document.querySelector("arcgis-slider-opacity")!;
+ * const opacitySlider = document.querySelector("arcgis-slider-opacity-legacy")!;
  *
  * const featureLayer = new FeatureLayer({
  *   url: "https://services.arcgis.com/P3ePLMYs2RVChkJx/ArcGIS/rest/services/USA_Census_2020_DHC_Total_Population/FeatureServer/2",
@@ -90,7 +90,6 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * ```
  *
  * @since 5.0
- * @see [OpacitySliderViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/OpacitySlider/OpacitySliderViewModel/)
  * @see [opacityVariableCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/opacity/)
  */
 export abstract class ArcgisSliderOpacityLegacy extends LitElement {
@@ -105,11 +104,9 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    */
   accessor autoDestroyDisabled: 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({
@@ -118,10 +115,11 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   * opacitySlider.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;
   /**
@@ -132,7 +130,7 @@ export abstract class ArcgisSliderOpacityLegacy 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-opacity-legacy/#labelFormatFunction), which formats
    * thumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins
    * to edit them.
    *
@@ -147,18 +145,19 @@ export abstract class ArcgisSliderOpacityLegacy 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-opacity-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-opacity-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-opacity-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
-   * opacitySlider.inputFormatFunction = (value: number): string => {
+   * slider.inputFormatFunction = (value: number): string => {
    *   if (value >= 1000000) {
    *     return (value / 1000000).toPrecision(3) + "m";
    *   }
@@ -170,24 +169,24 @@ export abstract class ArcgisSliderOpacityLegacy 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-opacity-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-opacity-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
-   * opacitySlider.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);
@@ -203,23 +202,19 @@ export abstract class ArcgisSliderOpacityLegacy 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
-   * opacitySlider.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;
   /**
@@ -248,13 +243,13 @@ export abstract class ArcgisSliderOpacityLegacy 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/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
-   * opacitySlider.precision = 7;
+   * // Rounds slider thumb values to 7 decimal places
+   * slider.precision = 7;
    * ```
    */
   accessor precision: number;
@@ -268,7 +263,7 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    * Defines the color to be used within the slider's track. The renderer assigned to the layer can be used to
    * match the `trackFillColor` to the current layer symbology.
    *
-   * @see [Color](https://developers.arcgis.com/javascript/latest/references/core/Color/)
+   * @see [Color](https://developers.arcgis.com/javascript/latest/references/core/esri-Color.html)
    * @example
    * ```js
    * opacitySlider.sliderStyle = {
@@ -300,67 +295,55 @@ export abstract class ArcgisSliderOpacityLegacy extends LitElement {
    */
   accessor stops: Array<OpacityStop>;
   /**
-   * 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](#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.
    *
-   * 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
-   * opacitySlider.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
-   * opacitySlider.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
-   * opacitySlider.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
-   * opacitySlider.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. */

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

@@ -33,7 +33,7 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * ```js
  * const sizeRendererCreator = await import("@arcgis/core/smartMapping/renderers/size.js");
  * const viewElement = document.querySelector("arcgis-map")!;
- * const sizeSlider = document.querySelector("arcgis-slider-size")!;
+ * const sizeSlider = document.querySelector("arcgis-slider-size-legacy")!;
  *
  * const featureLayer = new FeatureLayer({
  *   url: "https://services.arcgis.com/P3ePLMYs2RVChkJx/arcgis/rest/services/USA_Major_Cities_/FeatureServer/0",
@@ -87,7 +87,6 @@ import type { SmartMappingSliderBaseState } from "@arcgis/core/widgets/smartMapp
  * ```
  *
  * @since 5.0
- * @see [SizeSliderViewModel](https://developers.arcgis.com/javascript/latest/references/core/widgets/smartMapping/SizeSlider/SizeSliderViewModel/)
  * @see [sizeRendererCreator](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/renderers/size/)
  */
 export abstract class ArcgisSliderSizeLegacy extends LitElement {
@@ -105,8 +104,6 @@ export abstract class ArcgisSliderSizeLegacy extends LitElement {
    * 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/common-components/components/arcgis-histogram/)
    * @example
    * ```js
    * const histogramResult = await histogram({
@@ -115,10 +112,11 @@ export abstract class ArcgisSliderSizeLegacy extends LitElement {
    *   numBins: 30,
    * });
    *
-   * sizeSlider.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;
   /**
@@ -129,7 +127,7 @@ export abstract class ArcgisSliderSizeLegacy extends LitElement {
    */
   accessor icon: IconName;
   /**
-   * A function used to format user inputs. As opposed to [labelFormatFunction](#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-size-legacy/#labelFormatFunction), which formats
    * thumb labels, the `inputFormatFunction` formats thumb values in the input element when the user begins
    * to edit them.
    *
@@ -144,18 +142,19 @@ export abstract class ArcgisSliderSizeLegacy 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](#inputParseFunction) to parse user inputs to understandable slider values. In most cases, if
-   * you specify an `inputFormatFunction`, you should set the [labelFormatFunction](#labelFormatFunction) to the same value
+   * [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-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-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](#inputParseFunction)
+   * @see [inputParseFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-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
-   * sizeSlider.inputFormatFunction = (value: number): string => {
+   * slider.inputFormatFunction = (value: number): string => {
    *   if (value >= 1000000) {
    *     return (value / 1000000).toPrecision(3) + "m";
    *   }
@@ -167,24 +166,24 @@ export abstract class ArcgisSliderSizeLegacy extends LitElement {
    *   }
    *   return value.toFixed(0);
    * };
-   * ```
+   *            ```
    */
   accessor inputFormatFunction: LabelFormatFunction | null | undefined;
   /**
-   * Function used to parse slider inputs formatted by the [inputFormatFunction](#inputFormatFunction).
+   * Function used to parse slider inputs formatted by the [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-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](#inputFormatFunction)
+   * @see [inputFormatFunction](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-slider-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
-   * sizeSlider.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);
@@ -200,21 +199,19 @@ export abstract class ArcgisSliderSizeLegacy extends LitElement {
    *   }
    *   return parseFloat(value);
    * };
-   * ```
+   *           ```
    */
   accessor inputParseFunction: InputParseFunction | null | undefined;
   /**
-   * 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.
+   * 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
-   * sizeSlider.labelFormatFunction = (value, type?): string => {
+   * slider.labelFormatFunction = (value: number, type?: SliderFormatType): string => {
    *   return (type === "value") ? value.toFixed(0) : value.toString();
    * };
-   * ```
+   *           ```
    */
   accessor labelFormatFunction: LabelFormatFunction | null | undefined;
   /**
@@ -243,13 +240,13 @@ export abstract class ArcgisSliderSizeLegacy 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_ 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
-   * sizeSlider.precision = 7;
+   * // Rounds slider thumb values to 7 decimal places
+   * slider.precision = 7;
    * ```
    */
   accessor precision: number;
@@ -291,67 +288,55 @@ export abstract class ArcgisSliderSizeLegacy extends LitElement {
    */
   accessor stops: Array<SizeStop>;
   /**
-   * 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](#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.
    *
-   * 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
-   * sizeSlider.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
-   * sizeSlider.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
-   * sizeSlider.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
-   * sizeSlider.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. */

package/dist/components/arcgis-time-zone-label/customElement.d.ts

@@ -6,13 +6,7 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
 import type { Icon as Icon } from "@esri/calcite-components/components/calcite-icon";
 
 /**
- * Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).
- * The component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.
- * Users can toggle between these states by clicking the component's expand/collapse button.
- * By default the component is collapsed.
- *
- * When expanding, the component will lengthen inwards when [positioned](#position) within a Map.
- * This behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `"start"` or `"end"`.
+ * Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/#timeZone) of a [map](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-map/).
  *
  * @since 4.33
  */
@@ -26,29 +20,17 @@ export abstract class ArcgisTimeZoneLabel extends LitElement {
       noAdjustment: string;
   }>;
   /**
-   * When true, the component is visually withdrawn and cannot receive user interaction.
-   *
-   * @default false
-   */
-  accessor disabled: boolean;
-  /**
-   * The direction the component will expand.
-   *
-   * By default, the component will expand inward if assigned to a slotted corner. If the component is positioned manually,
-   * the component will expand towards the "end" which is equivalent to right in a left-to-right application.
+   * An optional leading icon that is displayed within the component.
    *
-   * > [!WARNING]
-   * >
-   * > This setting may be ignored if due to the component's position within the map, there is insufficient space to expand in the requested direction.
+   * @since 5.0
    */
-  get expandDirection(): ExpandDirection;
-  set expandDirection(value: ExpandDirection | undefined);
+  accessor actionIcon: Icon["icon"] | undefined;
   /**
-   * The expanded state of the component.
+   * When true, the component is visually withdrawn and cannot receive user interaction.
    *
    * @default false
    */
-  accessor expanded: boolean;
+  accessor disabled: boolean;
   /**
    * Icon which represents the component.
    * Typically used when the component is controlled by another component (e.g. by the Expand component).
@@ -82,9 +64,6 @@ export abstract class ArcgisTimeZoneLabel extends LitElement {
    *   > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-time-zone-label component will be associated with a map or scene component rather than using the `view` property.
    */
   accessor view: MapView | undefined;
-  "@setterTypes": {
-    expandDirection?: ExpandDirection | undefined;
-  };
   /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
   readonly arcgisPropertyChange: import("@arcgis/lumina").TargetedEvent<this, { name: "state"; }>;
   /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
@@ -95,6 +74,4 @@ export abstract class ArcgisTimeZoneLabel extends LitElement {
   };
 }
 
-export type ExpandDirection = "end" | "start";
-
 export type State = "disabled" | "ready";