Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DirectionsSearchProperties

Configurable Search properties of the widget.

Read more...

Hierarchy

  • Object
    • DirectionsSearchProperties

Index

Properties

Optional activeSourceIndex

activeSourceIndex: number

Number index indicating the current selected source.

Read more...

Optional allPlaceholder

allPlaceholder: string

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

Read more...

Optional autoNavigate

autoNavigate: boolean

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

Read more...

Optional autoSelect

autoSelect: boolean

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

Read more...

constructor

constructor: Function

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

Optional includeDefaultSources

includeDefaultSources: boolean | Function

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

Read more...

Optional locationType

locationType: string

Define the type of location, either "street" or "rooftop".

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 popupEnabled

popupEnabled: boolean

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

Read more...

Optional popupTemplate

popupTemplate: PopupTemplate

A customized PopupTemplate for the selected feature.

Read more...

Optional resultGraphicEnabled

resultGraphicEnabled: boolean

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

Read more...

Optional searchAllEnabled

searchAllEnabled: boolean

Indicates whether to display the option to search all sources.

Read more...

Optional searchTerm

searchTerm: string

The value of the search box input text string.

Read more...

Optional sources

Specifies the sources to search in the view.

Read more...

Optional suggestionsEnabled

suggestionsEnabled: boolean

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

Read more...

Optional view

The view of the widget.

Read more...

Optional viewModel

viewModel: SearchViewModel

The Search widget's view model.

Read more...

Methods

hasOwnProperty

  • hasOwnProperty(v: PropertyKey): boolean
  • Determines whether an object has a property with the specified name.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

isPrototypeOf

  • isPrototypeOf(v: Object): boolean
  • Determines whether an object exists in another object's prototype chain.

    Parameters

    • v: Object

      Another object whose prototype chain is to be checked.

    Returns boolean

propertyIsEnumerable

  • propertyIsEnumerable(v: PropertyKey): boolean
  • Determines whether a specified property is enumerable.

    Parameters

    • v: PropertyKey

      A property name.

    Returns boolean

toLocaleString

  • toLocaleString(): string
  • Returns a date converted to a string using the current locale.

    Returns string

toString

  • toString(): string
  • Returns a string representation of an object.

    Returns string

valueOf

  • valueOf(): Object
  • Returns the primitive value of the specified object.

    Returns Object

Generated using TypeDoc