@arcgis/map-components 4.33.0-next.12 → 4.33.0-next.120

package/dist/components/arcgis-elevation-profile/customElement.d.ts

@@ -1,85 +1,166 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
+import { Use } from '@arcgis/lumina/controllers';
 import { Nil } from '@arcgis/components-utils';
 import { default as ElevationProfile } from '@arcgis/core/widgets/ElevationProfile.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useElevationProfileWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<ElevationProfile, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+declare const useElevationProfileWidget: (component: LitElement & Pick<ElevationProfile, never> & {
     state?: unknown;
     viewModel?: __esri.ElevationProfileViewModel | undefined;
+    closed?: boolean;
     icon: Nil | string;
     label: Nil | string;
     referenceElement: ArcgisReferenceElement | Nil | string;
     position: __esri.UIPosition;
-    arcgisReady: import('@arcgis/components-controllers').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
+    arcgisReady: import('@arcgis/lumina').EventEmitter;
+    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
         name: string;
     }> | undefined;
     el: HTMLElement & {
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | Nil;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
 }, options?: {
     editConstructorProperties(props: __esri.ElevationProfileProperties | undefined): __esri.ElevationProfileProperties | Promise<__esri.ElevationProfileProperties | undefined> | undefined;
 } | undefined) => ElevationProfile;
-/** The ElevationProfile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).
+/**
+ * The Elevation Profile component is used to generate and display an elevation profile from an [input line graphic](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input).
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/)
  */
 export declare class ArcgisElevationProfile extends LitElement {
     /**
      * 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
      * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the \`destroy\` method when you are done to prevent
-     * memory leaks.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-elevation-profile/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * Units which have been selected according to the magnitude of the elevations and distances
+     * that are to be displayed in the widget, according to the selected unit or unit system.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#effectiveUnits)
+     */
     readonly effectiveUnits: __esri.EffectiveUnits;
+    /** @default false */
     hideChart: boolean;
+    /** @default false */
     hideClearButton: boolean;
+    /** @default false */
     hideLegend: boolean;
+    /** @default false */
     hideSelectButton: boolean;
+    /** @default false */
     hideSettingsButton: boolean;
+    /** @default false */
     hideSketchButton: boolean;
+    /** @default false */
     hideUniformChartScalingToggle: boolean;
+    /** @default false */
     hideUnitSelector: boolean;
+    /**
+     * Whether the graphic used as [input](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)
+     * is highlighted.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#highlightEnabled)
+     *
+     * @default true
+     */
     highlightEnabled: boolean;
+    /**
+     * The position, in the range [0, 1], being hovered in the graph.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#hoveredChartPosition)
+     */
     hoveredChartPosition: number | nullish;
     /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     * Icon which represents the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#icon)
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "altitude"
      */
     icon: string;
+    /**
+     * The input line graphic along which elevation will be queried in order to generate an elevation profile.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#input)
+     *
+     * @default null
+     */
     input: nullish | __esri.Graphic;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#label)
+     */
     label: string;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
+    /**
+     * Collection of elevation profile lines which are to be generated and displayed in the widget's
+     * chart.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#profiles)
+     */
     profiles: __esri.Collection<__esri.ElevationProfileLineGround | __esri.ElevationProfileLineInput | __esri.ElevationProfileLineQuery | __esri.ElevationProfileLineView>;
+    /**
+     * The progress, between 0 and 1 of generating all the configured elevation
+     * profiles.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#progress)
+     */
     readonly progress: number;
     referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * The current state of the view model that can be used for rendering the UI
+     * of the widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#state)
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "selected" | "disabled" | "creating" | "created" | "selecting";
+    /**
+     * Whether the chart should use a uniform scale for the X and Y axes.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile-ElevationProfileViewModel.html#uniformChartScaling)
+     *
+     * @default false
+     */
     uniformChartScaling: boolean;
+    /**
+     * Unit system (imperial, metric) or specific unit used for displaying the elevation and distance values.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unit)
+     */
     unit: __esri.SystemOrLengthUnit;
+    /**
+     * List of available units and unit systems (imperial, metric) for displaying the elevation and distance values.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ElevationProfile.html#unitOptions)
+     */
     unitOptions: __esri.SystemOrLengthUnit[];
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     start(): Promise<void>;
     stop(): Promise<void>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
-        name: "input" | "state" | "progress" | "effectiveUnits";
+        name: "state" | "input" | "progress" | "effectiveUnits";
     }>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, undefined>;
 }
 export {};

package/dist/components/arcgis-elevation-profile/customElement.js

@@ -1,12 +1,12 @@
 import { c as t } from "../../chunks/runtime.js";
