Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LayerSearchSourceProperties

Hierarchy

Index

Properties

Optional autoNavigate

autoNavigate: boolean

Indicates whether to automatically navigate to the selected result once selected.

Read more...

Optional displayField

displayField: string

The results are displayed using this field.

Read more...

Optional exactMatch

exactMatch: boolean

Indicates to only return results that match the search value exactly.

Read more...

Optional filter

For filtering suggests or search results.

Read more...

Optional getResults

getResults: GetResultsHandler

Function used to get search results.

Read more...

Optional getSuggestions

getSuggestions: GetSuggestionsParameters

Function used to get search suggestions.

Read more...

Optional layer

The layer queried in the search.

Read more...

Optional maxResults

maxResults: number

Indicates the maximum number of search results to return.

Read more...

Optional maxSuggestions

maxSuggestions: number

Indicates the maximum number of suggestions to return for the widget's input.

Read more...

Optional minSuggestCharacters

minSuggestCharacters: number

Indicates the minimum number of characters required before querying for a suggestion.

Read more...

Optional name

name: string

The name of the source for display.

Read more...

Optional orderByFields

orderByFields: string[]

One or more field names used to order the query results.

Read more...

Optional outFields

outFields: string[]

Specifies the fields returned with the search results.

Read more...

Optional placeholder

placeholder: string

Used as a hint for the source input text.

Read more...

Optional popupEnabled

popupEnabled: boolean

Indicates whether to display a Popup when a selected result is clicked.

Read more...

Optional popupTemplate

The popup template used to display search results.

Read more...

Optional prefix

prefix: string

Specify this to prefix the user's input of the search text.

Read more...

Optional resultGraphicEnabled

resultGraphicEnabled: boolean

Indicates whether to show a graphic on the map for the selected source using the resultSymbol.

Read more...

Optional resultSymbol

resultSymbol: SymbolProperties

The symbol used to display the result.

Read more...

Optional searchFields

searchFields: string[]

An array of string values representing the names of fields in the feature layer to search.

Read more...

Optional searchTemplate

searchTemplate: string

A template string used to display multiple fields in a defined order when results are displayed.

Read more...

Optional suffix

suffix: string

Specify this to add a suffix to the user's input for the search value.

Read more...

Optional suggestionTemplate

suggestionTemplate: string

A template string used to display multiple fields in a defined order when suggestions are displayed.

Read more...

Optional suggestionsEnabled

suggestionsEnabled: boolean

Indicates whether to display suggestions as the user enters input text in the widget.

Read more...

Optional withinViewEnabled

withinViewEnabled: boolean

Indicates whether to constrain the search results to the view's extent.

Read more...

Optional zoomScale

zoomScale: number

The set zoom scale for the resulting search result.

Read more...

Generated using TypeDoc