id
argumentmapStyle
reducer. They manage the display of base map, such as loading and receiving base map styles, hiding and showing map layers, user input of custom map style url.inputStyle
in the mapStyle
reducer. param {void}error
anyvisibleLayerGroups
to change layer group visibilitymapStyle.mapStyles
data
object required in dataset. You rarely need to manually format the data obejct.KeplerGlSchema.getConfigToSave
to generate a json blob of the currents instance config. The config object value will always have higher precedence than the options properties.dataId
in the config to match with loaded dataset. If you pass a config object, you need to match the info.id
of your dataset to the dataId
in each layer
, filter
and interactionConfig.tooltips.fieldsToShow
info
and data
property.data.datasets.data
Object *required The data object, in a tabular format with 2 properties fields
and rows
options.centerMap
will override config.mapState
if passed in.data.options.keepExistingConfig
boolean whether to keep exiting map data and associated layer filter interaction config default: false
.data.config
Object this object will contain the full kepler.gl instance configuration {mapState, mapStyle, visState}mapboxApiAccessToken
to mapStyle
reducer.KeplerGlSchema.parseSavedConfig
to convert saved config before passing it in is required.receiveMapConfig
before passing in any data. The reducer will store layer and filter config, waiting for data to come in. When data arrives, you can call addDataToMap
without passing any config, and the reducer will try to match preloaded configs. This behavior is designed to allow asynchronous data loading.receiveMapConfig
needs to be called before data is loaded. Currently kepler.gl doesn't allow calling receiveMapConfig
after data is loaded. It will reset current configuration first then apply config to it.options.keepExistingConfig
boolean whether to keep exiting layer filter and interaction config default: false
.visState
reducer. They manage how data is processed, filtered and displayed on the map by operates on layers, filters and interaction settings.interactionConfig
value
any new valuevisConfig
addDataToMap
if succeed, or loadFilesErr
if failederror
anyvisState.filters
, once a filter is removed, data will be re-filtered and layer will be updatedvalue
any new valueinfo