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

package/dist/components/arcgis-utility-network-validate-topology/customElement.d.ts

@@ -1,20 +1,19 @@
 /// <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 UtilityNetworkValidateTopology } from '@arcgis/core/widgets/UtilityNetworkValidateTopology.js';
 import { ToElement, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-export type UtilityNetworkValidateTopologysWidget = InstanceType<typeof UtilityNetworkValidateTopology>;
 declare const useUtilityNetworkValidateTopologyWidget: (component: LitElement & Pick<UtilityNetworkValidateTopology & {
     viewModel: __esri.Accessor;
 }, "icon" | "label" | "viewModel" | "extentToValidate" | "utilityNetwork"> & {
     state?: unknown;
     viewModel?: (__esri.UtilityNetworkValidateTopologyViewModel & __esri.Accessor) | 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<{
@@ -24,47 +23,68 @@ declare const useUtilityNetworkValidateTopologyWidget: (component: LitElement &
         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.UtilityNetworkValidateTopologyProperties): __esri.UtilityNetworkValidateTopologyProperties | Promise<__esri.UtilityNetworkValidateTopologyProperties>;
-} | undefined) => UtilityNetworkValidateTopology & {
+}) => UtilityNetworkValidateTopology & {
     viewModel: __esri.Accessor;
 };
+/** [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-utility-network-validate-topology/) */
 export declare class ArcgisUtilityNetworkValidateTopology 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-utility-network-validate-topology/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
     /**
      * Specifies the extent of the validation.
+     *
+     * @default "current"
      */
     extentToValidate: "current" | "entire";
     /**
-     * Icon displayed in the component's button.
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     * 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 "check-circle"
      */
     icon: string;
-    /** The component's default label. */
+    /**
+     * The widget's default label.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-UtilityNetworkValidateTopology.html#label)
+     */
     label: string;
+    /** @default "top-right" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    readonly state: "ready" | "disabled" | "executing" | "failed" | "loading" | "success";
     /**
-     * Determines the utility network to use.
+     * 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 "ready"
      */
+    readonly state: "ready" | "loading" | "disabled" | "executing" | "failed" | "success";
+    /** Determines the utility network to use. */
     utilityNetwork: nullish | __esri.UtilityNetwork;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): 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";
     }>;
-    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-utility-network-validate-topology/customElement.js

@@ -6,7 +6,7 @@ import { LitElement as a, createEvent as r, noShadowRoot as l } from "@arcgis/lu
 import { m as h } from "../../chunks/useWidget.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 w = h(
   // Workaround for https://devtopia.esri.com/WebGIS/arcgis-js-api/issues/69562
   s
@@ -21,14 +21,9 @@ class d extends a {
   static {
     this.shadowRootOptions = l;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }
-  //#endregion
-  //#region Lifecycle
   async loaded() {
     await this._loadUtilityNetwork(), this.manager.onLifecycle(() => [
       o(() => this.view, () => {
@@ -36,8 +31,6 @@ class d extends a {
       })
     ]);
   }
-  //#endregion
-  //#region Private Methods
   async _loadUtilityNetwork() {
     if (this.view?.map && this.view.map.portalItem) {
       await this.view.map.load();

package/dist/components/arcgis-value-picker/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 ValuePicker } from '@arcgis/core/widgets/ValuePicker.js';
 import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 
-declare const useValuePickerWidget: (component: LitElement & Pick<ValuePicker, never> & {
+declare const useValuePickerWidget: (component: LitElement & Pick<ValuePicker, "icon" | "label" | "component" | "values" | "caption" | "layout" | "canNext" | "canPlay" | "canPrevious" | "loop" | "playRate"> & {
     state?: unknown;
     viewModel?: unknown;
-    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,14 +21,14 @@ declare const useValuePickerWidget: (component: LitElement & Pick<ValuePicker, 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.ValuePickerProperties | undefined): __esri.ValuePickerProperties | Promise<__esri.ValuePickerProperties | undefined> | undefined;
-} | undefined) => ValuePicker;
+}) => ValuePicker;
 /**
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-value-picker/)
+ *
  * @internal
  */
 export declare class ArcgisValuePicker extends LitElement {
@@ -36,33 +36,101 @@ export declare class ArcgisValuePicker 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-value-picker/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /**
+     * Returns `true` if the ValuePicker can be advanced to the next position.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canNext)
+     *
+     * @default false
+     */
     canNext: boolean;
+    /**
+     * Returns `true` if the ValuePicker can be played.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPlay)
+     *
+     * @default false
+     */
     canPlay: boolean;
+    /**
+     * Returns `true` if the ValuePicker can moved to the previous item.
+     *
+     * [Read more...](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ValuePicker.html#canPrevious)
+     *
+     * @default false
+     */
     canPrevious: boolean;
+    /**
+     * An optional caption that appears on the ValuePicker widget to give context for the user.
+     *
+     * @default null
+     */
     caption: string | nullish;
+    /**
+     * An optional component for presenting and managing data.
+     *
+     * @default null
+     */
     component: nullish | __esri.ValuePickerCollection | __esri.ValuePickerCombobox | __esri.ValuePickerLabel | __esri.ValuePickerSlider;
+    /** @default false */
     hideNextButton: boolean | undefined;
+    /** @default false */
     hidePlayButton: boolean | undefined;
+    /** @default false */
     hidePreviousButton: boolean | undefined;
     /**
      * 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 "list-rectangle"
      */
     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;
+    /**
+     * Indicates if the widget should be orientated horizontally (default) or vertically.
+     *
+     * @default "horizontal"
+     */
     layout: "vertical" | "horizontal";
+    /**
+     * If true, playback will restart when it reaches the end.
+     *
+     * @default false
+     */
     loop: boolean;
+    /**
+     * The pause, in milliseconds between playback advancement.
+     *
+     * @default 1000
+     */
     playRate: number;
+    /** @default "bottom-left" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    values: any[] | string[] | nullish | number[];
-    /** Permanently destroy 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;
+    /**
+     * The current value of the ValuePicker.
+     *
+     * @default null
+     */
+    values: any[] | nullish | number[] | string[];
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     next(): Promise<void>;
     pause(): Promise<void>;
@@ -73,9 +141,11 @@ export declare class ArcgisValuePicker extends LitElement {
     readonly arcgisPause: TargetedEvent<this, __esri.ValuePickerPauseEvent>;
     readonly arcgisPlay: TargetedEvent<this, __esri.ValuePickerPlayEvent>;
     readonly arcgisPrevious: TargetedEvent<this, __esri.ValuePickerPreviousEvent>;
+    /** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "values";
     }>;
-    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-value-picker/customElement.js

@@ -7,7 +7,7 @@ import { m as h } 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 l = r`@layer{arcgis-value-picker{display:block}}`, c = h(s);
 class u extends a {
   constructor() {
@@ -22,9 +22,6 @@ class u extends a {
   static {
     this.styles = l;
   }
-  //#endregion
-  //#region Public Methods
-  /** Permanently destroy the component */
   async destroy() {
     await this.manager.destroy();
   }

package/dist/components/arcgis-version-management/customElement.d.ts

@@ -1,16 +1,12 @@
 /// <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 VersionManagementViewModel } from '@arcgis/core/widgets/VersionManagement/VersionManagementViewModel.js';
 import { JsxNode, ToEvents, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
 import { ArcgisVersionManagementServiceItem } from '../arcgis-version-management-service-item/customElement.js';
 
-export type VersionManagementViewModelWidget = InstanceType<typeof VersionManagementViewModel>;
-declare const useVersionManagementViewModel: (component: LitElement & Pick<VersionManagementViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<VersionManagementViewModel>, options?: {
-    editConstructorProperties(props: unknown): unknown;
-} | undefined) => VersionManagementViewModel;
+declare const useVersionManagementViewModel: (component: LitElement & Pick<VersionManagementViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<VersionManagementViewModel>) => VersionManagementViewModel;
 type VersioningStateEventType = "version-changed" | "version-created" | "version-deleted" | "version-switched";
 export interface VersioningStateEvent {
     type?: VersioningStateEventType;
@@ -21,52 +17,73 @@ export type InitialVersionInfo = {
     url: string;
     name: string;
 };
-/** The Version Management Component allows users to view available versions, change versions, delete versions, and alter versions.
-The [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.
-To learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).
-
-> The VersionManagement Component does not support proxied feature services or feature services that utilize stored credentials.
-
-Note: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`
+/**
+ * The Version Management component allows users to view available versions, change versions, delete versions, and alter versions.
+ * The [View](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html) will update to match the features on the selected version.
+ * To learn more about version management please visit the [versioning guide doc](https://developers.arcgis.com/javascript/latest/utility-network/version-management-service/).
+ *
+ * > The Version Management component does not support proxied feature services or feature services that utilize stored credentials.
+ *
+ * Note: Sign in to access the data in this sample, U/P: `viewer01`/`I68VGU^nMurF`
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-version-management/)
  */
 export declare class ArcgisVersionManagement extends LitElement {
+    /** @default false */
     allowEditingDisabled: 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-version-management/#destroy) method when you are done to
+     * prevent memory leaks.
+     *
+     * @default false
      */
     autoDestroyDisabled: boolean;
+    /** @default false */
     closable: boolean;
-    get initialVersionInfos(): InitialVersionInfo[];
     /**
-     * The `initialVersionInfos` property enables users to initialize the Version Management Component with a predefined set of versions.
+     * The `initialVersionInfos` property enables users to initialize the Version Management component with a predefined set of versions.
      * By providing an array of `InitialVersionInfo`, the component displays a specified version for each feature service upon initialization.
      */
+    get initialVersionInfos(): InitialVersionInfo[];
     set initialVersionInfos(value: InitialVersionInfo[]);
-    icon: Nil | string;
-    label: string | undefined;
-    /** Replace localized message strings with your own strings. */
+    icon?: string;
+    label?: string;
+    /**
+     * Replace localized message strings with your own strings.
+     *
+     * _**Note**: Individual message keys may change between releases._
+     */
     messageOverrides?: typeof this.messages._overrides;
-    mode: Nil | string;
+    mode?: string;
     /**
-     * Specifies the number of versions displayed on each page of the Version Management Component.
+     * Specifies the number of versions displayed on each page of the Version Management component.
+     *
+     * @default 5
      */
     pageSize: number;
+    /** @default "top-right" */
     position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
-    readonly state: "ready" | "disabled" | "executing" | "failed" | "loading" | "success";
+    /**
+     * 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. */
+    readonly state: "ready" | "loading" | "disabled" | "executing" | "failed" | "success";
     /**
      * This class provides functionality for managing versions in a versioned geodatabase.
-     * In the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management Component.
-     * The Version Management Component can be reinitialized using a `Collection<VersioningState>`, or a predefined `Collection<VersioningState>` can be provided during the initial instantiation of the Version Management Component.
+     * In the event that the Version Management component is destroyed, the VersioningStates can be utilized to maintain the current state of the Version Management component.
+     * The Version Management component can be reinitialized using a `Collection<VersioningState>`, or a predefined `Collection<VersioningState>` can be provided during the initial instantiation of the Version Management component.
      */
     versioningStates: __esri.Collection<__esri.VersioningState>;
-    /** Permanently destroy the component */
+    /** Permanently destroy the component. */
     destroy(): 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>;
     readonly arcgisVersioningStateChanged: TargetedEvent<this, VersioningStateEvent>;
     private messages: {
         label: string;