Class JGoogleEmbedMaps

Description
Description | Vars (details) | Methods (details)

Google Maps embed class for the Joomla Platform.

  • since: 12.3

Located in /libraries/joomla/google/embed/maps.php (line 19) 

JGoogleEmbed
   |
   --JGoogleEmbedMaps
Variable Summary
Description | Vars (details) | Methods (details)
JHttp $http
Method Summary
Description | Vars (details) | Methods (details)
JGoogleEmbedMaps __construct ([JRegistry $options = null], [JUri $uri = null], [JHttp $http = null])
mixed addMarker (mixed $location, [mixed $title = null], [array $options = array()])
array deleteMarker ([int $index = null])
array geocodeAddress (string $address)
string getAdditionalJavascript ()
string getAdditionalMapOptions ()
string getAsyncCallback ()
string getAutoload ()
string getBody ()
mixed getCenter ()
string getHeader ()
string getKey ()
string getMapClass ()
string getMapID ()
string getMapStyle ()
string getMapType ()
int getZoom ()
boolean hasSensor ()
boolean isAsync ()
array listMarkers ()
JGoogleEmbedAMaps noSensor ()
JGoogleEmbedMaps setAdditionalJavascript (array $script)
JGoogleEmbedMaps setAdditionalMapOptions (array $options)
JGoogleEmbedMaps setAsyncCallback (string $callback)
JGoogleEmbedAMaps setAutoload ([string $type = 'onload'])
JGoogleEmbedMaps setCenter (mixed $location, [mixed $title = true], [array $markeroptions = array()])
JGoogleEmbedMaps setKey (string $key)
JGoogleEmbedMaps setMapClass (string $class)
JGoogleEmbedMaps setMapID (string $id)
JGoogleEmbedMaps setMapStyle (string $style)
JGoogleEmbedMaps setMapType (string $type)
JGoogleEmbedMaps setZoom (int $zoom)
JGoogleEmbedMaps useAsync ()
JGoogleEmbedMaps useSensor ()
JGoogleEmbedAMaps useSync ()
Variables
Description | Vars (details) | Methods (details)
JHttp $http (line 26)
  • var: The HTTP client object to use in sending HTTP requests.
  • since: 12.3
  • access: protected

Inherited Variables

Inherited from JGoogleEmbed

JGoogleEmbed::$options
 JGoogleEmbed::$uri
Methods
Description | Vars (details) Methods (details)
Constructor __construct (line 37)

Constructor.

  • since: 12.3
  • access: public
JGoogleEmbedMaps __construct ([JRegistry $options = null], [JUri $uri = null], [JHttp $http = null])
  • JRegistry $options: Google options object
  • JUri $uri: URL of the page being rendered
  • JHttp $http: Http client for geocoding requests
Redefinition of:
JGoogleEmbed::__construct()
Constructor.
addMarker (line 331)

Add a marker to the map

  • return: The marker or false on failure
  • since: 12.3
  • access: public
mixed addMarker (mixed $location, [mixed $title = null], [array $options = array()])
  • mixed $location: A latitude longitude array or an address string
  • mixed $title: The hover-text for the marker
  • array $options: Options for marker
deleteMarker (line 385)

Delete a marker from the map

  • return: The latitude/longitude of the deleted marker
  • since: 12.3
  • access: public
array deleteMarker ([int $index = null])
  • int $index: Index of marker to delete (defaults to last added marker)
geocodeAddress (line 675)

Method to get the location information back from an address

  • return: An array containing Google's geocode data
  • since: 12.3
  • access: public
array geocodeAddress (string $address)
  • string $address: The address to geocode
getAdditionalJavascript (line 218)

Method to get additional map options

  • return: The options
  • since: 12.3
  • access: public
string getAdditionalJavascript ()
getAdditionalMapOptions (line 190)

Method to get additional map options

  • return: The options
  • since: 12.3
  • access: public
string getAdditionalMapOptions ()
getAsyncCallback (line 454)

Method to get callback function for async javascript loading

  • return: The ID
  • since: 12.3
  • access: public
string getAsyncCallback ()
getAutoload (line 522)

Checks how the script should be loaded

  • return: Autoload type (onload, jquery, mootools, or false)
  • since: 12.3
  • access: public
string getAutoload ()
getBody (line 643)

Method to retrieve the div that the map is loaded into

  • return: The body
  • since: 12.3
  • access: public
