​visStateUpdaters​
​addFilterUpdater​
​addLayerUpdater​
​applyCPUFilterUpdater​
​enlargeFilterUpdater​
​INITIAL_VIS_STATE​
​layerClickUpdater​
​layerHoverUpdater​
​layerTypeChangeUpdater​
​loadFilesErrUpdater​
​loadFilesUpdater​
​mapClickUpdater​
​receiveMapConfigUpdater​
​removeDatasetUpdater​
​removeFilterUpdater​
​removeLayerUpdater​
​reorderLayerUpdater​
​resetMapConfigUpdater​
​setFilterPlotUpdater​
​setFilterUpdater​
​setMapInfoUpdater​
​showDatasetTableUpdater​
​toggleLayerForMapUpdater​
​toggleSplitMapUpdater​
​updateVisDataUpdater​
Updaters for visState
reducer. Can be used in your root reducer to directly modify kepler.gl's state. Read more about Using updaters​
Examples
import keplerGlReducer, {visStateUpdaters} from 'kepler.gl/reducers';// Root Reducerconst reducers = combineReducers({keplerGl: keplerGlReducer,app: appReducer});​const composedReducer = (state, action) => {switch (action.type) {case 'CLICK_BUTTON':return {...state,keplerGl: {...state.keplerGl,foo: {...state.keplerGl.foo,visState: visStateUpdaters.enlargeFilterUpdater(state.keplerGl.foo.visState,{idx: 0})}}};}return reducers(state, action);};​export default composedReducer;
Add a new filter
Action: addFilter
​
Parameters
state
Object visState
Returns Object nextState
Add a new layer
Action: addLayer
​
Parameters
state
Object visState
Returns Object nextState
When select dataset for export, apply cpu filter to selected dataset
Action: applyCPUFilter
​
Parameters
state
Object visState
Returns Object nextState
Show larger time filter at bottom for time playback (apply to time filter only)
Action: enlargeFilter
​
Parameters
state
Object visState
Returns Object nextState
Default initial visState
Type: Object​
layers
Array
layerData
Array
layerToBeMerged
Array
layerOrder
Array
filters
Array
filterToBeMerged
Array
datasets
Array
editingDataset
string
interactionConfig
Object
interactionToBeMerged
Object
layerBlending
string
hoverInfo
Object
clicked
Object
mousePos
Object
splitMaps
Array a list of objects of layer availabilities and visibilities for each map
layerClasses
Object
animationConfig
Object
editor
Object
Update interactionConfig
Action: interactionConfigChange
​
Parameters
state
Object visState
Returns Object nextState
Trigger layer click event with clicked object
Action: onLayerClick
​
Parameters
state
Object visState
Returns Object nextState
Trigger layer hover event with hovered object
Action: onLayerHover
​
Parameters
state
Object visState
Returns Object nextState
Update layer type. Previews layer config will be copied if applicable.
Action: layerTypeChange
​
Parameters
state
Object visState
Returns Object nextState
Update layer visConfig
Action: layerVisConfigChange
​
Parameters
state
Object visState
Returns Object nextState
Update layer visual channel
Action: layerVisualChannelConfigChange
​
Parameters
state
Object visState
Returns Object nextState
Trigger loading file error
Action: loadFilesErr
​
Parameters
Returns Object nextState
Trigger file loading dispatch addDataToMap
if succeed, or loadFilesErr
if failed
Action: loadFiles
​
Parameters
state
Object visState
Returns Object nextState
Trigger map click event, unselect clicked object
Action: onMapClick
​
Parameters
state
Object visState
Returns Object nextState
Propagate visState
reducer with a new configuration. Current config will be override.
Action: receiveMapConfig
​
Parameters
state
Object visState
Returns Object nextState
Remove a dataset and all layers, filters, tooltip configs that based on it
Action: removeDataset
​
Parameters
state
Object visState
Returns Object nextState
Remove a filter
Action: removeFilter
​
Parameters
state
Object visState
Returns Object nextState
remove layer
Action: removeLayer
​
Parameters
state
Object visState
Returns Object nextState
Reorder layer
Action: reorderLayer
​
Parameters
state
Object visState
Returns Object nextState
reset visState to initial State
Action: resetMapConfig
​
Parameters
state
Object visState
Returns Object nextState
Set the property of a filter plot
Action: setFilterPlot
​
Parameters
state
Object visState
Returns Object nextState
Update filter property
Action: setFilter
​
Parameters
state
Object visState
datasetId
string used when updating a prop (dataId, name) that can be linked to multiple datasets
Returns Object nextState
User input to update the info of the map
Action: setMapInfo
​
Parameters
state
Object visState
Returns Object nextState
Display dataset table in a modal
Action: showDatasetTable
​
Parameters
state
Object visState
Returns Object nextState
Start and end filter animation
Action: toggleFilterAnimation
​
Parameters
state
Object visState
Returns Object nextState
Toggle visibility of a layer in a split map
Action: toggleLayerForMap
​
Parameters
state
Object
Returns Object nextState
Toggle visibility of a layer for a split map
Action: toggleSplitMap
​
Parameters
state
Object visState
Returns Object nextState
Reset animation config current time to a specified value
Action: updateAnimationTime
​
Parameters
state
Object visState
Returns Object nextState
Change filter animation speed
Action: updateFilterAnimationSpeed
​
Parameters
state
Object visState
Returns Object nextState
Update animation speed with the vertical speed slider
Action: updateLayerAnimationSpeed
​
Parameters
state
Object visState
Returns Object nextState
update layer blending mode
Action: updateLayerBlending
​
Parameters
state
Object visState
Returns Object nextState
Add new dataset to visState
, with option to load a map config along with the datasets
Action: updateVisData
​
Parameters
state
Object visState
action
Object action
Returns Object nextState