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
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:
-
popup :module:nyc/ol/MultiFeaturePopup~MultiFeaturePopup
-
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 eventjQuery.Event - Source:
-
<protected> createFilters( [choiceOptions])
-
Parameters:
Name Type Argument Description choiceOptionsArray.<module:nyc/ol/Filters~Filters.ChoiceOptions> <optional>
- Source:
Returns:
-
<protected> createTabs(options)
-
Parameters:
Name Type Description optionsmodule: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 featureol.Feature - Source:
-
<protected> expandDetail(event)
-
Parameters:
Name Type Description eventObject - Source:
-
<protected> located(location)
-
Parameters:
Name Type Description locationmodule:nycLocator~Locator.Result - Source:
-
ready(features)
-
Handles features after they are loaded
Parameters:
Name Type Description featuresArray.<ol.Feature> The facility features
- Source:
-
resetList(event)
-
Parameters:
Name Type Description eventObject - Source:
-
<protected> tabChange(tabs)
-
Parameters:
Name Type Description tabsmodule:nyc/Tabs~Tabs - Source:
-
zoomTo(feature)
-
Centers and zooms the map on the provided feature
Parameters:
Name Type Description featureol.Feature - Source:
Type Definitions
-
Options
-
Constructor options for module:nyc/ol/FinderApp~FinderApp
Type:
- Object
- Source:
Properties:
Name Type Argument Default Description titlestring The app title
splashOptionsmodule:nyc/Dialog~Dialog.Options Content to display as a splash page
facilityTabTitlestring <optional>
Facilities Title for the facilites list
facilityUrlstring The URL for the facility features data
facilityFormatol.format.Feature <optional>
The format of the facilities data
facilityStyleol.style.Style The styling for the facilities layer
facilitySearchmodule:nyc/ZoomSearch~ZoomSearch.FeatureSearchOptions | boolean <optional>
false Search options for feature searches or true to use default search options
filterTabTitlestring <optional>
Filters Title for the filters tab
filterChoiceOptionsArray.<module:nyc/ol/Filters~Filters.ChoiceOptions> <optional>
Filter definitions
geoclientUrlstring The URL for the Geoclient geocoder with approriate keys
directionsUrlstring The URL for the Google directions API with approriate keys