string getBody ()
Redefinition of:
JGoogleEmbed::getBody()
Method to retrieve the body for the API
getCenter (line 274)

Method to set the center of the map

  • return: A latitude longitude array or an address string
  • since: 12.3
  • access: public
mixed getCenter ()
getHeader (line 550)

Get code to load Google Maps javascript

  • return: Javascript code
  • since: 12.3
  • access: public
string getHeader ()
Redefinition of:
JGoogleEmbed::getHeader()
Method to retrieve the header for the API
getKey (line 50)

Method to get the API key

  • return: The Google Maps API key
  • since: 12.3
  • access: public
string getKey ()
getMapClass (line 106)

Method to get the class of the map div

  • return: The class
  • since: 12.3
  • access: public
string getMapClass ()
getMapID (line 78)

Method to get the id of the map div

  • return: The ID
  • since: 12.3
  • access: public
string getMapID ()
getMapStyle (line 134)

Method to get the style of the map div

  • return: The style
  • since: 12.3
  • access: public
string getMapStyle ()
getMapType (line 162)

Method to get the map type setting

  • return: The class
  • since: 12.3
  • access: public
string getMapType ()
getZoom (line 246)

Method to get the zoom

  • return: The zoom level
  • since: 12.3
  • access: public
int getZoom ()
hasSensor (line 482)

Checks if a sensor is set to be required

  • return: True if asynchronous
  • since: 12.3
  • access: public
boolean hasSensor ()
isAsync (line 414)

Checks if the javascript is set to be asynchronous

  • return: True if asynchronous
  • since: 12.3
  • access: public
boolean isAsync ()
listMarkers (line 371)

List the markers added to the map

  • return: A list of markers
  • since: 12.3
  • access: public
array listMarkers ()
noSensor (line 508)

Don't require access to sensor data

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedAMaps noSensor ()
setAdditionalJavascript (line 232)

Method to add additional javascript

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setAdditionalJavascript (array $script)
  • array $script: Additional javascript
setAdditionalMapOptions (line 204)

Method to add additional map options

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setAdditionalMapOptions (array $options)
  • array $options: Additional map options
setAsyncCallback (line 468)

Method to set the callback function for async javascript loading

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setAsyncCallback (string $callback)
  • string $callback: The callback function name
setAutoload (line 536)

Automatically add the callback to the window

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedAMaps setAutoload ([string $type = 'onload'])
  • string $type: The method to add the callback (options are onload, jquery, mootools, and false)
setCenter (line 290)

Method to set the center of the map

  • return: The latitude/longitude of the center or false on failure
  • since: 12.3
  • access: public
JGoogleEmbedMaps setCenter (mixed $location, [mixed $title = true], [array $markeroptions = array()])
  • mixed $location: A latitude/longitude array or an address string
  • mixed $title: Title of marker or false for no marker
  • array $markeroptions: Options for marker
setKey (line 64)

Method to set the API key

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setKey (string $key)
  • string $key: The Google Maps API key
setMapClass (line 120)

Method to set the map div class

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setMapClass (string $class)
  • string $class: The class
setMapID (line 92)

Method to set the map div id

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setMapID (string $id)
  • string $id: The ID
setMapStyle (line 148)

Method to set the map div style

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setMapStyle (string $style)
  • string $style: The style
setMapType (line 176)

Method to set the map type ()

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setMapType (string $type)
  • string $type: Valid types are ROADMAP, SATELLITE, HYBRID, and TERRAIN
setZoom (line 260)

Method to set the map zoom

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps setZoom (int $zoom)
  • int $zoom: Zoom level (0 is whole world)
useAsync (line 426)

Load javascript asynchronously

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps useAsync ()
useSensor (line 494)

Require access to sensor data

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedMaps useSensor ()
useSync (line 440)

Load javascript synchronously

  • return: The object for method chaining
  • since: 12.3
  • access: public
JGoogleEmbedAMaps useSync ()

Inherited Methods

Inherited From JGoogleEmbed

JGoogleEmbed::__construct()
JGoogleEmbed::echoBody()
JGoogleEmbed::echoHeader()
JGoogleEmbed::getBody()
JGoogleEmbed::getHeader()
JGoogleEmbed::getOption()
JGoogleEmbed::isSecure()
JGoogleEmbed::setOption()

Documentation generated on Tue, 19 Nov 2013 15:07:38 +0100 by phpDocumentor 1.4.3