Documentation

Class: Search

nyc/ol/Search~ Search

Class for providing a set of buttons to zoom and search.

Parameters:
Name Type Description
target jQuery | Element | string

The target
Source:
Fires:

Extends

Methods

disambiguate(ambiguous)

Displays possible address matches

Parameters:
Name Type Description
ambiguous module:nyc/Locator~Locator.Ambiguous

Possible locations resulting from a geocoder search to display to the user
Inherited From:
Source:

featureAsLocation(feature, options)

Parameters:
Name Type Description
feature Object

The feature object
options module:nyc/Search~Search.FeatureSearchOptions

Describes how to convert feature
Inherited From:
Overrides:
Source:
Returns:

The location

Type
module:nyc/Locator~Locator.Result

removeFeatures(featureTypeName)

Remove searchable features

Parameters:
Name Type Description
featureTypeName string

The featureTypeName used when the features were set
Inherited From:
Source:

setFeatures(options)

Add searchable features

Parameters:
Name Type Description
options module:nyc/Search~Search.FeatureSearchOptions

The options for creating a feature search
Inherited From:
Source:

val( [val])

Set or get the value of the search field

Parameters:
Name Type Argument Description
val string <optional>

The value for the search field
Inherited From:
Source:
Returns:

The value of the search field

Type
string

Events

disambiguated

The user has chosen a location from a list of possible locations

Type: module:nyc/Locate~Locate.Result
Inherited From:
Source:

search

The user has requested a search based on their text input

Type: string
Inherited From:
Source: