0byt3m1n1
Path:
/
var
/
lib
/
vz
/
www
/
clients
/
client6
/
web11
/
web
/
wp-content
/
plugins
/
wp-google-maps
/
docs
/
[
Home
]
File: module-WPGMZA.html
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Module: WPGMZA</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Module: WPGMZA</h1> <section> <header> </header> <article> <div class="container-overview"> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".assertInstanceOf"><span class="type-signature">(static) </span>assertInstanceOf<span class="signature">(instance, instanceName)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">This function is for checking inheritence has been setup correctly. For objects that have engine and Pro specific classes, it will automatically add the engine and pro prefix to the supplied string and if such an object exists it will test against that name rather than the un-prefix argument supplied. For example, if we are running the Pro addon with Google maps as the engine, if you supply Marker as the instance name the function will check to see if instance is an instance of GoogleProMarker</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>instance</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">The object to check</td> </tr> <tr> <td class="name"><code>instanceName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The class name as a string which this object should be an instance of</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line251">line 251</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".assertInstanceOf"><span class="type-signature">(static) </span>assertInstanceOf<span class="signature">(instance, instanceName)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">This function is for checking inheritence has been setup correctly. For objects that have engine and Pro specific classes, it will automatically add the engine and pro prefix to the supplied string and if such an object exists it will test against that name rather than the un-prefix argument supplied. For example, if we are running the Pro addon with Google maps as the engine, if you supply Marker as the instance name the function will check to see if instance is an instance of GoogleProMarker</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>instance</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">The object to check</td> </tr> <tr> <td class="name"><code>instanceName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The class name as a string which this object should be an instance of</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line253">line 253</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".getCurrentPosition"><span class="type-signature">(static) </span>getCurrentPosition<span class="signature">()</span><span class="type-signature"> → {object}</span></h4> <p class="summary">This function will get the users position, it first attempts to get high accuracy position (mobile with GPS sensors etc.), if that fails (desktops will time out) then it tries again without high accuracy enabled</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line188">line 188</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The users position as a LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".getCurrentPosition"><span class="type-signature">(static) </span>getCurrentPosition<span class="signature">()</span><span class="type-signature"> → {object}</span></h4> <p class="summary">This function will get the users position, it first attempts to get high accuracy position (mobile with GPS sensors etc.), if that fails (desktops will time out) then it tries again without high accuracy enabled</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line190">line 190</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The users position as a LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".getImageDimensions"><span class="type-signature">(static) </span>getImageDimensions<span class="signature">(src, callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Utility function to get the dimensions of an image, caches results for best performance</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>src</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Image source URL</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve image dimensions</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line98">line 98</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".getImageDimensions"><span class="type-signature">(static) </span>getImageDimensions<span class="signature">(src, callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Utility function to get the dimensions of an image, caches results for best performance</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>src</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Image source URL</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve image dimensions</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line96">line 96</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".getMapByID"><span class="type-signature">(static) </span>getMapByID<span class="signature">(id)</span><span class="type-signature"> → {object}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">mixed</span> </td> <td class="description last">The ID of the map to retrieve</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line300">line 300</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The map object, or null if no such map exists </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".getMapByID"><span class="type-signature">(static) </span>getMapByID<span class="signature">(id)</span><span class="type-signature"> → {object}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">mixed</span> </td> <td class="description last">The ID of the map to retrieve</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line298">line 298</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The map object, or null if no such map exists </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".guid"><span class="type-signature">(static) </span>guid<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p class="summary">Utility function returns a GUID</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line13">line 13</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The GUID </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id=".guid"><span class="type-signature">(static) </span>guid<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p class="summary">Utility function returns a GUID</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line15">line 15</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The GUID </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id=".hexOpacityToRGBA"><span class="type-signature">(static) </span>hexOpacityToRGBA<span class="signature">(colour, opacity)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Takes a hex string and opacity value and converts it to Openlayers RGBA format</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colour</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The hex color string</td> </tr> <tr> <td class="name"><code>opacity</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">The opacity from 0.0 - 1.0</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line31">line 31</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> RGBA where color components are 0 - 255 and opacity is 0.0 - 1.0 </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".hexOpacityToRGBA"><span class="type-signature">(static) </span>hexOpacityToRGBA<span class="signature">(colour, opacity)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Takes a hex string and opacity value and converts it to Openlayers RGBA format</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colour</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The hex color string</td> </tr> <tr> <td class="name"><code>opacity</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">The opacity from 0.0 - 1.0</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line33">line 33</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> RGBA where color components are 0 - 255 and opacity is 0.0 - 1.0 </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".isDeveloperMode"><span class="type-signature">(static) </span>isDeveloperMode<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if developer mode is set</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line127">line 127</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if developer mode is on </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isDeveloperMode"><span class="type-signature">(static) </span>isDeveloperMode<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if developer mode is set</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line125">line 125</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if developer mode is on </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isGoogleAutocompleteSupported"><span class="type-signature">(static) </span>isGoogleAutocompleteSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Shorthand function to determine if the Places Autocomplete is available</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line313">line 313</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isGoogleAutocompleteSupported"><span class="type-signature">(static) </span>isGoogleAutocompleteSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Shorthand function to determine if the Places Autocomplete is available</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line315">line 315</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isLatLngString"><span class="type-signature">(static) </span>isLatLngString<span class="signature">(str)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Utility function returns true is string is a latitude and longitude</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line54">line 54</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> the matched latitude and longitude or null if no match </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".isLatLngString"><span class="type-signature">(static) </span>isLatLngString<span class="signature">(str)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Utility function returns true is string is a latitude and longitude</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line52">line 52</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> the matched latitude and longitude or null if no match </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".isProVersion"><span class="type-signature">(static) </span>isProVersion<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if the Pro add-on is active</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line138">line 138</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if the Pro add-on is active </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isProVersion"><span class="type-signature">(static) </span>isProVersion<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if the Pro add-on is active</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line136">line 136</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if the Pro add-on is active </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".openMediaDialog"><span class="type-signature">(static) </span>openMediaDialog<span class="signature">(callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Opens the WP media dialog and returns the result to a callback</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve the attachment ID as the first parameter and URL as the second</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line147">line 147</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".openMediaDialog"><span class="type-signature">(static) </span>openMediaDialog<span class="signature">(callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Opens the WP media dialog and returns the result to a callback</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve the attachment ID as the first parameter and URL as the second</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line149">line 149</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".runCatchableTask"><span class="type-signature">(static) </span>runCatchableTask<span class="signature">(callback, friendlyErrorContainer)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Runs a catchable task and displays a friendly error if the function throws an error</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">The function to run</td> </tr> <tr> <td class="name"><code>friendlyErrorContainer</code></td> <td class="type"> <span class="param-type">HTMLElement</span> </td> <td class="description last">The container element to hold the error</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line230">line 230</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".runCatchableTask"><span class="type-signature">(static) </span>runCatchableTask<span class="signature">(callback, friendlyErrorContainer)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Runs a catchable task and displays a friendly error if the function throws an error</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">The function to run</td> </tr> <tr> <td class="name"><code>friendlyErrorContainer</code></td> <td class="type"> <span class="param-type">HTMLElement</span> </td> <td class="description last">The container element to hold the error</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line228">line 228</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".stringToLatLng"><span class="type-signature">(static) </span>stringToLatLng<span class="signature">(str)</span><span class="type-signature"> → {object}</span></h4> <p class="summary">Utility function returns a latLng literal given a valid latLng string</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line79">line 79</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".stringToLatLng"><span class="type-signature">(static) </span>stringToLatLng<span class="signature">(str)</span><span class="type-signature"> → {object}</span></h4> <p class="summary">Utility function returns a latLng literal given a valid latLng string</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line81">line 81</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> </article> </section> <section> <header> </header> <article> <div class="container-overview"> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".assertInstanceOf"><span class="type-signature">(static) </span>assertInstanceOf<span class="signature">(instance, instanceName)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">This function is for checking inheritence has been setup correctly. For objects that have engine and Pro specific classes, it will automatically add the engine and pro prefix to the supplied string and if such an object exists it will test against that name rather than the un-prefix argument supplied. For example, if we are running the Pro addon with Google maps as the engine, if you supply Marker as the instance name the function will check to see if instance is an instance of GoogleProMarker</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>instance</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">The object to check</td> </tr> <tr> <td class="name"><code>instanceName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The class name as a string which this object should be an instance of</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line251">line 251</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".assertInstanceOf"><span class="type-signature">(static) </span>assertInstanceOf<span class="signature">(instance, instanceName)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">This function is for checking inheritence has been setup correctly. For objects that have engine and Pro specific classes, it will automatically add the engine and pro prefix to the supplied string and if such an object exists it will test against that name rather than the un-prefix argument supplied. For example, if we are running the Pro addon with Google maps as the engine, if you supply Marker as the instance name the function will check to see if instance is an instance of GoogleProMarker</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>instance</code></td> <td class="type"> <span class="param-type">object</span> </td> <td class="description last">The object to check</td> </tr> <tr> <td class="name"><code>instanceName</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The class name as a string which this object should be an instance of</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line253">line 253</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".getCurrentPosition"><span class="type-signature">(static) </span>getCurrentPosition<span class="signature">()</span><span class="type-signature"> → {object}</span></h4> <p class="summary">This function will get the users position, it first attempts to get high accuracy position (mobile with GPS sensors etc.), if that fails (desktops will time out) then it tries again without high accuracy enabled</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line188">line 188</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The users position as a LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".getCurrentPosition"><span class="type-signature">(static) </span>getCurrentPosition<span class="signature">()</span><span class="type-signature"> → {object}</span></h4> <p class="summary">This function will get the users position, it first attempts to get high accuracy position (mobile with GPS sensors etc.), if that fails (desktops will time out) then it tries again without high accuracy enabled</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line190">line 190</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The users position as a LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".getImageDimensions"><span class="type-signature">(static) </span>getImageDimensions<span class="signature">(src, callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Utility function to get the dimensions of an image, caches results for best performance</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>src</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Image source URL</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve image dimensions</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line98">line 98</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".getImageDimensions"><span class="type-signature">(static) </span>getImageDimensions<span class="signature">(src, callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Utility function to get the dimensions of an image, caches results for best performance</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>src</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">Image source URL</td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve image dimensions</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line96">line 96</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".getMapByID"><span class="type-signature">(static) </span>getMapByID<span class="signature">(id)</span><span class="type-signature"> → {object}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">mixed</span> </td> <td class="description last">The ID of the map to retrieve</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line300">line 300</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The map object, or null if no such map exists </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".getMapByID"><span class="type-signature">(static) </span>getMapByID<span class="signature">(id)</span><span class="type-signature"> → {object}</span></h4> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>id</code></td> <td class="type"> <span class="param-type">mixed</span> </td> <td class="description last">The ID of the map to retrieve</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line298">line 298</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The map object, or null if no such map exists </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".guid"><span class="type-signature">(static) </span>guid<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p class="summary">Utility function returns a GUID</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line13">line 13</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The GUID </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id=".guid"><span class="type-signature">(static) </span>guid<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <p class="summary">Utility function returns a GUID</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line15">line 15</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> The GUID </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id=".hexOpacityToRGBA"><span class="type-signature">(static) </span>hexOpacityToRGBA<span class="signature">(colour, opacity)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Takes a hex string and opacity value and converts it to Openlayers RGBA format</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colour</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The hex color string</td> </tr> <tr> <td class="name"><code>opacity</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">The opacity from 0.0 - 1.0</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line31">line 31</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> RGBA where color components are 0 - 255 and opacity is 0.0 - 1.0 </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".hexOpacityToRGBA"><span class="type-signature">(static) </span>hexOpacityToRGBA<span class="signature">(colour, opacity)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Takes a hex string and opacity value and converts it to Openlayers RGBA format</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>colour</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The hex color string</td> </tr> <tr> <td class="name"><code>opacity</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last">The opacity from 0.0 - 1.0</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line33">line 33</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> RGBA where color components are 0 - 255 and opacity is 0.0 - 1.0 </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".isDeveloperMode"><span class="type-signature">(static) </span>isDeveloperMode<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if developer mode is set</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line127">line 127</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if developer mode is on </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isDeveloperMode"><span class="type-signature">(static) </span>isDeveloperMode<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if developer mode is set</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line125">line 125</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if developer mode is on </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isGoogleAutocompleteSupported"><span class="type-signature">(static) </span>isGoogleAutocompleteSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Shorthand function to determine if the Places Autocomplete is available</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line313">line 313</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isGoogleAutocompleteSupported"><span class="type-signature">(static) </span>isGoogleAutocompleteSupported<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Shorthand function to determine if the Places Autocomplete is available</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line315">line 315</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isLatLngString"><span class="type-signature">(static) </span>isLatLngString<span class="signature">(str)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Utility function returns true is string is a latitude and longitude</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line54">line 54</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> the matched latitude and longitude or null if no match </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".isLatLngString"><span class="type-signature">(static) </span>isLatLngString<span class="signature">(str)</span><span class="type-signature"> → {array}</span></h4> <p class="summary">Utility function returns true is string is a latitude and longitude</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line52">line 52</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> the matched latitude and longitude or null if no match </div> <dl> <dt> Type </dt> <dd> <span class="param-type">array</span> </dd> </dl> <h4 class="name" id=".isProVersion"><span class="type-signature">(static) </span>isProVersion<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if the Pro add-on is active</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line138">line 138</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if the Pro add-on is active </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".isProVersion"><span class="type-signature">(static) </span>isProVersion<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4> <p class="summary">Returns true if the Pro add-on is active</p> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line136">line 136</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> True if the Pro add-on is active </div> <dl> <dt> Type </dt> <dd> <span class="param-type">boolean</span> </dd> </dl> <h4 class="name" id=".openMediaDialog"><span class="type-signature">(static) </span>openMediaDialog<span class="signature">(callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Opens the WP media dialog and returns the result to a callback</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve the attachment ID as the first parameter and URL as the second</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line147">line 147</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".openMediaDialog"><span class="type-signature">(static) </span>openMediaDialog<span class="signature">(callback)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Opens the WP media dialog and returns the result to a callback</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">Callback to recieve the attachment ID as the first parameter and URL as the second</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line149">line 149</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".runCatchableTask"><span class="type-signature">(static) </span>runCatchableTask<span class="signature">(callback, friendlyErrorContainer)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Runs a catchable task and displays a friendly error if the function throws an error</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">The function to run</td> </tr> <tr> <td class="name"><code>friendlyErrorContainer</code></td> <td class="type"> <span class="param-type">HTMLElement</span> </td> <td class="description last">The container element to hold the error</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line230">line 230</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".runCatchableTask"><span class="type-signature">(static) </span>runCatchableTask<span class="signature">(callback, friendlyErrorContainer)</span><span class="type-signature"> → {void}</span></h4> <p class="summary">Runs a catchable task and displays a friendly error if the function throws an error</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type">function</span> </td> <td class="description last">The function to run</td> </tr> <tr> <td class="name"><code>friendlyErrorContainer</code></td> <td class="type"> <span class="param-type">HTMLElement</span> </td> <td class="description last">The container element to hold the error</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line228">line 228</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id=".stringToLatLng"><span class="type-signature">(static) </span>stringToLatLng<span class="signature">(str)</span><span class="type-signature"> → {object}</span></h4> <p class="summary">Utility function returns a latLng literal given a valid latLng string</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="core.js.html">core.js</a>, <a href="core.js.html#line79">line 79</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> <h4 class="name" id=".stringToLatLng"><span class="type-signature">(static) </span>stringToLatLng<span class="signature">(str)</span><span class="type-signature"> → {object}</span></h4> <p class="summary">Utility function returns a latLng literal given a valid latLng string</p> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>str</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last">The string to attempt to parse as coordinates</td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="wp-google-maps.combined.js.html">wp-google-maps.combined.js</a>, <a href="wp-google-maps.combined.js.html#line81">line 81</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> LatLng literal </div> <dl> <dt> Type </dt> <dd> <span class="param-type">object</span> </dd> </dl> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-Circle.html">Circle</a></li><li><a href="module-Distance.html">Distance</a></li><li><a href="module-Event.html">Event</a></li><li><a href="module-EventDispatcher.html">EventDispatcher</a></li><li><a href="module-FriendlyError.html">FriendlyError</a></li><li><a href="module-Geocoder.html">Geocoder</a></li><li><a href="module-GoogleCircle.html">GoogleCircle</a></li><li><a href="module-GoogleGeocoder.html">GoogleGeocoder</a></li><li><a href="module-GoogleInfoWindow.html">GoogleInfoWindow</a></li><li><a href="module-GoogleMap.html">GoogleMap</a></li><li><a href="module-GoogleMarker.html">GoogleMarker</a></li><li><a href="module-GoogleModernStoreLocator.html">GoogleModernStoreLocator</a></li><li><a href="module-GoogleModernStoreLocatorCircle.html">GoogleModernStoreLocatorCircle</a></li><li><a href="module-GooglePolygon.html">GooglePolygon</a></li><li><a href="module-GooglePolyline.html">GooglePolyline</a></li><li><a href="module-GoogleVertexContextMenu.html">GoogleVertexContextMenu</a></li><li><a href="module-InfoWindow.html">InfoWindow</a></li><li><a href="module-LatLng.html">LatLng</a></li><li><a href="module-LatLngBounds.html">LatLngBounds</a></li><li><a href="module-Map.html">Map</a></li><li><a href="module-MapObject.html">MapObject</a></li><li><a href="module-MapsEngineDialog.html">MapsEngineDialog</a></li><li><a href="module-MapSettings.html">MapSettings</a></li><li><a href="module-Marker.html">Marker</a></li><li><a href="module-ModernStoreLocator.html">ModernStoreLocator</a></li><li><a href="module-ModernStoreLocatorCircle.html">ModernStoreLocatorCircle</a></li><li><a href="module-OLCircle.html">OLCircle</a></li><li><a href="module-OLGeocoder.html">OLGeocoder</a></li><li><a href="module-OLInfoWindow.html">OLInfoWindow</a></li><li><a href="module-OLMap.html">OLMap</a></li><li><a href="module-OLMarker.html">OLMarker</a></li><li><a href="module-OLModernStoreLocator.html">OLModernStoreLocator</a></li><li><a href="module-OLModernStoreLocatorCircle.html">OLModernStoreLocatorCircle</a></li><li><a href="module-OLPolygon.html">OLPolygon</a></li><li><a href="module-OLPolyline.html">OLPolyline</a></li><li><a href="module-Polygon.html">Polygon</a></li><li><a href="module-Polyline.html">Polyline</a></li><li><a href="module-WPGMZA.html">WPGMZA</a></li></ul><h3>Classes</h3><ul><li><a href="module-Circle-Circle.html">Circle</a></li><li><a href="module-ModernStoreLocatorCircle-WPGMZA.ModernStoreLocatorCircle.html">ModernStoreLocatorCircle</a></li><li><a href="module-OLGeocoder-OLGeocoder.html">OLGeocoder</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.3</a> on Wed May 16 2018 13:18:38 GMT+0100 (GMT Daylight Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>