Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Circle

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

Access by calling const {Circle} = await google.maps.importLibrary("maps"). See https://developers.google.com/maps/documentation/javascript/libraries.

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Methods

addListener

  • Adds the given listener function to the given event name. Returns an identifier for this listener that can be used with google.maps.event.removeListener.

    Parameters

    • eventName: string
    • handler: Function

    Returns MapsEventListener

bindTo

  • bindTo(key: string, target: MVCObject, targetKey?: null | string, noNotify?: boolean): void

  • Binds a View to a Model.

    Parameters

    • key: string
    • target: MVCObject
    • Optional targetKey: null | string
    • Optional noNotify: boolean

    Returns void

get

  • get(key: string): any

  • Gets a value.

    Parameters

    • key: string

    Returns any

getBounds

  • Gets the LatLngBounds of this Circle.

    Returns null | LatLngBounds

getCenter

  • Returns the center of this circle.

    Returns null | LatLng

getDraggable

  • getDraggable(): boolean

  • Returns whether this circle can be dragged by the user.

    Returns boolean

getEditable

  • getEditable(): boolean

  • Returns whether this circle can be edited by the user.

    Returns boolean

getMap

  • getMap(): null | Map

  • Returns the map on which this circle is displayed.

    Returns null | Map

getRadius

  • getRadius(): number

  • Returns the radius of this circle (in meters).

    Returns number

getVisible

  • getVisible(): boolean

  • Returns whether this circle is visible on the map.

    Returns boolean

notify

  • notify(key: string): void

  • Notify all observers of a change on this property. This notifies both objects that are bound to the object's property as well as the object that it is bound to.

    Parameters

    • key: string

    Returns void

set

  • set(key: string, value: unknown): void

  • Sets a value.

    Parameters

    • key: string
    • value: unknown

    Returns void

setCenter

setDraggable

  • setDraggable(draggable: boolean): void

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

    Parameters

    • draggable: boolean

    Returns void

setEditable

  • setEditable(editable: boolean): void

  • 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.

    Parameters

    • editable: boolean

    Returns void

setMap

  • setMap(map: null | Map): void

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

    Parameters

    • map: null | Map

    Returns void

setOptions

setRadius

  • setRadius(radius: number): void

  • Sets the radius of this circle (in meters).

    Parameters

    • radius: number

    Returns void

setValues

  • setValues(values?: null | object): void

  • Sets a collection of key-value pairs.

    Parameters

    • Optional values: null | object

    Returns void

setVisible

  • setVisible(visible: boolean): void

  • Hides this circle if set to false.

    Parameters

    • visible: boolean

    Returns void

unbind

  • unbind(key: string): void

  • Removes a binding. Unbinding will set the unbound property to the current value. The object will not be notified, as the value has not changed.

    Parameters

    • key: string

    Returns void

unbindAll

  • unbindAll(): void

Generated using TypeDoc