Skip To Content
ArcGIS Developer
Dashboard

Search widget

(Added at v2.1)

The Search widget enables you to find locations in the scene. Unlike the Search widget in a 2D app, it does not support feature search. By default, the widget uses the geocoding service from your organization or portal. You can also add more geocoding services.

Configure the Search widget

The widget configuration window allows you to specify the geocoding services you want the widget to work with.

  1. Hover over the Search widget and click the Show or hide button Show or hide to show or hide this widget in your app.
  2. Hover over the widget and click the Configure this widget button Configure this widget to open the configuration window.
    Note:

    If you need to add the widget to the app first, click a widget placeholder on the Widget tab. In the Choose Widget window that opens, select the widget and click OK.

  3. By default, the widget uses the geocoding service from your organization or portal. Click Add Search Source, to add more geocoding services.

    There are two options: Geocoder and Feature Layer.

    • Choose Feature Layer.
    1. Click an option to choose a layer and click OK to close the window.
    2. The new layer source is automatically listed on the table. You can change the searchable layer name in the Name text box.
    3. Optionally type the text in the Placeholder Text text box.
    4. Click the pencil icon to add search fields. This opens the Set Search Fields window. Choose one or multiple fields. Numerical fields and string fields, including coded domains, are searchable. Click OK to close the window. You should see all the selected fields listed in the Search Fields text box.
    5. Click the drop-down list to choose the display field in the search suggestion.
      Caution:

      A geocode service must meet the following requirements to support the suggest operation:

      • The address locator from which the geocode service was published must support suggestions. Only address locators created using ArcGIS 10.3 for Desktop and later can support suggestions. See the Create Address Locator geoprocessing tool help topic for more information.
      • The geocode service must have the Suggest capability enabled. Only geocode services published using ArcGIS 10.3 for Server or later support the Suggest capability.

    6. By default, 6 is the maximum suggestions returned for a searchable layer. Change it if necessary.
    7. By default, 6 is the maximum results returned for a searchable layer. Change it if necessary.
    8. Be default, zoom scale is defined as 1:50,000. Change it if necessary.
    9. Optionally check the Exact Match check box if needed.
    10. Optionally check the Only search in current map extent check box if needed.
    • Choose Geocoder.
    1. The new Geocoder source is automatically listed on the table.
    2. Click the Set button to open the Set Geocoder URL window.
    3. Provide a valid URL for the geocoding service you want to use, click Validate to load the service, choose the service, and click OK.

      The geocoder URL is automatically added in the Geocoder URL text box. You can change the geocoder name in the Geocode Name text box.

    4. Optionally type text in the Placeholder Text text box.
    5. Optionally type the country or region code to limit the search area if applicable. See Geocode coverage for a code list.
    6. By default, 6 is the maximum suggestions and results returned. Change it if necessary.
    7. Define the scale to zoom to when geocoder does not return an extent.
      Caution:
      The zoom scale set in the widget only takes effect when the result does not have an associated extent. If the result returns an extent, it will be ignored.

    8. Check the Enable local search check box if needed. It allows you to define when to enable the local search by setting the map scale and specifying a search distance around the current map center so the candidates closest to the location are returned first.
    9. Optionally check the Only search in current map extent check box if needed.
  4. Under General Settings, set the placeholder text for geocoders.
  5. By default, a pop-up appears when the location is found on the scene. Uncheck the box if you don't want a pop-up to appear.
  6. Click OK to close the configuration window.

Use the Search widget

When you type a place-name in the search box, suggestions appear as you type. If an arrow appears in the search box, you can search on all sources, or click the arrow and choose a locator from the drop-down list.

A pop-up appears at the location of the place-name and displays any available attribute information.