Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GroundOverlay

A rectangular image overlay on the map.

Access by calling const {GroundOverlay} = 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 overlay.

    Returns null | LatLngBounds

getMap

  • getMap(): null | Map

  • Returns the map on which this ground overlay is displayed.

    Returns null | Map

getOpacity

  • getOpacity(): number

  • Returns the opacity of this ground overlay.

    Returns number

getUrl

  • getUrl(): string

  • Gets the url of the projected image.

    Returns string

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

setMap

  • setMap(map: null | Map): void

  • Renders the ground overlay on the specified map. If map is set to null, the overlay is removed.

    Parameters

    • map: null | Map

    Returns void

setOpacity

  • setOpacity(opacity: number): void

  • Sets the opacity of this ground overlay.

    Parameters

    • opacity: number

    Returns void

setValues

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

  • Sets a collection of key-value pairs.

    Parameters

    • Optional values: null | object

    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