From abc6e948e0953e473362209a0fa203fe511ece98 Mon Sep 17 00:00:00 2001 From: rolux Date: Wed, 30 May 2012 22:39:47 +0200 Subject: [PATCH] update docs --- source/Ox.UI/js/Map/Map.js | 80 +++++++++++++++++++------------------- 1 file changed, 40 insertions(+), 40 deletions(-) diff --git a/source/Ox.UI/js/Map/Map.js b/source/Ox.UI/js/Map/Map.js index 931ce304..948e031c 100644 --- a/source/Ox.UI/js/Map/Map.js +++ b/source/Ox.UI/js/Map/Map.js @@ -1,13 +1,11 @@ 'use strict'; /*@ -Ox.Map Basic map object +Ox.Map Basic map object # DESCRIPTION -------------------------------------------------------------- Ox.Map is a wrapper around the Google Maps API. - # USAGE -------------------------------------------------------------------- - ([options[, self]]) -> Map object # ARGUMENTS ---------------------------------------------------------------- options options clickable If true, clicking on the map finds a place @@ -38,44 +36,46 @@ Ox.Map Basic map object showZoombar If true, the map has a zoombar zoomOnlyWhenFocused If true, scroll-zoom only when focused self Shared private variable - # EVENTS ------------------------------------------------------------------- - addplace Fires when a place has been added - place Place object - editplace Fires when a place has been edited - place Place object - geocode Fires when a google geocode request returns - latLng Query coordinates, or undefined - lat latitude - lng longitude - address Query string, or undefined - results <[o]> Google Maps geocode results - address_components <[o]> Address components - long_name Long name - short_name Short name + # USAGE -------------------------------------------------------------------- + ([options[, self]]) -> Map object + # EVENTS --------------------------------------------------------------- + addplace Fires when a place has been added + place Place object + editplace Fires when a place has been edited + place Place object + geocode Fires when a google geocode request returns + latLng Query coordinates, or undefined + lat latitude + lng longitude + address Query string, or undefined + results <[o]> Google Maps geocode results + address_components <[o]> Address components + long_name Long name + short_name Short name + types <[s]> Types (like "country" or "political") + formatted_address Formatted address + geometry Geometry + bounds Bounds + northEast North-east corner + lat Latitude + lng Longitude + southWest South-west corner + lat Latitude + lng Longitude + location Location + lat Latitude + lng Longitude + location_type Location type (like "APPROXIMATE") + viewport Viewport + northEast North-east corner + lat Latitude + lng Longitude + southWest South-west corner + lat Latitude + lng Longitude types <[s]> Types (like "country" or "political") - formatted_address Formatted address - geometry Geometry - bounds Bounds - northEast North-east corner - lat Latitude - lng Longitude - southWest South-west corner - lat Latitude - lng Longitude - location Location - lat Latitude - lng Longitude - location_type Location type (like "APPROXIMATE") - viewport Viewport - northEast North-east corner - lat Latitude - lng Longitude - southWest South-west corner - lat Latitude - lng Longitude - types <[s]> Types (like "country" or "political") - selectplace Fires when a place has been selected or deselected - place Place object + selectplace Fires when a place has been selected or deselected + place Place object # EXAMPLES -----------------------------------------------------------------