Kepler.gl is a powerful open source geospatial analysis tool for large-scale data sets.
Table of Contents
- visStateUpdaters
- addFilterUpdater
- addLayerUpdater
- addToDatasetUpdater
- applyCPUFilterUpdater
- enlargeFilterUpdater
- INITIAL_VIS_STATE
- interactionConfigChangeUpdater
- layerClickUpdater
- layerHoverUpdater
- layerTypeChangeUpdater
- layerVisConfigChangeUpdater
- layerVisualChannelChangeUpdater
- loadFilesErrUpdater
- loadFilesUpdater
- mapClickUpdater
- receiveMapConfigUpdater
- removeDatasetUpdater
- removeFromDatasetUpdater
- removeFilterUpdater
- removeLayerUpdater
- reorderLayerUpdater
- resetMapConfigUpdater
- setFilterPlotUpdater
- setFilterUpdater
- setMapInfoUpdater
- showDatasetTableUpdater
- toggleFilterAnimationUpdater
- toggleLayerForMapUpdater
- toggleSplitMapUpdater
- updateAnimationTimeUpdater
- updateFilterAnimationSpeedUpdater
- updateLayerAnimationSpeedUpdater
- updateLayerBlendingUpdater
- updateVisDataUpdater
visStateUpdaters
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 Reducer
const 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;
addFilterUpdater
Add a new filter
- Action:
addFilter
Parameters
stateObjectvisStateactionObject actionaction.dataIdstring datasetidthis new filter is associated with
Returns Object nextState
addLayerUpdater
Add a new layer
- Action:
addLayer
Parameters
Returns Object nextState
addToDatasetUpdater
Append or upsert rows on an existing in-memory row or Arrow dataset. Keeps layers and re-runs filters. DuckDB tables warn and are left unchanged (INSERT not implemented). Nested, binary, and geoarrow Arrow columns are rejected.
- Action:
addToDataset
Parameters
Returns Object nextState
applyCPUFilterUpdater
When select dataset for export, apply cpu filter to selected dataset
- Action:
applyCPUFilter
Parameters
Returns Object nextState
enlargeFilterUpdater
Show larger time filter at bottom for time playback (apply to time filter only)
- Action:
enlargeFilter
Parameters
Returns Object nextState
INITIAL_VIS_STATE
Default initial visState
Type: Object
Properties
layersArraylayerDataArraylayerToBeMergedArraylayerOrderArrayfiltersArrayfilterToBeMergedArraydatasetsArrayeditingDatasetstringinteractionConfigObjectinteractionToBeMergedObjectlayerBlendingstringhoverInfoObjectclickedObjectmousePosObjectsplitMapsArray a list of objects of layer availabilities and visibilities for each maplayerClassesObjectanimationConfigObjecteditorObject
interactionConfigChangeUpdater
Update interactionConfig
- Action:
interactionConfigChange
Parameters
stateObjectvisStateactionObject actionaction.configObject new config as key value map:{tooltip: {enabled: true}}
Returns Object nextState
layerClickUpdater
Trigger layer click event with clicked object
- Action:
onLayerClick
Parameters
Returns Object nextState
layerHoverUpdater
Trigger layer hover event with hovered object
- Action:
onLayerHover
Parameters
Returns Object nextState
layerTypeChangeUpdater
Update layer type. Previous layer config will be copied if applicable.
- Action:
layerTypeChange
Parameters
Returns Object nextState
layerVisConfigChangeUpdater
Update layer visConfig
- Action:
layerVisConfigChange
Parameters
Returns Object nextState
layerVisualChannelChangeUpdater
Update layer visual channel
- Action:
layerVisualChannelConfigChange
Parameters
Returns Object nextState
loadFilesErrUpdater
Trigger loading file error
- Action:
loadFilesErr
Parameters
Returns Object nextState
loadFilesUpdater
Trigger file loading dispatch addDataToMap if succeed, or loadFilesErr if failed
- Action:
loadFiles
Parameters
Returns Object nextState
mapClickUpdater
Trigger map click event, unselect clicked object
- Action:
onMapClick
Parameters
stateObjectvisState
Returns Object nextState
receiveMapConfigUpdater
Propagate visState reducer with a new configuration. Current config will be override.
- Action:
receiveMapConfig
Parameters
Returns Object nextState
removeDatasetUpdater
Remove a dataset and all layers, filters, tooltip configs that based on it
- Action:
removeDataset
Parameters
Returns Object nextState
removeFromDatasetUpdater
Delete rows by index or by field values from an existing in-memory row or Arrow dataset. Keeps layers. DuckDB tables warn and are left unchanged.
- Action:
removeFromDataset
Parameters
stateObjectvisStateactionObject actionaction.dataIdstring dataset idaction.rowIndexesrow indexes (optional)action.byField{field, values}matcher (optional)
Returns Object nextState
removeFilterUpdater
Remove a filter
- Action:
removeFilter
Parameters
Returns Object nextState
removeLayerUpdater
remove layer
- Action:
removeLayer
Parameters
Returns Object nextState
reorderLayerUpdater
Reorder layer
- Action:
reorderLayer
Parameters
Returns Object nextState
resetMapConfigUpdater
reset visState to initial State
- Action:
resetMapConfig
Parameters
stateObjectvisState
Returns Object nextState
setFilterPlotUpdater
Set the property of a filter plot
- Action:
setFilterPlot
Parameters
Returns Object nextState
setFilterUpdater
Update filter property
- Action:
setFilter
Parameters
stateObjectvisStateactionObject actiondatasetIdstring used when updating a prop (dataId, name) that can be linked to multiple datasets
Returns Object nextState
setMapInfoUpdater
User input to update the info of the map
- Action:
setMapInfo
Parameters
Returns Object nextState
showDatasetTableUpdater
Display dataset table in a modal
- Action:
showDatasetTable
Parameters
Returns Object nextState
toggleFilterAnimationUpdater
Start and end filter animation
- Action:
toggleFilterAnimation
Parameters
Returns Object nextState
toggleLayerForMapUpdater
Toggle visibility of a layer in a split map
- Action:
toggleLayerForMap
Parameters
Returns Object nextState
toggleSplitMapUpdater
Toggle visibility of a layer for a split map
- Action:
toggleSplitMap
Parameters
Returns Object nextState
updateAnimationTimeUpdater
Reset animation config current time to a specified value
- Action:
updateAnimationTime
Parameters
stateObjectvisStateactionObject actionaction.valueNumber the value current time will be set to
Returns Object nextState
updateFilterAnimationSpeedUpdater
Change filter animation speed
- Action:
updateFilterAnimationSpeed
Parameters
Returns Object nextState
updateLayerAnimationSpeedUpdater
Update animation speed with the vertical speed slider
- Action:
updateLayerAnimationSpeed
Parameters
Returns Object nextState
updateLayerBlendingUpdater
update layer blending mode
- Action:
updateLayerBlending
Parameters
stateObjectvisStateactionObject actionaction.modestring one ofadditive,normalandsubtractive
Returns Object nextState
updateVisDataUpdater
Add new dataset to visState, with option to load a map config along with the datasets
- Action:
updateVisData
Parameters
stateObjectvisStateactionObject actionaction.datasets(Array<Object> | Object) *required datasets can be a dataset or an array of datasets Each dataset object needs to haveinfoanddataproperty.action.optionsObject option object{centerMap: true, keepExistingConfig: false}action.configObject map config
Returns Object nextState