docs: Describe chart preview via API + expose DebugPanel via flag #1206
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
bprusinowski
force-pushed
the
docs/update-chart-config-docs
branch
from
3391e0f to
ae54d56
Compare
Rdataflow
reviewed
Oct 6, 2023
bprusinowski
force-pushed
the
docs/update-chart-config-docs
branch
from
ae54d56 to
5de620a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Closes #1200.
As the types can differ a lot between different chart types, and there are some hidden dependencies to some properties (e.g. multi filter connected to temporal X field, some sorting options only available for column charts, segmentation not available for maps, etc, etc), I decided to point to the file with types in the docs and expose the configurator & interactive filters debug panel via flag.
By doing this, editors will be able to edit a chart, tailor it to their needs, and dump the state to the console to copy and modify it slightly to fit their needs. With this we don't need to prepare a complete list of all combination possibilities between the types, which would be really difficult, but rather encourage to pre-create a chart and edit it afterwards, making sure that all necessary side effects have been applied.