Documentation

Class: FinderApp

nyc/ol/FinderApp~ FinderApp

new FinderApp(options)

A class that provides a template for creating basic finder apps

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

Constructor options
Source:

Members

filters :module:nyc/ol/Filters~Filters

The filters for filtering the facilities

Type:
Source:

tabs :module:nyc/Tabs~Tabs

The tabs containing the map, facilities and filters

Type:
Source:

Methods

createDecorations(options, format)

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

Constructor options
format ol.format.Feature

The OpenLayers feature format
Source:
Returns:

Decorations

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

<protected> createFilters( [choiceOptions])

Creates the filters for the facility features

Parameters:
Name Type Argument Description
choiceOptions Array.<module:nyc/ol/Filters~Filters.ChoiceOptions> <optional>

Choice options
Source:
Returns:

Filters

Type
module:nyc/ol/Filters~Filters

createParentFormat(options)

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

Constructor options
Source:
Returns:

The parent format

Type
ol.format.Feature

<protected> createTabs(options)

Creates the tabs for the map, facilities and filters

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

Options
Source:
Returns:

Tabs

Type
module:nyc/Tabs~Tabs

directionsTo(feature)

Provides directions to the provided facility feature

Parameters:
Name Type Description
feature ol.Feature

OpenLayers feature
Source:

<protected> located(location)

Handles geocoded and geolocated events

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

Location
Source:

resetList(event)

Reset the facilities list

Parameters:
Name Type Description
event Object

Event object
Source:

<protected> tabChange(tabs)

Handles the tab change event

Parameters:
Name Type Description
tabs module:nyc/Tabs~Tabs

Tabs
Source:

zoomTo(feature)

Centers and zooms to the provided feature

Parameters:
Name Type Description
feature ol.Feature

OpenLayers feature
Source:

Type Definitions

Options

Constructor options for module:nyc/ol/FinderApp~FinderApp

Type:
  • Object
Properties:
Name Type Argument Default Description
title string

The app title
splashOptions module:nyc/Dialog~Dialog.Options

Content to display as a splash page
facilityTabTitle string <optional>
 Facilities

Title for the facilites list
facilityUrl string

The URL for the facility features data
facilityFormat ol.format.Feature <optional>

The format of the facilities data
facilityStyle ol.style.Style

The styling for the facilities layer
facilitySearch module:nyc/Search~Search.FeatureSearchOptions | boolean <optional>
 false

Search options for feature searches or true to use default search options
filterTabTitle string <optional>
 Filters

Title for the filters tab
filterChoiceOptions Array.<module:nyc/ol/Filters~Filters.ChoiceOptions> <optional>

Filter definitions
geoclientUrl string

The URL for the Geoclient geocoder with approriate keys
directionsUrl string

The URL for the Google directions API with approriate keys
mouseWheelZoom boolean <optional>
 true

Allow mouse wheel map zooming
Source: