@arcgis/map-components 5.0.0-next.13 → 5.0.0-next.131

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

@@ -1,10 +1,12 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference path="../../index.d.ts" />
-import { default as BookmarksViewModel } from '@arcgis/core/widgets/Bookmarks/BookmarksViewModel.js';
+import { default as BookmarksViewModel } from './BookmarksViewModel.js';
 import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
 import { Use } from '@arcgis/lumina/controllers';
 import { HeadingLevel } from '../../support/heading';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { BookmarkOptions, BookmarkEditEvent, BookmarkSelectEvent } from './types';
+import { IconName } from '../../utils/action-utils';
 
 declare const useBookmarksViewModel: (component: LitElement & Pick<BookmarksViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<BookmarksViewModel>) => BookmarksViewModel;
 /**
@@ -30,25 +32,23 @@ declare const useBookmarksViewModel: (component: LitElement & Pick<BookmarksView
 export declare class ArcgisBookmarks 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 ArcgisBookmarks 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 Bookmarks 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/MapView.js').default | import('@arcgis/core/views/SceneView.js').default | undefined;
     /**
      * 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;
-    /** @deprecated since 4.34, use [`slot`](https://developer.mozilla.org/en-US/docs/Web/HTML/Reference/Elements/slot) instead. */
-    position?: __esri.UIPosition;
     /**
      * 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 "bookmark"
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
      */
-    icon?: string;
+    icon: IconName;
     /**
      * Indicates whether a component is closed. When `true`, the component will be hidden.
      *
@@ -58,8 +58,7 @@ export declare class ArcgisBookmarks extends LitElement {
     /**
      * Specifies how new bookmarks will be created if [showAddBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showAddBookmarkButton) is set to `true`.
      * Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current
-     * view when a bookmark is created. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel-BookmarkOptions.html)
-     * for the full list of options.
+     * view when a bookmark is created.
      *
      * @example
      * ```js
@@ -79,14 +78,13 @@ export declare class ArcgisBookmarks extends LitElement {
      * };
      * ```
      */
-    defaultCreateOptions: __esri.BookmarkOptions;
+    defaultCreateOptions: BookmarkOptions;
     /**
      * Specifies how bookmarks will be edited, if [showEditBookmarkButton](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showEditBookmarkButton) is set to `true`.
      * Can be used to enable or disable taking screenshots or capturing the bookmark's viewpoint based on the current
-     * view when a bookmark is edited. See [BookmarkOptions](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Bookmarks-BookmarksViewModel-BookmarkOptions.html)
-     * for the full list of options.
+     * view when a bookmark is edited.
      */
-    defaultEditOptions: __esri.BookmarkOptions;
+    defaultEditOptions: BookmarkOptions;
     /**
      * A collection of [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html)s. These are typically defined inside of a [WebMap](https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html#bookmarks), but can also be defined manually, as shown in the code snippet below.
      *
@@ -128,7 +126,7 @@ export declare class ArcgisBookmarks extends LitElement {
      *   })
      * ];
      */
-    bookmarks: __esri.Collection<__esri.Bookmark>;
+    bookmarks: import('@arcgis/core/core/Collection.js').default<import('@arcgis/core/webmap/Bookmark.js').default>;
     /**
      * When true, the component is visually withdrawn and cannot be interacted with.
      *
@@ -138,22 +136,22 @@ export declare class ArcgisBookmarks extends LitElement {
     /**
      * Indicates if a Bookmark is able to be dragged in order to update its position in the list.
      *
-     * @since 4.29
      * @default false
+     * @since 4.29
      */
     dragEnabled: boolean;
     /**
      * Defines the text used as a placeholder when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.
      *
-     * @since 4.29
      * @default ""
+     * @since 4.29
      */
     filterPlaceholder: string;
     /**
      * Defines the text used to filter the bookmarks when [showFilter](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-bookmarks/#showFilter) is set to `true`.
      *
-     * @since 4.29
      * @default ""
+     * @since 4.29
      */
     filterText: string;
     /**
@@ -163,13 +161,14 @@ export declare class ArcgisBookmarks extends LitElement {
      * in your app, you may need to adjust this heading for proper semantics. This is
      * important for meeting accessibility standards.
      *
+     * @default 2
      * @see [Heading Elements](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/Heading_Elements)
+     * @since 4.34
      * @example
      * ```js
      * // "No bookmarks" will render as an <h3>
      * bookmarksElement.headingLevel = 3;
      * ```
-     * @default 2
      */
     headingLevel: HeadingLevel;
     /**
@@ -177,77 +176,87 @@ export declare class ArcgisBookmarks 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-Bookmarks-BookmarksViewModel.html#goToOverride)
+     * @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
+     * // components 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('../support/goTo.js').GoToOverride | undefined;
     /**
      * Indicates whether to display the button to add a new bookmark.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     showAddBookmarkButton: boolean;
     /**
      * Indicates whether to display the close button.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     showCloseButton: boolean;
     /**
      * Indicates whether to display the collapse button.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     showCollapseButton: boolean;
     /**
      * Indicates whether to display the button to edit a bookmark.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     showEditBookmarkButton: boolean;
     /**
      * Indicates whether to display the bookmark filter.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     showFilter: boolean;
     /**
      * Determines whether the component should be rendered within its built-in [flow component](https://developers.arcgis.com/calcite-design-system/components/flow/).
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     hideFlow: boolean;
     /**
      * Indicates whether to display the heading.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     showHeading: boolean;
     /**
      * Indicates whether the thumbnail associated with the bookmark is hidden.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     hideThumbnail: boolean;
     /**
      * Indicates whether the time (`h:m:s`) displayed next to the date is hidden if the bookmark has a time extent defined.
      *
-     * @since 4.30
      * @default false
+     * @since 4.30
      */
     hideTime: boolean;
     /**
      * Indicates whether to disable the time capability of the Bookmarks component.
      *
-     * @since 4.34
      * @default false
+     * @since 4.34
      */
     timeDisabled: boolean | undefined;
     /**
@@ -264,6 +273,8 @@ export declare class ArcgisBookmarks extends LitElement {
      * Replace localized message strings with your own strings.
      *
      * _**Note**: Individual message keys may change between releases._
+     *
+     * @since 4.34
      */
     messageOverrides?: typeof this.messages._overrides;
     /** The component's default label. */