-import { usePropertyChange as i } from "@arcgis/components-controllers";
+import { usePropertyChange as i } from "@arcgis/lumina/controllers";
 import e from "@arcgis/core/widgets/ElevationProfile.js";
 import { LitElement as s, createEvent as o, noShadowRoot as h } from "@arcgis/lumina";
 import { m as n } from "../../chunks/useWidget.js";
 import { css as l } from "@lit/reactive-element/css-tag.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.12 */
+v4.33.0-next.120 */
 const r = l`@layer{arcgis-elevation-profile{display:block}}`, a = n(e);
 class d extends s {
   constructor() {
@@ -21,9 +21,6 @@ class d extends s {
   static {
     this.styles = r;
   }
-  // #endregion
-  // #region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }

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

@@ -1,78 +1,166 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
+import { Use } from '@arcgis/lumina/controllers';
 import { Nil } from '@arcgis/components-utils';
 import { default as Expand } from '@arcgis/core/widgets/Expand.js';
-import { PublicLitElement as LitElement, ToElement, TargetedEvent } from '@arcgis/lumina';
+import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useExpandWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
-    manager: import('@arcgis/components-controllers').ControllerManager;
-    el: HTMLElement;
-    autoDestroyDisabled?: boolean;
-    destroy?: () => Promise<void>;
-} & Pick<Expand, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
+declare const useExpandWidget: (component: LitElement & Pick<Expand, never> & {
     state?: unknown;
     viewModel?: __esri.ExpandViewModel | undefined;
+    closed?: boolean;
     icon: Nil | string;
     label: Nil | string;
     referenceElement: ArcgisReferenceElement | Nil | string;
     position: __esri.UIPosition;
-    arcgisReady: import('@arcgis/components-controllers').EventEmitter;
-    arcgisPropertyChange: import('@arcgis/components-controllers').EventEmitter<{
+    arcgisReady: import('@arcgis/lumina').EventEmitter;
+    arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
         name: string;
     }> | undefined;
     el: HTMLElement & {
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView | Nil;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
 }, options?: {
     editConstructorProperties(props: __esri.ExpandProperties | undefined): __esri.ExpandProperties | Promise<__esri.ExpandProperties | undefined> | undefined;
 } | undefined) => Expand;
-/** Expand component acts as a clickable button for opening content.
+/**
+ * Expand component acts as a clickable button for opening content.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/)
  */
 export declare class ArcgisExpand extends LitElement {
+    /**
+     * Automatically collapses the expand widget instance when the view's
+     * viewpoint updates.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#autoCollapse)
+     *
+     * @default false
+     */
     autoCollapse: boolean;
     /**
      * 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
      * component to a different place on the page, or temporarily hide it. If this
-     * is set, make sure to call the \`destroy\` method when you are done to prevent
-     * memory leaks.
+     * is set, make sure to call the [destroy](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-expand/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#closeOnEsc)
+     *
+     * @default true
+     */
     closeOnEsc: boolean | Function;
+    /**
+     * Calcite icon used to style the Expand button when the [content](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#content) can be collapsed.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseIcon)
+     *
+     * @default "chevrons-right"
+     */
     collapseIcon: string;
+    /**
+     * Tooltip to display to indicate Expand widget can be collapsed.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#collapseTooltip)
+     *
+     * @default "Collapse" (English locale)
+     */
     collapseTooltip: string;
+    /**
+     * Calcite icon used when the widget is collapsed.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandIcon)
+     *
+     * @default "chevrons-left"
+     */
     expandIcon: string | nullish;
+    /**
+     * Tooltip to display to indicate Expand widget can be expanded.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expandTooltip)
+     *
+     * @default "Expand" (English locale)
+     */
     expandTooltip: string;
+    /**
+     * Indicates whether the widget is currently expanded or not.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#expanded)
+     *
+     * @default false
+     */
     expanded: boolean;
+    /**
+     * Disables focus trapping within the expand widget.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#focusTrapDisabled)
+     *
+     * @deprecated since 4.33. Use [`focusTrapDisabled`](#focusTrapDisabled) instead.
+     * @default false
+     */
     focusTrapEnabled: boolean;
+    /**
+     * Disables focus trapping within the expand component.
+     *
+     * @default false
+     */
+    focusTrapDisabled: boolean;
+    /**
+     * This value associates two or more Expand widget instances with each other, allowing one
+     * instance to auto collapse when another instance in the same group is expanded.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#group)
+     */
     group: string | nullish;
-    /** @private */
     /**
-     * Icon which represents the component.
-     * Typically used when the component is controlled by another component (e.g. by the Expand component).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     * A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#iconNumber)
      */
-    icon: string | nullish;
     iconNumber: number;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#label)
+     */
     label: string;
+    /**
+     * The mode in which the widget displays.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#mode)
+     *
+     * @default "auto"
+     */
     mode: "auto" | "floating" | "drawer";
+    /**
+     * The placement used by the [calcite popover](https://developers.arcgis.com/calcite-design-system/components/popover/) when the widget is expanded.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Expand.html#placement)
+     *
+     * @default null
+     */
     placement: nullish | "left" | "right" | "top" | "bottom" | "auto" | "auto-start" | "auto-end" | "top-start" | "top-end" | "bottom-start" | "bottom-end" | "right-start" | "right-end" | "left-start" | "left-end" | "leading-start" | "leading" | "leading-end" | "trailing-end" | "trailing" | "trailing-start";
+    /** @default "top-right" */
     position: __esri.UIPosition;
     referenceElement: ArcgisReferenceElement | Nil | string;
     collapse(): Promise<void>;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     expand(): Promise<void>;
     toggle(): Promise<void>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, undefined>;
 }
 export {};

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

@@ -1,33 +1,28 @@
 import { c as t } from "../../chunks/runtime.js";
 import e from "@arcgis/core/widgets/Expand.js";
-import { LitElement as i, createEvent as s, noShadowRoot as o } from "@arcgis/lumina";
+import { LitElement as s, createEvent as i, noShadowRoot as o } from "@arcgis/lumina";
 import { m as a } from "../../chunks/useWidget.js";
 import { css as n } from "@lit/reactive-element/css-tag.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.33/esri/copyright.txt for details.
-v4.33.0-next.12 */
-const c = n`@layer{arcgis-expand{display:flex;pointer-events:auto}arcgis-expand>.esri-expand__content--expanded{background-color:var(--calcite-color-background)}}`, d = a(e);
-class l extends i {
-  // #endregion
-  // #region Lifecycle
+v4.33.0-next.120 */
+const d = n`@layer{arcgis-expand{display:flex;pointer-events:auto}arcgis-expand>.esri-expand__content--expanded{background-color:var(--calcite-color-background)}}`, c = a(e);
+class l extends s {
   constructor() {
-    super(), this.widget = d(this), this.viewModel = this.widget.viewModel, this.autoCollapse = this.widget.autoCollapse, this.autoDestroyDisabled = !1, this.closeOnEsc = this.widget.closeOnEsc, this.collapseIcon = this.widget.collapseIcon, this.collapseTooltip = this.widget.collapseTooltip, this.content = this.widget.content, this.expandIcon = this.widget.expandIcon, this.expandTooltip = this.widget.expandTooltip, this.expanded = this.widget.expanded, this.focusTrapEnabled = this.widget.focusTrapDisabled, this.group = this.widget.group, this.icon = this.widget.icon, this.iconNumber = this.widget.iconNumber, this.label = this.widget.label, this.mode = this.widget.mode, this.placement = this.widget.placement, this.position = "top-right", this.arcgisReady = s(), this.content ??= document.createElement("div");
+    super(), this.widget = c(this), this.viewModel = this.widget.viewModel, this.autoCollapse = this.widget.autoCollapse, this.autoDestroyDisabled = !1, this.closeOnEsc = this.widget.closeOnEsc, this.collapseIcon = this.widget.collapseIcon, this.collapseTooltip = this.widget.collapseTooltip, this.content = this.widget.content, this.expandIcon = this.widget.expandIcon, this.expandTooltip = this.widget.expandTooltip, this.expanded = this.widget.expanded, this.focusTrapEnabled = this.widget.focusTrapDisabled, this.focusTrapDisabled = this.widget.focusTrapDisabled, this.group = this.widget.group, this.icon = this.widget.icon, this.iconNumber = this.widget.iconNumber, this.label = this.widget.label, this.mode = this.widget.mode, this.placement = this.widget.placement, this.position = "top-right", this.arcgisReady = i(), this.content ??= document.createElement("div");
   }
   static {
-    this.properties = { autoCollapse: 5, autoDestroyDisabled: 5, closeOnEsc: 5, collapseIcon: 1, collapseTooltip: 1, content: 1, expandIcon: 1, expandTooltip: 1, expanded: 7, focusTrapEnabled: 5, group: 1, icon: 1, iconNumber: 9, label: 1, mode: 1, placement: 1, position: 1, referenceElement: 1 };
+    this.properties = { autoCollapse: 5, autoDestroyDisabled: 5, closeOnEsc: 5, collapseIcon: 1, collapseTooltip: 1, content: 1, expandIcon: 1, expandTooltip: 1, expanded: 7, focusTrapEnabled: 5, focusTrapDisabled: 5, group: 1, icon: 1, iconNumber: 9, label: 1, mode: 1, placement: 1, position: 1, referenceElement: 1 };
   }
   static {
     this.shadowRootOptions = o;
   }
   static {
-    this.styles = c;
+    this.styles = d;
   }
-  // #endregion
-  // #region Public Methods
   async collapse() {
     this.widget?.collapse();
   }
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }