API Docs for: 0.0.8-0
Show:

QuickZoom Class

Uses
Defined in: javascript\src\RAMP\Modules\quickzoom.js:13
Module: QuickZoom
Parent Module: RAMP

The QuickZoom class handles zooming in the map based on province, city, or postal code. These zoom in services rely on web services which return extent values based the user-entered province, city, or postal code

Methods

changeExtent

(
  • url
  • query
)
private

Defined in javascript\src\RAMP\Modules\quickzoom.js:138

Change the extent of the map based on the extent data retrieved from the given url

Parameters:

populateCityDropDown

(
  • prov
)
private

Defined in javascript\src\RAMP\Modules\quickzoom.js:216

Populates the city dropdown menu with the cities in the selected province.

Parameters:

populateDropDown

(
  • url
  • select
  • mapFunc
)

Defined in javascript\src\RAMP\Modules\quickzoom.js:171

Populate the given dropdown with data from the given url.

Parameters:

  • url String

    the url to the service containing the data to populate the dropdown

  • select DObject

    the dojo Select object to populate

  • mapFunc Function

    the function to convert each element in the retrieved data to a label that can be added to the dropdown menu

validatePostalCode

(
  • fsa
)
private

Defined in javascript\src\RAMP\Modules\quickzoom.js:264

Returns true if the given postal code is valid, false otherwise.

Parameters:

Attributes

getConfigUrl

readonly

Inherited from GlobalStorage: javascript\src\RAMP\Modules\globalStorage.js:22

Returns a URL that points to the application configuration (JSON format) if it's hosted on a web service. This is not required if the application has a JSON config file in the website's folder