@kepler.gl/components 3.2.6 → 3.3.0-alpha.1

package/dist/kepler-gl.d.ts

@@ -2,7 +2,7 @@ import React, { Dispatch } from 'react';
 import { FeatureFlags } from './context';
 import { AttributionWithStyle, DatasetAttribution, OnErrorCallBack, OnSuccessCallBack, Viewport, MapState } from '@kepler.gl/types';
 import { MapStateActions, MapStyleActions, ProviderActions, UIStateActions, VisStateActions } from '@kepler.gl/actions';
-declare type KeplerGlActions = {
+type KeplerGlActions = {
     visStateActions: typeof VisStateActions;
     mapStateActions: typeof MapStateActions;
     mapStyleActions: typeof MapStyleActions;
@@ -22,7 +22,7 @@ import DndContextFactory from './dnd-context';
 import { KeplerGlState } from '@kepler.gl/reducers';
 import { Provider } from '@kepler.gl/cloud-providers';
 export declare const isViewportDisjointed: (props: any) => any;
-declare type MapStateProps = {
+type MapStateProps = {
     mapState: MapState;
 };
 export declare const mapStateSelector: ((state: MapStateProps, index?: number | undefined) => MapState) & import("reselect").OutputSelectorFields<(args_0: MapState, args_1: number | undefined) => MapState, {
@@ -36,6 +36,7 @@ export declare const mapFieldsSelector: (props: KeplerGLProps, index?: number) =
     mapboxApiUrl: string;
     mapState: MapState;
     datasetAttributions: DatasetAttribution[];
+    attributionLogos: AttributionWithStyle[];
     mapStyle: import("@kepler.gl/reducers").MapStyle;
     onDeckInitialized: (() => void) | undefined;
     onViewStateChange: ((viewState: Viewport) => void) | undefined;
@@ -58,6 +59,7 @@ export declare const mapFieldsSelector: (props: KeplerGLProps, index?: number) =
     transformRequest: ((url: string) => {
         url: string;
     }) | undefined;
+    RTLTextPlugin: string | false | undefined;
 };
 export declare function getVisibleDatasets(datasets: any): {};
 export declare const sidePanelSelector: (props: KeplerGLProps, availableProviders: any, filteredDatasets: any) => {
@@ -73,7 +75,7 @@ export declare const sidePanelSelector: (props: KeplerGLProps, availableProvider
     mapStateActions: typeof MapStateActions;
     datasets: any;
     filters: import("@kepler.gl/types").Filter[];
-    layers: import("@kepler.gl/layers/dist/base-layer").default[];
+    layers: import("@kepler.gl/layers").Layer[];
     layerOrder: string[];
     layerClasses: {
         point: typeof import("@kepler.gl/layers/dist/point-layer/point-layer").default;
@@ -89,9 +91,12 @@ export declare const sidePanelSelector: (props: KeplerGLProps, availableProvider
         "3D": typeof import("@kepler.gl/layers").ScenegraphLayer;
         trip: typeof import("@kepler.gl/layers/dist/trip-layer/trip-layer").default;
         s2: typeof import("@kepler.gl/layers/dist/s2-geometry-layer/s2-geometry-layer").default;
+        flow: typeof import("@kepler.gl/layers/dist/flow-layer/flow-layer").default;
         vectorTile: typeof import("@kepler.gl/layers").VectorTileLayer;
         rasterTile: typeof import("@kepler.gl/layers").RasterTileLayer;
         wms: typeof import("@kepler.gl/layers/dist/wms-layer/wms-layer").default;
+        tile3d: typeof import("@kepler.gl/layers").Tile3DLayer;
+        bitmap: typeof import("@kepler.gl/layers").BitmapOverlayLayer;
     };
     interactionConfig: import("@kepler.gl/types").InteractionConfig;
     mapInfo: import("@kepler.gl/types").MapInfo;
@@ -121,6 +126,7 @@ export declare const plotContainerSelector: (props: KeplerGLProps) => {
         mapboxApiUrl: string;
         mapState: MapState;
         datasetAttributions: DatasetAttribution[];
+        attributionLogos: AttributionWithStyle[];
         mapStyle: import("@kepler.gl/reducers").MapStyle;
         onDeckInitialized: (() => void) | undefined;
         onViewStateChange: ((viewState: Viewport) => void) | undefined;
@@ -143,23 +149,20 @@ export declare const plotContainerSelector: (props: KeplerGLProps) => {
         transformRequest: ((url: string) => {
             url: string;
         }) | undefined;
+        RTLTextPlugin: string | false | undefined;
     };
-    addNotification: (notification: object) => {
-        payload: object;
+    addNotification: (notification: UIStateActions.AddNotificationUpdaterAction["payload"]) => import("@kepler.gl/types").Merge<UIStateActions.AddNotificationUpdaterAction, {
         type: "@@kepler.gl/ADD_NOTIFICATION";
-    };
-    setExportImageSetting: (newSetting: Partial<import("@kepler.gl/types").ExportImage>) => {
-        payload: Partial<import("@kepler.gl/types").ExportImage>;
+    }>;
+    setExportImageSetting: (newSetting: UIStateActions.SetExportImageSettingUpdaterAction["payload"]) => import("@kepler.gl/types").Merge<UIStateActions.SetExportImageSettingUpdaterAction, {
         type: "@@kepler.gl/SET_EXPORT_IMAGE_SETTING";
-    };
-    setExportImageDataUri: (dataUri: string) => {
-        payload: string;
+    }>;
+    setExportImageDataUri: (dataUri: UIStateActions.SetExportImageDataUriUpdaterAction["payload"]) => import("@kepler.gl/types").Merge<UIStateActions.SetExportImageDataUriUpdaterAction, {
         type: "@@kepler.gl/SET_EXPORT_IMAGE_DATA_URI";
-    };
-    setExportImageError: (error: Error) => {
-        payload: Error;
+    }>;
+    setExportImageError: (error: UIStateActions.SetExportImageErrorUpdaterAction["payload"]) => import("@kepler.gl/types").Merge<UIStateActions.SetExportImageErrorUpdaterAction, {
         type: "@@kepler.gl/SET_EXPORT_IMAGE_ERROR";
-    };
+    }>;
     splitMaps: import("@kepler.gl/types").SplitMap[];
 };
 export declare const isSplitSelector: (props: KeplerGLProps) => boolean;
@@ -167,13 +170,12 @@ export declare const bottomWidgetSelector: (props: KeplerGLProps, theme: any) =>
     filters: import("@kepler.gl/types").Filter[];
     datasets: import("@kepler.gl/table").Datasets;
     uiState: import("@kepler.gl/types").UiState;
-    layers: import("@kepler.gl/layers/dist/base-layer").default[];
+    layers: import("@kepler.gl/layers").Layer[];
     animationConfig: import("@kepler.gl/types").AnimationConfig;
     visStateActions: typeof VisStateActions;
-    toggleModal: (id: string | null) => {
-        payload: string | null;
+    toggleModal: (id: UIStateActions.ToggleModalUpdaterAction["payload"]) => import("@kepler.gl/types").Merge<UIStateActions.ToggleModalUpdaterAction, {
         type: "@@kepler.gl/TOGGLE_MODAL";
-    };
+    }>;
     sidePanelWidth: any;
 };
 export declare const modalContainerSelector: (props: KeplerGLProps, rootNode: any) => {
@@ -207,14 +209,11 @@ export declare const geoCoderPanelSelector: (props: KeplerGLProps, dimensions: {
     layerOrder: string[];
     updateVisData: typeof VisStateActions.updateVisData;
     removeDataset: typeof VisStateActions.removeDataset;
-    updateMap: (viewport: Viewport, mapIndex?: number | undefined) => {
-        payload: {
-            viewport: Viewport;
-            mapIndex?: number | undefined;
-        };
+    updateMap: (viewport: Viewport, mapIndex?: number) => import("@kepler.gl/types").Merge<MapStateActions.UpdateMapUpdaterAction, {
         type: "@@kepler.gl/UPDATE_MAP";
-    };
+    }>;
     appWidth: number;
+    limitSearch: boolean;
 };
 /**
  * Returns array of unique dataset attributions, each with title and url properties.
@@ -224,14 +223,15 @@ export declare const datasetAttributionSelector: ((state: any) => DatasetAttribu
 }> & {
     clearCache: () => void;
 };
-/**
- * Deduplicated dataset and layer text attributions and logos.
- * Returns text attributions and logos to display.
- */
+export declare const layerAttributionSelector: ((state: any) => AttributionWithStyle[]) & import("reselect").OutputSelectorFields<(args_0: any, args_1: string) => AttributionWithStyle[], {
+    clearCache: () => void;
+}> & {
+    clearCache: () => void;
+};
 export declare const attributionSelector: ((state: any) => {
     sources: DatasetAttribution[];
     logos: AttributionWithStyle[];
-}) & import("reselect").OutputSelectorFields<(args_0: DatasetAttribution[]) => {
+}) & import("reselect").OutputSelectorFields<(args_0: DatasetAttribution[], args_1: AttributionWithStyle[]) => {
     sources: DatasetAttribution[];
     logos: AttributionWithStyle[];
 }, {
@@ -240,10 +240,9 @@ export declare const attributionSelector: ((state: any) => {
     clearCache: () => void;
 };
 export declare const notificationPanelSelector: (props: KeplerGLProps) => {
-    removeNotification: (id: string) => {
-        payload: string;
+    removeNotification: (id: UIStateActions.RemoveNotificationUpdaterAction["payload"]) => import("@kepler.gl/types").Merge<UIStateActions.RemoveNotificationUpdaterAction, {
         type: "@@kepler.gl/REMOVE_NOTIFICATION";
-    };
+    }>;
     notifications: import("@kepler.gl/types").Notifications[];
 };
 export declare const DEFAULT_KEPLER_GL_PROPS: {
@@ -260,7 +259,7 @@ export declare const DEFAULT_KEPLER_GL_PROPS: {
     readOnly: boolean;
     featureFlags: {};
 };
-declare type KeplerGLBasicProps = {
+type KeplerGLBasicProps = {
     mapboxApiAccessToken: string;
     mapboxApiUrl?: string;
     id: string;
@@ -303,8 +302,10 @@ declare type KeplerGLBasicProps = {
     transformRequest?: (url: string) => {
         url: string;
     };
+    /** Pass `false` to disable the remote RTL text plugin, or a URL string to self-host it. */
+    RTLTextPlugin?: string | false;
 };
-declare type KeplerGLProps = KeplerGlState & KeplerGlActions & KeplerGLBasicProps;
+type KeplerGLProps = KeplerGlState & KeplerGlActions & KeplerGLBasicProps;
 declare function KeplerGlFactory(BottomWidget: ReturnType<typeof BottomWidgetFactory>, GeoCoderPanel: ReturnType<typeof GeoCoderPanelFactory>, MapContainer: ReturnType<typeof MapContainerFactory>, MapsLayout: ReturnType<typeof MapsLayoutFactory>, ModalContainer: ReturnType<typeof ModalContainerFactory>, SidePanel: ReturnType<typeof SidePanelFactory>, PlotContainer: ReturnType<typeof PlotContainerFactory>, NotificationPanel: ReturnType<typeof NotificationPanelFactory>, DndContext: ReturnType<typeof DndContextFactory>): React.ComponentType<KeplerGLBasicProps & {
     selector: (...args: any[]) => KeplerGlState;
 }>;
@@ -323,47 +324,49 @@ export declare function mapStateToProps(state: KeplerGlState, props: KeplerGLPro
     uiStateActions: typeof UIStateActions;
     providerActions: typeof ProviderActions;
     mapboxApiAccessToken: string;
-    mapboxApiUrl?: string | undefined;
+    mapboxApiUrl?: string;
     id: string;
-    width?: number | undefined;
-    height?: number | undefined;
+    width?: number;
+    height?: number;
     appWebsite?: any;
-    onSaveMap?: (() => void) | undefined;
-    onViewStateChange?: ((viewState: Viewport) => void) | undefined;
-    onDeckInitialized?: (() => void) | undefined;
-    onKeplerGlInitialized?: (() => void) | undefined;
-    getMapboxRef?: (() => React.RefObject<any>) | undefined;
+    onSaveMap?: () => void;
+    onViewStateChange?: (viewState: Viewport) => void;
+    onDeckInitialized?: () => void;
+    onKeplerGlInitialized?: () => void;
+    getMapboxRef?: () => React.RefObject<any>;
     mapStyles?: {
         id: string;
-        style?: object | undefined;
-    }[] | undefined;
-    mapStylesReplaceDefault?: boolean | undefined;
-    appName?: string | undefined;
-    version?: string | undefined;
-    sidePanelWidth?: number | undefined;
-    theme?: object | undefined;
-    cloudProviders?: Provider[] | undefined;
-    deckGlProps?: object | undefined;
-    onLoadCloudMapSuccess?: OnSuccessCallBack | undefined;
-    onLoadCloudMapError?: OnErrorCallBack | undefined;
-    onMouseMove?: ((event: React.MouseEvent<Element, MouseEvent> & {
-        lngLat?: [number, number] | undefined;
-    }) => void) | undefined;
-    onExportToCloudSuccess?: OnSuccessCallBack | undefined;
-    onExportToCloudError?: OnErrorCallBack | undefined;
-    readOnly?: boolean | undefined;
-    featureFlags?: FeatureFlags | undefined;
+        style?: object;
+    }[];
+    mapStylesReplaceDefault?: boolean;
+    appName?: string;
+    version?: string;
+    sidePanelWidth?: number;
+    theme?: object;
+    cloudProviders?: Provider[];
+    deckGlProps?: object;
+    onLoadCloudMapSuccess?: OnSuccessCallBack;
+    onLoadCloudMapError?: OnErrorCallBack;
+    onMouseMove?: (event: React.MouseEvent & {
+        lngLat?: [number, number];
+    }) => void;
+    onExportToCloudSuccess?: OnSuccessCallBack;
+    onExportToCloudError?: OnErrorCallBack;
+    readOnly?: boolean;
+    featureFlags?: FeatureFlags;
     localeMessages?: {
         [key: string]: {
             [key: string]: string;
         };
-    } | undefined;
-    dispatch: React.Dispatch<any>;
-    topMapContainerProps?: object | undefined;
-    bottomMapContainerProps?: object | undefined;
-    transformRequest?: ((url: string) => {
+    };
+    dispatch: Dispatch<any>;
+    topMapContainerProps?: object;
+    bottomMapContainerProps?: object;
+    transformRequest?: (url: string) => {
         url: string;
-    }) | undefined;
+    };
+    /** Pass `false` to disable the remote RTL text plugin, or a URL string to self-host it. */
+    RTLTextPlugin?: string | false;
 };
 /** @type {() => import('reselect').OutputParametricSelector<any, any, any, any>} */
 export declare function makeGetActionCreators(): ((state: any, props: any) => {