Class: FinderApp

nyc/ol/FinderApp~ FinderApp


new FinderApp(options)

A template for creating basic finder apps

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

Constructor options

Source:

Mixins

FEATURE_DECORATIONS

Members


filters :module:nyc/ol/Filters~Filters

Type:
Source:

layer :ol.layer.Vector

Type:
  • ol.layer.Vector
Source:

locationMgr :module:nyc/ol/LocationMgr~LocationMgr

Type:
Source:

map :ol.Map

Type:
  • ol.Map
Source:

Type:
Source:

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

Type:
  • module:nyc/ol/source/FilterAndSort~FilterAndSort
Source:

tabs :module:nyc/Tabs~Tabs

Type:
Source:

view :ol.View

Type:
  • ol.View
Source:

Methods


<static> handleButton(event)

Handles map and direction button click

Parameters:
Name Type Description
event jQuery.Event
Source:

<protected> createFilters( [choiceOptions])

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

<protected> createTabs(options)

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

directionsTo(feature)

Provides directions to the provided facility feature

Parameters:
Name Type Description
feature ol.Feature
Source:

<protected> expandDetail(event)

Parameters:
Name Type Description
event Object
Source:

<protected> located(location)

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

ready(features)

Handles features after they are loaded

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

The facility features

Source:

resetList(event)

Parameters:
Name Type Description
event Object
Source:

<protected> tabChange(tabs)

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

zoomTo(feature)

Centers and zooms the map on the provided feature

Parameters:
Name Type Description
feature ol.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/ZoomSearch~ZoomSearch.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

Source: