combine.md

Table of Contents

• combinedUpdaters
  • addDataToMapUpdater

combinedUpdaters

Some actions will affect the entire kepler.lg instance state. The updaters for these actions is exported as combinedUpdaters. These updater take the entire instance state as the first argument. Read more about Using updaters

Examples

import keplerGlReducer, {combinedUpdaters} from 'kepler.gl/reducers';
// Root Reducer
const reducers = combineReducers({
 keplerGl: keplerGlReducer,
 app: appReducer
});

const composedReducer = (state, action) => {
 switch (action.type) {
   // add data to map after receiving data from remote sources
   case 'LOAD_REMOTE_RESOURCE_SUCCESS':
     return {
       ...state,
       keplerGl: {
         ...state.keplerGl,
         // pass in kepler.gl instance state to combinedUpdaters
         map:  combinedUpdaters.addDataToMapUpdater(
          state.keplerGl.map,
          {
            payload: {
              datasets: action.datasets,
              options: {readOnly: true},
              config: action.config
             }
           }
         )
       }
     };
 }
 return reducers(state, action);
};

export default composedReducer;

addDataToMapUpdater

Combine data and full configuration update in a single action

• Action: addDataToMap

Parameters

• state Object kepler.gl instance state, containing all subreducer state
• action Object
  • action.payload Object {datasets, options, config}
    • action.payload.datasets (Array<Object> | Object) *required datasets can be a dataset or an array of datasets Each dataset object needs to have info and data property.
      • action.payload.datasets.info Object -info of a dataset
        • action.payload.datasets.info.id string id of this dataset. If config is defined, id should matches the dataId in config.
        • action.payload.datasets.info.label string A display name of this dataset
      • action.payload.datasets.data Object *required The data object, in a tabular format with 2 properties fields and rows
        • action.payload.datasets.data.fields Array<Object> *required Array of fields,
          • action.payload.datasets.data.fields.name string *required Name of the field,
        • action.payload.datasets.data.rows Array<Array> *required Array of rows, in a tabular format with fields and rows
    • action.payload.options Object option object {centerMap: true}
    • action.payload.config Object map config

Returns Object nextState