@kepler.gl/constants 3.0.0-alpha.0 → 3.0.0-alpha.2

package/dist/default-settings.d.ts

@@ -1,8 +1,8 @@
 import { scaleLinear, scaleQuantize, scaleQuantile, scaleOrdinal, scaleSqrt, scaleLog, scalePoint } from 'd3-scale';
-import { RGBAColor } from '@kepler.gl/types';
+import { RGBAColor, EffectDescription, BaseMapStyle } from '@kepler.gl/types';
 export declare const ACTION_PREFIX = "@@kepler.gl/";
-export declare const CLOUDFRONT = "https://d1a3f4spazzrp4.cloudfront.net/kepler.gl";
-export declare const ICON_PREFIX: string;
+export declare const KEPLER_UNFOLDED_BUCKET = "https://studio-public-data.foursquare.com/statics/keplergl";
+export declare const BASEMAP_ICON_PREFIX: string;
 export declare const DEFAULT_MAPBOX_API_URL = "https://api.mapbox.com";
 export declare const TRANSITION_DURATION = 0;
 /**
@@ -121,30 +121,43 @@ export declare const SIDEBAR_PANELS: {
     label: string;
     onClick: null;
 }[];
+export declare const PANEL_VIEW_TOGGLES: {
+    list: "list";
+    byDataset: "byDataset";
+};
 export declare const PANELS: {
     id: string;
     label: string;
     onClick: null;
 }[];
-declare type DEFAULT_LAYER_GROUP = {
+export declare const DEFAULT_BLDG_COLOR = "#D1CEC7";
+export declare const DEFAULT_BACKGROUND_COLOR = "#000000";
+export declare const BASE_MAP_BACKGROUND_LAYER_IDS: string[];
+export declare const BACKGROUND_LAYER_GROUP_SLUG = "Background";
+export declare const THREE_D_BUILDING_LAYER_GROUP_SLUG = "3d building";
+export declare type DEFAULT_LAYER_GROUP = {
     slug: string;
     filter: (value: any) => boolean;
     defaultVisibility: boolean;
+    isVisibilityToggleAvailable?: boolean;
+    isMoveToTopAvailable?: boolean;
+    isColorPickerAvailable?: boolean;
 };
+export declare const BACKGROUND_LAYER_GROUP: DEFAULT_LAYER_GROUP;
 export declare const DEFAULT_LAYER_GROUPS: DEFAULT_LAYER_GROUP[];
-export declare const DEFAULT_MAP_STYLES: ({
-    id: string;
-    label: string;
-    url: string;
-    icon: string;
-    layerGroups: DEFAULT_LAYER_GROUP[];
-} | {
-    id: string;
-    label: string;
-    url: string;
-    icon: string;
-    layerGroups?: undefined;
-})[];
+export declare const BASE_MAP_COLOR_MODES: {
+    NONE: "NONE";
+    DARK: "DARK";
+    LIGHT: "LIGHT";
+};
+export declare const NO_MAP_ID = "no_map";
+export declare const EMPTY_MAPBOX_STYLE: {
+    version: number;
+    sources: {};
+    layers: never[];
+};
+export declare const NO_BASEMAP_ICON: string;
+export declare const DEFAULT_MAP_STYLES: BaseMapStyle[];
 export declare const GEOJSON_FIELDS: {
     geojson: string[];
 };
@@ -167,6 +180,12 @@ export declare const FILTER_TYPES: {
     multiSelect: "multiSelect";
     polygon: "polygon";
 };
+export declare const FILTER_VIEW_TYPES: {
+    side: "side";
+    enlarged: "enlarged";
+    minified: "minified";
+};
+export declare const DEFAULT_FILTER_VIEW_TYPE: "side";
 export declare const SCALE_TYPES: {
     ordinal: "ordinal";
     quantile: "quantile";
@@ -194,6 +213,9 @@ export declare const ALL_FIELD_TYPES: {
     string: "string";
     timestamp: "timestamp";
     point: "point";
+    array: "array";
+    object: "object";
+    geoarrow: "geoarrow";
 };
 export declare const SORT_ORDER: {
     ASCENDING: "ASCENDING";
@@ -207,6 +229,7 @@ export declare const TABLE_OPTION: {
     PIN: "PIN";
     UNPIN: "UNPIN";
     COPY: "COPY";
+    FORMAT_COLUMN: "FORMAT_COLUMN";
 };
 export declare const TABLE_OPTION_LIST: ({
     value: "SORT_ASC";
@@ -238,6 +261,11 @@ export declare const TABLE_OPTION_LIST: ({
     display: string;
     icon: string;
     condition?: undefined;
+} | {
+    value: "FORMAT_COLUMN";
+    display: string;
+    icon: string;
+    condition?: undefined;
 })[];
 export declare const FIELD_TYPE_DISPLAY: {
     boolean: {
@@ -252,6 +280,10 @@ export declare const FIELD_TYPE_DISPLAY: {
         label: string;
         color: string;
     };
+    geoarrow: {
+        label: string;
+        color: string;
+    };
     integer: {
         label: string;
         color: string;
@@ -272,6 +304,14 @@ export declare const FIELD_TYPE_DISPLAY: {
         label: string;
         color: string;
     };
+    array: {
+        label: string;
+        color: string;
+    };
+    object: {
+        label: string;
+        color: string;
+    };
 };
 export declare const FIELD_COLORS: {
     default: string;
@@ -294,8 +334,12 @@ export declare const AGGREGATION_TYPES: {
     sum: 'sum';
     variance: 'variance';
     mode: 'mode';
-    countUnique: 'count unique';
+    countUnique: 'countUnique';
 };
+export declare const AGGREGATION_TYPE_OPTIONS: {
+    id: string;
+    label: string;
+}[];
 export declare const linearFieldScaleFunctions: {
     color: ("quantile" | "quantize")[];
     radius: "sqrt"[];
@@ -329,7 +373,7 @@ export declare const ordinalFieldScaleFunctions: {
 export declare const ordinalFieldAggrScaleFunctions: {
     colorAggr: {
         mode: "ordinal"[];
-        "count unique": ("quantile" | "quantize")[];
+        countUnique: ("quantile" | "quantize")[];
     };
     sizeAggr: {};
 };
@@ -362,7 +406,7 @@ export declare const FIELD_OPTS: {
         scale: {
             colorAggr: {
                 mode: "ordinal"[];
-                "count unique": ("quantile" | "quantize")[];
+                countUnique: ("quantile" | "quantize")[];
             };
             sizeAggr: {};
             color: "ordinal"[];
@@ -453,7 +497,7 @@ export declare const FIELD_OPTS: {
         scale: {
             colorAggr: {
                 mode: "ordinal"[];
-                "count unique": ("quantile" | "quantize")[];
+                countUnique: ("quantile" | "quantize")[];
             };
             sizeAggr: {};
             color: "ordinal"[];
@@ -466,10 +510,11 @@ export declare const FIELD_OPTS: {
         };
     };
     date: {
+        type: string;
         scale: {
             colorAggr: {
                 mode: "ordinal"[];
-                "count unique": ("quantile" | "quantize")[];
+                countUnique: ("quantile" | "quantize")[];
             };
             sizeAggr: {};
             color: "ordinal"[];
@@ -495,6 +540,36 @@ export declare const FIELD_OPTS: {
             tooltip: never[];
         };
     };
+    geoarrow: {
+        type: string;
+        scale: {
+            colorAggr: {};
+            sizeAggr: {};
+            color: never[];
+            radius: never[];
+            size: never[];
+        };
+        format: {
+            legend: (d: any) => string;
+            tooltip: never[];
+        };
+    };
+    object: {
+        type: string;
+        scale: {};
+        format: {
+            legend: (d: any) => string;
+            tooltip: never[];
+        };
+    };
+    array: {
+        type: string;
+        scale: {};
+        format: {
+            legend: (d: any) => string;
+            tooltip: never[];
+        };
+    };
 };
 export declare const CHANNEL_SCALE_SUPPORTED_FIELDS: {
     [id: string]: string[];
@@ -507,6 +582,21 @@ export declare const DEFAULT_LAYER_COLOR: {
 };
 export declare const DEFAULT_TOOLTIP_FIELDS: any[];
 export declare const NO_VALUE_COLOR: RGBAColor;
+export declare const DEFAULT_PICKING_RADIUS = 3;
+export declare const OVERLAY_BLENDINGS: {
+    normal: {
+        label: string;
+        value: string;
+    };
+    screen: {
+        label: string;
+        value: string;
+    };
+    darken: {
+        label: string;
+        value: string;
+    };
+};
 export declare const LAYER_BLENDINGS: {
     additive: {
         label: string;
@@ -551,6 +641,7 @@ export declare type ExportImage = {
     exporting: boolean;
     processing: boolean;
     error: Error | false;
+    escapeXhtmlForWebpack?: boolean;
     center: boolean;
 };
 export declare type ImageRatioOption = {
@@ -601,7 +692,7 @@ export declare const EXPORT_MAP_FORMAT_OPTIONS: {
     label: any;
     available: boolean;
 }[];
-export declare function getHTMLMapModeTileUrl(mode: any): string;
+export declare function getHTMLMapModeTileUrl(mode: string): string;
 export declare const EXPORT_HTML_MAP_MODE_OPTIONS: {
     id: string;
     label: string;
@@ -620,7 +711,7 @@ export declare const DEFAULT_NOTIFICATION_TOPICS: {
     global: "global";
     file: "file";
 };
-export declare const THROTTLE_NOTIFICATION_TIME = 2500;
+export declare const THROTTLE_NOTIFICATION_TIME = 330;
 export declare const BASE_SPEED = 600;
 export declare const FPS = 60;
 /**
@@ -659,16 +750,18 @@ export declare const GEOCODER_LAYER_ID = "geocoder_layer";
 export declare const GEOCODER_GEO_OFFSET = 0.05;
 export declare const GEOCODER_ICON_COLOR: [number, number, number];
 export declare const GEOCODER_ICON_SIZE = 80;
+export declare const EDITOR_LAYER_ID = "kepler_editor_layer";
+export declare const EDITOR_LAYER_PICKING_RADIUS = 6;
 export declare const EDITOR_MODES: {
-    READ_ONLY: any;
-    DRAW_POLYGON: any;
-    DRAW_RECTANGLE: any;
-    EDIT: any;
+    DRAW_POLYGON: string;
+    DRAW_RECTANGLE: string;
+    EDIT: string;
 };
 export declare const PLOT_TYPES: {
     histogram: "histogram";
     lineChart: "lineChart";
 };
+export declare const INIT_FILTER_ITEMS_IN_DROPDOWN = 100;
 /**
  * Max number of filter value buffers that deck.gl provides
  */
