maps.nyc.gov

Class: Basemap

nyc.Basemap

(abstract) new Basemap(options)

An abstract class for creating and manipulating the NYC basemap
Parameters:
Name Type Description
options nyc.Basemap.Options Constructor options
Source:

Members

(static) LabelType :string

Enumerator for label types
Type:
  • string
Properties:
Name Type Description
BASE string Label type for base layer
PHOTO string Label type for photo layer
Source:

Methods

(abstract) getBaseLayers() → {nyc.Basemap.BaseLayers}

Returns the base layers
Source:
Returns:
Type
nyc.Basemap.BaseLayers

(abstract) getStorage() → {nyc.storage.Local}

Get the storage used for laoding and saving data
Source:
Returns:
srorage
Type
nyc.storage.Local

(abstract) hidePhoto()

Hide photo layer
Source:

loadLayer() → {nyc.Basemap.BaseLayers}

Returns the base layers
Source:
Returns:
Type
nyc.Basemap.BaseLayers

(abstract) showLabels(labelType)

Show the specified label layer
Parameters:
Name Type Description
labelType nyc.Basemap.LabelType The label type to show
Source:

(abstract) showPhoto(layer)

Show photo layer
Parameters:
Name Type Description
layer number The photo year to show
Source:

sortedPhotos() → {nyc.Basemap.BaseLayers}

Returns the base layers
Source:
Returns:
Type
nyc.Basemap.BaseLayers

Type Definitions

BaseLayers

Object type to hold base layers
Type:
  • Object
Properties:
Name Type Description
base Object The base layer
labels Object.<string, (ol.layer.Base|L.Layer)> The label layers
photos Object.<string, (ol.layer.Base|L.Layer)> The photo layers
Source:

Options

Object type to hold constructor options for nyc.Basemap
Type:
  • Object
Properties:
Name Type Description
target Element | JQuery | string The target DOM node for creating the map
Source: