Search widget

The Search widget allows you to configure a search tool to find features, records, or locations based on specific layers and locators, and define how to display search results. If you add multiple search sources to the widget, users can choose which ones to search. Performing the search using a layer source affects data across your app, so other widgets that use the same layer are filtered to show the corresponding search result. Performing a search using a locator source generates an output data source that other widgets can use.

To search, users type a word or phrase in the search box and press Enter, click the search button, or choose from a list of suggestions that appear based on matching records. (The suggestions list displays each matching value as an item, so if a record has two fields that match the search phrase, that record appears as two suggestions.) Clicking a suggestion replaces the search phrase with the content from the suggested item to apply the search using the new value, which returns corresponding data in a result panel. You can also configure the widget to open another page in your app to show the result in another widget instead.

Examples

Use this widget to support app design requirements such as the following:

  • You want to configure a search option in your app that provides more flexibility than the search tool included in the Map, List, and Table widgets. In particular, you want to search limited fields for specific layers in the map, provide unique hint text in the search box, and display values for certain data fields in the results panel.
  • You want users to find information from multiple sources when performing a search.
  • You want to display search results in other widgets on a different page in your app.

Usage notes

The Search widget supports two types of search sources—layers and locators. When you add a Search widget, the ArcGIS World Geocoding Service is added as a locator source by default. To use another locator source, add a URL for the locator service. To search layers, select from feature layers and scene layers that are added as data to your app.

You can set actions for a Search widget to interact with other widgets in your app, such as zooming a map to the selected result or showing search results (from a locator source) in a map.

Settings

The Search widget includes the following settings:

  • New search source—Optionally add sources for searching content other than the default ArcGIS World Geocoding Service. Choose Layer source or Locator source and specify the following settings for each:
    • Data—If applicable, select the data source for the feature layer that you want users to search. In the data view settings, you can filter the data to limit the search scope or sort the data to display search results in a particular order.
    • Locator URL—If applicable, provide the locator service URL (that begins with https://).
    • Label—Type a name for the search source. This name appears in the search menu, the suggestion list, and the results panel.
    • Icon—Select an icon for the source. This icon shows in the suggestion list and the search results panel. You can choose icons from the General and Arrows galleries, or add your own icon from a file.
      Note:

      You can upload the following image formats: PNG, GIF, JPG, JPEG, and BMP.

    • Search options—Customize the hint text that appears in the search box when users choose to search only this source. For Layer source, you can set the following additional options:
      • Select searching fields—Choose one or more fields to search in the layer.
      • Exact match—Limit search results to only records that match the search phrase.
      • Display fields—Choose one or more fields to display in the search result panel. You can drag selected fields to reorder them.
  • General search options
    • Hint for multiple search sources—Customize the hint text that appears in the search box when users choose to search multiple sources.
    • Search suggestion—Define the maximum number of suggestions that appear for each search source. You can also configure the following options:
      • Use current location—Include a suggestion option to search based on the user’s current location.
      • Recent searches—Display the search history in the suggestion box based on a specified maximum number of recent searches. (Users can clear the search history.)
  • Search result—Choose to display a search results panel or link to a page in your app to show results in another widget.
    • Result panel—Displays the search results in a panel that opens under the search box. You can define the maximum number of results to display per search source and choose to automatically select the first result.
    • Set link—Opens a specific page in your app to show relevant search results in a corresponding widget.

Interaction options

When configured with a locator source, the Search widget generates an output data source that can be used in other widgets. The interaction with additional widgets using the same output data source is achieved through adding actions. For example, the map can automatically display the search results and zoom to the features. In the Search widget settings, on the Action tab, add the Records created trigger, select the target map, and add actions for Show on map and Zoom to.

To select a feature on a map that corresponds with a selected search result, add the Record selection changes trigger for the Search widget (when configured to use the results panel). Select the target framework, add the Select data records action, and configure it with the feature layer for the map and the fields that bind the connection between the trigger and action data. Additionally, you can add the Zoom to action to zoom the map to the feature.