diff --git a/classes/Loader.html b/classes/Loader.html index ef196210..bfccf9a7 100644 --- a/classes/Loader.html +++ b/classes/Loader.html @@ -6,7 +6,7 @@ 
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 @@ -32,22 +32,22 @@ 
const loader = Loader({apiKey, version: 'weekly', libraries: ['places']});
-

Parameters

Returns Loader

Properties

ReadonlyapiKey

apiKey: string

See [[LoaderOptions.apiKey]]

-

ReadonlyauthReferrerPolicy

authReferrerPolicy

See [[LoaderOptions.authReferrerPolicy]]

-

Readonlychannel

channel: string

See [[LoaderOptions.channel]]

-

Readonlyclient

client: string

See [[LoaderOptions.client]]

-

Readonlyid

id: string

See [[LoaderOptions.id]]

-

Readonlylanguage

language: string

See [[LoaderOptions.language]]

-

Readonlylibraries

libraries: Libraries

See [[LoaderOptions.libraries]]

-

ReadonlymapIds

mapIds: string[]

See [[LoaderOptions.mapIds]]

-

Readonlynonce

nonce: string

See [[LoaderOptions.nonce]]

-

Readonlyregion

region: string

See [[LoaderOptions.region]]

-

Readonlyretries

retries: number

See [[LoaderOptions.retries]]

-

Readonlyurl

url: string

See [[LoaderOptions.url]]

-

Readonlyversion

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

ReadonlyapiKey

apiKey: string

See [[LoaderOptions.apiKey]]

+

ReadonlyauthReferrerPolicy

authReferrerPolicy

See [[LoaderOptions.authReferrerPolicy]]

+

Readonlychannel

channel: string

See [[LoaderOptions.channel]]

+

Readonlyclient

client: string

See [[LoaderOptions.client]]

+

Readonlyid

id: string

See [[LoaderOptions.id]]

+

Readonlylanguage

language: string

See [[LoaderOptions.language]]

+

Readonlylibraries

libraries: Libraries

See [[LoaderOptions.libraries]]

+

ReadonlymapIds

mapIds: string[]

See [[LoaderOptions.mapIds]]

+

Readonlynonce

nonce: string

See [[LoaderOptions.nonce]]

+

Readonlyregion

region: string

See [[LoaderOptions.region]]

+

Readonlyretries

retries: number

See [[LoaderOptions.retries]]

+

Readonlyurl

url: string

See [[LoaderOptions.url]]

+

Readonlyversion

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: ErrorEvent) => void)
        • (e): void

        • Parameters

          • e: ErrorEvent

          Returns void

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Parameters

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

      • Parameters

        • e: ErrorEvent

        Returns void

Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/enums/LoaderStatus.html b/enums/LoaderStatus.html index 428b3b07..9bb75c21 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

INITIALIZED

INITIALIZED

LOADING

LOADING

SUCCESS

SUCCESS

Settings

Member Visibility

On This Page

Enumeration Members
+

Enumeration Members

FAILURE

FAILURE

INITIALIZED

INITIALIZED

LOADING

LOADING

SUCCESS

SUCCESS

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/interfaces/LoaderOptions.html b/interfaces/LoaderOptions.html index 3471ddfa..0595b3c2 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.

-

OptionalauthReferrerPolicy

authReferrerPolicy

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

OptionalauthReferrerPolicy

authReferrerPolicy

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.

-

Optionalchannel

channel?: string

Deprecated

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

-

Optionalclient

client?: string

Deprecated

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

-

Optionalid

id?: string

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

-

Optionallanguage

language?: string

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

Optionalchannel

channel?: string

Deprecated

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

+

Optionalclient

client?: string

Deprecated

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

+

Optionalid

id?: string

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

+

Optionallanguage

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 @@ -44,7 +44,7 @@

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

-

Optionallibraries

libraries?: Libraries

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

Optionallibraries

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.

@@ -52,9 +52,9 @@

Set the list of libraries for more options.

-

OptionalmapIds

mapIds?: string[]

Deprecated

Passing mapIds is no longer required in the script tag.

-

Optionalnonce

nonce?: string

Use a cryptographic nonce attribute.

-

Optionalregion

region?: string

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

OptionalmapIds

mapIds?: string[]

Deprecated

Passing mapIds is no longer required in the script tag.

+

Optionalnonce

nonce?: string

Use a cryptographic nonce attribute.

+

Optionalregion

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 @@ -70,9 +70,9 @@ 

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

Optionalretries

retries?: number

The number of script load retries.

-

Optionalurl

url?: string

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

-

Optionalversion

version?: string

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

+

Optionalretries

retries?: number

The number of script load retries.

+

Optionalurl

url?: string

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

+

Optionalversion

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'});
@@ -91,4 +91,4 @@
 
 
If you do not explicitly specify a version, you will receive the
 weekly version by default.

-

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/types/Libraries.html b/types/Libraries.html index 35de2bd2..271e5838 100644 --- a/types/Libraries.html +++ b/types/Libraries.html @@ -1 +1 @@ -Libraries | @googlemaps/js-api-loader

Type Alias Libraries

Libraries: Library[]

Settings

Member Visibility
+Libraries | @googlemaps/js-api-loader

Type Alias Libraries

Libraries: Library[]

Settings

Member Visibility
diff --git a/types/Library.html b/types/Library.html index 302924d3..0e4cffcd 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
+Library | @googlemaps/js-api-loader

Type Alias Library

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

Settings

Member Visibility
diff --git a/variables/DEFAULT_ID.html b/variables/DEFAULT_ID.html index d2d798d9..6eb2525e 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"

Settings

Member Visibility
+DEFAULT_ID | @googlemaps/js-api-loader

Variable DEFAULT_IDConst

DEFAULT_ID = "__googleMapsScriptId"

Settings

Member Visibility