keplergl / keplergl/kepler.gl

[docs] document the schema of key concepts such as "filter"

Open
#673 0 comments 0 reactions 1 assignee Claimed by @heshan0131 View on GitHub
Dominant language
TypeScript
Stars
12k
Forks
2k
Avg merge
1d 5h
Merged PRs (30d)
66

Description

The `setFilterUpdater` here https://github.com/keplergl/kepler.gl/blob/master/docs/api-reference/reducers/vis-state.md#setfilterupdater says:
```
- `action` **[Object][63]** action
- `action.idx` **[Number][67]** `idx` of filter to be updated
- `action.prop` **[string][64]** `prop` of filter, e,g, `dataId`, `name`, `value`
```
However the schema of "filter" is found in this documentation. Since filter is a common concept, would be nice to document it.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.