Options
All
  • Public
  • Public/Protected
  • All
Menu

This class implements the MapType interface and is provided for rendering image tiles.

Hierarchy

Implements

Index

Constructors

constructor

Properties

alt

alt: null | string

Alt text to display when this MapType's button is hovered over in the MapTypeControl. Optional.

maxZoom

maxZoom: number

The maximum zoom level for the map when displaying this MapType. Required for base MapTypes, ignored for overlay MapTypes.

minZoom

minZoom: number

The minimum zoom level for the map when displaying this MapType. Optional; defaults to 0.

name

name: null | string

Name to display in the MapTypeControl. Optional.

projection

projection: null | Projection

The Projection used to render this MapType. Optional; defaults to Mercator.

radius

radius: number

Radius of the planet for the map, in meters. Optional; defaults to Earth's equatorial radius of 6378137 meters.

tileSize

tileSize: null | Size

The dimensions of each tile. Required.

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

getOpacity

  • getOpacity(): number
  • Returns the opacity level (0 (transparent) to 1.0) of the ImageMapType tiles.

    Returns number

getTile

  • getTile(tileCoord: null | Point, zoom: number, ownerDocument: null | Document): null | Node
  • Returns a tile for the given tile coordinate (x, y) and zoom level. This tile will be appended to the given ownerDocument. Not available for base map types.

    Parameters

    • tileCoord: null | Point
    • zoom: number
    • ownerDocument: null | Document

    Returns null | Node

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

releaseTile

  • releaseTile(tileDiv: null | Node): void
  • Releases the given tile, performing any necessary cleanup. The provided tile will have already been removed from the document. Optional.

    Parameters

    • tileDiv: null | Node

    Returns void

set

  • set(key: string, value: any): void
  • Sets a value.

    Parameters

    • key: string
    • value: any

    Returns void

setOpacity

  • setOpacity(opacity: number): void
  • Sets the opacity level (0 (transparent) to 1.0) of the ImageMapType tiles.

    Parameters

    • opacity: number

      The new opacity.

    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