@@ -276,12 +287,17 @@ export declare class ArcgisBookmarks extends LitElement {
     readonly state: "ready" | "loading";
     /** Permanently destroy the component. */
     destroy(): Promise<void>;
-    /** Zoom to a specific bookmark. */
-    goTo(bookmark: __esri.Bookmark): Promise<void>;
     /**
+     * Zoom to a specific bookmark.
      *
+     * @param bookmark
+     * @since 4.34
+     */
+    goTo(bookmark: __esri.Bookmark): Promise<void>;
+    /**
      * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is edited.
      *
+     * @since 4.34
      * @example
      * ```js
      * // once an edit has been made, enable the "Save Webmap" button
@@ -291,35 +307,45 @@ export declare class ArcgisBookmarks extends LitElement {
      * });
      * ```
      */
-    readonly arcgisBookmarkEdit: TargetedEvent<this, __esri.BookmarksBookmarkEditEvent>;
+    readonly arcgisBookmarkEdit: TargetedEvent<this, BookmarkEditEvent>;
     /**
      * Fires when a [Bookmark](https://developers.arcgis.com/javascript/latest/api-reference/esri-webmap-Bookmark.html) is selected.
      *
+     * @since 4.34
      * @example
      * ```html
      * <arcgis-expand expanded>
      *  <arcgis-bookmarks></arcgis-bookmarks>
      * </arcgis-expand>
-     * ```
      *
-     * ```js
-     * const bookmarksElement = document.querySelector("arcgis-bookmarks");
-     * const expandElement = document.querySelector("arcgis-expand");
+     * <script>
+     *   const bookmarksElement = document.querySelector("arcgis-bookmarks");
+     *   const expandElement = document.querySelector("arcgis-expand");
      *
-     * // collapses the associated Expand component
-     * // when a bookmark is selected
-     * bookmarksElement.addEventListener("arcgisBookmarkSelect", (event) => {
-     *   expandElement.expanded = false;
-     * });
+     *   // collapses the associated Expand component
+     *   // when a bookmark is selected
+     *   bookmarksElement.addEventListener("arcgisBookmarkSelect", (event) => {
+     *     expandElement.expanded = false;
+     *   });
+     * </script>
      * ```
      */
-    readonly arcgisBookmarkSelect: TargetedEvent<this, __esri.BookmarksBookmarkSelectEvent>;
+    readonly arcgisBookmarkSelect: TargetedEvent<this, BookmarkSelectEvent>;
     /** 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 the component's close button is clicked. */
+    readonly arcgisClose: TargetedEvent<this, void>;
     private messages;
+    "@eventTypes": {
+        "arcgisBookmarkEdit": ArcgisBookmarks["arcgisBookmarkEdit"]["detail"];
+        "arcgisBookmarkSelect": ArcgisBookmarks["arcgisBookmarkSelect"]["detail"];
+        "arcgisClose": ArcgisBookmarks["arcgisClose"]["detail"];
+        "arcgisPropertyChange": ArcgisBookmarks["arcgisPropertyChange"]["detail"];
+        "arcgisReady": ArcgisBookmarks["arcgisReady"]["detail"];
+    };
 }
 export {};