ADD expose some controls (#26)

Author: jonathanlurie

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [v1.0.6](https://github.com/maptiler/maptiler-sdk-js/releases/tag/v1.0.6)
+- Now exposing `MaptilerGeolocateControl` for external initialization if needed
+- Now exposing `MaptilerTerrain` for external initialization if needed
+
 ## [v1.0.5](https://github.com/maptiler/maptiler-sdk-js/releases/tag/v1.0.5)
 - Terrain elevation is now using MapTiler's `terrain-rgb-v2`
 

demos/maptiler-sdk.umd.js

@@ -1,5 +1,5 @@
 import * as maplibre_gl from 'maplibre-gl';
-import maplibre_gl__default, { MapOptions as MapOptions$1, StyleSpecification, ControlPosition, StyleOptions } from 'maplibre-gl';
+import maplibre_gl__default, { MapOptions as MapOptions$1, StyleSpecification, ControlPosition, StyleOptions, LogoOptions as LogoOptions$1 } from 'maplibre-gl';
 export * from 'maplibre-gl';
 import * as _mapbox_mapbox_gl_supported from '@mapbox/mapbox-gl-supported';
 import { ReferenceMapStyle, MapStyleVariant, FetchFunction } from '@maptiler/client';
@@ -254,6 +254,57 @@ declare class Map extends maplibre_gl__default.Map {
     getCameraHash(): string;
 }
 
+declare const GeolocateControl$1: typeof maplibre_gl.GeolocateControl;
+/**
+ * The MaptilerGeolocateControl is an extension of the original GeolocateControl
+ * with a few changes. In this version, the active mode persists as long as the
+ * location is still centered. This means it's robust to rotation, pitch and zoom.
+ *
+ */
+declare class MaptilerGeolocateControl extends GeolocateControl$1 {
+    private lastUpdatedCenter;
+    /**
+     * Update the camera location to center on the current position
+     *
+     * @param {Position} position the Geolocation API Position
+     * @private
+     */
+    _updateCamera(position: GeolocationPosition): void;
+    _setupUI(supported: boolean): void;
+    _updateCircleRadius(): void;
+    _onZoom(): void;
+}
+
+declare type LogoOptions = LogoOptions$1 & {
+    logoURL?: string;
+    linkURL?: string;
+};
+/**
+ * This LogoControl extends the MapLibre LogoControl but instead can use any image URL and
+ * any link URL. By default this is using MapTiler logo and URL.
+ */
+declare class MaptilerLogoControl extends maplibre_gl__default.LogoControl {
+    private logoURL;
+    private linkURL;
+    constructor(options?: LogoOptions);
+    onAdd(map: Map): HTMLElement;
+}
+
+/**
+ * A `MaptilerTerrainControl` control adds a button to turn terrain on and off
+ * by triggering the terrain logic that is already deployed in the Map object.
+ */
+declare class MaptilerTerrainControl implements maplibregl.IControl {
+    _map: Map;
+    _container: HTMLElement;
+    _terrainButton: HTMLButtonElement;
+    constructor();
+    onAdd(map: Map): HTMLElement;
+    onRemove(): void;
+    _toggleTerrain(): void;
+    _updateTerrainIcon(): void;
+}
+
 /**
  * This is TypeScript rewrite of the Point class to use instead of the version imported in MapLibre.
  * It also uses a class instead of prototypes.
@@ -528,4 +579,4 @@ declare const workerUrl: string;
 declare const addProtocol: (customProtocol: string, loadFn: (requestParameters: maplibre_gl.RequestParameters, callback: maplibre_gl.ResponseCallback<any>) => maplibre_gl.Cancelable) => void;
 declare const removeProtocol: (customProtocol: string) => void;
 
-export { AJAXError, AttributionControl, CanvasSource, Evented, FullscreenControl, GeoJSONSource, GeolocateControl, GeolocationType, ImageSource, Language, LanguageKey, LanguageString, LngLat, LngLatBounds, LogoControl, Map, MapOptions, Marker, Matrix2, MercatorCoordinate, NavigationControl, Point, Popup, RasterDEMTileSource, RasterTileSource, ScaleControl, SdkConfig, Style, TerrainControl, Unit, VectorTileSource, VideoSource, addProtocol, clearPrewarmedResources, clearStorage, config, getRTLTextPluginStatus, maxParallelImageRequests, prewarm, removeProtocol, setRTLTextPlugin, supported, version, workerCount, workerUrl };
+export { AJAXError, AttributionControl, CanvasSource, Evented, FullscreenControl, GeoJSONSource, GeolocateControl, GeolocationType, ImageSource, Language, LanguageKey, LanguageString, LngLat, LngLatBounds, LogoControl, Map, MapOptions, MaptilerGeolocateControl, MaptilerLogoControl, MaptilerTerrainControl, Marker, Matrix2, MercatorCoordinate, NavigationControl, Point, Popup, RasterDEMTileSource, RasterTileSource, ScaleControl, SdkConfig, Style, TerrainControl, Unit, VectorTileSource, VideoSource, addProtocol, clearPrewarmedResources, clearStorage, config, getRTLTextPluginStatus, maxParallelImageRequests, prewarm, removeProtocol, setRTLTextPlugin, supported, version, workerCount, workerUrl };

dist/maptiler-sdk.d.ts

@@ -142,7 +142,7 @@ const defaults = {
 };
 Object.freeze(defaults);
 
-class CustomLogoControl extends maplibregl__default.LogoControl {
+class MaptilerLogoControl extends maplibregl__default.LogoControl {
   constructor(options = {}) {
     var _a, _b;
     super(options);
@@ -235,7 +235,7 @@ function styleToStyle(style) {
   return style;
 }
 
-class TerrainControl$1 {
+class MaptilerTerrainControl {
   constructor() {
     bindAll(["_toggleTerrain", "_updateTerrainIcon"], this);
   }
@@ -349,7 +349,7 @@ var __spreadProps$1 = (a, b) => __defProps$1(a, __getOwnPropDescs$1(b));
 const GeolocateControl$1 = maplibregl__default.GeolocateControl;
 const Marker$1 = maplibregl__default.Marker;
 const LngLat$1 = maplibregl__default.LngLat;
-class CustomGeolocateControl extends GeolocateControl$1 {
+class MaptilerGeolocateControl extends GeolocateControl$1 {
   constructor() {
     super(...arguments);
     this.lastUpdatedCenter = new LngLat$1(0, 0);
@@ -665,14 +665,14 @@ class Map extends maplibregl__default.Map {
       if ("logo" in tileJsonContent && tileJsonContent.logo) {
         const logoURL = tileJsonContent.logo;
         this.addControl(
-          new CustomLogoControl({ logoURL }),
+          new MaptilerLogoControl({ logoURL }),
           options.logoPosition
         );
         if (options.attributionControl === false) {
           this.addControl(new maplibregl__default.AttributionControl(options));
         }
       } else if (options.maptilerLogo) {
-        this.addControl(new CustomLogoControl(), options.logoPosition);
+        this.addControl(new MaptilerLogoControl(), options.logoPosition);
       }
       if (options.scaleControl) {
         const position = options.scaleControl === true || options.scaleControl === void 0 ? "bottom-right" : options.scaleControl;
@@ -689,7 +689,7 @@ class Map extends maplibregl__default.Map {
       if (options.geolocateControl !== false) {
         const position = options.geolocateControl === true || options.geolocateControl === void 0 ? "top-right" : options.geolocateControl;
         this.addControl(
-          new CustomGeolocateControl({
+          new MaptilerGeolocateControl({
             positionOptions: {
               enableHighAccuracy: true,
               maximumAge: 0,
@@ -707,7 +707,7 @@ class Map extends maplibregl__default.Map {
       }
       if (options.terrainControl) {
         const position = options.terrainControl === true || options.terrainControl === void 0 ? "top-right" : options.terrainControl;
-        this.addControl(new TerrainControl$1(), position);
+        this.addControl(new MaptilerTerrainControl(), position);
       }
       if (options.fullscreenControl) {
         const position = options.fullscreenControl === true || options.fullscreenControl === void 0 ? "top-right" : options.fullscreenControl;
@@ -1146,5 +1146,5 @@ const {
   removeProtocol
 } = maplibregl__default;
 
-export { AJAXError, AttributionControl, CanvasSource, Evented, FullscreenControl, GeoJSONSource, GeolocateControl, GeolocationType, ImageSource, Language, LngLat, LngLatBounds, LogoControl, Map, Marker, MercatorCoordinate, NavigationControl, Point, Popup, RasterDEMTileSource, RasterTileSource, ScaleControl, SdkConfig, Style, TerrainControl, VectorTileSource, VideoSource, addProtocol, clearPrewarmedResources, clearStorage, config, getRTLTextPluginStatus, maxParallelImageRequests, prewarm, removeProtocol, setRTLTextPlugin, supported, version, workerCount, workerUrl };
+export { AJAXError, AttributionControl, CanvasSource, Evented, FullscreenControl, GeoJSONSource, GeolocateControl, GeolocationType, ImageSource, Language, LngLat, LngLatBounds, LogoControl, Map, MaptilerGeolocateControl, MaptilerLogoControl, MaptilerTerrainControl, Marker, MercatorCoordinate, NavigationControl, Point, Popup, RasterDEMTileSource, RasterTileSource, ScaleControl, SdkConfig, Style, TerrainControl, VectorTileSource, VideoSource, addProtocol, clearPrewarmedResources, clearStorage, config, getRTLTextPluginStatus, maxParallelImageRequests, prewarm, removeProtocol, setRTLTextPlugin, supported, version, workerCount, workerUrl };
 //# sourceMappingURL=maptiler-sdk.mjs.map