reducers

Search…
reducers
Table of Contents
​keplerGlReducer​
​keplerGlReducer.initialState​
​keplerGlReducer.plugin​
​mapStateLens​
​mapStyleLens​
​providerStateLens​
​uiStateLens​
​visStateLens​
keplerGlReducer
Kepler.gl reducer to be mounted to your store. You can mount keplerGlReducer at property keplerGl, if you choose to mount it at another address e.g. foo you will need to specify it when you mount KeplerGl component in your app with getState: state => state.foo
Examples
1
import keplerGlReducer from 'kepler.gl/reducers';
2
import {createStore, combineReducers, applyMiddleware, compose} from 'redux';
3
import {taskMiddleware} from 'react-palm/tasks';
4
​
5
const initialState = {};
6
const reducers = combineReducers({
7
  // <-- mount kepler.gl reducer in your app
8
  keplerGl: keplerGlReducer,
9
​
10
  // Your other reducers here
11
  app: appReducer
12
});
13
​
14
// using createStore
15
export default createStore(reducer, initialState, applyMiddleware(taskMiddleware));
Copied!
keplerGlReducer.initialState
Return a reducer that initiated with custom initial state. The parameter should be an object mapping from subreducer name to custom subreducer state, which will be shallow merged with default initial state.
Default subreducer state:
​visState​
​mapState​
​mapStyle​
​uiState​
Parameters
iniSt Object custom state to be merged with default initial state
Examples
1
const myKeplerGlReducer = keplerGlReducer
2
 .initialState({
3
   uiState: {readOnly: true}
4
 });
Copied!
keplerGlReducer.plugin
Returns a kepler.gl reducer that will also pass each action through additional reducers spiecified. The parameter should be either a reducer map or a reducer function. The state passed into the additional action handler is the instance state. It will include all the subreducers visState, uiState, mapState and mapStyle. .plugin is only meant to be called once when mounting the keplerGlReducer to the store. Note This is an advanced option to give you more freedom to modify the internal state of the kepler.gl instance. You should only use this to adding additional actions instead of replacing default actions.
Parameters
customReducer (Object | Function) A reducer map or a reducer
Examples
1
const myKeplerGlReducer = keplerGlReducer
2
 .plugin({
3
   // 1. as reducer map
4
   HIDE_AND_SHOW_SIDE_PANEL: (state, action) => ({
5
     ...state,
6
     uiState: {
7
       ...state.uiState,
8
       readOnly: !state.uiState.readOnly
9
     }
10
   })
11
 })
12
.plugin(handleActions({
13
  // 2. as reducer
14
  'HIDE_MAP_CONTROLS': (state, action) => ({
15
    ...state,
16
    uiState: {
17
      ...state.uiState,
18
      mapControls: hiddenMapControl
19
    }
20
  })
21
}, {}));
Copied!
mapStateLens
Connect subreducer mapState, used with injectComponents. Learn more at Replace UI Component​
Parameters
reduxState any 
mapStyleLens
Connect subreducer mapStyle, used with injectComponents. Learn more at Replace UI Component​
Parameters
reduxState any 
providerStateLens
Connect subreducer providerState, used with injectComponents. Learn more at Replace UI Component​
Parameters
reduxState any 
uiStateLens
Connect subreducer uiState, used with injectComponents. Learn more at Replace UI Component​
Parameters
reduxState any 
visStateLens
Connect subreducer visState, used with injectComponents. Learn more at Replace UI Component​
Parameters
reduxState any 
Reducers
map-style
Last modified 1yr ago
Copy link
Contents
Table of Contents
keplerGlReducer
keplerGlReducer.initialState
keplerGlReducer.plugin