@arcgis/map-components 4.34.0-next.132 → 4.34.0-next.134

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

@@ -27,23 +27,109 @@ 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.
+     */
     view?: __esri.MapView | __esri.SceneView | nullish;
+    /**
+     * 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-home/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
     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)
+     */
     goToOverride: nullish | __esri.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"
+     */
     icon?: string;
+    /** 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;
+    /** @deprecated since 4.34, use `slot` 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.
+     *
+     * @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";
+    /**
+     * 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).
+     *
+     * @example
+     *  ```js
+     * // Create viewpoint centered on extent of a polygon geometry
+     *
+     * let vp = new Viewpoint({
+     *   targetGeometry: geom.extent
+     * });
+     *
+     * // Sets the Home's viewpoint to that Viewpoint
+     * home.viewpoint = vp;
+     * ```
+     * @default null
+     */
     viewpoint: nullish | __esri.Viewpoint;
+    /**
+     * This function provides the ability to interrupt and cancel the process
+     * of navigating back to the initial extent.
+     */
     cancelGo(): Promise<void>;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
+    /**
+     * Animates the map or scene to its initial Viewpoint or the
+     * value of `viewpoint`.
+     */
     go(): Promise<void>;
+    /**
+     * Fires when the go() method is called.
+     *
+     * @example
+     * ```js
+     * home.addEventListener("arcgisGo", (event) => {
+     *   console.log("updating viewpoint");
+     * });
+     * ```
+     */
     readonly arcgisGo: TargetedEvent<this, __esri.HomeViewModelGoEvent>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
     private messages: Partial<{
         componentLabel: string;

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

@@ -9,7 +9,7 @@ import { u as p } from "../../chunks/useT9n.js";
 import { m as w } from "../../chunks/useViewModel.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.132 */
+v4.34.0-next.134 */
 const b = r`.arcgis-button{--calcite-ui-icon-color: var(--calcite-color-text-3);--calcite-button-background-color: var(--calcite-color-foreground-1);color:var(--calcite-color-text-3);line-height:1.3em;display:flex;flex-flow:column;cursor:pointer;background-color:var(--calcite-color-foreground-1);font-size:var(--calcite-font-size);:hover{--calcite-ui-icon-color: var(--calcite-color-text-1);--calcite-button-background-color: var(--calcite-color-transparent-hover)}calcite-button{width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl)}}:host{width:var(--calcite-spacing-xxxl);height:var(--calcite-spacing-xxxl)}`, f = "home", s = {
   base: f,
   button: "arcgis-button"

package/dist/components/arcgis-labeled-switch/customElement.d.ts

@@ -8,12 +8,32 @@ import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/
  * @private
  */
 export declare class LabeledSwitch extends LitElement {
+    /**
+     * Tracks the state of the switch.
+     *
+     * @default false
+     */
     checked: boolean;
+    /**
+     * Used to disable the switch.
+     *
+     * @default false
+     */
     disabled: boolean;
+    /** Label to display alongside the switch. */
     label?: string;
+    /** Hint shown when user hovers over the hint icon. */
     hint?: string;
+    /** Icon to show for the hint. Common values are "warning" and "information" */
     hintIcon?: string;
+    /**
+     * Controls the presentation of the hint icon. Uses a yellow color if set to warning.
+     *
+     * @default "info"
+     */
     hintKind: "info" | "warning";
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
+    /** Emitted when the switch is toggled. Event detail is the new checked state. */
     readonly arcgisCheckedChanged: TargetedEvent<this, boolean>;
 }

package/dist/components/arcgis-labeled-switch/customElement.js

@@ -5,7 +5,7 @@ import { keyed as b } from "lit/directives/keyed.js";
 import { LitElement as g, createEvent as m, safeClassMap as c } from "@arcgis/lumina";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.132 */
+v4.34.0-next.134 */
 const f = p`.label{--calcite-label-margin-bottom: 0}.label-content{display:flex;flex:1;gap:var(--calcite-spacing-sm);align-items:center;text-wrap:balance}.label-content>div{flex-grow:1}.icon{margin-top:-1px;&.info{color:var(--calcite-color-status-info)}&.warning{color:var(--calcite-color-status-warning)}}.tooltip{text-wrap:wrap}`, e = {
   label: "label",
   labelContent: "label-content",

package/dist/components/arcgis-layer-list/customElement.d.ts

@@ -34,48 +34,192 @@ declare const useLayerListWidget: (component: LitElement & Pick<LayerList, "icon
  * @since 4.28
  */
 export declare class ArcgisLayerList extends LitElement {
+    /**
+     * Emitted when the component's close button is clicked.
+     *
+     * @since 4.33
+     */
     readonly arcgisClose: TargetedEvent<this>;
+    /**
+     * 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 ArcgisLayerList component will be associated with a map or scene component rather than using the `view` property.
+     *
+     * @default null
+     */
     view?: __esri.MapView | __esri.SceneView | nullish;
+    /**
+     * 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-layer-list/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
     autoDestroyDisabled: boolean;
+    /** The CatalogLayerList that displays a catalog layer's dynamic group layer. */
     get catalogLayerList(): __esri.CatalogLayerList | nullish;
+    /**
+     * [CatalogLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CatalogLayer.html) specific properties.
+     *
+     * @default null
+     */
     catalogOptions: nullish | __esri.LayerListCatalogOptions;
+    /**
+     * Indicates whether a component is closed. When `true`, the component will be hidden.
+     *
+     * @since 4.33
+     * @default false
+     */
     closed: boolean;
+    /**
+     * Indicates whether the widget is collapsed.
+     *
+     * @default false
+     */
     collapsed: boolean;
+    /**
+     * Indicates whether [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) may be reordered within the list by dragging and dropping.
+     *
+     * @default false
+     */
     dragEnabled: boolean;
+    /**
+     * Placeholder text used in the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterPlaceholder: string;
+    /**
+     * Specifies a function to handle filtering [list items](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html).
+     *
+     * @default null
+     */
     filterPredicate: nullish | __esri.LayerListFilterPredicate;
+    /**
+     * The value of the filter input if [visibleElements.filter](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#visibleElements) is true.
+     *
+     * @default ""
+     */
     filterText: string;
+    /**
+     * Indicates the heading level to use for the heading of the widget.
+     *
+     * @default 2
+     */
     headingLevel: number;
+    /** @default false */
     hideCatalogLayerList: boolean;
+    /** @default false */
     hideFlow: boolean;
+    /** @default false */
     hideStatusIndicators: 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 "layers"
+     */
     icon: string;
+    /**
+     * [KnowledgeGraphLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-KnowledgeGraphLayer.html) specific properties.
+     *
+     * @default null
+     */
     knowledgeGraphOptions: nullish | __esri.LayerListKnowledgeGraphOptions;
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#label)
+     */
     label: string;
+    /**
+     * A function that executes each time a [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html) is created.
+     *
+     * @default null
+     */
     listItemCreatedFunction: nullish | __esri.LayerListListItemCreatedHandler;
+    /**
+     * The minimum number of list items required to enable drag and drop reordering with [dragEnabled](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#dragEnabled).
+     *
+     * @default 2
+     */
     minDragEnabledItems: number;
+    /**
+     * The minimum number of list items required to display the visibleElements.filter input box.
+     *
+     * @default 10
+     */
     minFilterItems: number;
+    /**
+     * A collection of [Layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html)s that are opened
+     * in a [catalogLayerList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#catalogLayerList) or [tableList](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#tableList) flow item.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#openedLayers)
+     *
+     * @default []
+     */
     readonly openedLayers: __esri.Collection<__esri.Layer>;
+    /** A collection of ListItems representing operational layers. */
     get operationalItems(): __esri.Collection<__esri.ListItem>;
+    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) 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.
+     *
+     * @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;
+    /**
+     * A collection of selected [ListItem](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList-ListItem.html)s representing operational layers
+     * selected by the user.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-LayerList.html#selectedItems)
+     */
     selectedItems: __esri.Collection<__esri.ListItem>;
+    /**
+     * Specifies the selection mode.
+     *
+     * @default "none"
+     */
     selectionMode: "multiple" | "single" | "none" | "single-persist";
+    /** @default false */
     showCloseButton: boolean;
+    /** @default false */
     showCollapseButton: boolean;
+    /** @default false */
     showErrors: boolean;
+    /** @default false */
     showFilter: boolean;
+    /** @default false */
     showHeading: boolean;
+    /** @default false */
     showTemporaryLayerIndicators: boolean;
+    /**
+     * The current state of the component.
+     *
+     * @default "disabled"
+     */
     readonly state: "ready" | "loading" | "disabled";
+    /** The TableList that displays the tables associated with a KnowledgeGraphLayer. */
     get tableList(): __esri.TableList | nullish;
+    /**
+     * Determines the icons used to indicate visibility.
+     *
+     * @default "default"
+     */
     visibilityAppearance: "default" | "checkbox";
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     triggerAction(action: __esri.ActionButton | __esri.ActionToggle, item: __esri.ListItem): 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";
     }>;
+    /** Emitted when the component associated with a map or scene view is ready to be interacted with. */
     readonly arcgisReady: TargetedEvent<this, void>;
+    /** Emitted when an action is triggered on the component. */
     readonly arcgisTriggerAction: TargetedEvent<this, __esri.LayerListTriggerActionEvent>;
 }
 export {};

package/dist/components/arcgis-layer-list/customElement.js

@@ -8,7 +8,7 @@ import { s as d } from "../../chunks/layer-list.js";
 import { c as n } from "../../chunks/createCloseEvent.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.132 */
+v4.34.0-next.134 */
 const g = h(r);
 class c extends o {
   constructor() {

package/dist/components/arcgis-layer-list-item/customElement.d.ts

@@ -15,19 +15,31 @@ export declare class ArcgisLayerListItem extends LitElement {
     canMove?: ({ dragEl, fromEl, toEl }: DragDetail, type: "pull" | "put") => boolean;
     css: UnionCSS;
     displayMode: ListDisplayMode;
+    /** @default false */
     hideCatalogLayerList: boolean;
+    /** @default false */
     showCloseButton: boolean;
+    /** @default false */
     showCollapseButton: boolean;
+    /** @default false */
     showErrors: boolean;
+    /** @default false */
     showFilter: boolean;
+    /** @default false */
     hideFlow: boolean;
+    /** @default false */
     showHeading: boolean;
+    /** @default false */
     hideStatusIndicators: boolean;
+    /** @default false */
     showTemporaryLayerIndicators: boolean;
+    /** @default false */
     showTemporaryTableIndicators: boolean;
+    /** @default false */
     dragEnabled: boolean;
     item: UnionListItem;
     layerTablesEnabled?: __esri.Collection<TableSupportedLayers>;
+    /** @default false */
     listModeDisabled: boolean;
     handleAction: (action: Action, item: UnionListItem) => void;
     handlePanelOpen: () => void;
@@ -42,7 +54,17 @@ export declare class ArcgisLayerListItem extends LitElement {
     selectedItems: __esri.Collection<UnionListItem>;
     selectedDragItemLayerUid?: string;
     visibilityAppearance?: VisibilityAppearance;
+    /**
+     * 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-layer-list-item/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
+     */
     autoDestroyDisabled: boolean;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
 }
 export {};

package/dist/components/arcgis-layer-list-item/customElement.js

@@ -10,7 +10,7 @@ import { s as E } from "../../chunks/layer-list.js";
 import { u as x } from "../../chunks/useT9n.js";
 /*! All material copyright Esri, All Rights Reserved, unless otherwise specified.
 See https://js.arcgis.com/4.34/esri/copyright.txt for details.
-v4.34.0-next.132 */
+v4.34.0-next.134 */
 const D = {
   hideChildren: "hide-children"
 };