Cloud providers
The kepler.gl application does not have a backend, however it offers integration point for optional commercial backends. Each backend can integrate with kepler by adding a "cloud provider" object to kepler's global list of cloud providers.
These objects must implement certain minimal set of methods, and can optionally immplement others, depending on the capability of the backend.
The set of methods available for cloud providers to implement is subject to change as new features are added to the front-end.
Cloud Provider Object
A "cloud provider" object provides:
a name and an icon
any service specific methods (such as
uploadFile
)a set of oauth2 methods to plug into the authentication flow and get access tokens
Cloud-providers providers can implement the following properties
Field/method | Description | Required? |
---|---|---|
| Name of the provider | required |
| Display name | |
| React Element to render as Icon | |
| Size of the thumbnail image of the map that required by the provider | |
| To participate in kepler's build-in private map saving function | required |
| To participate in kepler's build-in share map via URL function | required |
| To show user the shared Url of the map | |
| To update browser location once a map has been saved / loaded | |
| To participate in kepler's built-in oauth login routes | |
| To display user name of the logged in user | |
| Method called to perform user login | required |
| Method called to logout an user | required |
| Method called to upload map to storage | required |
| Method called to load a catalog of maps saved by the current user | required |
| MEthod called to download a specific map | required |
Adding a new Cloud Provider
An instance of the provider is added to array of cloud providers in the file src/cloud-providers/providers.js
then passed to kepler.gl demo app. An example provider: Dropbox Provider
Cloud Provider Instance Fields and Methods
Last updated