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

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

@@ -6,10 +6,11 @@ import { default as Directions } from '@arcgis/core/widgets/Directions.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { PropertyValues } from 'lit';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { IconName } from '../../utils/action-utils';
 
-declare const useDirectionsWidget: (component: LitElement & Pick<Directions, "label" | "viewModel" | "icon" | "unit" | "layer" | "headingLevel" | "apiKey" | "goToOverride" | "maxStops" | "searchProperties"> & {
+declare const useDirectionsWidget: (component: LitElement & Pick<Directions, "unit" | "label" | "headingLevel" | "layer" | "viewModel" | "icon" | "goToOverride" | "apiKey" | "maxStops" | "searchProperties"> & {
     state?: unknown;
-    viewModel?: __esri.DirectionsViewModel | undefined;
+    viewModel?: import('@arcgis/core/widgets/Directions/DirectionsViewModel').default | undefined;
     closed?: boolean;
     icon: import('@arcgis/toolkit/type').nil | string;
     label: import('@arcgis/toolkit/type').nil | string;
@@ -38,15 +39,35 @@ declare const useDirectionsWidget: (component: LitElement & Pick<Directions, "la
 export declare class ArcgisDirections 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 ArcgisDirections 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 Directions component will be associated with a map or scene component rather than using the `view` property.
      */
-    view?: __esri.MapView | __esri.SceneView | nullish;
+    view?: import('@arcgis/core/views/MapViewOrSceneView').MapViewOrSceneView | null | undefined;
     /**
      * An authorization string used to access a resource or service.
+     * [API keys](https://developers.arcgis.com/documentation/security-and-authentication/api-key-authentication/) are generated
+     * and managed in the portal. An API key is tied
+     * explicitly to an ArcGIS account; it is also used to monitor service usage.
+     * Setting a fine-grained API key on a specific class overrides the [global API key](https://developers.arcgis.com/javascript/latest/api-reference/esri-config.html#ConfigWithApiKey).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#apiKey)
+     * By default, the following URLs will be used (unless overwritten in the app, or if using different defaults from a portal):
+     *
+     * Geocoding URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`
+     *
+     * Routing URL: `https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World`
+     *
+     * @since 4.19
+     * @example
+     * const directionsWidget = new Directions({
+     *   view: view,
+     *   layer: routeLayer,
+     *   apiKey: "YOUR_API_KEY"
+     * });
+     * // Add the Directions widget to the top right corner of the view
+     * view.ui.add(directionsWidget, {
+     *   position: "top-right"
+     * });
      */
-    apiKey: string | nullish;
+    apiKey: string | null | undefined;
     /**
      * 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
@@ -62,58 +83,96 @@ export declare class ArcgisDirections extends LitElement {
      * [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-Directions.html#goToOverride)
-     *
      * @since 4.33
+     * @see [MapView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html#goTo)
+     * @see [SceneView#goTo()](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-SceneView.html#goTo)
+     * @example
+     * // The following snippet uses Search but can be applied to any
+     * // widgets that support the goToOverride property.
+     * search.goToOverride = function(view, goToParams) {
+     *   goToParams.options = {
+     *     duration: updatedDuration
+     *   };
+     *   return view.goTo(goToParams.target, goToParams.options);
+     * };
      */
-    goToOverride: nullish | __esri.GoToOverride;
+    goToOverride: import('@arcgis/core/widgets/support/types').GoToOverride | null | undefined;
     /**
-     * Indicates the heading level to use for the origin and destination addresses (i.e.
+     * Indicates the heading level to use for the origin and destination addresses (i.e. "380 New York Street").
+     * By default, this is rendered
+     * as a level 2 heading (e.g. `<h2>380 New York Street</h2>`). Depending on the widget's placement
+     * in your app, you may need to adjust this heading for proper semantics. This is
+     * important for meeting accessibility standards.
      *
      * @default 2
+     * @since 4.20
+     * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+     * @example
+     * // address text will render as an <h3>
+     * directions.headingLevel = 3;
      */
-    headingLevel: number;
-    /** @default false */
-    hideLayerDetails: boolean | undefined;
-    /** @default false */
-    hideSaveAsButton: boolean | undefined;
-    /** @default false */
-    hideSaveButton: boolean | undefined;
+    headingLevel: import('@arcgis/core/widgets/support/types').HeadingLevel;
+    /**
+     * Indicates whether to a link to the route layer portal-item (if any) will be displayed. Default is `true`.
+     *
+     * @default true
+     * @since 5.0
+     */
+    hideLayerDetails: boolean;
+    /**
+     * Indicates whether to the Save As button will be displayed. Default is `true`.
+     *
+     * @default true
+     * @since 5.0
+     */
+    hideSaveAsButton: boolean;
+    /**
+     * Indicates whether to the Save button will be displayed. Default is `true`.
+     *
+     * @default true
+     * @since 5.0
+     */
+    hideSaveButton: boolean;
     /**
      * 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 "right"
+     * @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);
     /**
      * The widget's default label.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#label)
+     * @since 4.7
      */
     label: string;
     /**
-     * The most recent route result.
+     * The most recent route result. Returns a [RouteLayerSolveResult](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-types.html#RouteLayerSolveResult)
+     * object containing properties for barriers (if any), stops, and directions.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#lastRoute)
-     *
-     * @default null
+     * @see [RouteLayer#solve()](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html#solve)
      */
-    readonly lastRoute: nullish | __esri.DirectionsLastRoute;
+    readonly lastRoute: import('@arcgis/core/layers/types').RouteLayerSolveResult | null | undefined;
     /**
      * The [RouteLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-RouteLayer.html) associated with the Directions widget.
+     * This property is required.
+     * The RouteLayer contains stops and barriers and will be used to display and solve routes.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#layer)
+     * @since 4.24
      */
-    layer: nullish | RouteLayer;
+    layer: RouteLayer | null | undefined;
     /**
      * The maximum number of stops allowed for routing.
      *
      * @default 50
      */
     maxStops: number;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/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.
@@ -124,28 +183,44 @@ export declare class ArcgisDirections extends LitElement {
     routeLayerItemId?: string;
     /**
      * Controls the default properties used when searching.
+     * Note that the default `searchProperties` differ slightly from
+     * the [Search component](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/).
      *
      * @default { popupEnabled: false, resultGraphicEnabled: false }
      */
-    searchProperties: nullish | __esri.DirectionsSearchProperties;
+    searchProperties: import('@arcgis/core/widgets/Search').SearchProperties | null | undefined;
     /**
      * The current state of the component.
      *
      * @default "disabled"
      */
-    readonly state: "ready" | "disabled" | "error" | "initializing" | "routing" | "unauthenticated";
+    readonly state: import('@arcgis/core/widgets/Directions/DirectionsViewModel').State;
     /**
      * Unit system (imperial, metric) or specific unit used for displaying the distance values.
+     * If not set, the widget will attempt to pick "imperial" or "metric" based on the user's portal settings.
+     *
+     * This property will affect the summary distance as well as distance for each turn-by-turn maneuver.
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Directions.html#unit)
+     * @since 4.25
+     * @example
+     * // Display distances in nautical miles.
+     * const directions = new Directions({
+     *   unit: "nautical-miles",
+     *   layer: routeLayer,
+     *   view: view
+     * });
      */
-    unit: __esri.SystemOrLengthUnit;
+    unit: import('@arcgis/core/core/units').SystemOrLengthUnit;
     /** @default false */
     useDefaultRouteLayer: boolean;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
     getDirections(): Promise<__esri.RouteLayerSolveResult>;
     save(): Promise<__esri.PortalItem>;
+    /**
+     * @param portalItem
+     * @param options
+     */
     saveAs(portalItem: __esri.PortalItem, options: {
         folder: __esri.PortalFolder;
     }): Promise<__esri.PortalItem>;
@@ -156,5 +231,9 @@ export declare class ArcgisDirections extends LitElement {
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    private widget: Directions;
+    readonly _setterTypes: {
+        icon?: IconName;
+    };
 }
 export {};

package/dist/components/arcgis-directions/customElement.js

@@ -9,14 +9,14 @@ import { d as p } from "../../chunks/component-utils.js";
 import { css as h } 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.100 */
 const m = h`.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}.esri-widget--panel{min-width:300px;min-height:32px;padding:var(--esri-widget-padding);transition:max-height .25s ease-in-out;overflow-y:auto}.esri-search{flex-flow:row;justify-content:center;align-items:center;width:240px;display:flex}.esri-search__dropdown{--calcite-color-border-1: var(--calcite-color-border-input);--calcite-dropdown-width: 240px;width:31px}.esri-search__autocomplete{flex:1}.esri-search__container{flex-flow:row;flex:1 0 100%;align-items:stretch;display:flex;position:relative}.esri-search__form{flex-flow:row;flex:1 0;align-items:stretch;margin:0;padding:0;display:flex}.esri-search-result-renderer calcite-block,.esri-search-result-renderer calcite-block[expanded]{margin-block:0;border:0;margin-block-start:var(--calcite-spacing-md)}.esri-search__submit-button{position:absolute;margin:-1px;border-width:0;padding:0;width:1px;height:1px;overflow:hidden;white-space:nowrap;clip:rect(0,0,0,0)}:host{display:flex}.esri-directions calcite-flow-item{--calcite-color-background: var(--calcite-color-foreground-1)}.esri-directios calcite-flow{z-index:1;position:relative}.esri-directions__accordion{--calcite-accordion-border-color: transparent}.esri-directions__stop-container{--calcite-list-border-color: transparent;--calcite-list-background-color-hover: var(--calcite-color-foreground-1);margin-block-start:var(--calcite-spacing-sm);display:flex}.esri-directions__stop-list{flex:auto}.esri-directions__action-container{margin-top:var(--calcite-spacing-sm);margin-inline:var(--calcite-spacing-sm);display:flex}.esri-directions__add-stop-button{margin-inline-end:var(--calcite-spacing-xs)}.esri-directions__departure-time{--calcite-label-margin-bottom: 0}.esri-directions__departure-time-options{margin-bottom:var(--calcite-spacing-sm);display:flex}.esri-directions__departure-time-options calcite-input-date-picker,.esri-directions__departure-time-options calcite-input-time-picker{flex:1}.esri-directions__directions-header{line-height:var(--calcite-font-line-height-relative-snug);color:var(--calcite-color-text-3);font-size:var(--calcite-font-size--2);flex-direction:column;display:flex}.esri-directions__header-stops{gap:var(--calcite-spacing-base) var(--calcite-spacing-xxs);font-size:var(--calcite-font-size--1);grid-template-columns:auto 1fr;margin-block-end:var(--calcite-spacing-base);display:grid}.esri-directions__directions-header-stop-name{text-overflow:ellipsis;color:var(--calcite-color-text-1);font-weight:var(--calcite-font-weight-medium);overflow:hidden}.esri-directions__edit-footer{border-top:var(--calcite-border-width-sm) solid var(--calcite-color-border-3);padding:var(--calcite-spacing-md)}.esri-directions__edit-toolbar-container{margin:var(--calcite-spacing-md);flex-flow:column;align-items:flex-start;display:flex}.esri-directions__edit-toolbar{border-width:var(--calcite-border-width-sm);border-radius:var(--calcite-corner-radius-round);border-style:solid;border-color:var(--calcite-color-foreground-3);flex-flow:row;display:flex;overflow:hidden}.esri-directions__solve-route{border-inline-start:solid var(--calcite-border-width-sm) var(--calcite-color-border-3)}.esri-directions__flex-column{flex-direction:column;display:flex}.esri-directions__flex-row{flex-direction:row;display:flex}.esri-directions__label-emphasize{font-weight:var(--calcite-font-weight-medium)}.esri-directions__label-no-bottom-margin{--calcite-label-margin-bottom: 0}.esri-directions__margin-inline-medium{margin-inline:var(--calcite-spacing-md)}.esri-directions__padding-medium{padding:var(--calcite-spacing-md)}.esri-directions__route-item{margin:var(--calcite-spacing-md);border:var(--calcite-border-width-sm) solid var(--calcite-color-border-3);border-radius:var(--calcite-corner-radius-round);flex:1 0 auto;width:auto;margin-block-start:var(--calcite-spacing-sm);display:flex;overflow:hidden}.esri-directions__route-item-button{background-color:var(--calcite-color-foreground-1);padding:var(--calcite-spacing-sm) var(--calcite-spacing-md);text-align:unset;font-family:var(--calcite-font-family);border:none;flex:1 0 auto;align-items:center;margin:0;padding-inline-end:var(--calcite-spacing-xs);display:flex}.esri-directions__route-item-button:hover{background-color:var(--calcite-color-foreground-2);cursor:pointer}.esri-directions__route-item-button-content{flex-direction:column;flex:1 0 auto;display:flex}.esri-directions__route-item-label{line-height:var(--calcite-font-line-height-relative-snug);color:var(--calcite-color-text-1);font-size:var(--calcite-font-size-md);font-weight:var(--calcite-font-weight-medium)}.esri-directions__route-item-description{line-height:var(--calcite-font-line-height-relative-snug);color:var(--calcite-color-text-3);font-size:var(--calcite-font-size--2);font-weight:var(--calcite-font-weight-regular)}.esri-directions__optimize-section{--calcite-block-section-header-text-color: var(--calcite-color-text-1)}.esri-directions__optimize-switches{cursor:pointer;margin-inline-start:var(--calcite-spacing-md)}.esri-directions__panel-header-action{align-items:center;display:flex}.esri-directions__primary-flow-item{flex-flow:column;flex:auto;justify-content:flex-start;align-items:stretch;display:flex;overflow:visible}.esri-directions__primary-footer{border-top:var(--calcite-border-width-sm) solid var(--calcite-color-border-3);padding:var(--calcite-spacing-md)}.esri-directions__primary-footer-centered{border-top:var(--calcite-border-width-sm) solid var(--calcite-color-border-3);padding:var(--calcite-spacing-md);flex-flow:column wrap;align-items:center;display:flex}.esri-directions__primary-footer-loader{--calcite-loader-spacing: 0;margin-top:var(--calcite-spacing-md);margin-bottom:var(--calcite-spacing-md)}.esri-directions__save-error{flex-direction:column;align-items:center;display:flex}.esri-directions__save-error-icon{margin-top:calc(var(--calcite-spacing-lg) * 3);margin-bottom:var(--calcite-spacing-xxs);color:var(--calcite-color-status-danger)}.esri-directions__save-error-label{margin-inline:var(--calcite-spacing-sm)}.esri-directions__save-process-loader{padding-top:calc(var(--calcite-spacing-lg) * 3);padding-bottom:calc(var(--calcite-spacing-lg) * 2)}.esri-directions__selected-feature-container{margin-inline:var(--calcite-spacing-md);height:100px;overflow-y:auto}.esri-directions__separator{margin:var(--calcite-spacing-md) 0;background-color:var(--calcite-color-border-3);height:var(--calcite-border-width-sm)}.esri-directions__stop-item .esri-search{width:auto}.esri-directions__print-document{box-sizing:border-box;z-index:var(--calcite-z-index-overlay);background-color:var(--calcite-color-foreground-1);width:100%;height:100%;position:fixed;top:0;left:0;overflow-y:scroll}.esri-directions__print-body{padding-inline:var(--calcite-spacing-md);flex-direction:column;display:flex}.esri-directions__print-header{margin-bottom:var(--calcite-spacing-lg);border-block-end:var(--calcite-border-width-sm) solid var(--calcite-color-border-3);align-items:center;display:flex}.esri-directions__print-header-label{padding-block:var(--calcite-spacing-sm);line-height:var(--calcite-font-line-height-relative-snug);color:var(--calcite-color-text-3);font-size:var(--calcite-font-size--2);font-weight:var(--calcite-font-weight-bold);flex-direction:column;flex-grow:1;display:flex}.esri-directions__print-section{margin-top:var(--calcite-spacing-md);flex-direction:column;display:flex}.esri-directions__print-header-buttons{padding-inline-end:var(--calcite-spacing-md);display:flex}.esri-directions__print--avoid-page-break{break-inside:avoid}@media print{body.esri-directions__print-media{margin:0;padding:0}body.esri-directions__print-media>:not(div.esri-directions__print-document){display:none}}@media print{.esri-directions__print-document{height:auto;position:static;overflow:visible}.esri-directions__print--hide-on-print{display:none}}`, f = g(n), t = "map-components:arcgis-directions";
 class _ extends l {
   constructor() {
     super(...arguments), this.widget = f(this), this.viewModel = this.widget.viewModel, this.view = this.widget.view, this.apiKey = this.widget.apiKey, this.autoDestroyDisabled = !1, this.goToOverride = this.widget.goToOverride, this.headingLevel = this.widget.headingLevel, this.hideLayerDetails = this.widget.visibleElements.layerDetails, this.hideSaveAsButton = this.widget.visibleElements.saveAsButton, this.hideSaveButton = this.widget.visibleElements.saveButton, this.icon = this.widget.icon, this.label = this.widget.label, this.lastRoute = this.widget.lastRoute, this.layer = this.widget.layer, this.maxStops = this.widget.maxStops, this.searchProperties = this.widget.searchProperties, this.state = this.viewModel.state, this.unit = this.widget.unit, this.useDefaultRouteLayer = !1, this.arcgisPropertyChange = s()("lastRoute", "state"), this.arcgisReady = d();
   }
   static {
-    this.properties = { view: 0, apiKey: 1, autoDestroyDisabled: 5, goToOverride: 0, headingLevel: 9, hideLayerDetails: 5, hideSaveAsButton: 5, hideSaveButton: 5, icon: 1, label: 1, lastRoute: 0, layer: 0, maxStops: 9, position: 1, referenceElement: 1, routeLayerItemId: 1, searchProperties: 0, state: 3, unit: 1, useDefaultRouteLayer: 5 };
+    this.properties = { view: 0, apiKey: 1, autoDestroyDisabled: 5, goToOverride: 0, headingLevel: 9, hideLayerDetails: 5, hideSaveAsButton: 5, hideSaveButton: 5, icon: 0, label: 1, lastRoute: 0, layer: 0, maxStops: 9, position: 1, referenceElement: 1, routeLayerItemId: 1, searchProperties: 0, state: 3, unit: 1, useDefaultRouteLayer: 5 };
   }
   static {
     this.styles = m;

package/dist/components/arcgis-distance-measurement-2d/DistanceMeasurement2dViewModel.d.ts

@@ -0,0 +1,39 @@
+import { default as DistanceMeasurementAnalysis } from '@arcgis/core/analysis/DistanceMeasurementAnalysis.js';
+import { default as MapView } from '@arcgis/core/views/MapView.js';
+import { AnalysisViewModel } from '../../support/AnalysisViewModel';
+import { Length, MeasurementState, MeasurementValue, SystemOrLengthUnit } from '../../support/measurementUtils';
+import { MeasurementMode } from '@arcgis/core/views/analysis/types';
+export interface Measurement {
+    readonly mode: MeasurementMode;
+    readonly length: MeasurementValue<Length>;
+}
+export type State = Exclude<MeasurementState, "unsupported">;
+export default class DistanceMeasurement2dViewModel extends AnalysisViewModel<MapView, DistanceMeasurementAnalysis> {
+    initialize(): void;
+    get state(): MeasurementState;
+    /**
+     * The current measurement.
+     */
+    get measurement(): Measurement;
+    /**
+     * List of unit systems (imperial, metric) and specific units for displaying the distance values.
+     */
+    get unitOptions(): SystemOrLengthUnit[];
+    set unitOptions(units: SystemOrLengthUnit[] | undefined);
+    private _userUnitOptions?;
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the distance values.
+     */
+    get unit(): SystemOrLengthUnit;
+    set unit(unit: SystemOrLengthUnit | undefined);
+    private _userUnit?;
+    private get _defaultUnit();
+    place(options?: {
+        signal?: AbortSignal;
+    }): Promise<void>;
+    protected clearAnalysis(): void;
+    protected readonly supportedViewType = "2d";
+    protected readonly unsupportedErrorMessage = "The Distance Measurement 2D component is only supported in 2D views.";
+    protected constructAnalysis(): DistanceMeasurementAnalysis;
+    protected shouldForceInteractive: boolean;
+}

package/dist/components/arcgis-distance-measurement-2d/customElement.d.ts

@@ -1,33 +1,20 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
+import { PublicLitElement as LitElement, JsxNode, TargetedEvent } from '@arcgis/lumina';
 import { Use } from '@arcgis/lumina/controllers';
-import { default as DistanceMeasurement2D } from '@arcgis/core/widgets/DistanceMeasurement2D.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { default as DistanceMeasurement2dViewModel } from './DistanceMeasurement2dViewModel';
 
-declare const useDistanceMeasurement2dWidget: (component: LitElement & Pick<DistanceMeasurement2D, "label" | "viewModel" | "icon" | "snappingOptions" | "unit" | "unitOptions"> & {
-    state?: unknown;
-    viewModel?: __esri.DistanceMeasurement2DViewModel | undefined;
-    closed?: boolean;
-    icon: import('@arcgis/toolkit/type').nil | string;
-    label: import('@arcgis/toolkit/type').nil | string;
-    referenceElement?: ArcgisReferenceElement | string;
-    position?: __esri.UIPosition;
-    arcgisReady: import('@arcgis/lumina').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | nullish;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}) => DistanceMeasurement2D;
+declare const useViewModel: (component: LitElement & Pick<DistanceMeasurement2dViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<DistanceMeasurement2dViewModel>) => DistanceMeasurement2dViewModel;
 /**
- * The Distance Measurement 2D component calculates and displays the distance between two or more points in a [MapView](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-MapView.html).
+ * The Distance Measurement 2D component can be added to a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)
+ * component to calculate and display the length of a polyline.
+ *
+ * How distances are computed depends on the scene's spatial reference.
+ *
+ * In **geographic coordinate systems** (GCS), and in **Web Mercator**, lengths are computed geodetically, taking into consideration the curvature of the planet.
+ *
+ * In **projected coordinate systems** (PCS), apart from Web Mercator, lengths are computed in a Euclidean manner (in their respective PCS).
  *
  * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-distance-measurement-2d/)
  *
@@ -36,9 +23,49 @@ declare const useDistanceMeasurement2dWidget: (component: LitElement & Pick<Dist
 export declare class ArcgisDistanceMeasurement2d 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 ArcgisDistanceMeasurement2d 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 Distance Measurement 2D component will be associated with a map or scene component rather than using the `view` property.
+     */
+    view?: import('@arcgis/core/views/MapView').default | undefined;
+    /**
+     * The [DistanceMeasurementAnalysis](https://developers.arcgis.com/javascript/latest/api-reference/esri-analysis-DistanceMeasurementAnalysis.html)
+     * created or modified by the component.
+     *
+     * When connecting the Distance Measurement 2D component to the [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/)
+     * component, it automatically creates an empty analysis and adds it to the Map's
+     * [analyses](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#analyses) collection.
+     * Whenever the component is destroyed, the analysis is automatically removed from the collection.
+     *
+     * Alternatively, a programmatically created analysis can be provided to the component.
+     * Then, the application itself needs to add it to and later remove it from the Map's analyses collection.
+     *
+     * ```js
+     * // Create the analysis.
+     * const distanceMeasurementAnalysis = new DistanceMeasurementAnalysis({
+     *   geometry: new Polyline({
+     *     paths: [
+     *       [
+     *         [-118.25, 34.05], // Los Angeles
+     *         [-77.02, 38.90], // Washington, D.C.
+     *       ]
+     *     ],
+     *   }),
+     *   unit: "miles", // Display length in miles.
+     * });
+     *
+     * // Get the Map and measurement component and wait until they are ready.
+     * const viewElement = document.querySelector("arcgis-map");
+     * await viewElement.viewOnReady();
+     * const distanceMeasurement2d = document.querySelector("arcgis-distance-measurement-2d");
+     * await distanceMeasurement2d.componentOnReady();
+     *
+     * // Add the analysis to the Map component.
+     * viewElement.analyses.add(distanceMeasurementAnalysis);
+     *
+     * // Connect the analysis to the measurement component:
+     * distanceMeasurement2d.analysis = distanceMeasurementAnalysis;
+     * ```
      */
-    view?: __esri.MapView | nullish;
+    analysis: import('@arcgis/core/analysis/DistanceMeasurementAnalysis').default;
     /**
      * 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
@@ -50,20 +77,22 @@ export declare class ArcgisDistanceMeasurement2d extends LitElement {
      */
     autoDestroyDisabled: boolean;
     /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
+     * Whether to hide the analysis visualization in the view.
      *
-     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
-     * @default "measure-line"
+     * @default false
      */
-    icon: string;
+    hideVisualization: boolean;
     /**
-     * The widget's default label.
+     * Icon which represents the component.
+     * Typically used when the component is controlled by another component (e.g. by the Expand component).
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#label)
+     * @default "measure-line"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    label: string;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
+    icon?: HTMLCalciteIconElement["icon"];
+    /** The component's default label. */
+    label?: string;
+    /** @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.
@@ -72,30 +101,26 @@ export declare class ArcgisDistanceMeasurement2d extends LitElement {
      */
     referenceElement?: ArcgisReferenceElement | string;
     /**
-     * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html) for sketching.
+     * The component's state. The values mean the following:
      *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#snappingOptions)
+     * * `disabled` -  not ready yet
+     * * `ready` - ready for measuring
+     * * `measuring` - currently measuring
+     * * `measured` - measuring has finished
      */
-    snappingOptions: __esri.SnappingOptions;
+    readonly state: import('../../support/measurementUtils').MeasurementState;
     /**
-     * The current state of the component.
-     *
-     * @default "disabled"
+     * Unit system (imperial, metric) or specific unit used for displaying the distance values. Possible values are listed in
+     * [unitOptions](#unitOptions).
      */
-    readonly state: "ready" | "disabled" | "measuring" | "measured";
+    unit: import('@arcgis/core/core/units').SystemOrLengthUnit;
     /**
-     * Unit system (imperial, metric) or specific unit used for displaying the distance values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unit)
-     */
-    unit: __esri.SystemOrLengthUnit;
-    /**
-     * List of available units and unit systems (imperial, metric) for displaying the distance values.
-     *
-     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-DistanceMeasurement2D.html#unitOptions)
+     * List of available units and unit systems (imperial, metric) that are shown in the component's dropdown.
+     * By default, the following units are included: `metric`, `imperial`, `inches`, `feet`, `us-feet`, `yards`, `miles`, `nautical-miles`, `meters`, `kilometers`.
+     * Possible [unit](#unit) values can only be a subset of this list.
      */
-    unitOptions: __esri.SystemOrLengthUnit[];
-    /** Clear the current measurement. */
+    unitOptions: import('@arcgis/core/core/units').SystemOrLengthUnit[];
+    /** Clears the current measurement. */
     clear(): Promise<void>;
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
@@ -103,7 +128,7 @@ export declare class ArcgisDistanceMeasurement2d extends LitElement {
     start(): Promise<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: "analysis" | "state";
     }>;
     /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;