Skip to content

Latest commit

 

History

History
304 lines (153 loc) · 5.98 KB

Circle.md

File metadata and controls

304 lines (153 loc) · 5.98 KB
Raw

See html formatted version

Circle class

google.maps.Circle class

A circle on the Earth's surface; also known as a "spherical cap".

This class extends MVCObject.

Constructor

undefined

Circle([opts])

Parameters: 

Create a circle using the passed CircleOptions, which specify the center, radius, and style.

Methods

undefined

getBounds()

Parameters:  None

Return Value:  LatLngBounds

Gets the LatLngBounds of this Circle.

undefined

getCenter()

Parameters:  None

Return Value:  LatLng

Returns the center of this circle.

undefined

getDraggable()

Parameters:  None

Return Value:  boolean

Returns whether this circle can be dragged by the user.

undefined

getEditable()

Parameters:  None

Return Value:  boolean

Returns whether this circle can be edited by the user.

undefined

getMap()

Parameters:  None

Return Value:  Map

Returns the map on which this circle is displayed.

undefined

getRadius()

Parameters:  None

Return Value:  number

Returns the radius of this circle (in meters).

undefined

getVisible()

Parameters:  None

Return Value:  boolean

Returns whether this circle is visible on the map.

undefined

setCenter(center)

Parameters: 

Return Value:  None

Sets the center of this circle.

undefined

setDraggable(draggable)

Parameters: 

  • draggable:  boolean

Return Value:  None

If set to true, the user can drag this circle over the map.

undefined

setEditable(editable)

Parameters: 

  • editable:  boolean

Return Value:  None

If set to true, the user can edit this circle by dragging the control points shown at the center and around the circumference of the circle.

undefined

setMap(map)

Parameters: 

Return Value:  None

Renders the circle on the specified map. If map is set to null, the circle will be removed.

undefined

setOptions(options)

Parameters: 

Return Value:  None

undefined

setRadius(radius)

Parameters: 

  • radius:  number

Return Value:  None

Sets the radius of this circle (in meters).

undefined

setVisible(visible)

Parameters: 

  • visible:  boolean

Return Value:  None

Hides this circle if set to false.

Events

undefined

function()

Arguments:  None

This event is fired when the circle's center is changed.

undefined

function(event)

Arguments: 

This event is fired when the DOM click event is fired on the circle.

undefined

function(event)

Arguments: 

This event is fired when the DOM dblclick event is fired on the circle.

undefined

function(event)

Arguments: 

This event is repeatedly fired while the user drags the circle.

undefined

function(event)

Arguments: 

This event is fired when the user stops dragging the circle.

undefined

function(event)

Arguments: 

This event is fired when the user starts dragging the circle.

undefined

function(event)

Arguments: 

This event is fired when the DOM mousedown event is fired on the circle.

undefined

function(event)

Arguments: 

This event is fired when the DOM mousemove event is fired on the circle.

undefined

function(event)

Arguments: 

This event is fired on circle mouseout.

undefined

function(event)

Arguments: 

This event is fired on circle mouseover.

undefined

function(event)

Arguments: 

This event is fired when the DOM mouseup event is fired on the circle.

undefined

function()

Arguments:  None

This event is fired when the circle's radius is changed.

undefined

function(event)

Arguments: 

This event is fired when the circle is right-clicked on.