Class Loader

[[Loader]] makes it easier to add Google Maps JavaScript API to your application dynamically using Promises. It works by dynamically creating and appending a script node to the the document head and wrapping the callback function so as to return a promise.

const loader = new Loader({
  apiKey: "",
  version: "weekly",
  libraries: ["places"]
});

loader.load().then((google) => {
  const map = new google.maps.Map(...)
})

Constructors

constructor

Properties

apiKey authReferrerPolicy channel client id language libraries mapIds nonce region retries url version

Accessors

options status

Methods

deleteScript importLibrary load loadCallback

Constructors

constructor

  • new Loader(__namedParameters): Loader

  • Creates an instance of Loader using [[LoaderOptions]]. No defaults are set using this library, instead the defaults are set by the Google Maps JavaScript API server.

    const loader = Loader({apiKey, version: 'weekly', libraries: ['places']});

    Parameters

    Returns Loader

Properties

Readonly apiKey

apiKey: string

See [[LoaderOptions.apiKey]]

Readonly authReferrerPolicy

authReferrerPolicy: "origin"

See [[LoaderOptions.authReferrerPolicy]]

Readonly channel

channel: string

See [[LoaderOptions.channel]]

Readonly client

client: string

See [[LoaderOptions.client]]

Readonly id

id: string

See [[LoaderOptions.id]]

Readonly language

language: string

See [[LoaderOptions.language]]

Readonly libraries

libraries: Libraries

See [[LoaderOptions.libraries]]

Readonly mapIds

mapIds: string[]

See [[LoaderOptions.mapIds]]

Readonly nonce

nonce: string

See [[LoaderOptions.nonce]]

Readonly region

region: string

See [[LoaderOptions.region]]

Readonly retries

retries: number

See [[LoaderOptions.retries]]

Readonly url

url: string

See [[LoaderOptions.url]]

Readonly version

version: string

See [[LoaderOptions.version]]

Accessors

options

status

Methods

deleteScript

importLibrary

  • importLibrary(name): Promise<CoreLibrary>

  • See https://developers.google.com/maps/documentation/javascript/reference/top-level#google.maps.importLibrary

    Parameters

    • name: "core"

    Returns Promise<CoreLibrary>

  • importLibrary(name): Promise<MapsLibrary>

  • Parameters

    • name: "maps"

    Returns Promise<MapsLibrary>

  • importLibrary(name): Promise<PlacesLibrary>

  • Parameters

    • name: "places"

    Returns Promise<PlacesLibrary>

  • importLibrary(name): Promise<GeocodingLibrary>

  • Parameters

    • name: "geocoding"

    Returns Promise<GeocodingLibrary>

  • importLibrary(name): Promise<RoutesLibrary>

  • Parameters

    • name: "routes"

    Returns Promise<RoutesLibrary>

  • importLibrary(name): Promise<MarkerLibrary>

  • Parameters

    • name: "marker"

    Returns Promise<MarkerLibrary>

  • importLibrary(name): Promise<GeometryLibrary>

  • Parameters

    • name: "geometry"

    Returns Promise<GeometryLibrary>

  • importLibrary(name): Promise<ElevationLibrary>

  • Parameters

    • name: "elevation"

    Returns Promise<ElevationLibrary>

  • importLibrary(name): Promise<StreetViewLibrary>

  • Parameters

    • name: "streetView"

    Returns Promise<StreetViewLibrary>

  • importLibrary(name): Promise<JourneySharingLibrary>

  • Parameters

    • name: "journeySharing"

    Returns Promise<JourneySharingLibrary>

  • importLibrary(name): Promise<DrawingLibrary>

  • Parameters

    • name: "drawing"

    Returns Promise<DrawingLibrary>

  • importLibrary(name): Promise<VisualizationLibrary>

  • Parameters

    • name: "visualization"

    Returns Promise<VisualizationLibrary>

  • importLibrary(name): Promise<unknown>

  • Parameters

    Returns Promise<unknown>

load

  • load(): Promise<typeof google>

  • Load the Google Maps JavaScript API script and return a Promise. @deprecated, use importLibrary() instead.

    Returns Promise<typeof google>

loadCallback

  • loadCallback(fn): void

  • Load the Google Maps JavaScript API script with a callback. @deprecated, use importLibrary() instead.

    Parameters

    • fn: ((e) => void)
        • (e): void

        • Parameters

          • e: ErrorEvent

          Returns void

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc