maplibre-gl

import assert from 'assert'; import {supported} from '@mapbox/mapbox-gl-supported'; import packageJSON from '../package.json' assert {type: 'json'}; import Map from './ui/map'; import NavigationControl from './ui/control/navigation_control'; import GeolocateControl from './ui/control/geolocate_control'; import AttributionControl from './ui/control/attribution_control'; import LogoControl from './ui/control/logo_control'; import ScaleControl from './ui/control/scale_control'; import FullscreenControl from './ui/control/fullscreen_control'; import TerrainControl from './ui/control/terrain_control'; import Popup from './ui/popup'; import Marker from './ui/marker'; import Style from './style/style'; import LngLat from './geo/lng_lat'; import LngLatBounds from './geo/lng_lat_bounds'; import Point from '@mapbox/point-geometry'; import MercatorCoordinate from './geo/mercator_coordinate'; import {Evented} from './util/evented'; import config from './util/config'; import {Debug} from './util/debug'; import {isSafari} from './util/util'; import {setRTLTextPlugin, getRTLTextPluginStatus} from './source/rtl_text_plugin'; import WorkerPool from './util/worker_pool'; import {prewarm, clearPrewarmedResources} from './util/global_worker_pool'; import {clearTileCache} from './util/tile_request_cache'; import {PerformanceUtils} from './util/performance'; import {AJAXError} from './util/ajax'; import type {RequestParameters, ResponseCallback} from './util/ajax'; import type {Cancelable} from './types/cancelable'; import GeoJSONSource from './source/geojson_source'; import CanvasSource from './source/canvas_source'; import ImageSource from './source/image_source'; import RasterDEMTileSource from './source/raster_dem_tile_source'; import RasterTileSource from './source/raster_tile_source'; import VectorTileSource from './source/vector_tile_source'; import VideoSource from './source/video_source'; const version = packageJSON.version; const exported = { supported, setRTLTextPlugin, getRTLTextPluginStatus, Map, NavigationControl, GeolocateControl, AttributionControl, LogoControl, ScaleControl, FullscreenControl, TerrainControl, Popup, Marker, Style, LngLat, LngLatBounds, Point, MercatorCoordinate, Evented, AJAXError, config, CanvasSource, GeoJSONSource, ImageSource, RasterDEMTileSource, RasterTileSource, VectorTileSource, VideoSource, /** * Initializes resources like WebWorkers that can be shared across maps to lower load * times in some situations. `maplibregl.workerUrl` and `maplibregl.workerCount`, if being * used, must be set before `prewarm()` is called to have an effect. * * By default, the lifecycle of these resources is managed automatically, and they are * lazily initialized when a Map is first created. By invoking `prewarm()`, these * resources will be created ahead of time, and will not be cleared when the last Map * is removed from the page. This allows them to be re-used by new Map instances that * are created later. They can be manually cleared by calling * `maplibregl.clearPrewarmedResources()`. This is only necessary if your web page remains * active but stops using maps altogether. * * This is primarily useful when using GL-JS maps in a single page app, wherein a user * would navigate between various views that can cause Map instances to constantly be * created and destroyed. * * @function prewarm * @example * maplibregl.prewarm() */ prewarm, /** * Clears up resources that have previously been created by `maplibregl.prewarm()`. * Note that this is typically not necessary. You should only call this function * if you expect the user of your app to not return to a Map view at any point * in your application. * * @function clearPrewarmedResources * @example * maplibregl.clearPrewarmedResources() */ clearPrewarmedResources, /** * Returns the package version of the library * @returns {string} Package version of the library */ get version(): string { return version; }, /** * Gets and sets the number of web workers instantiated on a page with GL JS maps. * By default, it is set to half the number of CPU cores (capped at 6). * Make sure to set this property before creating any map instances for it to have effect. * * @var {string} workerCount * @returns {number} Number of workers currently configured. * @example * maplibregl.workerCount = 2; */ get workerCount(): number { return WorkerPool.workerCount; }, set workerCount(count: number) { WorkerPool.workerCount = count; }, /** * Gets and sets the maximum number of images (raster tiles, sprites, icons) to load in parallel, * which affects performance in raster-heavy maps. 16 by default. * * @var {string} maxParallelImageRequests * @returns {number} Number of parallel requests currently configured. * @example * maplibregl.maxParallelImageRequests = 10; */ get maxParallelImageRequests(): number { return config.MAX_PARALLEL_IMAGE_REQUESTS; }, set maxParallelImageRequests(numRequests: number) { config.MAX_PARALLEL_IMAGE_REQUESTS = numRequests; }, /** * Clears browser storage used by this library. Using this method flushes the MapLibre tile * cache that is managed by this library. Tiles may still be cached by the browser * in some cases. * * This API is supported on browsers where the [`Cache` API](https://developer.mozilla.org/en-US/docs/Web/API/Cache) * is supported and enabled. This includes all major browsers when pages are served over * `https://`, except Internet Explorer and Edge Mobile. * * When called in unsupported browsers or environments (private or incognito mode), the * callback will be called with an error argument. * * @function clearStorage * @param {Function} callback Called with an error argument if there is an error. * @example * maplibregl.clearStorage(); */ clearStorage(callback?: (err?: Error | null) => void) { clearTileCache(callback); }, workerUrl: '', /** * Sets a custom load tile function that will be called when using a source that starts with a custom url schema. * The example below will be triggered for custom:// urls defined in the sources list in the style definitions. * The function passed will receive the request parameters and should call the callback with the resulting request, * for example a pbf vector tile, non-compressed, represented as ArrayBuffer. * * @function addProtocol * @param {string} customProtocol - the protocol to hook, for example 'custom' * @param {Function} loadFn - the function to use when trying to fetch a tile specified by the customProtocol * @example * // this will fetch a file using the fetch API (this is obviously a non iteresting example...) * maplibre.addProtocol('custom', (params, callback) => { fetch(`https://${params.url.split("://")[1]}`) .then(t => { if (t.status == 200) { t.arrayBuffer().then(arr => { callback(null, arr, null, null); }); } else { callback(new Error(`Tile fetch error: ${t.statusText}`)); } }) .catch(e => { callback(new Error(e)); }); return { cancel: () => { } }; }); * // the following is an example of a way to return an error when trying to load a tile * maplibre.addProtocol('custom2', (params, callback) => { * callback(new Error('someErrorMessage')); * return { cancel: () => { } }; * }); */ addProtocol(customProtocol: string, loadFn: (requestParameters: RequestParameters, callback: ResponseCallback<any>) => Cancelable) { config.REGISTERED_PROTOCOLS[customProtocol] = loadFn; }, /** * Removes a previusly added protocol * * @function removeProtocol * @param {string} customProtocol - the custom protocol to remove registration for * @example * maplibregl.removeProtocol('custom'); */ removeProtocol(customProtocol: string) { delete config.REGISTERED_PROTOCOLS[customProtocol]; } }; //This gets automatically stripped out in production builds. Debug.extend(exported, {isSafari, getPerformanceMetrics: PerformanceUtils.getPerformanceMetrics}); /** * Test whether the browser supports MapLibre GL JS. * * @function supported * @param {Object} [options] * @param {boolean} [options.failIfMajorPerformanceCaveat=false] If `true`, * the function will return `false` if the performance of MapLibre GL JS would * be dramatically worse than expected (e.g. a software WebGL renderer would be used). * @return {boolean} * @example * // Show an alert if the browser does not support MapLibre GL * if (!maplibregl.supported()) { * alert('Your browser does not support MapLibre GL'); * } * @see [Check for browser support](https://maplibre.org/maplibre-gl-js-docs/example/check-for-support/) */ /** * Sets the map's [RTL text plugin](https://www.mapbox.com/mapbox-gl-js/plugins/#mapbox-gl-rtl-text). * Necessary for supporting the Arabic and Hebrew languages, which are written right-to-left. * * @function setRTLTextPlugin * @param {string} pluginURL URL pointing to the Mapbox RTL text plugin source. * @param {Function} callback Called with an error argument if there is an error. * @param {boolean} lazy If set to `true`, mapboxgl will defer loading the plugin until rtl text is encountered, * rtl text will then be rendered only after the plugin finishes loading. * @example * maplibregl.setRTLTextPlugin('https://unpkg.com/@mapbox/mapbox-gl-rtl-text@0.2.3/mapbox-gl-rtl-text.js'); * @see [Add support for right-to-left scripts](https://maplibre.org/maplibre-gl-js-docs/example/mapbox-gl-rtl-text/) */ /** * Gets the map's [RTL text plugin](https://www.mapbox.com/mapbox-gl-js/plugins/#mapbox-gl-rtl-text) status. * The status can be `unavailable` (i.e. not requested or removed), `loading`, `loaded` or `error`. * If the status is `loaded` and the plugin is requested again, an error will be thrown. * * @function getRTLTextPluginStatus * @example * const pluginStatus = maplibregl.getRTLTextPluginStatus(); */ export default exported; // canary assert: used to confirm that asserts have been removed from production build assert(true, 'canary assert');