kepler.gl/src/actions/dist/identity-actions.d.ts

kepler.gl is a webgl based application to visualize large scale location data in the browser

import { default as ActionTypes } from './action-types';
import { UiState } from '@kepler.gl/types';
export declare type RegisterEntryUpdaterAction = {
    payload: {
        id: string;
        mint?: boolean;
        mapboxApiAccessToken?: string;
        mapboxApiUrl?: string;
        mapStylesReplaceDefault?: boolean;
        initialUiState?: Partial<UiState>;
    };
};
export declare type RenameEntryUpdaterAction = {
    payload: {
        oldId: string;
        newId: string;
    };
};
/**
 *
 * Add a new kepler.gl instance in `keplerGlReducer`. This action is called under-the-hood when a `KeplerGl` component is **mounted** to the dom.
 * Note that if you dispatch actions such as adding data to a kepler.gl instance before the React component is mounted, the action will not be
 * performed. Instance reducer can only handle actions when it is instantiated.
 * @memberof rootActions
 * @param payload
 * @param payload.id - ***required** The id of the instance
 * @param payload.mint - Whether to use a fresh empty state, when `mint: true` it will *always* load a fresh state when the component is re-mounted.
 * When `mint: false` it will register with existing instance state under the same `id`, when the component is unmounted then mounted again. Default: `true`
 * @param payload.mapboxApiAccessToken - mapboxApiAccessToken to be saved in `map-style` reducer.
 * @param payload.mapboxApiUrl - mapboxApiUrl to be saved in `map-style` reducer.
 * @param payload.mapStylesReplaceDefault - mapStylesReplaceDefault to be saved in `map-style` reducer.
 * @param payload.initialUiState - initial ui state
 * @public
 */
export declare const registerEntry: (entry: RegisterEntryUpdaterAction['payload']) => {
    type: typeof ActionTypes.REGISTER_ENTRY;
    payload: RegisterEntryUpdaterAction['payload'];
};
/**
 *
 * Delete an instance from `keplerGlReducer`. This action is called under-the-hood when a `KeplerGl` component is **un-mounted** to the dom.
 * If `mint` is set to be `true` in the component prop, the instance state will be deleted from the root reducer. Otherwise, the root reducer will keep
 * the instance state and later transfer it to a newly mounted component with the same `id`
 * @memberof rootActions
 * @param {string} id - the id of the instance to be deleted
 * @public
 */
export declare const deleteEntry: (id: string) => {
    type: typeof ActionTypes.DELETE_ENTRY;
    payload: {
        id: string;
    };
};
/**
 *
 * Rename an instance in the root reducer, keep its entire state
 *
 * @memberof rootActions
 * @param {string} oldId - ***required** old id
 * @param {string} newId - ***required** new id
 * @public
 */
export declare const renameEntry: (oldId: string, newId: string) => {
    type: typeof ActionTypes.RENAME_ENTRY;
    payload: RenameEntryUpdaterAction['payload'];
};