@arcgis/map-components 4.33.0-next.90 → 4.33.0-next.91

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

@@ -1,112 +1,316 @@
 /// <reference types="@arcgis/core/interfaces.d.ts" />
 /// <reference types="../../index.d.ts" />
-import { Use } from '@arcgis/components-controllers';
-import { Nil } from '@arcgis/components-utils';
-import { default as Search } from '@arcgis/core/widgets/Search.js';
-import { PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { default as SearchViewModel } from '@arcgis/core/widgets/Search/SearchViewModel.js';
 import { ArcgisReferenceElement } from '../../utils/component-utils';
+import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
+import { Nil } from '@arcgis/components-utils';
+import { Use } from '@arcgis/components-controllers';
 
-declare const useSearchWidget: (component: import('@arcgis/components-controllers').StencilLifecycles & {
+type ActiveMenu = "none" | "source" | "suggestion";
+declare const useSearchViewModel: (component: import('@arcgis/components-controllers').StencilLifecycles & {
     manager: import('@arcgis/components-controllers').ControllerManager;
     el: HTMLElement;
     autoDestroyDisabled?: boolean;
     destroy?: () => Promise<void>;
-} & Pick<Search, never> & {
-    reactiveUtils?: typeof __esri.reactiveUtils;
-    state?: unknown;
-    viewModel?: __esri.SearchViewModel | undefined;
-    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<{
-        name: string;
-    }> | undefined;
-    el: HTMLElement & {
-        childElem?: HTMLElement & {
-            ownedBy?: HTMLElement;
-        };
-        view?: __esri.MapView | __esri.SceneView | Nil;
-    };
-    autoDestroyDisabled: boolean;
-    destroy: () => Promise<void>;
-}, options?: {
-    editConstructorProperties(props: __esri.widgetsSearchProperties | undefined): __esri.widgetsSearchProperties | Promise<__esri.widgetsSearchProperties | undefined> | undefined;
-} | undefined) => Search;
-/** Search component provides a way to perform search operations
+} & Pick<SearchViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<SearchViewModel>, options?: {
+    editConstructorProperties(props: unknown): unknown;
+} | undefined) => SearchViewModel;
+/** The Search component provides a way to perform search operations on locator service(s), map/feature service feature layer(s), SceneLayers with an associated feature layer,
+ * BuildingComponentSublayer with an associated feature layer, GeoJSONLayer, CSVLayer, OGCFeatureLayer, and/or table(s). If using a locator with a geocoding service, the
+ * findAddressCandidates operation is used, whereas queries are used on feature layers.
+ *
+ * By default, the Search component uses the ArcGIS World Geocoding Service via this URL: `https://geocode.arcgis.com/arcgis/rest/services/World/GeocodeServer`.
+ * If a global apiKey is present, the Search component uses this URL: `https://geocode-api.arcgis.com/arcgis/rest/services/World/GeocodeServer`. If an apiKey
+ * is present on the LocatorSearchSource, then the Search component uses the URL defined by the LocatorSearchSource.url property.
+ *
+ * The Search component sets the view on the Search result. The level of detail (LOD) at the center of the view depends on the data source, with higher quality data
+ * sources returning extents closer to the `feature` obtained from the search. To manually define the scale of the view at the Search result, use the `zoomScale` property
+ * of the LocatorSearchSource or LayerSearchSource. Search component results are typically sorted according to their relevance to the search and their relative importance.
+ * However, when the scale of the MapView or SceneView is less than or equal to 300,000, the operations support prioritization of candidates based on their distance from a
+ * specified point (the center of the view) by passing in the `location parameter`. Features closest to the input location show up higher in the list of results.
+ * This behavior can be changed by using the localSearchDisabled property.
  */
 export declare class ArcgisSearch extends LitElement {
-    activeMenu: "source" | "warning" | "none" | "suggestion";
-    readonly activeSource: nullish | __esri.LayerSearchSource | __esri.LocatorSearchSource;
+    referenceElement: ArcgisReferenceElement | Nil | string;
+    position: __esri.UIPosition;
+    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).
+     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     */
+    icon: string;
+    /**
+     * The current active menu of the Search component.
+     *
+     */
+    activeMenu: ActiveMenu;
+    /**
+     * The [source](#sources) object currently selected. Can be either a
+     * {@link module:esri/widgets/Search/LayerSearchSource} or a {@link module:esri/widgets/Search/LocatorSearchSource}.
+     *
+     * @default null
+     */
+    get activeSource(): Nil | (__esri.LayerSearchSource | __esri.LocatorSearchSource);
+    /**
+     * The selected source's index. This value is `-1` when all sources are selected.
+     *
+     * @default 0
+     */
     activeSourceIndex: number;
+    /**
+     * String value used as a hint for input text when searching on multiple sources. See
+     * the image below to view the location and style of this text in the context of the component.
+     *
+     * ![search-allPlaceholder](../assets/img/apiref/widgets/search-allplaceholder.png)
+     *
+     * @default "Find address or place"
+     */
     allPlaceholder: string | nullish;
+    /**
+     * The combined collection of {@link module:esri/widgets/Search/SearchViewModel#defaultSources defaultSources}
+     * and {@link module:esri/widgets/Search/SearchViewModel#sources sources}.
+     * The {@link module:esri/widgets/Search/SearchViewModel#defaultSources defaultSources}
+     * displays first in the Search UI.
+     *
+     * @readonly
+     */
     readonly allSources: __esri.Collection<__esri.LayerSearchSource | __esri.LocatorSearchSource>;
     /**
-     * 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.
+     * Indicates whether to automatically select and zoom to the first geocoded result. If `false`, the
+     * [findAddressCandidates](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-find-address-candidates.htm)
+     * operation will still geocode the input string, but the top result will not be selected. To work with the
+     * geocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results
+     * through the event object.
+     *
+     * @default true
+     */
+    autoSelect: boolean;
+    /**
+     * A read-only property that is a {@link module:esri/core/Collection Collection}
+     * of {@link module:esri/widgets/Search/LayerSearchSource}
+     * and/or {@link module:esri/widgets/Search/LocatorSearchSource}. This property
+     * may contain [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/)
+     * [locators](http://enterprise.arcgis.com/en/server/latest/publish-services/windows/geocode-services.htm)
+     * and any web map or web scene [configurable search sources](http://doc.arcgis.com/en/arcgis-online/create-maps/configure-feature-search.htm).
+     * Web maps or web scenes may contain
+     * {@link module:esri/layers/MapImageLayer map}/{@link module:esri/layers/FeatureLayer feature} service feature
+     * layer(s), and/or {@link module:esri/webdoc/applicationProperties/SearchTable table(s)} as sources.
+     *
+     * This property is used to populate the Search UI if the {@link module:esri/widgets/Search/SearchViewModel#sources sources} property is not set.
+     *
+     * @readonly
      */
-    autoDestroyDisabled: boolean;
-    /** @default false */
-    autoSelectDisabled: boolean;
     readonly defaultSources: __esri.Collection<__esri.LayerSearchSource | __esri.LocatorSearchSource>;
+    /**
+     * When true, the component is visually withdrawn and cannot be interacted with.
+     *
+     */
     disabled: boolean;
-    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).
-     * Search [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/) for possible values.
+     * Indicates whether or not to include {@link module:esri/widgets/Search/SearchViewModel#defaultSources defaultSources} in the Search UI.
+     * This can be a boolean value or a function that returns an array of Search {@link module:esri/widgets/Search/SearchViewModel#sources sources}.
+     *
+     * @default true
+     */
+    includeDefaultSources: boolean | Function;
+    /**
+     * Enables location services within the component.
+     *
+     * ![locationEnabled](../assets/img/apiref/widgets/search-locationEnabled.png)
+     *
+     * ::: esri-md class="warning"
+     * The use of this property is only supported on secure origins.
+     * To use it, switch your application to a secure origin, such as HTTPS.
+     * Note that localhost is considered "potentially secure" and can be used for easy testing in browsers that supports
+     * [Window.isSecureContext](https://developer.mozilla.org/en-US/docs/Web/API/isSecureContext#browser_compatibility)
+     * (currently Chrome and Firefox).
+     * :::
+     *
+     * @default true
+     */
+    locationEnabled: boolean;
+    /**
+     * The maximum number of results returned by the component if not specified by the source.
+     *
+     * @default 6
      */
-    icon: string;
-    /** @default false */
-    includeDefaultSourcesDisabled: boolean | Function;
-    /** The component's default label. */
-    label: string;
-    /** @default false */
-    locationDisabled: boolean;
     maxResults: number;
+    /**
+     * The maximum number of suggestions returned by the component if not specified by the source.
+     *
+     * If working with the default
+     * [ArcGIS Online Geocoding service](https://developers.arcgis.com/rest/geocode/api-reference/overview-world-geocoding-service.htm),
+     * the default remains at `5`.
+     *
+     * @default 6
+     */
     maxSuggestions: number;
+    /**
+     * The minimum number of characters needed for the search if not specified by the source.
+     *
+     * @default 3
+     */
     minSuggestCharacters: number;
-    /** @default false */
-    popupDisabled: boolean;
+    /**
+     * Indicates whether to display the {@link module:esri/widgets/Popup} on feature click. The graphic can
+     * be clicked to display a {@link module:esri/widgets/Popup}.
+     *
+     * @default true
+     */
+    popupEnabled: boolean;
+    /**
+     * A customized {@link module:esri/PopupTemplate} for the selected feature.
+     * Note that any {@link module:esri/PopupTemplate templates}
+     * defined on [allSources](#allSources) take precedence over those defined directly on the template.
+     *
+     * @autocast
+     */
     popupTemplate: nullish | __esri.PopupTemplate;
+    /**
+     * It is possible to search a specified portal instance's [locator services](http://enterprise.arcgis.com/en/portal/latest/administer/windows/configure-portal-to-geocode-addresses.htm)
+     * Use this property to set this [ArcGIS Portal](https://enterprise.arcgis.com/en/portal/) instance to search.
+     *
+     */
     portal: nullish | __esri.Portal;
-    position: __esri.UIPosition;
-    referenceElement: ArcgisReferenceElement | Nil | string;
+    /**
+     * The graphic used to highlight the resulting feature or location.
+     *
+     * :::esri-md class="panel trailer-1"
+     * A graphic will be placed in the View's
+     * {@link module:esri/views/View#graphics graphics}
+     * for {@link module:esri/views/layers/LayerView layer views}
+     * that do not support the `highlight` method.
+     * :::
+     *
+     * @readonly
+     */
     readonly resultGraphic: nullish | __esri.Graphic;
-    /** @default false */
-    resultGraphicDisabled: boolean;
-    readonly results: any[] | nullish;
-    /** @default false */
-    searchAllDisabled: boolean;
+    /**
+     * Indicates if the [resultGraphic](#resultGraphic) will display at the
+     * location of the selected feature.
+     *
+     * @default true
+     */
+    resultGraphicEnabled: boolean;
+    /**
+     * An array of objects, each containing a [SearchResult](#SearchResult) from the search.
+     *
+     * @readonly
+     */
+    readonly results: nullish | __esri.SearchResults[];
+    /**
+     * Indicates whether to display the option to search all sources. When `true`, the "All" option
+     * is displayed by default:
+     *
+     * ![search-searchAllEnabled-true](../assets/img/apiref/widgets/search-enablesearchingall-true.png)
+     *
+     * When `false`, no option to search all sources at once is available:
+     *
+     * ![search-searchAllEnabled-false](../assets/img/apiref/widgets/search-enablesearchingall-false.png)
+     *
+     * @default true
+     */
+    searchAllEnabled: boolean;
+    /** The value of the search box input text string. */
     searchTerm: string;
-    readonly selectedResult: nullish | __esri.SearchSearchResult;
-    sources: __esri.Collection<__esri.SearchSource>;
-    readonly state: "ready" | "disabled" | "loading" | "searching";
+    /**
+     * The result selected from a search.
+     *
+     * @see [Event: select-result](#event-select-result)
+     * @see [select()](#select)
+     * @readonly
+     */
+    readonly selectedResult: nullish | __esri.SearchResult;
+    /**
+     * The Search component may be used to search features in a
+     * {@link module:esri/layers/MapImageLayer map}/{@link module:esri/layers/FeatureLayer feature} service feature
+     * layer(s), {@link module:esri/layers/SceneLayer SceneLayers} with an associated feature layer,
+     * {@link module:esri/layers/buildingSublayers/BuildingComponentSublayer} with an associated feature layer,
+     * {@link module:esri/layers/GeoJSONLayer}, {@link module:esri/layers/CSVLayer} or
+     * {@link module:esri/layers/OGCFeatureLayer}, or {@link module:esri/webdoc/applicationProperties/SearchTable table},
+     * or geocode locations with a {@link module:esri/rest/locator}. The `sources` property defines the sources from which
+     * to search for the [view](#view) specified by the Search component instance. There are two types of sources:
+     *
+     * * {@link module:esri/widgets/Search/LayerSearchSource}
+     * * {@link module:esri/widgets/Search/LocatorSearchSource}
+     *
+     * Any combination of these sources may be used
+     * together in the same instance of the Search component.
+     *
+     * ::: esri-md class="warning"
+     * Feature layers created from client-side graphics are not supported.
+     * :::
+     *
+     * @autocast {"typedCollection": true}
+     */
+    sources: __esri.Collection<__esri.LayerSearchSource | __esri.LocatorSearchSource>;
+    /**
+     * An array of results from the [suggest method](#suggest).
+     *
+     * This is available if working with a 10.3 or greater geocoding service that has [suggest capability
+     * loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a
+     * 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.
+     *
+     */
     readonly suggestions: nullish | __esri.SuggestResults[];
-    /** @default false */
-    suggestionsDisabled: boolean;
-    blurSearch(): Promise<void>;
-    clearSearch(): Promise<void>;
+    /**
+     * Enable suggestions for the component.
+     *
+     * This is only available if working with a 10.3 or greater geocoding service that has [suggest capability
+     * loaded](https://developers.arcgis.com/rest/geocode/api-reference/geocoding-suggest.htm) or a 10.3 or greater feature layer that supports pagination, i.e. `supportsPagination = true`.
+     *
+     * @default true
+     */
+    suggestionsEnabled: 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.
+     */
+    autoDestroyDisabled: boolean;
+    /** Overwrite localized strings for this component */
+    messageOverrides?: typeof this.messages._overrides;
+    /** The component's default label. */
+    label: Nil | string;
+    readonly state: "ready" | "disabled" | "loading" | "searching";
     /** Permanently destroy the component */
     destroy(): Promise<void>;
-    focusSearch(): Promise<void>;
-    search(term: __esri.Point | __esri.SuggestResult | nullish | number[] | string): Promise<__esri.SearchSearchResponse | nullish>;
-    suggest(term: string): Promise<__esri.SearchSuggestResponse | nullish>;
-    readonly arcgisBlur: TargetedEvent<this, __esri.SearchSearchBlurEvent>;
-    readonly arcgisClear: TargetedEvent<this, __esri.SearchSearchClearEvent>;
-    readonly arcgisComplete: TargetedEvent<this, __esri.SearchSearchCompleteEvent>;
-    readonly arcgisFocus: TargetedEvent<this, __esri.SearchSearchFocusEvent>;
+    /**
+     * Brings focus to the component's text input.
+     *
+     */
+    setFocus(): Promise<void>;
     readonly arcgisPropertyChange: TargetedEvent<this, {
         name: "state";
     }>;
     readonly arcgisReady: TargetedEvent<this, undefined>;
-    readonly arcgisSelectResult: TargetedEvent<this, __esri.SearchSelectResultEvent>;
-    readonly arcgisStart: TargetedEvent<this, __esri.SearchSearchStartEvent>;
-    readonly arcgisSuggestComplete: TargetedEvent<this, __esri.SearchSuggestCompleteEvent>;
-    readonly arcgisSuggestStart: TargetedEvent<this, __esri.SearchSuggestStartEvent>;
+    /**
+     * Fires when a result is cleared from the input box or a new result is selected.
+     */
+    readonly arcgisSearchClear: TargetedEvent<this, __esri.SearchViewModelSearchClearEvent>;
+    /**
+     * Fires when the [search()](#search) method is called and returns its results.
+     */
+    readonly arcgisSearchComplete: TargetedEvent<this, __esri.SearchViewModelSearchCompleteEvent>;
+    /**
+     * Fires when the [search()](#search) method starts.
+     */
+    readonly arcgisSearchStart: TargetedEvent<this, __esri.SearchViewModelSearchStartEvent>;
+    /**
+     * Fires when a search result is selected.
+     */
+    readonly arcgisSelectResult: TargetedEvent<this, __esri.SearchViewModelSelectResultEvent>;
+    /**
+     * Fires when the [suggest](#suggest) method is called and returns its results.
+     */
+    readonly arcgisSuggestComplete: TargetedEvent<this, __esri.SearchViewModelSuggestCompleteEvent>;
+    /**
+     * Fires when the [suggest()](#suggest) method starts.
+     */
+    readonly arcgisSuggestStart: TargetedEvent<this, __esri.SearchViewModelSuggestStartEvent>;
+    private messages;
 }
 export {};