Documentation

Class: Circle

Circle

WPGMZA.Circle

new Circle()

Base class for circles. Please do not call this constructor directly. Always use createInstance rather than instantiating this class directly. Using createInstance allows this class to be externally extensible.
See:

Extends

Methods

<static> createInstance(options)

Creates an instance of a circle, please always use this function rather than calling the constructor directly.
Parameters:
Name Type Description
options object Options for the object (optional)

_triggerListeners()

Handles the logic of triggering listeners
Inherited From:

addEventListener(type, callback [, thisObject] [, useCapture])

Adds an event listener on this object
Parameters:
Name Type Argument Description
type string The event type, or multiple types separated by spaces
callback function The callback to call when the event fires
thisObject object <optional>
 The object to use as "this" when firing the callback
useCapture bool <optional>
 If true, fires the callback on the capture phase, as opposed to bubble phase
Inherited From:

dispatchEvent(event)

Fires an event on this object
Parameters:
Name Type Description
event string | WPGMZA.Event Either the event type as a string, or an instance of WPGMZA.Event
Inherited From:

getCenter()

Gets the circles center
Returns:
Type
WPGMZA.LatLng

getMap()

Returns the map that this circle is being displayed on
Returns:
Type
WPGMZA.Map

getRadius(latLng)

Gets the circles radius, in kilometers
Parameters:
Name Type Description
latLng object | WPGMZA.LatLng either a literal or as a WPGMZA.LatLng
Returns:
Type
WPGMZA.LatLng

hasEventListener(type)

Test for listeners of type on this object
Parameters:
Name Type Description
type string The event type to test for
Inherited From:
Returns:
True if this object has listeners bound for the specified type
Type
bool

off()

Alias for removeEventListener
Inherited From:
See:

on()

Alias for addEventListener
Inherited From:
See:

parseGeometry(string)

Scans a string for all floating point numbers and build an array of latitude and longitude literals from the matched numbers
Parameters:
Name Type Description
string string The string to parse numbers from
Inherited From:
Returns:
An array of LatLng literals parsed from the string
Type
array

removeEventListener(type [, listener] [, thisObject] [, useCapture])

Removes event listeners from this object
Parameters:
Name Type Argument Description
type string The event type to remove listeners from
listener function <optional>
 The function to remove. If omitted, all listeners will be removed
thisObject object <optional>
 Use the parameter to remove listeners bound with the same thisObject
useCapture bool <optional>
 Remove the capture phase event listener. Otherwise, the bubble phase event listener will be removed.
Inherited From:

setCenter(latLng)

Sets the circles center
Parameters:
Name Type Description
latLng object | WPGMZA.LatLng either a literal or as a WPGMZA.LatLng

setMap(map)

Puts this circle on a map
Parameters:
Name Type Description
map WPGMZA.Map The target map
Returns:
Type
void

setRadius(radius)

Sets the circles radius, in kilometers
Parameters:
Name Type Description
radius number The radius
Returns:
Type
void

toJSON()

Returns a copy of this object as a JSON object for serializsation
Inherited From:
Returns:
This object as represented by JSON
Type
object

trigger()

Alias for removeEventListener
Inherited From:
See: