Requires
- module:WPGMZA.MapObject
Classes
- Circle
- Represents a generic circle. Please do not instantiate this object directly, use createInstance
- Circle
- Represents a generic circle. Please do not instantiate this object directly, use createInstance
Methods
(inner) 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) |
(inner) 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) |
- Source:
(inner) getCenter() → {WPGMZA.LatLng}
- Source:
Returns:
- Type
- WPGMZA.LatLng
(inner) getCenter() → {WPGMZA.LatLng}
Returns:
- Type
- WPGMZA.LatLng
(inner) getMap() → {WPGMZA.Map}
Returns the map that this circle is being displayed on
Returns:
- Type
- WPGMZA.Map
(inner) getMap() → {WPGMZA.Map}
Returns the map that this circle is being displayed on
- Source:
Returns:
- Type
- WPGMZA.Map
(inner) getRadius() → {WPGMZA.LatLng}
Returns the circles radius in kilometers
- Source:
Returns:
- Type
- WPGMZA.LatLng
(inner) getRadius() → {WPGMZA.LatLng}
Returns the circles radius in kilometers
Returns:
- Type
- WPGMZA.LatLng
(inner) setCenter(latLng) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
latLng |
object | WPGMZA.LatLng | either a literal or as a WPGMZA.LatLng |
- Source:
Returns:
- Type
- void
(inner) setCenter(latLng) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
latLng |
object | WPGMZA.LatLng | either a literal or as a WPGMZA.LatLng |
Returns:
- Type
- void
(inner) setMap(The) → {void}
Puts this circle on a map
Parameters:
| Name | Type | Description |
|---|---|---|
The |
WPGMZA.Map | target map |
Returns:
- Type
- void
(inner) setMap(The) → {void}
Puts this circle on a map
Parameters:
| Name | Type | Description |
|---|---|---|
The |
WPGMZA.Map | target map |
- Source:
Returns:
- Type
- void
(inner) setRadius(The) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
The |
number | radius |
Returns:
- Type
- void
(inner) setRadius(The) → {void}
Parameters:
| Name | Type | Description |
|---|---|---|
The |
number | radius |
- Source:
Returns:
- Type
- void