@arcgis/map-components 4.33.0-next.98 → 4.33.0

package/dist/components/arcgis-floor-filter/customElement.d.ts

@@ -1,17 +1,17 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { Nil } from '@arcgis/components-utils';
 import { default as FloorFilter } from '@arcgis/core/widgets/FloorFilter.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useFloorFilterWidget: (component: LitElement & Pick<FloorFilter, never> & {
+declare const useFloorFilterWidget: (component: LitElement & Pick<FloorFilter, "icon" | "label" | "viewModel" | "headingLevel" | "facility" | "level" | "longNames" | "site"> & {
     state?: unknown;
     viewModel?: __esri.FloorFilterViewModel | undefined;
-    icon: Nil | string;
-    label: Nil | string;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    closed?: boolean;
+    icon: import('@arcgis/components-utils').Nil | string;
+    label: import('@arcgis/components-utils').Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
     position: __esri.UIPosition;
     arcgisReady: import('@arcgis/lumina').EventEmitter;
     arcgisPropertyChange: import('@arcgis/lumina').EventEmitter<{
@@ -21,42 +21,85 @@ declare const useFloorFilterWidget: (component: LitElement & Pick<FloorFilter, n
         childElem?: HTMLElement & {
             ownedBy?: HTMLElement;
         };
-        view?: __esri.MapView | __esri.SceneView | Nil;
+        view?: __esri.LinkChartView | __esri.MapView | __esri.SceneView;
     };
     autoDestroyDisabled: boolean;
     destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.FloorFilterProperties | undefined): __esri.FloorFilterProperties | Promise<__esri.FloorFilterProperties | undefined> | undefined;
-} | undefined) => FloorFilter;
-/** The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.
+}) => FloorFilter;
+/**
+ * The Floor Filter component simplifies visualization of GIS data for a specific floor of a building in your application.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-floor-filter/)
  */
 export declare class ArcgisFloorFilter 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-floor-filter/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * The currently selected facility.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#facility)
+     */
     facility: string | nullish;
+    /**
+     * Indicates the heading level to use for the headings separating floors in buildings.
+     *
+     * @default 2
+     */
     headingLevel: number;
     /**
      * 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.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "floor-plan"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Widget.html#label)
+     */
     label: string | nullish;
+    /**
+     * The currently selected floor level.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#level)
+     */
     level: string | nullish;
+    /**
+     * Determines if the widget is expanded or collapsed.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#longNames)
+     *
+     * @default false
+     */
     longNames: boolean;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * 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.
+     *
+     * @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 currently selected site.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-FloorFilter.html#site)
+     */
     site: string | nullish;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     updateWebDocument(webMap: __esri.WebMap): Promise<void>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
 }
 export {};

package/dist/components/arcgis-floor-filter/customElement.js

@@ -5,7 +5,7 @@ import { m as a } from "../../chunks/useWidget.js";
 import { css as r } 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.98 */