@@ -691,6 +784,7 @@ export declare const DATASET_FORMATS: {
     geojson: "geojson";
     csv: "csv";
     keplergl: "keplergl";
+    arrow: "arrow";
 };
 export declare const MAP_CONTROLS: {
     visibleLayers: "visibleLayers";
@@ -699,6 +793,7 @@ export declare const MAP_CONTROLS: {
     splitMap: "splitMap";
     mapDraw: "mapDraw";
     mapLocale: "mapLocale";
+    effect: "effect";
 };
 /**
  * A multiplier for screen-space width/scale for Arc, Line, Icon and Text layers.
@@ -706,4 +801,36 @@ export declare const MAP_CONTROLS: {
  * https://github.com/visgl/deck.gl/blob/master/docs/upgrade-guide.md
  */
 export declare const PROJECTED_PIXEL_SIZE_MULTIPLIER: number;
-export {};
+/**
+ * Maximum value for text outline width
+ */
+export declare const TEXT_OUTLINE_MULTIPLIER = 5;
+export declare const dataTestIds: Record<string, string>;
+export declare const DEFAULT_TIMEZONE = "UTC";
+export declare const DEFAULT_POST_PROCESSING_EFFECT_TYPE: string;
+export declare const DEFAULT_LIGHT_COLOR: [number, number, number];
+export declare const DEFAULT_LIGHT_INTENSITY = 1;
+export declare const DEFAULT_SHADOW_INTENSITY = 0.5;
+export declare const DEFAULT_SHADOW_COLOR: [number, number, number];
+export declare const LIGHT_AND_SHADOW_EFFECT_TIME_MODES: {
+    pick: "pick";
+    current: "current";
+    animation: "animation";
+};
+export declare type LightAndShadowEffectTimeMode = 'pick' | 'current' | 'animation';
+export declare const DEFAULT_LIGHT_AND_SHADOW_PROPS: {
+    timestamp: number;
+    timeMode: LightAndShadowEffectTimeMode;
+    shadowIntensity: number;
+    shadowColor: [number, number, number];
+    sunLightColor: [number, number, number];
+    sunLightIntensity: number;
+    ambientLightColor: [number, number, number];
+    ambientLightIntensity: number;
+};
+export declare const LIGHT_AND_SHADOW_EFFECT: EffectDescription;
+export declare const POSTPROCESSING_EFFECTS: {
+    [key: string]: EffectDescription;
+};
+export declare const EFFECT_DESCRIPTIONS: EffectDescription[];
+export declare type EffectType = 'ink' | 'brightnessContrast' | 'hueSaturation' | 'vibrance' | 'sepia' | 'dotScreen' | 'colorHalftone' | 'noise' | 'triangleBlur' | 'zoomBlur' | 'tiltShift' | 'edgeWork' | 'vignette' | 'magnify' | 'hexagonalPixelate' | 'lightAndShadow';