Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LocatorSearchSource

Hierarchy

Index

Properties

apiKey

apiKey: string

An authorization string used to access a resource or service.

Read more...

autoNavigate

autoNavigate: boolean

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

Read more...

categories

categories: string[]

A string array which limits the results to one or more categories.

Read more...

countryCode

countryCode: string

Constricts search results to a specified country code.

Read more...

declaredClass

declaredClass: string

defaultZoomScale

defaultZoomScale: number

Sets the scale of the MapView or SceneView for the resulting search result, if the locator service doesn’t return an extent with a scale.

Read more...

destroyed

destroyed: boolean

filter

For filtering suggests or search results.

Read more...

getResults

getResults: GetResultsHandler

Function used to get search results.

Read more...

getSuggestions

getSuggestions: GetSuggestionsParameters

Function used to get search suggestions.

Read more...

initialized

initialized: boolean

locationType

locationType: "rooftop" | "street"

Defines the type of location, either street or rooftop, of the point returned from the World Geocoding Service.

Read more...

locator

locator: Locator

The locator task used to search.

Read more...

maxResults

maxResults: number

Indicates the maximum number of search results to return.

Read more...

maxSuggestions

maxSuggestions: number

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

Read more...

minSuggestCharacters

minSuggestCharacters: number

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

Read more...

name

name: string

The name of the source for display.

Read more...

outFields

outFields: string[]

Specifies the fields returned with the search results.

Read more...

placeholder

placeholder: string

Used as a hint for the source input text.

Read more...

popupEnabled

popupEnabled: boolean

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

Read more...

popupTemplate

popupTemplate: PopupTemplate

The popup template used to display search results.

Read more...

prefix

prefix: string

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

Read more...

resultGraphicEnabled

resultGraphicEnabled: boolean

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

Read more...

resultSymbol

resultSymbol: Symbol

The symbol used to display the result.

Read more...

searchTemplate

searchTemplate: string

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

Read more...

singleLineFieldName

singleLineFieldName: string

The field name of the Single Line Address Field in the REST services directory for the locator service.

Read more...

suffix

suffix: string

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

Read more...

suggestionsEnabled

suggestionsEnabled: boolean

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

Read more...

withinViewEnabled

withinViewEnabled: boolean

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

Read more...

zoomScale

zoomScale: number

The set zoom scale for the resulting search result.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns LocatorSearchSource

clone

  • Creates a deep clone of this object.

    Read more...

    Returns LocatorSearchSource

destroy

  • destroy(): void
  • Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns LocatorSearchSource

  • Parameters

    Returns LocatorSearchSource

toJSON

  • toJSON(): any
  • Converts an instance of this class to its ArcGIS portal JSON representation.

    Read more...

    Returns any

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

Generated using TypeDoc