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

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

@@ -7,10 +7,9 @@ import { Nil } from '@arcgis/components-utils';
 import { Use } from '@arcgis/lumina/controllers';
 
 type ActiveMenu = "none" | "source" | "suggestion";
-declare const useSearchViewModel: (component: LitElement & 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,
+declare const useSearchViewModel: (component: LitElement & Pick<SearchViewModel, never> & import('../../controllers/useViewModel').ViewModelControllerUses<SearchViewModel>) => 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.
  *
@@ -24,25 +23,45 @@ declare const useSearchViewModel: (component: LitElement & Pick<SearchViewModel,
  * 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.
+ *
+ * [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/)
  */
 export declare class ArcgisSearch extends LitElement {
-    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;
+    /** @default "top-left" */
     position: __esri.UIPosition;
+    /**
+     * 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-Search-SearchViewModel.html#goToOverride)
+     *
+     * @since 4.33
+     */
     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.
+     *
+     * @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
+     * @default "search"
      */
     icon: string;
     /**
      * The current active menu of the Search component.
      *
+     * @default "none"
      */
     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}.
+     * [LayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html) or a [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html).
      *
      * @default null
      */
@@ -57,18 +76,16 @@ export declare class ArcgisSearch extends LitElement {
      * 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)
+     * ![search-allPlaceholder](https://developers.arcgis.com/javascript/latest/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}
+     * The combined collection of [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources)
+     * and [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).
+     * The [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources)
      * displays first in the Search UI.
-     *
-     * @readonly
      */
     readonly allSources: __esri.Collection<__esri.LayerSearchSource | __esri.LocatorSearchSource>;
     /**
@@ -78,41 +95,40 @@ export declare class ArcgisSearch extends LitElement {
      * geocoded results, you can set up a [search-complete](#event-search-complete) event handler and get the results
      * through the event object.
      *
-     * @default true
+     * @default false
      */
-    autoSelect: boolean;
+    autoSelectDisabled: 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
+     * A read-only property that is a [Collection](https://developers.arcgis.com/javascript/latest/api-reference/esri-core-Collection.html)
+     * of [LayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html)
+     * and/or [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html). 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.
+     * [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature
+     * layer(s), and/or [table(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html) as sources.
      *
-     * @readonly
+     * This property is used to populate the Search UI if the [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources) property is not set.
      */
     readonly defaultSources: __esri.Collection<__esri.LayerSearchSource | __esri.LocatorSearchSource>;
     /**
      * When true, the component is visually withdrawn and cannot be interacted with.
      *
+     * @default false
      */
     disabled: boolean;
     /**
-     * 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}.
+     * Indicates whether or not to include [defaultSources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#defaultSources) in the Search UI.
+     * This can be a boolean value or a function that returns an array of Search [sources](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#sources).
      *
-     * @default true
+     * @default false
      */
-    includeDefaultSources: boolean | Function;
+    includeDefaultSourcesDisabled: boolean | Function;
     /**
      * Enables location services within the component.
      *
-     * ![locationEnabled](../assets/img/apiref/widgets/search-locationEnabled.png)
+     * ![locationEnabled](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-locationEnabled.png)
      *
      * ::: esri-md class="warning"
      * The use of this property is only supported on secure origins.
@@ -122,9 +138,9 @@ export declare class ArcgisSearch extends LitElement {
      * (currently Chrome and Firefox).
      * :::
      *
-     * @default true
+     * @default false
      */
-    locationEnabled: boolean;
+    locationDisabled: boolean;
     /**
      * The maximum number of results returned by the component if not specified by the source.
      *
@@ -148,24 +164,24 @@ export declare class ArcgisSearch extends LitElement {
      */
     minSuggestCharacters: number;
     /**
-     * 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}.
+     * Indicates whether to display the [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html) on feature click. The graphic can
+     * be clicked to display a [Popup](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Popup.html).
      *
-     * @default true
+     * @default false
      */
-    popupEnabled: boolean;
+    popupDisabled: boolean;
     /**
-     * A customized {@link module:esri/PopupTemplate} for the selected feature.
-     * Note that any {@link module:esri/PopupTemplate templates}
+     * A customized [PopupTemplate](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html) for the selected feature.
+     * Note that any [templates](https://developers.arcgis.com/javascript/latest/api-reference/esri-PopupTemplate.html)
      * defined on [allSources](#allSources) take precedence over those defined directly on the template.
      *
      * @autocast
+     * @default null
      */
     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;
     /**
@@ -173,62 +189,62 @@ export declare class ArcgisSearch extends LitElement {
      *
      * :::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}
+     * [graphics](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-View.html#graphics)
+     * for [layer](https://developers.arcgis.com/javascript/latest/api-reference/esri-views-layers-LayerView.html)
      * that do not support the `highlight` method.
      * :::
      *
-     * @readonly
+     * @default null
      */
     readonly resultGraphic: nullish | __esri.Graphic;
     /**
      * Indicates if the [resultGraphic](#resultGraphic) will display at the
      * location of the selected feature.
      *
-     * @default true
+     * @default false
      */
-    resultGraphicEnabled: boolean;
+    resultGraphicDisabled: boolean;
     /**
      * An array of objects, each containing a [SearchResult](#SearchResult) from the search.
      *
-     * @readonly
+     * @default null
      */
     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)
+     * ![search-searchAllEnabled-true](https://developers.arcgis.com/javascript/latest/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)
+     * ![search-searchAllEnabled-false](https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/search-enablesearchingall-false.png)
      *
-     * @default true
+     * @default false
      */
-    searchAllEnabled: boolean;
+    searchAllDisabled: boolean;
     /** The value of the search box input text string. */
     searchTerm: string;
     /**
      * The result selected from a search.
      *
-     * @see [Event: select-result](#event-select-result)
-     * @see [select()](#select)
-     * @readonly
+     * @see [arcgisSelectResult](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-search/#arcgisSelectResult)
+     * @see [select()](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-SearchViewModel.html#select)
+     * @default null
      */
     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
+     * [map](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-MapImageLayer.html)/[feature](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-FeatureLayer.html) service feature
+     * layer(s), [SceneLayers](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-SceneLayer.html) with an associated feature layer,
+     * [BuildingComponentSublayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-buildingSublayers-BuildingComponentSublayer.html) with an associated feature layer,
+     * [GeoJSONLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-GeoJSONLayer.html), [CSVLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-CSVLayer.html) or
+     * [OGCFeatureLayer](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-OGCFeatureLayer.html), or [table](https://developers.arcgis.com/javascript/latest/api-reference/esri-webdoc-applicationProperties-SearchTable.html),
+     * or geocode locations with a [locator](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html). 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}
+     * * [LayerSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LayerSearchSource.html)
+     * * [LocatorSearchSource](https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-Search-LocatorSearchSource.html)
      *
      * Any combination of these sources may be used
      * together in the same instance of the Search component.
@@ -247,6 +263,7 @@ export declare class ArcgisSearch extends LitElement {
      * 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 null
      */
     readonly suggestions: nullish | __esri.SuggestResults[];
     /**
@@ -255,57 +272,112 @@ export declare class ArcgisSearch extends LitElement {
      * 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
+     * @default false
      */
-    suggestionsEnabled: boolean;
+    suggestionsDisabled: 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-search/#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;
-    readonly state: "ready" | "disabled" | "loading" | "searching";
-    /** Permanently destroy the component */
+    label?: string;
+    /**
+     * The current state of the component.
+     *
+     * @default "ready"
+     */
+    readonly state: "ready" | "loading" | "disabled" | "searching";
+    /**
+     * Clears the current searchTerm, search results, suggest results, graphic, and graphics layer.
+     * It also hides any open menus.
+     */
+    clear(): void;
+    /** Permanently destroy the component. */
     destroy(): Promise<void>;
     /**
-     * Brings focus to the component's text input.
+     * Depending on the sources specified, search() queries the feature layer(s) and/or performs
+     * address matching using any specified [locator(s)](https://developers.arcgis.com/javascript/latest/api-reference/esri-rest-locator.html) and
+     * returns any applicable results.
+     */
+    search(searchItem?: __esri.Graphic | __esri.Point | __esri.SuggestResult | Nil | number[] | string): Promise<__esri.SearchResponse | Nil>;
+    /**
+     * Performs a suggest() request on the active Locator. It also uses the current value of
+     * the component or one that is passed in.
      *
+     * Suggestions are 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`.
      */
+    suggest(query?: string): Promise<__esri.SuggestResponse | Nil>;
+    /** Brings focus to the component's text input. */
     setFocus(): 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>;
-    /**
-     * Fires when a result is cleared from the input box or a new result is selected.
-     */
+    /** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
+    readonly arcgisReady: TargetedEvent<this, void>;
+    /** 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.
-     */
+    /** 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.
-     */
+    /** Fires when the [search()](#search) method starts. */
     readonly arcgisSearchStart: TargetedEvent<this, __esri.SearchViewModelSearchStartEvent>;
-    /**
-     * Fires when a search result is selected.
-     */
+    /** 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.
-     */
+    /** 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.
-     */
+    /** Fires when the [suggest()](#suggest) method starts. */
     readonly arcgisSuggestStart: TargetedEvent<this, __esri.SearchViewModelSuggestStartEvent>;
-    private messages;
+    private messages: Partial<{
+        componentLabel: string;
+        searchButtonTitle: string;
+        placeholder: string;
+        searchIn: string;
+        all: string;
+        allPlaceholder: string;
+        locateError: string;
+        untitledResult: string;
+        untitledSource: string;
+        noResults: string;
+        noResultsFound: string;
+        noResultsFoundForValue: string;
+        showMoreResults: string;
+        hideMoreResults: string;
+        searchResult: string;
+        moreResultsHeader: string;
+        useCurrentLocation: string;
+    }> & import('@arcgis/lumina/controllers').T9nMeta<{
+        componentLabel: string;
+        searchButtonTitle: string;
+        placeholder: string;
+        searchIn: string;
+        all: string;
+        allPlaceholder: string;
+        locateError: string;
+        untitledResult: string;
+        untitledSource: string;
+        noResults: string;
+        noResultsFound: string;
+        noResultsFoundForValue: string;
+        showMoreResults: string;
+        hideMoreResults: string;
+        searchResult: string;
+        moreResultsHeader: string;
+        useCurrentLocation: string;
+    }>;
 }
 export {};