@arcgis/map-components 5.0.0-next.10 → 5.0.0-next.101

package/dist/components/arcgis-histogram-range-slider/customElement.d.ts

@@ -4,10 +4,11 @@ import { Use } from '@arcgis/lumina/controllers';
 import { default as HistogramRangeSlider } from '@arcgis/core/widgets/HistogramRangeSlider.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { IconName } from '../../utils/action-utils';
 
-declare const useHistogramRangeSliderWidget: (component: LitElement & Pick<HistogramRangeSlider, "label" | "viewModel" | "icon" | "values" | "max" | "min" | "average" | "barCreatedFunction" | "bins" | "dataLineCreatedFunction" | "dataLines" | "labelFormatFunction" | "precision" | "rangeType" | "standardDeviation" | "standardDeviationCount"> & {
+declare const useHistogramRangeSliderWidget: (component: LitElement & Pick<HistogramRangeSlider, "values" | "label" | "viewModel" | "icon" | "average" | "barCreatedFunction" | "bins" | "dataLineCreatedFunction" | "dataLines" | "labelFormatFunction" | "max" | "min" | "precision" | "rangeType" | "standardDeviation" | "standardDeviationCount"> & {
     state?: unknown;
-    viewModel?: __esri.HistogramRangeSliderViewModel | undefined;
+    viewModel?: import('@arcgis/core/widgets/HistogramRangeSlider/HistogramRangeSliderViewModel').default | undefined;
     closed?: boolean;
     icon: import('@arcgis/toolkit/type').nil | string;
     label: import('@arcgis/toolkit/type').nil | string;
@@ -18,7 +19,7 @@ declare const useHistogramRangeSliderWidget: (component: LitElement & Pick<Histo
         name: string;
     }> | undefined;
     el: HTMLElement & {
-        childElem? /** @copyDoc */: HTMLElement & {
+        childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
         view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
@@ -43,43 +44,114 @@ export declare class ArcgisHistogramRangeSlider extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * The statistical average of the data in the histogram.
+     * The statistical average of the data in the histogram. You would typically
+     * get this value from the `avg` property of
+     * [SummaryStatisticsResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-types.html#SummaryStatisticsResult),
+     * which is the result of the
+     * [summaryStatistics](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-summaryStatistics.html) function.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#average)
+     * When set, this value will render on the histogram with a line and an average symbol.
+     *
+     * @example
+     * // sets result returned from a smart mapping method
+     * // to the histogram
+     * slider.average = response.statistics.avg;
+     * @example slider.average = 34.5;
      */
-    average: number | nullish;
+    average: number | null | undefined;
     /**
      * Function for styling bars representing histogram bins.
+     * This can be used to color bins with the same color of features in the
+     * view that fall into bins representing the same range of data.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#barCreatedFunction)
+     * @example
+     * slider.barCreatedFunction = function(index, element){
+     *   const bin = slider.bins[index];
+     *   element.addEventListener("focus", function(){
+     *     layerView.filter = {
+     *       where: `POPULATION >= ${bin.minValue} AND POPULATION < ${bin.maxValue}`
+     *     };
+     *   });
+     *   element.addEventListener("blur", function(){
+     *     layerView.filter = null;
+     *   });
+     * };
      */
-    barCreatedFunction: nullish | __esri.BarCreatedFunction;
+    barCreatedFunction: import('@arcgis/core/widgets/Histogram/types').BarCreatedFunction | null | undefined;
     /**
-     * An array of objects representing each bin in the histogram.
+     * An array of objects representing each bin in the histogram. This
+     * information is typically returned from the
+     * [histogram](https://developers.arcgis.com/javascript/latest/api-reference/esri-smartMapping-statistics-histogram.html) function.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#bins)
+     * @example
+     * // sets the bins of the histogram from the bins in the histogram() result
+     * histogram.bins = histogramResult.bins;
+     * @example
+     * // Creates a histogram with 7 bins.
+     * histogram.bins = [
+     *   { minValue: 0, maxValue: 10, count: 4 },
+     *   { minValue: 10.1, maxValue: 20, count: 14 },
+     *   { minValue: 20.1, maxValue: 30, count: 9 },
+     *   { minValue: 30.1, maxValue: 40, count: 34 },
+     *   { minValue: 40.1, maxValue: 50, count: 351 },
+     *   { minValue: 50.1, maxValue: 60, count: 100 },
+     *   { minValue: 60.1, maxValue: 70, count: 1 }
+     * ];
      */
-    bins: nullish | __esri.HistogramBin[];
+    bins: import('@arcgis/core/smartMapping/statistics/types').HistogramBin[] | null | undefined;
     /**
      * Function that fires each time a data line is created.
+     * You can use this to style individual [dataLines](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines) on the data axis.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLineCreatedFunction)
+     * @example
+     * histogram.dataLineCreatedFunction = function (lineElement, labelElement) {
+     *   lineElement.setAttribute("y2", "25%");
+     *   lineElement.classList.add("line-style");
+     * };
      */
-    dataLineCreatedFunction: nullish | __esri.DataLineCreatedFunction;
+    dataLineCreatedFunction: import('@arcgis/core/widgets/Histogram/types').DataLineCreatedFunction | null | undefined;
     /**
      * When set, renders lines on the histogram that indicate important or
      * meaningful values to the end user.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines)
+     * @example
+     * // will render lines at the 25th, 50th, 75th, and 99th percentiles
+     * histogram.dataLines = [{
+     *   value: 30,
+     *   label: "25 pctl"
+     * }, {
+     *   value: 45,
+     *   label: "50 pctl"
+     * }, {
+     *   value: 65,
+     *   label: "75 pctl"
+     * }, {
+     *   value: 89,
+     *   label: "99 pctl"
+     * }];
+     * @example
+     * // calculate standard deviations from mean using stats
+     * // returned from smart mapping statistic methods
+     * const stddevs = smartMappingUtils.getDeviationValues(stats.stddev, stats.avg, 2);
+     * histogram.dataLines = stddevs.map(function(stddev){
+     *   return {
+     *     value: stddev
+     *   };
+     * });
      */
-    dataLines: nullish | __esri.HistogramRangeSliderDataLines[];
+    dataLines: import('@arcgis/core/widgets/Histogram/types').DataLineInfos[] | null | undefined;
     /**
      * Sets the color of the histogram bars that are excluded based on the specified
-     * [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).
+     * [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). For example, when a rangeType of `between` is used,
+     * all bars **not** between the slider thumbs will be rendered with the color set here.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor)
+     * To change the style of histogram bars representing included data based on the
+     * [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType), use the [includedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) property.
      *
      * @default "#d7e5f0"
+     * @see [includedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor)
+     * @see [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType)
+     * @example slider.excludedBarColor = "black";
      */
     get excludedBarColor(): typeof this.widget.excludedBarColor;
     set excludedBarColor(value: __esri.ColorProperties);
@@ -87,58 +159,160 @@ export declare class ArcgisHistogramRangeSlider extends LitElement {
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "arrow-double-horizontal"
+     * @since 4.27
+     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon: string;
+    get icon(): typeof this.widget.icon;
+    set icon(value: IconName);
     /**
      * Sets the color of the histogram bars that are included in the specified
-     * [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).
+     * [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType). For example, when a rangeType of `between` is used,
+     * all bars between the slider thumbs will be rendered with the color set here.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor)
+     * To change the style of histogram bars representing excluded data based on the
+     * [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType), use the [excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor) property.
      *
      * @default "#599dd4"
+     * @see [excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#excludedBarColor)
+     * @see [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType)
+     * @example slider.includedBarColor = "green";
      */
     get includedBarColor(): typeof this.widget.includedBarColor;
     set includedBarColor(value: __esri.ColorProperties);
     /**
-     * The widget's default label.
+     * The widget's default label. This label displays when it is
+     * used within another widget, such as the [Expand](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html)
+     * or [LayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html) widgets.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#label)
+     * @since 4.11
      */
     label: string;
     /**
-     * A function used to format labels.
+     * A function used to format labels. Overrides the default label formatter.
+     *
+     * By default labels are formatted in the following way:
+     *
+     * - When the data range is less than `10` (`(max - min) < 10`), labels
+     *   are rounded based on the value set in the [precision](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#precision) property.
+     * - When the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labels) display with a precision of
+     *   no more than two decimal places, though actual slider thumb values will maintain the
+     *   precision specified in [precision](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#precision).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction)
+     * Use this property to override the behavior defined above.
+     *
+     * @example
+     * // For thumb values, rounds each label to whole numbers.
+     * // Note the actual value of the thumb continues to be stored
+     * // based on the indicated data `precision` despite this formatting
+     * slider.labelFormatFunction = function(value, type) {
+     *   return (type === "value") ? value.toFixed(0) : value;
+     * }
+     * @example
+     * // Format thumb values as dates
+     * slider.labelFormatFunction = function(value, type) {
+     *   return new Date(value).toLocaleDateString();
+     * }
      */
-    labelFormatFunction: __esri.SliderLabelFormatter;
+    labelFormatFunction: import('@arcgis/core/widgets/types').LabelFormatFunction;
     /**
-     * The maximum value or upper bound of the slider.
+     * The maximum value or upper bound of the slider. If the largest
+     * slider [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values) _in the constructor_ is greater than the `maxValue` set in
+     * this property, then the `maxValue` will update to match the largest
+     * slider [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max)
+     * @example slider.max = 150;
      */
-    max: number | nullish;
+    max: number | null | undefined;
     /**
-     * The minimum value or lower bound of the slider.
+     * The minimum value or lower bound of the slider. If the smallest
+     * slider [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values) _in the constructor_ is greater than the `minValue` set in
+     * this property, then the `minValue` will update to match the smallest
+     * slider [value](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min)
+     * @example slider.min = -150;
      */
-    min: number | nullish;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
+    min: number | null | undefined;
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
     position?: __esri.UIPosition;
     /**
-     * Defines how slider thumb values should be rounded.
+     * 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.
+     *
+     * This value also indicates the precision of thumb [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labels) when the data range
+     * ([max](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#max) - [min](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#min)) is less than `10`.
+     *
+     * When the data range is larger than `10`, [HistogramRangeSliderViewModel#labels](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider-HistogramRangeSliderViewModel.html#labels) display with a precision of
+     * no more than two decimal places, though actual slider thumb values will maintain the
+     * precision specified in this property.
+     *
+     * For example, given the default precision of `4`, and the following slider configuration,
+     * The label of the thumb will display two decimal places, but the precision of the actual
+     * thumb value will not be lost even when the user slides or moves the thumb.
+     *
+     * ```js
+     * const slider = new HistogramRangeSliderViewModel({
+     *   min: 20,
+     *   max: 100,  // data range of 80
+     *   values: [50.4331],
+     *   // thumb label will display 50.43
+     *   // thumb value will maintain precision, so
+     *   // value will remain at 50.4331
+     * });
+     * ```
+     *
+     * If the user manually enters a value that has a higher precision than what's indicated by
+     * this property, the precision of that thumb value will be maintained until the thumb
+     * is moved by the user. At that point, the value will be rounded according to the indicated precision.
+     *
+     * Keep in mind this property rounds thumb [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values) and shouldn't be used exclusively
+     * for formatting purposes. To format thumb `labels`, use the [labelFormatFunction](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#labelFormatFunction)
+     * property.
      *
      * @default 4
+     * @example histogramRangeSlider.precision = 7;
      */
     precision: number;
     /**
-     * Indicates how the histogram bins should be rendered as the user slides the thumbs.
+     * Indicates how the histogram bins should be rendered as the user slides the thumbs. By default,
+     * blue bars indicate data bins included in the range. Gray bars indicate data bins excluded from
+     * the range. These colors can be customized with the [includedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) and
+     * [excludedBarColor](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#includedBarColor) properties.
+     *
+     * This property also determines the SQL where clause generated in [generateWhereClause()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#generateWhereClause)
+     * for filtering purposes. The value set here determines the number of [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values)
+     * allowed on the slider.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType)
+     * See the table below for a description and requirements of all possible values. `value1` refers to
+     * the value of the first thumb position. `value2` refers to the value of the final thumb position, if applicable.
+     *
+     * Possible Value | Number of [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values) | [Where clause](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#generateWhereClause)
+     * ---------------|----------------------------|----------------------
+     * equal | 1 | `${field} = ${value1}`
+     * not-equal | 1 | `${field} <> ${value1}`
+     * less-than | 1 | `${field} < ${value1}`
+     * greater-than | 1 | `${field} > ${value1}`
+     * at-most | 1 | `${field} <= ${value1}`
+     * at-least | 1 | `${field} >= ${value1}`
+     * between | 2 | `${field} BETWEEN ${value1} AND ${value2}`
+     * not-between | 2 | `${field} NOT BETWEEN ${value1} AND ${value2}`
+     *
+     * @see [values](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values)
+     * @see [generateWhereClause()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#generateWhereClause)
+     * @example
+     * // renders the histogram so that all bins between
+     * // the two handles are shaded with a blue color
+     * slider.rangeType = "between";
+     *
+     * // filters the layer view based on the configuration
+     * // of the slider
+     * layerView.filter = {
+     *   where: slider.generateWhereClause("POPULATION")
+     * }
      */
-    rangeType: "equal" | "not-equal" | "less-than" | "greater-than" | "at-most" | "at-least" | "between" | "not-between";
+    rangeType: import('@arcgis/core/widgets/HistogramRangeSlider/types').RangeType;
     /**
      * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
      *
@@ -147,30 +321,47 @@ export declare class ArcgisHistogramRangeSlider extends LitElement {
     referenceElement?: ArcgisReferenceElement | string;
     /**
      * Indicates the standard deviation of the dataset.
+     * When set, computed [dataLines](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#dataLines) will render on the histogram
+     * at the location of the given standard deviation
+     * above and below the `average`.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#standardDeviation)
+     * @example
+     * // stddev returned from summaryStatistics
+     * slider.standardDeviation = stats.stddev;
      */
-    standardDeviation: number | nullish;
+    standardDeviation: number | null | undefined;
     /**
      * Indicates the number of standard deviation lines to render on the histogram
      * from the [average].
      *
      * @default 1
+     * @example slider.standardDeviationCount = 2;
      */
     standardDeviationCount: number;
     /** The current state of the component. */
-    readonly state: "ready" | "disabled";
+    readonly state: import('@arcgis/core/widgets/Slider/SliderViewModel').SliderViewModelState;
     /**
      * An array of either one or two numbers representing thumb positions on the slider.
+     * The number of values that should be indicated here depends on the associated [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#values)
+     * @see [rangeType](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-HistogramRangeSlider.html#rangeType)
+     * @example
+     * const slider = new HistogramRangeSlider({
+     *   min: 20,
+     *   max: 100,  // data range of 80
+     *   values: [50.4331],
+     *   rangeType: "at-least"
+     *   container: "sliderDiv"
+     * });
      */
-    values: number[] | nullish;
+    values: number[] | null | undefined;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
     /**
      * Generates a SQL where clause based on a given field and the slider's
      * rangeType
+     *
+     * @param field
      */
     generateWhereClause(field: string): Promise<nullish | string>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
@@ -182,6 +373,7 @@ export declare class ArcgisHistogramRangeSlider extends LitElement {
     private widget: HistogramRangeSlider;
     readonly _setterTypes: {
         excludedBarColor?: __esri.ColorProperties;
+        icon?: IconName;
         includedBarColor?: __esri.ColorProperties;
     };
 }

package/dist/components/arcgis-histogram-range-slider/customElement.js

@@ -6,14 +6,14 @@ import { m as a } from "../../chunks/useWidget.js";
 import { css as l } from "lit";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/5.0/esri/copyright.txt for details.
-v5.0.0-next.10 */
+v5.0.0-next.101 */
 const n = l`.esri-widget__heading{color:var(--calcite-color-text-2);margin:0 0 .5rem;font-weight:var(--calcite-font-weight-semibold)}h1.esri-widget__heading{font-size:var(--calcite-font-size-xl)}h2.esri-widget__heading{font-size:var(--calcite-font-size-md)}h3.esri-widget__heading,h4.esri-widget__heading,h5.esri-widget__heading,h6.esri-widget__heading{font-size:var(--calcite-font-size)}.esri-widget{--esri-widget-padding-x: 15px;--esri-widget-padding-y: var(--calcite-spacing-md);--esri-widget-padding: var(--esri-widget-padding-y) var(--esri-widget-padding-x);box-sizing:border-box;color:var(--calcite-color-text-2);background-color:var(--calcite-color-foreground-1);font-size:var(--calcite-font-size);line-height:var(--calcite-font-line-height-relative-tight)}.esri-widget *,.esri-widget :before,.esri-widget :after{box-sizing:inherit}.esri-widget.esri-widget--disabled>*{opacity:.4;pointer-events:none}.esri-widget.esri-widget--compact{--esri-widget-padding-y: 0;--esri-widget-padding-x: 0}.esri-widget__anchor{color:var(--calcite-color-text-2)}.esri-widget__anchor:hover{color:var(--calcite-color-text-3)}.esri-widget__anchor:hover,.esri-widget__anchor:focus{text-decoration:underline}.esri-widget__anchor--disabled{opacity:.4;pointer-events:none}.esri-widget__header{background-color:var(--calcite-color-foreground-1);flex:1 0 100%;justify-content:space-between;align-items:center;width:100%;min-height:48px;padding:12px 0 12px 15px;display:flex}.esri-widget__header .esri-widget__heading{width:calc(100% - 48px);text-align:initial;color:var(--calcite-color-text-1);align-items:center;margin:0;padding:0;display:flex}.esri-widget__header-button{appearance:none;cursor:pointer;color:var(--calcite-color-text-2);background-color:var(--calcite-color-foreground-1);border:none;flex:0 0 48px;justify-content:center;align-self:stretch;align-items:center;width:48px;padding:0;display:flex}.esri-widget__footer{background-color:var(--calcite-color-foreground-1);justify-content:center;align-items:center;width:100%;min-height:48px;display:flex}.esri-widget__footer-pagination{color:var(--calcite-color-text-2);justify-content:space-between;align-items:center;display:flex}.esri-widget__footer-pagination-previous-button,.esri-widget__footer-pagination-next-button{cursor:pointer;background-color:var(--calcite-color-foreground-1);border:0;margin:0 7px;padding:12px 15px;transition:background-color .125s ease-in-out}.esri-widget__footer-pagination-previous-button:hover,.esri-widget__footer-pagination-previous-button:focus,.esri-widget__footer-pagination-next-button:hover,.esri-widget__footer-pagination-next-button:focus{color:var(--calcite-color-text-1);background-color:var(--calcite-color-foreground-1)}.esri-menu{visibility:hidden;z-index:1;background-clip:padding;background-color:var(--calcite-color-foreground-1);background-clip:padding-box;width:100%;max-height:0;margin:2px 0 0;padding:0;font-size:var(--calcite-font-size);line-height:var(--calcite-spacing-xl);position:absolute;top:100%;left:0;overflow:hidden;box-shadow:0 1px 2px #0000004d}.esri-menu .esri-menu__header{color:var(--calcite-color-text-inverse);background-color:var(--calcite-color-inverse);padding:6px 12px}.esri-menu__list{margin:0;padding:0;list-style:none}.esri-menu__list-item{cursor:pointer;border-top:1px solid #adadad4d;border-left:3px solid #0000;padding:.8em 1em}.esri-menu__list-item [class^=esri-icon-],.esri-menu__list-item [class*=" esri-icon-"]{padding-right:2.8px}.esri-menu__list-item:first-child{border-top:none}.esri-menu__list-item--focus,.esri-menu__list-item:hover,.esri-menu__list-item:focus{background-color:var(--calcite-color-foreground-1)}.esri-menu__list-item:active{background-color:var(--calcite-color-foreground-current)}.esri-menu__list-item--active,.esri-menu__list-item--active:hover,.esri-menu__list-item--active:focus{background-color:var(--calcite-color-foreground-1);border-left-color:var(--calcite-color-brand)}.esri-widget__table{border-collapse:collapse;color:var(--calcite-color-text-1);border:none;width:100%;line-height:var(--calcite-font-line-height-relative-tight)}.esri-widget__table tr:nth-child(odd){background-color:var(--calcite-color-transparent)}.esri-widget__table tr:nth-child(2n){background-color:var(--calcite-color-transparent-press)}.esri-widget__table tr a{color:var(--calcite-color-text-2)}.esri-widget__table tr a:hover,.esri-widget__table tr a:focus{color:var(--calcite-color-text-1)}.esri-widget__table tr td,.esri-widget__table tr th{vertical-align:top;word-break:break-word;padding:.5em .7em;font-size:var(--calcite-font-size-sm);font-weight:var(--calcite-font-weight-regular)}.esri-widget__table tr th{text-align:left;border-right:3px solid #0000000d;width:50%}.esri-widget__table tr td{width:50%}.esri-input{color:var(--calcite-color-text-1);background-color:var(--calcite-color-foreground-1);border:1px solid #959595;font-size:var(--calcite-font-size)}.esri-input::-ms-clear{display:none}.esri-input::placeholder{opacity:1;color:var(--calcite-color-text-2)}.esri-input:placeholder-shown{text-overflow:ellipsis}.esri-input[type=text],.esri-input[type=password],.esri-input[type=number]{height:32px;padding:0 .5em}calcite-combobox.esri-input{border:none}.esri-widget__content--empty{text-align:center;color:var(--calcite-color-border-input);flex-flow:column wrap;align-items:center;padding:18px 22px;display:flex}.esri-widget__content--empty h1.esri-widget__heading,.esri-widget__content--empty h2.esri-widget__heading,.esri-widget__content--empty h3.esri-widget__heading,.esri-widget__content--empty h4.esri-widget__heading,.esri-widget__content--empty h5.esri-widget__heading{font-weight:var(--calcite-font-weight-regular)}.esri-widget__content-illustration--empty{width:128px;padding:1rem 0}.esri-widget__content-icon--empty{width:32px;padding:.5rem 0}.esri-select{appearance:none;cursor:pointer;color:var(--calcite-color-text-2);background:var(--calcite-color-foreground-1) url("data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' viewBox='-8 -8 32 32' width='32' height='32'%3E%3Cpath d='M8 11.207l-4-4V5.793l4 4 4-4v1.414z' fill='%23adadad' fillrule='nonzero'/%3E%3C/svg%3E") 100% no-repeat;border:1px solid #959595;border-radius:0;width:100%;height:32px;margin:0;padding:0 .5em;font-family:inherit;font-size:.85em;display:block}.esri-select[disabled]{cursor:auto}.esri-select::-ms-expand{display:none}.esri-disabled a,.esri-disabled [role=menu],.esri-disabled [role=checkbox],.esri-disabled [class^=esri-icon-],.esri-disabled [class*=" esri-icon-"]{color:var(--calcite-color-text-3)}.keynav-mode .esri-widget:focus,.keynav-mode .esri-widget :focus{z-index:1;outline-offset:2px;outline:2px solid #adadad}.esri-widget__loader-animation{border:.15em solid #adadad4d;border-top-color:var(--calcite-color-border-input);border-radius:100%;width:1em;height:1em;font-size:var(--calcite-font-size-md);animation:1.25s linear infinite esri-rotate;display:block;transform:translateZ(0)}:dir(rtl) .esri-widget__table th{text-align:right;border-left:3px solid #0000000d;border-right:none}:dir(rtl) .esri-select{background-position:0}:dir(rtl) .esri-menu__list-item{border-left:none;border-right:3px solid #0000}:dir(rtl) .esri-menu__list-item [class^=esri-icon-],:dir(rtl) .esri-menu__list-item [class*=" esri-icon-"]{padding-left:2px;padding-right:0}:dir(rtl) .esri-menu__list-item--active{border-right-color:var(--calcite-color-brand)}.esri-icon-font-fallback-text{clip:rect(0 0 0 0);width:1px;height:1px;position:absolute;overflow:hidden}.esri-rotating{animation:1.25s linear infinite esri-rotate;transform:translateZ(0)}.esri-clearfix:before,.esri-clearfix:after{content:" ";display:table}.esri-clearfix:after{clear:both}.esri-interactive{cursor:pointer}.esri-hidden{display:none!important}.esri-invisible{visibility:hidden!important}.esri-offscreen{position:absolute;top:-999em;left:-999em}.esri-match-height{flex-direction:column;flex:auto;display:flex;overflow:hidden}@supports (-ms-ime-align: auto){.esri-slider__anchor:focus{outline:1px dotted var(--calcite-color-foreground-current)}}.esri-slider{-webkit-user-select:none;user-select:none;direction:ltr;width:100%;height:100%;display:flex}.esri-disabled{pointer-events:none}.esri-disabled .esri-slider__content,.esri-disabled .esri-slider__min,.esri-disabled .esri-slider__max{opacity:var(--calcite-opacity-light)}.esri-slider--reversed.esri-slider--horizontal{flex-direction:row-reverse}.esri-slider--reversed.esri-slider--vertical{flex-direction:column}.esri-slider--horizontal{flex-direction:row}.esri-slider--horizontal .esri-slider__content{height:auto}.esri-slider--horizontal .esri-slider__track{width:100%;height:2px}.esri-slider--horizontal .esri-slider__segment--interactive:hover{cursor:ew-resize}.esri-slider--horizontal .esri-slider__anchor{width:1px;height:100%}.esri-slider--horizontal .esri-slider__label{text-align:center;margin:0 11px;top:-30px;left:-50px}.esri-slider--horizontal .esri-slider__label-input{text-align:center}.esri-slider--horizontal .esri-slider__max,.esri-slider--horizontal .esri-slider__min{flex:none;width:50px;height:auto;margin:auto}.esri-slider--horizontal .esri-slider__ticks{width:100%;margin:9px 0 0;top:100%;left:0}.esri-slider--horizontal .esri-slider__tick{width:1px;height:5px}.esri-slider--horizontal .esri-slider__tick-label{margin-top:18px}.esri-slider--vertical{flex-direction:column-reverse}.esri-slider--vertical .esri-slider__content{flex-direction:column;width:auto}.esri-slider--vertical .esri-slider__track{flex-direction:column;flex:1 0 0;width:2px;height:100%}.esri-slider--vertical .esri-slider__segment--interactive:hover{cursor:ns-resize}.esri-slider--vertical .esri-slider__anchor{width:100%;height:1px}.esri-slider--vertical .esri-slider__label{text-align:left;top:-10px;left:20px}.esri-slider--vertical .esri-slider__max,.esri-slider--vertical .esri-slider__min{flex:0 0 22px;width:100%;margin:auto}.esri-slider--vertical .esri-slider__ticks{margin:0 0 0 11px;top:0;left:100%}.esri-slider--vertical .esri-slider__tick{width:5px;height:1px}.esri-slider--vertical .esri-slider__tick-label{margin-left:30px}.esri-slider__content{z-index:0;flex:1 0 auto;justify-content:center;align-items:center;margin:auto;line-height:0;display:flex;position:relative}.esri-slider__track{touch-action:none;background-color:var(--calcite-color-border-ghost);display:inline-block;position:relative}.esri-slider__segment{transform-origin:0 0;will-change:transform;touch-action:none;width:100%;height:100%;position:absolute;top:0;left:0}.esri-slider__segment:hover{cursor:pointer}.esri-slider__anchor{touch-action:none;-webkit-user-select:none;user-select:none;background-color:var(--calcite-color-brand);position:absolute}.esri-slider__anchor:focus .esri-slider__thumb,.esri-slider__anchor:focus .esri-slider__label{outline:inherit}.esri-slider__anchor--moving:focus .esri-slider__thumb{cursor:grabbing;border:3px solid var(--calcite-color-brand-press)}.esri-slider__anchor--moving .esri-slider__label:hover,.esri-slider__anchor--moving .esri-slider__label--interactive:hover{cursor:grabbing}.esri-slider__thumb{box-sizing:border-box;z-index:1;touch-action:none;background-color:var(--calcite-color-foreground-2);border:2px solid var(--calcite-color-brand);border-radius:16px;width:16px;height:16px;transition:all .125s ease-in-out;position:absolute;top:-7px;left:-7px}.esri-slider__thumb:hover{cursor:grab;border-width:3px;border-color:var(--calcite-color-brand-press);width:19.2px;height:19.2px;top:-8.6px;left:-8.6px}.esri-slider__label{min-width:80px;line-height:var(--calcite-font-line-height-fixed-xl);position:absolute}.esri-slider__label:hover{cursor:grab}.esri-slider__label--interactive:hover,.esri-slider__max--interactive:hover,.esri-slider__min--interactive:hover{cursor:pointer;text-decoration:underline}.esri-slider__label-input{z-index:1;width:100%;position:relative}.esri-slider__extra-content{display:inline-block}.esri-slider__max,.esri-slider__min{text-align:center;justify-content:center;align-items:center;height:22px;line-height:var(--calcite-font-line-height-fixed-xl);display:flex}.esri-slider__max--interactive:hover,.esri-slider__min--interactive:hover{background-color:var(--calcite-color-foreground-2)}.esri-slider__range-input{text-align:center;width:100%;padding:1px 0}.esri-slider__ticks{z-index:0;height:100%;display:inline-block;position:absolute}.esri-slider__tick{background:var(--calcite-color-foreground-1);position:absolute}.esri-slider__tick-label{width:max-content;position:absolute}:dir(rtl) .esri-slider__label,:dir(rtl) .esri-slider__max,:dir(rtl) .esri-slider__min,:dir(rtl) .esri-slider__tick-label{direction:rtl;unicode-bidi:plaintext}:dir(rtl) .esri-slider__range-input,:dir(rtl) .esri-slider__label-input{unicode-bidi:plaintext}.esri-histogram-range-slider{flex-direction:column;width:100%;height:100%;display:flex;position:relative}.esri-histogram-range-slider .esri-slider .esri-slider__label{display:none;top:24px}.esri-histogram-range-slider .esri-slider__anchor--moving .esri-slider__label{display:inline}.esri-histogram-range-slider .esri-slider{font-size:var(--calcite-font-size-sm)}.esri-histogram-range-slider .esri-slider__content{flex-direction:column-reverse;display:flex}.esri-histogram-range-slider .esri-slider__max{text-align:right;position:absolute;bottom:0;right:0}.esri-histogram-range-slider .esri-slider__max .esri-slider__range-input{float:right;text-align:right}.esri-histogram-range-slider .esri-slider__min{text-align:left;position:absolute;bottom:0;left:0}.esri-histogram-range-slider .esri-slider__min .esri-slider__range-input{text-align:left}.esri-histogram-range-slider .esri-slider--horizontal .esri-slider__max,.esri-histogram-range-slider .esri-slider--horizontal .esri-slider__min{min-width:50%;display:inline}.esri-histogram-range-slider .esri-histogram{align-self:flex-end;display:flex}.esri-histogram-range-slider .esri-histogram__bar{touch-action:none}.esri-histogram-range-slider__slider-container{align-self:flex-end;width:100%;margin-bottom:var(--calcite-font-size-xxl)}.esri-histogram-range-slider__histogram-container{flex-grow:1;width:100%;height:100%;min-height:0;display:flex}.esri-histogram-range-slider__range-type--less-than .esri-slider__segment-0,.esri-histogram-range-slider__range-type--at-most .esri-slider__segment-0,.esri-histogram-range-slider__range-type--greater-than .esri-slider__segment-1,.esri-histogram-range-slider__range-type--at-least .esri-slider__segment-1,.esri-histogram-range-slider__range-type--between .esri-slider__segment-1,.esri-histogram-range-slider__range-type--not-between .esri-slider__segment-1{background-color:var(--calcite-color-brand)}`, d = a(t);
 class c extends s {
   constructor() {
     super(...arguments), this.widget = d(this), this.viewModel = this.widget.viewModel, this.autoDestroyDisabled = !1, this.average = this.widget.average, this.barCreatedFunction = this.widget.barCreatedFunction, this.bins = this.widget.bins, this.dataLineCreatedFunction = this.widget.dataLineCreatedFunction, this.dataLines = this.widget.dataLines, this.excludedBarColor = this.widget.excludedBarColor, this.icon = this.widget.icon, this.includedBarColor = this.widget.includedBarColor, this.label = this.widget.label, this.labelFormatFunction = this.widget.labelFormatFunction, this.max = this.widget.max, this.min = this.widget.min, this.precision = this.widget.precision, this.rangeType = this.widget.rangeType, this.standardDeviation = this.widget.standardDeviation, this.standardDeviationCount = this.widget.standardDeviationCount, this.state = this.viewModel.state, this.values = this.widget.values, this.arcgisPropertyChange = r()("state"), this.arcgisReady = o();
   }
   static {
-    this.properties = { autoDestroyDisabled: 5, average: 9, barCreatedFunction: 0, bins: 0, dataLineCreatedFunction: 0, dataLines: 0, excludedBarColor: 1, icon: 1, includedBarColor: 1, label: 1, labelFormatFunction: 0, max: 9, min: 9, position: 1, precision: 9, rangeType: 1, referenceElement: 1, standardDeviation: 9, standardDeviationCount: 9, state: 3, values: 0 };
+    this.properties = { autoDestroyDisabled: 5, average: 9, barCreatedFunction: 0, bins: 0, dataLineCreatedFunction: 0, dataLines: 0, excludedBarColor: 1, icon: 0, includedBarColor: 1, label: 1, labelFormatFunction: 0, max: 9, min: 9, position: 1, precision: 9, rangeType: 1, referenceElement: 1, standardDeviation: 9, standardDeviationCount: 9, state: 3, values: 0 };
   }
   static {
     this.styles = n;

package/dist/components/arcgis-home/customElement.d.ts

@@ -1,11 +1,16 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { default as HomeViewModel } from '@arcgis/core/widgets/Home/HomeViewModel.js';
+import { default as Viewpoint } from '@arcgis/core/Viewpoint.js';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { nil } from '@arcgis/toolkit/type';
+import { default as MapView } from '@arcgis/core/views/MapView';
+import { default as SceneView } from '@arcgis/core/views/SceneView';
+import { GoToOverride } from '@arcgis/core/widgets/support/types';
+import { useView } from '../../controllers/useView';
+import { IconName } from '../../utils/action-utils';
 
-declare const useHomeViewModel: (component: LitElement & Pick<HomeViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<HomeViewModel>) => HomeViewModel;
 /**
  * The Home component is a button that navigates back to the
  * initial [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)
@@ -29,9 +34,9 @@ declare const useHomeViewModel: (component: LitElement & Pick<HomeViewModel, nev
 export declare class ArcgisHome extends LitElement {
     /**
      * The view associated with the component.
-     *   > **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 ArcgisHome component will be associated with a map or scene component rather than using the `view` property.
+     *   > **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 Home component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: __esri.MapView | __esri.SceneView | nullish;
+    view?: MapView | SceneView;
     /**
      * If true, the component will not be destroyed automatically when it is
      * disconnected from the document. This is useful when you want to move the
@@ -43,21 +48,18 @@ export declare class ArcgisHome extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * This function provides the ability to override either the
-     * [MapView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo) or
-     * [SceneView goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo) methods.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Home-HomeViewModel.html#goToOverride)
+     * Overrides the default `goTo()` method of this component's
+     * associated `MapView` or `SceneView`.
      */
-    goToOverride: nullish | __esri.GoToOverride;
+    goToOverride?: GoToOverride;
     /**
      * Icon which represents the component.
      * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      * @default "home"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon?: string;
+    icon?: IconName;
     /** The component's default label. */
     label?: string;
     /**
@@ -66,7 +68,7 @@ export declare class ArcgisHome extends LitElement {
      * _**Note**: Individual message keys may change between releases._
      */
     messageOverrides?: typeof this.messages._overrides;
-    /** @deprecated since 4.34, use `slot` instead. */
+    /** @deprecated since 4.34, use [`slot`](https://developers.arcgis.com/javascript/latest/building-your-ui/#slots) instead. */
     position?: __esri.UIPosition;
     /**
      * By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
@@ -74,19 +76,17 @@ export declare class ArcgisHome extends LitElement {
      * @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
      */
     referenceElement?: ArcgisReferenceElement | string;
-    /**
-     * The current state of the component.
-     *
-     * @default "disabled"
-     */
-    readonly state: "ready" | "disabled" | "going-home";
+    /** @default "m" */
+    visualScale: HTMLCalciteButtonElement["scale"];
+    /** The current state of the component. */
+    get state(): "disabled" | "going-home" | "ready";
     /**
      * The [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html)
      * to go to when going "home".
      * The initial value is determined in a few different ways:
      *
-     * If no referenceElement is provided, the value is `null`.
-     * Once the referenceElement is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html).
+     * If no `referenceElement` is provided, the value is `null`.
+     * Once the `referenceElement` is ready, the initial viewpoint value is the user-defined [Viewpoint](https://developers.arcgis.com/javascript/latest/api-reference/esri-Viewpoint.html).
      *
      * @example
      *  ```js
@@ -99,9 +99,9 @@ export declare class ArcgisHome extends LitElement {
      * // Sets the Home's viewpoint to that Viewpoint
      * home.viewpoint = vp;
      * ```
-     * @default null
      */
-    viewpoint: __esri.Viewpoint | nullish;
+    get viewpoint(): nil | Viewpoint;
+    set viewpoint(value: nil | Viewpoint);
     /**
      * This function provides the ability to interrupt and cancel the process
      * of navigating back to the initial extent.
@@ -124,10 +124,10 @@ export declare class ArcgisHome extends LitElement {
      * });
      * ```
      */
-    readonly arcgisGo: TargetedEvent<this, __esri.HomeViewModelGoEvent>;
+    readonly arcgisGo: TargetedEvent<this, void>;
     /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "state";
+        name: "state" | "viewpoint";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
@@ -141,4 +141,3 @@ export declare class ArcgisHome extends LitElement {
         cancel: string;
     }>;
 }
-export {};