UNPKG

@ng-maps/google

Version:

**@ng-maps/google** is a simple, modular and tree-shakable library for displaying google-maps inside an angular application

63 lines (62 loc) 2.35 kB
import { InjectionToken } from '@angular/core'; export declare enum GoogleMapsScriptProtocol { HTTP = 1, HTTPS = 2, AUTO = 3 } /** * Token for the config of google maps module * Please provide an object of type {@link GoogleModuleOptions}. */ export declare const GOOGLE_MAPS_API_CONFIG: InjectionToken<GoogleModuleOptions | Promise<GoogleModuleOptions>>; export interface GoogleModuleOptions { /** * The Google Maps API Key (see: * https://developers.google.com/maps/documentation/javascript/get-api-key) */ apiKey?: string; /** * The Google Maps client ID (for premium plans). * When you have a Google Maps APIs Premium Plan license, you must authenticate * your application with either an API key or a client ID. * The Google Maps API will fail to load if both a client ID and an API key are included. */ clientId?: string; /** * The Google Maps channel name (for premium plans). * A channel parameter is an optional parameter that allows you to track usage under your client * ID by assigning a distinct channel to each of your applications. */ channel?: string; /** * Google Maps API version. */ apiVersion?: string; /** * Host and Path used for the `<script>` tag. */ hostAndPath?: string; /** * Protocol used for the `<script>` tag. */ protocol?: GoogleMapsScriptProtocol; /** * Defines which Google Maps libraries should get loaded. * For available libraries see: https://developers.google.com/maps/documentation/javascript/libraries */ libraries?: Array<string>; /** * The default bias for the map behavior is US. * If you wish to alter your application to serve different map tiles or bias the * application, you can overwrite the default behavior (US) by defining a `region`. * See https://developers.google.com/maps/documentation/javascript/basics#Region */ region?: string; /** * The Google Maps API uses the browser's preferred language when displaying * textual information. If you wish to overwrite this behavior and force the API * to use a given language, you can use this setting. * See https://developers.google.com/maps/documentation/javascript/basics#Language */ language?: string; }