Documentation

Class: MapLocator

nyc/MapLocator~ MapLocator

<abstract> new MapLocator()

An abstract class for managing map location

Source:

Members

<static, constant> ZOOM_LEVEL :number

The default zoom level when zooming to locations

Type:
  • number
Source:

Methods

<abstract> getProjection()

Get the projection of the map

Source:
Returns:

The map projection

Type
string

<abstract> setLocation(data)

Set the location to the provided loacation without moving the map

Parameters:
Name Type Description
data module:nyc/Locator~Locator.Result

The location
Source:

<abstract> zoomLocation(data [, callback])

Zoom to the provided loacation then optionally invoke a callback function

Parameters:
Name Type Argument Description
data module:nyc/Locator~Locator.Result

The location to which the map will be oriented
callback module:nyc/MapLocator~MapLocator#zoomLocationCallback <optional>

The function to call after the locator has zoomed to the location
Source:

Type Definitions

zoomLocationCallback()

Callback for module:nyc/MapLocator~MapLocator#zoomLocation

Source: