@kepler.gl/deckgl-layers 3.3.0-alpha.3 → 3.3.0-alpha.5

package/dist/globe/globe-layers.d.ts

@@ -0,0 +1,108 @@
+import { Layer } from '@deck.gl/core';
+import type { Globe } from '@kepler.gl/constants';
+import type { RGBColor } from '@kepler.gl/types';
+type LayerGroup = {
+    slug: string;
+    filter: (layer: any) => boolean;
+};
+export declare const DEFAULT_BASEMAP_COLOR: {
+    backgroundFillColor: RGBColor;
+    basemapDefaultFillColor: RGBColor;
+    basemapWaterFillColor: RGBColor;
+    basemapDefaultLineColor: RGBColor;
+    basemapAdminLineColor: RGBColor;
+    basemapLabelColor: RGBColor;
+};
+export declare const getBasemapColors: (mapStyle: Partial<{
+    style: any;
+    layerGroups: LayerGroup[];
+}>) => {
+    backgroundFillColor: RGBColor;
+    basemapWaterFillColor: RGBColor;
+    basemapAdminLineColor: RGBColor;
+    basemapLabelColor: RGBColor;
+};
+/**
+ * Get basemap colors either from the style JSON or from known style presets.
+ * Falls back to default dark colors if style is unknown and no JSON is available.
+ */
+export declare const getBasemapColorsForStyle: (styleType: string, mapStyle?: Partial<{
+    style: any;
+    layerGroups: LayerGroup[];
+}>) => {
+    backgroundFillColor: RGBColor;
+    basemapWaterFillColor: RGBColor;
+    basemapAdminLineColor: RGBColor;
+    basemapLabelColor: RGBColor;
+};
+/**
+ * Clear color (background around the globe) for globe mode, in RGBA 0-255 as
+ * expected by deck.gl's View `clearColor` prop (deck.gl >= 9 no longer supports
+ * the global `parameters.clearColor`; it must be set per-view with `clear: true`).
+ */
+export declare function getGlobeClearColor(backgroundColor?: [number, number, number] | number[]): [number, number, number, number];
+/**
+ * Globe basemap tile provider.
+ *
+ * - `mapbox` uses Mapbox vector/raster tiles and requires an access token.
+ * - `carto` uses CARTO's free OpenMapTiles vector tiles + Esri World Imagery
+ *   raster, and needs no token. Used as an automatic fallback when no Mapbox
+ *   token is available (e.g. MapLibre / CARTO basemap setups), so the globe
+ *   basemap still renders instead of showing a solid-color sphere.
+ */
+export type GlobeBasemapProvider = 'mapbox' | 'carto';
+/**
+ * Resolve which globe basemap tile provider to use.
+ *
+ * The globe should follow the *selected basemap style's* rendering library so
+ * it stays consistent with the flat 2D map: a MapLibre/CARTO style uses the
+ * free CARTO tiles (even when a Mapbox token is available), and a Mapbox style
+ * uses Mapbox tiles. A Mapbox style with no token falls back to CARTO so the
+ * globe still renders instead of showing a bare colored sphere.
+ *
+ * @param baseMapLibrary the selected style's library ('mapbox' | 'maplibre'),
+ *   e.g. from `getBaseMapLibrary(currentStyle)`.
+ */
+export declare const resolveGlobeBasemapProvider: (baseMapLibrary: "mapbox" | "maplibre" | undefined, mapboxApiAccessToken?: string) => GlobeBasemapProvider;
+export type GlobeAttribution = {
+    label: string;
+    href: string;
+};
+/**
+ * Resolve the tile-source attribution entries for the globe basemap. deck.gl
+ * renders the globe basemap tiles itself (not the base Maplibre/Mapbox map), so
+ * the base map's attribution machinery never sees them. This lets the UI credit
+ * the actual tile provider(s) in globe mode.
+ */
+export declare const getGlobeBasemapAttributions: ({ globe, mapboxApiAccessToken, mapStyleType, basemapProvider }: {
+    globe?: Globe;
+    mapboxApiAccessToken?: string;
+    mapStyleType?: string;
+    basemapProvider?: GlobeBasemapProvider;
+}) => GlobeAttribution[];
+export declare const getGlobeBaseLayers: ({ mapboxApiAccessToken, globe, mapStyleType, basemapProvider, latitude, zoom }: {
+    mapboxApiAccessToken: string;
+    globe: Globe;
+    mapStyleType?: string;
+    /**
+     * Which tile provider to use for the globe basemap. Defaults to `mapbox` when
+     * a token is present, otherwise falls back to the token-free `carto` tiles.
+     */
+    basemapProvider?: GlobeBasemapProvider;
+    /**
+     * Current camera center latitude. Used to keep tile LOD constant while rotating
+     * toward the poles (deck.gl 9 lowers the effective zoom near the poles). When
+     * omitted, no latitude compensation is applied (equator behavior).
+     */
+    latitude?: number;
+    /**
+     * Current map zoom level. Used to fade the atmosphere effects out when the user
+     * zooms in past a certain threshold (mirrors Google Maps globe behaviour).
+     */
+    zoom?: number;
+}) => Layer[];
+export declare const getGlobeTopLayers: ({ globe, zoom }: {
+    globe: Globe;
+    zoom?: number;
+}) => Layer[];
+export {};