api-reference

API Reference

Table of Contents

• Overview

• Ecosystem

  • Component
  • Reducer and Forward Dispatcher
  • Actions and Updaters
  • Processors and Schema Manager

• Get Started

• Advanced Usage

  • Using reducer plugin
  • Custom reducer initial state
  • Using updaters to modify kepler.gl state
  • Forward actions
  • Saving and loading maps with schema manager
  • Replace UI component
  • Custom Mapbox Host
  • Custom Map Style
  • Localization

• API

  • Components
  • Reducers
  • Actions and Updaters
  • Data Processor
  • Schemas

Overview

Kepler.gl is a Redux-connected component. You can embed kepler.gl in your App, which uses redux to manage its state. The basic implementation of kepler.gl reducer is simple. However, to make the most of it, it's recommended to have basic knowledge on:

• React
• Redux state container
• React Redux connect

To start out with kepler.gl, you simply need to add the Kepler.gl UI component and mount the Kepler.gl reducer. To give the user full access of all the functionalities of kepler.gl, this package also includes actions, schema managers and a set of utilities to load and save map data.