Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchViewModel

Hierarchy

Index

Properties

Readonly activeSource

The source object currently selected.

Read more...

activeSourceIndex

activeSourceIndex: number

The selected source's index.

Read more...

allPlaceholder

allPlaceholder: string

String value used as a hint for input text when searching on multiple sources.

Read more...

Readonly allSources

The combined collection of defaultSources and sources.

Read more...

autoSelect

autoSelect: boolean

Indicates whether to automatically select and zoom to the first geocoded result.

Read more...

declaredClass

declaredClass: string

Readonly defaultSources

A read-only property that is a Collection of LayerSearchSource and/or LocatorSearchSource.

Read more...

defaultSymbol

defaultSymbol: Symbol

The default symbol for the search result.

Read more...

destroyed

destroyed: boolean

goToOverride

goToOverride: GoToOverride

This function provides the ability to override either the IMapView goTo() or SceneView goTo() methods.

Read more...

includeDefaultSources

includeDefaultSources: boolean | Function

Indicates whether or not to include defaultSources in the Search UI.

Read more...

initialized

initialized: boolean

locationEnabled

locationEnabled: boolean

Indicates whether location services are enabled within the widget.

Read more...

maxInputLength

maxInputLength: number

The maximum character length of the search text.

Read more...

maxResults

maxResults: number

The maximum number of results returned by the widget if not specified by the source.

Read more...

maxSuggestions

maxSuggestions: number

The maximum number of suggestions returned by the widget if not specified by the source.

Read more...

minSuggestCharacters

minSuggestCharacters: number

The minimum number of characters needed for the search if not specified by the source.

Read more...

Readonly placeholder

placeholder: string

The placeholder used by the activeSource.

Read more...

popupEnabled

popupEnabled: boolean

Indicates whether to display the Popup on feature click.

Read more...

popupTemplate

popupTemplate: PopupTemplate

A customized PopupTemplate for the selected feature.

Read more...

portal

portal: Portal

It is possible to search a specified portal instance's locator services Use this property to set this ArcGIS Portal instance to search.

Read more...

Readonly resultGraphic

resultGraphic: Graphic

The graphic used to highlight the resulting feature or location.

Read more...

resultGraphicEnabled

resultGraphicEnabled: boolean

Indicates if the resultGraphic will display at the location of the selected feature.

Read more...

Readonly results

results: any[]

An array of current results from the search.

Read more...

searchAllEnabled

searchAllEnabled: boolean

Indicates whether to display the option to search all sources.

Read more...

searchTerm

searchTerm: string

The value of the search box input text string.

Read more...

Readonly selectedResult

selectedResult: any

The result selected from a search.

Read more...

Readonly selectedSuggestion

The selected SuggestResult.

Read more...

sources

The Search widget may be used to search features in a FeatureLayer or table, or geocode locations with a Locator.

Read more...

Readonly state

state: "disabled" | "ready" | "loading" | "searching"

The current state of the widget.

Read more...

suggestionDelay

suggestionDelay: number

The millisecond delay after keyup and before making a suggest network request.

Read more...

Readonly suggestions

An array of results from the suggest method.

Read more...

suggestionsEnabled

suggestionsEnabled: boolean

Enable suggestions for the widget.

Read more...

Readonly updating

updating: boolean

Indicates whether the View or Portal is loading resources prior to use.

Read more...

view

A reference to the MapView or SceneView.

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 SearchViewModel

clear

  • clear(): void
  • Clears the current value, search results, suggest results, graphic, and graphics layer.

    Read more...

    Returns void

destroy

  • destroy(): void
  • Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

get

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

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

search

searchNearby

  • Returns search results near your current location.

    Read more...

    Returns Promise<SearchViewModelSearchResponse>

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SearchViewModel

  • Parameters

    Returns SearchViewModel

suggest

  • Performs a suggest() request on the active Locator.

    Read more...

    Parameters

    • Optional value: string

    Returns Promise<SearchViewModelSuggestResponse>

watch

  • Parameters

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

    Returns WatchHandle

Generated using TypeDoc