+v4.33.0 */
 const h = r`@layer{arcgis-floor-filter{display:block}}`, n = a(i);
 class c extends s {
   constructor() {
@@ -20,9 +20,6 @@ class c extends s {
   static {
     this.styles = h;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }

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

@@ -1,7 +1,6 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
 import { Use } from '@arcgis/lumina/controllers';
-import { Nil } from '@arcgis/components-utils';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 import { useView } from '../../controllers/useView';
@@ -10,30 +9,49 @@ import { default as SceneView } from '@arcgis/core/views/SceneView.js';
 import { default as LinkChartView } from '@arcgis/core/views/LinkChartView.js';
 
 /**
- * Provides a simple component to present the View or a user-defined HTMLElement using the entire screen
+ * The Fullscreen component allows users to toggle the map or scene to fullscreen mode.
+ * Use the escape key (`esc`) to exit fullscreen mode.
+ *
+ * **Known limitations**
+ *
+ * * The Fullscreen widget only works with browsers that implement the [Fullscreen](https://developer.mozilla.org/en-US/docs/Web/API/Fullscreen_API) API.
+ *   Thus, iOS Safari is not supported.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-fullscreen/)
  */
 export declare class ArcgisFullscreen extends LitElement {
-    /**
-     * The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode.
-     */
-    element: HTMLElement | nullish;
-    /**
-     * The component's default label.
-     */
-    label: Nil | string;
+    /** The [HTMLElement](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement) to present in fullscreen mode. */
+    element?: HTMLElement;
+    /** The component's default label. */
+    label?: string;
     /**
      * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
      */
     messageOverrides?: typeof this.messages._overrides;
+    /** @default "top-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
     /**
-     * The current state of the component.
+     * 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.
+     *
+     * @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;
     get state(): "active" | "disabled" | "ready" | "unsupported";
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
-    private messages;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    private messages: Partial<{
+        componentLabel: string;
+        enter: string;
+        exit: string;
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        componentLabel: string;
+        enter: string;
+        exit: string;
+    }>;
 }

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

@@ -9,13 +9,11 @@ import { css as p } from "@lit/reactive-element/css-tag.js";
 import { u as h } from "../../chunks/useView.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.98 */
+v4.33.0 */
 const g = p`arcgis-fullscreen{display:block}`, E = {
   base: "esri-fullscreen"
 };
 class b extends u {
-  //#endregion
-  //#region Lifecycle
   constructor() {
     super(), this.messages = f(), this.view = h(this), this.position = "top-left", this.arcgisPropertyChange = o()("state"), this.arcgisReady = m(), this.listenOn(document, "fullscreenchange", () => this.fullscreenElement = document.fullscreenElement);
   }
@@ -29,9 +27,6 @@ class b extends u {
     const e = this.state;
     return e === "active" ? this.messages.exit : e === "ready" ? this.messages.enter : "";
   }
-  /**
-   * The current state of the component.
-   */
   get state() {
     if (!document.fullscreenEnabled)
       return "unsupported";
@@ -41,16 +36,12 @@ class b extends u {
   connectedCallback() {
     super.connectedCallback(), this.fullscreenElement = document.fullscreenElement;
   }
-  //#endregion
-  //#region Private Methods
   _getElement() {
     return this.element ?? this.view?.container?.parentElement ?? null;
   }
   _toggle() {
     document.fullscreenElement ? document.exitFullscreen() : this._getElement()?.requestFullscreen();
   }
-  //#endregion
-  //#region Rendering
   render() {
     const { fullscreenTitle: e, state: t } = this, r = t === "unsupported", i = t === "ready" || t === "disabled" || t === "unsupported" ? "zoom-out-fixed" : "zoom-in-fixed";
     return s`<div class=${l(a(E.base, n.widget))}>${!r && s`<calcite-button class=${l(n.widgetButton)} .disabled=${t === "disabled"} .iconStart=${i} kind=neutral .label=${e} @click=${this._toggle} title=${e ?? d}></calcite-button>` || ""}</div>`;

package/dist/components/arcgis-grid-controls/customElement.d.ts

@@ -8,36 +8,40 @@ import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/
 import { default as Color } from '@arcgis/core/Color.js';
 import { default as GridControlsViewModel } from '@arcgis/core/widgets/support/GridControls/GridControlsViewModel.js';
 
-declare const useGridControlsViewModel: (component: LitElement & Pick<GridControlsViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<GridControlsViewModel>, options?: {
-    editConstructorProperties(props: unknown): unknown;
-} | undefined) => GridControlsViewModel;
+declare const useGridControlsViewModel: (component: LitElement & Pick<GridControlsViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<GridControlsViewModel>) => GridControlsViewModel;
 /**
- * `GridControls` provides a user interface (UI) for configuring and displaying a two-dimensional grid.
+ * The Grid Controls component provides a user interface (UI) for configuring and displaying a two-dimensional grid.
  * The grid displayed provides a network of horizontal and vertical lines used to divide the view into equal cells.
  * With support for snapping, the grid lines can be used as a reference when drawing features.
  * Note: grid controls are embedded in snapping controls for Sketch and Editor by default.
  *
  * **Known limitations**
  *
- * - GridControls is only supported in 2D/arcgis-map.
+ * - Grid Controls is only supported in a 2D Map component.
  * - The grid spacing does not correspond to real world measurements. Distortion will be minimized when used in conjunction with an equal area basemap.
  * - The grid spacing input will be hidden when working with Web Mercator and Geographic Coordinate Systems.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-grid-controls/)
  */
 export declare class ArcgisGridControls extends LitElement {
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    position: __esri.UIPosition;
     /**
-     * Icon which represents the component. It is typically used when the component is controlled by another
-     * one (e.g. in <arcgis-expand>).
+     * 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.
      *
-     * @see [Calcite Icon Search](https://developers.arcgis.com/calcite-design-system/icons/)
-     * @default "grid-unit"
+     * @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)
      */
-    icon: Nil | string;
+    referenceElement?: ArcgisReferenceElement | string;
+    /** @default "bottom-right" */
+    position: __esri.UIPosition;
     /**
-     * The custom color used for drawing the grid, if any.
+     * 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 "grid-unit"
      */
-    customColor: Color | Nil;
+    icon?: string;
+    /** The custom color used for drawing the grid, if any. */
+    customColor?: Color;
     /**
      * The [SnappingOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-interactive-snapping-SnappingOptions.html)
      * that will be controlled by this component if the snapping toggle is enabled for display.
@@ -54,74 +58,97 @@ export declare class ArcgisGridControls extends LitElement {
     set theme(theme: GridTheme | Nil);
     /**
      * Controls display of the color and theme selection options.
+     *
+     * @default false
      */
     hideColorSelection: boolean;
     /**
      * Controls display of the dynamic scaling toggle. Dynamic scaling adjusts the size of the grid to work
      * well regardless of view scale.
+     *
+     * @default false
      */
     hideDynamicScaleToggle: boolean;
     /**
      * Controls display of the grid enabled toggle. This toggle controls whether the grid is displayed.
+     *
+     * @default false
      */
     hideGridEnabledToggle: boolean;
     /**
      * Controls display of the numeric input fields for setting grid spacing and rotation.
+     *
+     * @default false
      */
     hideNumericInputs: boolean;
     /**
      * Controls display of the grid snapping enabled toggle. This toggle controls whether snapping is enabled.
+     *
+     * @default false
      */
     hideGridSnapEnabledToggle: boolean;
     /**
      * Controls display of the line interval input field for setting the interval between major grid lines.
+     *
+     * @default false
      */
     hideLineIntervalInput: boolean;
     /**
      * Controls display of the out of scale warning. This warning is displayed when the grid is not shown
      * because it would be too small at the current scale and dynamic scaling is disabled.
+     *
+     * @default false
      */
     hideOutOfScaleWarning: boolean;
     /**
      * Controls display of the grid placement buttons. These buttons allow the user to start interactive
      * configuration of the grid.
+     *
+     * @default false
      */
     hidePlacementButtons: boolean;
     /**
      * Controls display of the rotate with map toggle. This toggle controls whether the grid rotates with the map.
+     *
+     * @default false
      */
     hideRotateWithMapToggle: boolean;
-    /**
-     * Rotation of the grid in radians. NOTE: UI controls convert to and from degrees automatically.
-     */
+    /** Rotation of the grid in radians. NOTE: UI controls convert to and from degrees automatically. */
     rotation: number;
     /**
      * Controls whether the grid rotates with the map, or stays fixed to the screen.
+     *
+     * @default true
      */
     rotateWithMap: boolean;
     /**
      * Length of a grid cell. Grid cells are always square. Defined in [unit](#unit).
+     *
      * @default 1
      */
     spacing: number;
     /**
      * Controls the number of grid cells shown between major grid lines. Can be anything between 1 and 15.
      * No minor grid lines are shown when this is set to 1.
+     *
+     * @default 10
      */
     majorLineInterval: number;
-    /**
-     * Controls the color of the major grid lines. Minor grid lines are a slightly transparent version of this color.
-     */
+    /** Controls the color of the major grid lines. Minor grid lines are a slightly transparent version of this color. */
     gridColor: Color | Nil;
     /**
      * Returns `true` if the grid is enabled for display.
      * Use [trySetDisplayEnabled](#trySetDisplayEnabled) to enable or disable grid display.
+     *
+     * @default false
      */
     readonly displayEnabled: boolean;
     /**
      * True if the grid is currently not displayed (and therefore also not a valid snap target),
      * because [dynamicScaling](#dynamicScaling) is off and the grid cells are too small
      * to render at the current scale.
+     *
+     * @default false
      */
     readonly gridOutOfScale: boolean;
     /**
@@ -142,10 +169,14 @@ export declare class ArcgisGridControls extends LitElement {
      * Returns `true` if the grid is set to scale dynamically. When dynamic scaling is enabled,
      * grid cells are added or removed to ensure that grid cells are a reasonable size on screen as the user zooms.
      * The way additional grid lines are shown is controlled by the [majorLineInterval](#majorLineInterval) property.
+     *
+     * @default false
      */
     dynamicScaling: boolean;
     /**
      * Returns `true` if the grid is in a valid state for manually setting grid properties or starting an interactive placement.
+     *
+     * @default false
      */
     readonly gridControlsEnabled: boolean;
     /**
@@ -153,6 +184,7 @@ export declare class ArcgisGridControls extends LitElement {
      * Interactive placement allows the user to define the center of the grid, then the scale and rotation of the grid by
      * drawing a second point. Setting this to "place" allows the user to move the grid center only. Setting this to "rotate"
      * keeps the scale and center of the grid constant while rotating the grid by defining a second point.
+     *
      * @default null
      */
     interactivePlacementState: nullish | "rotate" | "place" | "interactive";
@@ -164,39 +196,112 @@ export declare class ArcgisGridControls extends LitElement {
      * @default false
      */
     snappingEnabled: boolean;
-    /**
-     * Returns the actual spacing of grid lines after dynamic scaling has been applied at the current scale.
-     */
+    /** Returns the actual spacing of grid lines after dynamic scaling has been applied at the current scale. */
     readonly effectiveSpacingAfterDynamicScaling: number | nullish;
     /**
      * Use this property to disable the interactive grid placement buttons as needed.
      * An example use case might be to block interaction while another interactive operation
      * (e.g. sketching) is in progress.
+     *
+     * @default false
      */
     placementDisabled: 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
-     * temporary hide it. If this is set, make sure to call the
-     * \`destroy\` method when you are done to prevent memory leaks.
+     * 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](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-grid-controls/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
-    /** Overwrite localized strings for this component */
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this._messages._overrides;
     /** The component's default label. */
-    label: Nil | string;
-    /** Permanently destroy the component */
+    label?: string;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     /**
      * Call this to turn the grid on/off.
+     *
      * @param enabled Desired end state for grid display.
      */
     trySetDisplayEnabled(enabled: boolean): void;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "rotation" | "theme" | "customColor" | "rotateWithMap" | "spacing" | "majorLineInterval" | "gridColor" | "displayEnabled" | "gridOutOfScale" | "dynamicScaling" | "gridControlsEnabled" | "interactivePlacementState" | "snappingEnabled" | "effectiveSpacingAfterDynamicScaling";
     }>;
-    readonly arcgisReady: TargetedEvent<this, undefined>;
-    private _messages;
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    private _messages: Partial<{
+        componentLabel: string;
+        placementOptions: string;
+        gridLineColorPopoverLabel: string;
+        switchLabel: {
+            rotateWithMap: string;
+            scaling: string;
+            display: string;
+            snap: string;
+        };
+        inputLabel: {
+            spacing: string;
+            interval: string;
+            angle: string;
+            theme: string;
+        };
+        gridTheme: {
+            light: string;
+            dark: string;
+            custom: string;
+        };
+        placementState: {
+            interactive: string;
+            place: string;
+            scale: string;
+            rotate: string;
+        };
+        warnings: {
+            dynamicSpacing: string;
+            outOfScale: string;
+            interactivePlaceDisabled: string;
+        };
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        componentLabel: string;
+        placementOptions: string;
+        gridLineColorPopoverLabel: string;
+        switchLabel: {
+            rotateWithMap: string;
+            scaling: string;
+            display: string;
+            snap: string;
+        };
+        inputLabel: {
+            spacing: string;
+            interval: string;
+            angle: string;
+            theme: string;
+        };
+        gridTheme: {
+            light: string;
+            dark: string;
+            custom: string;
+        };
+        placementState: {
+            interactive: string;
+            place: string;
+            scale: string;
+            rotate: string;
+        };
+        warnings: {
+            dynamicSpacing: string;
+            outOfScale: string;
+            interactivePlaceDisabled: string;
+        };
+    }>;
 }
 export {};