diff --git a/classes/Loader.html b/classes/Loader.html index ee58583e..16ccafae 100644 --- a/classes/Loader.html +++ b/classes/Loader.html @@ -5,7 +5,7 @@ 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 +

Constructors

constructor

Properties

apiKey authReferrerPolicy channel @@ -30,22 +30,22 @@ 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. +

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

    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

\ No newline at end of file +

Parameters

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

      • Parameters

        • e: ErrorEvent

        Returns void

Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/enums/LoaderStatus.html b/enums/LoaderStatus.html index 62a8fc60..1dbc5e73 100644 --- a/enums/LoaderStatus.html +++ b/enums/LoaderStatus.html @@ -1,6 +1,6 @@ LoaderStatus | @googlemaps/js-api-loader

Enumeration LoaderStatus

The status of the [[Loader]].

-

Enumeration Members

FAILURE +

Enumeration Members

FAILURE INITIALIZED LOADING SUCCESS -

Enumeration Members

FAILURE

FAILURE: 3

INITIALIZED

INITIALIZED: 0

LOADING

LOADING: 1

SUCCESS

SUCCESS: 2

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Enumeration Members

FAILURE

FAILURE: 3

INITIALIZED

INITIALIZED: 0

LOADING

LOADING: 1

SUCCESS

SUCCESS: 2

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/interfaces/LoaderOptions.html b/interfaces/LoaderOptions.html index 40049a7e..6a23f95d 100644 --- a/interfaces/LoaderOptions.html +++ b/interfaces/LoaderOptions.html @@ -3,7 +3,7 @@ is the authoritative source for [[LoaderOptions]]. /** Loader options

-
interface LoaderOptions {
    apiKey: string;
    authReferrerPolicy?: "origin";
    channel?: string;
    client?: string;
    id?: string;
    language?: string;
    libraries?: Libraries;
    mapIds?: string[];
    nonce?: string;
    region?: string;
    retries?: number;
    url?: string;
    version?: string;
}

Properties

apiKey +
interface LoaderOptions {
    apiKey: string;
    authReferrerPolicy?: "origin";
    channel?: string;
    client?: string;
    id?: string;
    language?: string;
    libraries?: Libraries;
    mapIds?: string[];
    nonce?: string;
    region?: string;
    retries?: number;
    url?: string;
    version?: string;
}

Properties

apiKey authReferrerPolicy? channel? client? @@ -17,7 +17,7 @@ url? version?

Properties

apiKey

apiKey: string

See https://developers.google.com/maps/documentation/javascript/get-api-key.

-

Optional authReferrerPolicy

authReferrerPolicy?: "origin"

Maps JS customers can configure HTTP Referrer Restrictions in the Cloud +

Optional authReferrerPolicy

authReferrerPolicy?: "origin"

Maps JS customers can configure HTTP Referrer Restrictions in the Cloud Console to limit which URLs are allowed to use a particular API Key. By default, these restrictions can be configured to allow only certain paths to use an API Key. If any URL on the same domain or origin may use the API @@ -27,10 +27,10 @@ HTTP Referrer Restrictions are enabled on Cloud Console, Maps JavaScript API will only be able to load if there is an HTTP Referrer Restriction that matches the current website's domain without a path specified.

-

Optional channel

channel?: string

Deprecated

See https://developers.google.com/maps/premium/overview.

-

Optional client

client?: string

Deprecated

See https://developers.google.com/maps/premium/overview, use apiKey instead.

-

Optional id

id?: string

The id of the script tag. Before adding a new script, the Loader will check for an existing one.

-

Optional language

language?: string

By default, the Maps JavaScript API uses the user's preferred language +

Optional channel

channel?: string

Deprecated

See https://developers.google.com/maps/premium/overview.

+

Optional client

client?: string

Deprecated

See https://developers.google.com/maps/premium/overview, use apiKey instead.

+

Optional id

id?: string

The id of the script tag. Before adding a new script, the Loader will check for an existing one.

+

Optional language

language?: string

By default, the Maps JavaScript API uses the user's preferred language setting as specified in the browser, when displaying textual information such as the names for controls, copyright notices, driving directions and labels on maps. In most cases, it's preferable to respect the browser @@ -43,16 +43,16 @@

See the list of supported languages. Note that new languages are added often, so this list may not be exhaustive.

-

Optional libraries

libraries?: Libraries

When loading the Maps JavaScript API via the URL you may optionally load +

Optional libraries

libraries?: Libraries

When loading the Maps JavaScript API via the URL you may optionally load additional libraries through use of the libraries URL parameter. Libraries are modules of code that provide additional functionality to the main Maps JavaScript API but are not loaded unless you specifically request them.

const loader = Loader({
 apiKey,
 libraries: ['drawing', 'geometry', 'places', 'visualization'],
});

Set the list of libraries for more options.

-

Optional mapIds

mapIds?: string[]

Deprecated

Passing mapIds is no longer required in the script tag.

-

Optional nonce

nonce?: string

Use a cryptographic nonce attribute.

-

Optional region

region?: string

When you load the Maps JavaScript API from maps.googleapis.com it applies a +

Optional mapIds

mapIds?: string[]

Deprecated

Passing mapIds is no longer required in the script tag.

+

Optional nonce

nonce?: string

Use a cryptographic nonce attribute.

+

Optional region

region?: string

When you load the Maps JavaScript API from maps.googleapis.com it applies a default bias for application behavior towards the United States. If you want to alter your application to serve different map tiles or bias the application (such as biasing geocoding results towards the region), you can @@ -67,9 +67,9 @@

For example, the following example localizes the map to the United Kingdom:

const loader = Loader({apiKey, region: 'GB'});
-

Optional retries

retries?: number

The number of script load retries.

-

Optional url

url?: string

Use a custom url and path to load the Google Maps API script.

-

Optional version

version?: string

In your application you can specify release channels or version numbers:

+

Optional retries

retries?: number

The number of script load retries.

+

Optional url

url?: string

Use a custom url and path to load the Google Maps API script.

+

Optional version

version?: string

In your application you can specify release channels or version numbers:

The weekly version is specified with version=weekly. This version is updated once per week, and is the most current.

const loader = Loader({apiKey, version: 'weekly'});
@@ -85,4 +85,4 @@

If you do not explicitly specify a version, you will receive the weekly version by default.

-

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file +

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Libraries.html b/types/Libraries.html index d8ac4d56..9e4719c9 100644 --- a/types/Libraries.html +++ b/types/Libraries.html @@ -1 +1 @@ -Libraries | @googlemaps/js-api-loader

Type alias Libraries

Libraries: Library[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Libraries | @googlemaps/js-api-loader

Type alias Libraries

Libraries: Library[]

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/types/Library.html b/types/Library.html index 47d8e6df..c193526c 100644 --- a/types/Library.html +++ b/types/Library.html @@ -1 +1 @@ -Library | @googlemaps/js-api-loader

Type alias Library

Library: "core" | "maps" | "places" | "geocoding" | "routes" | "marker" | "geometry" | "elevation" | "streetView" | "journeySharing" | "drawing" | "visualization"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +Library | @googlemaps/js-api-loader

Type alias Library

Library: "core" | "maps" | "places" | "geocoding" | "routes" | "marker" | "geometry" | "elevation" | "streetView" | "journeySharing" | "drawing" | "visualization"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/variables/DEFAULT_ID.html b/variables/DEFAULT_ID.html index 3561d9e6..c65d27d3 100644 --- a/variables/DEFAULT_ID.html +++ b/variables/DEFAULT_ID.html @@ -1 +1 @@ -DEFAULT_ID | @googlemaps/js-api-loader

Variable DEFAULT_IDConst

DEFAULT_ID: "__googleMapsScriptId" = "__googleMapsScriptId"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file +DEFAULT_ID | @googlemaps/js-api-loader

Variable DEFAULT_IDConst

DEFAULT_ID: "__googleMapsScriptId" = "__googleMapsScriptId"

Settings

Member Visibility

Theme

Generated using TypeDoc

\ No newline at end of file