maps.nyc.gov

Class: Locator

nyc.ol.Locator(options)

new Locator(options)

A class for managing map location
Parameters:
Name Type Description
options nyc.ol.Locator.Options Constructor options
Implements:
Source:

Members

layer :ol.layer.Vector

Type:
  • ol.layer.Vector
Source:

Methods

setLocation(data)

Parameters:
Name Type Description
data nyc.Locate.Result The data to set as the location
Source:

zoomLocation(data, callback)

Parameters:
Name Type Description
data nyc.Locate.Result The location to which the map will be oriented
callback function The function to call after the locator has zoomed to the location
Implements:
Source:

Type Definitions

Options

Object type to hold constructor options for nyc.ol.Locator
Type:
  • Object
Properties:
Name Type Attributes Default Description
map ol.Map The map on which location will be managed
style ol.style.Style <optional>
The style for the layer on which user-specified locations will be displayed
info nyc.info.Finder <optional>
Building or tax lot feature finder
zoom number <optional>
nyc.ol.Locate.ZOOM_LEVEL The zoom level used when locating coordinates
Source:

nyc-lib: Class: Locator

maps.nyc.gov

Class: Locator

nyc.ol.Locator(options)

new Locator(options)

A class for managing map location
Parameters:
Name Type Description
options nyc.ol.Locator.Options Constructor options
Implements:
Source:

Members

layer :ol.layer.Vector

Type:
  • ol.layer.Vector
Source:

Methods

setLocation(data)

Parameters:
Name Type Description
data nyc.Locate.Result The data to set as the location
Source:

zoomLocation(data, callback)

Parameters:
Name Type Description
data nyc.Locate.Result The location to which the map will be oriented
callback function The function to call after the locator has zoomed to the location
Implements:
Source:

Type Definitions

Options

Object type to hold constructor options for nyc.ol.Locator
Type:
  • Object
Properties:
Name Type Attributes Default Description
map ol.Map The map on which location will be managed
style ol.style.Style <optional>
The style for the layer on which user-specified locations will be displayed
info nyc.info.Finder <optional>
Building or tax lot feature finder
zoom number <optional>
nyc.ol.Locate.ZOOM_LEVEL The zoom level used when locating coordinates
Source: