Documentation

Class: FrameworkMap

nyc/ol/FrameworkMap~ FrameworkMap

new FrameworkMap(options)

Class that provides module:nyc/ol/Basemap~Basemap, module:nyc/ol/LocationMgr~LocationMgr and displays facility data from CSV

Parameters:
Name Type Description
options module:nyc/ol/MapMgr~MapMgr.Options

Constructor options
Source:

Extends

Mixins

FEATURE_DECORATIONS

Members

layer :ol.layer.Vector

The vector layer for facilities

Type:
  • ol.layer.Vector
Inherited From:
Overrides:
Source:

locationMgr :module:nyc/ol/LocationMgr~LocationMgr

The LocationMgr

Type:
Inherited From:
Overrides:
Source:

map :ol.Map

The map

Type:
  • ol.Map
Inherited From:
Overrides:
Source:

The popup

Type:
Inherited From:
Overrides:
Source:

source :module:nyc/ol/source/FilterAndSort~FilterAndSort

The data to display in the map layer

Type:
Inherited From:
Overrides:
Source:

view :ol.View

The view

Type:
  • ol.View
Inherited From:
Overrides:
Source:

Methods

createDecorations(options)

Create the feature decorations

Parameters:
Name Type Description
options module:nyc/ol/MapMgr~MapMgr.Options

Constructor options
Inherited From:
Overrides:
Source:
Returns:

The combined decorations

Type
Array.<Object.<string, Object>>

<abstract> createLayer(source, style)

Create the leayer

Parameters:
Name Type Description
source module:nyc/ol/MapMgr~MapMgr.Options

The data source for the layer
style ol.style.Style

The style for the layer
Inherited From:
Overrides:
Source:
Returns:

The layer

Type
ol.layer.Vector

createParentFormat(options)

Create the parent format for the source

Parameters:
Name Type Description
options module:nyc/ol/MapMgr~MapMgr.Options

Constructor options
Inherited From:
Overrides:
Source:
Returns:

The parent format

Type
ol.format.Feature

directionsTo(feature)

Provides directions to the provided facility feature

Parameters:
Name Type Description
feature ol.Feature

OpenLayers feature
Inherited From:
Overrides:
Source:

<protected> expandDetail(event)

Handles the event triggered when a rendered feature's collapsible details is expanded

Parameters:
Name Type Description
event Object

Event object
Inherited From:
Overrides:
Source:

<protected> focusInfo()

Focus on screen reader alert

Inherited From:
Overrides:
Source:

<protected> getFromAddr()

Convert current user location into usable form for Google directions API

Inherited From:
Overrides:
Source:
Returns:

Location coordinates or name

Type
string | Array.<number>

highlight( [feature])

Highlight a single feature on the map

Parameters:
Name Type Argument Description
feature ol.Feature <optional>

The feature
Inherited From:
Overrides:
Source:

<protected> loadFailed(err)

Parameters:
Name Type Description
err Error

The Error
Inherited From:
Overrides:
Source:

<protected> located(location)

Handles geocoded and geolocated events

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

Location
Inherited From:
Overrides:
Source:

<protected> ready(features)

Handles features after they are loaded

Parameters:
Name Type Description
features Array.<ol.Feature>

The facility features
Inherited From:
Overrides:
Source:

resetList(event)

Reset the facilities list

Parameters:
Name Type Description
event Object

Event object
Inherited From:
Overrides:
Source:

zoomTo(feature)

Centers and zooms to the provided feature

Parameters:
Name Type Description
feature ol.Feature

OpenLayers feature
Inherited From:
Overrides:
Source: