kepler.gl
Version:
kepler.gl is a webgl based application to visualize large scale location data in the browser
44 lines (43 loc) • 1.8 kB
TypeScript
import { MapLib, MapRef } from 'react-map-gl';
import type { BaseMapLibraryType } from '@kepler.gl/constants';
import type { DatabaseAdapter } from './application-config-types';
export declare type MapLibInstance = MapLib<any>;
export declare type GetMapRef = ReturnType<MapRef['getMap']>;
export declare type BaseMapLibraryConfig = {
getMapLib: () => Promise<MapLibInstance>;
mapLibAttributionCssClass: string;
mapLibCssClass: string;
mapLibName: string;
mapLibUrl: string;
};
/**
* A mechanism to override default Kepler values/settings so that we
* without having to make application-specific changes to the kepler repo.
*/
export declare type KeplerApplicationConfig = {
/** Default name of export HTML file, can be overridden by user */
defaultHtmlName?: string;
defaultImageName?: string;
defaultJsonName?: string;
defaultDataName?: string;
defaultExportJsonSettings?: {
hasData?: boolean;
};
baseMapLibraryConfig?: Record<BaseMapLibraryType, BaseMapLibraryConfig>;
plugins?: any[];
table?: any;
database?: DatabaseAdapter | null;
useArrowProgressiveLoading?: boolean;
showReleaseBanner?: boolean;
useOnFilteredItemsChange?: boolean;
cdnUrl?: string;
enableRasterTileLayer?: boolean;
/** Titiler v0.11 vs v0.21 */
rasterServerUseLatestTitiler?: boolean;
/** An array of URLs to shards of the raster tile server to be used by the raster tile layer. */
rasterServerUrls?: string[];
/** If true then try to fetch quantized elevation meshes from raster servers */
rasterServerSupportsElevation?: boolean;
};
export declare const getApplicationConfig: () => Required<KeplerApplicationConfig>;
export declare function initApplicationConfig(appConfig?: KeplerApplicationConfig): void;