-
-
Notifications
You must be signed in to change notification settings - Fork 634
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: animated time encoding documentation and examples #9535
base: main
Are you sure you want to change the base?
Conversation
@@ -458,6 +458,13 @@ To provide themes for all scales, the scale config (`config: {scale: {...}}`) ca | |||
|
|||
{% include table.html props="invalid" source="ScaleConfig" %} | |||
|
|||
#### Animation | |||
|
|||
<!-- TODO(jzong): uncomment animationDuration when linear scales for animation are implemented --> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please reference an issue so we know when this work is done and keep track of what needs to be done here.
* | ||
* __Default value:__ `2` | ||
* | ||
*/ | ||
framesPerSecond?: number; | ||
|
||
/** | ||
* Default animation duration (in seconds) for time encodings, except for [`band`](https://vega.github.io/vega-lite/docs/scale.html#band) scales. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this is not supported yet, we should not expose this in the spec. You can use @hidden if you still need it in the types.
- must also explicility specify a selection parameter | ||
- parameter must have a `timer` event | ||
- parameter must select the same field as the `time` field definition | ||
- must explicitliy define a filter using that parameter |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- must explicitliy define a filter using that parameter | |
- must explicitly define a filter using that parameter |
Yeah, don't put manual ones in. I suspect something doesn't get cleared. |
I'm seeing warnings for |
This PR contains documentation for animation features added in #8921.
time
encoding channel,animationDuration
andframesPerSecond
scale config (updates schema)time
channel toencoding.md
documentation.time
channelscale.md
under newAnimation
subhead inConfiguration
sectionAnimated
header (afterInteractive
)A problem before I ask for a review: the automatic
vg2png
thumbnail generation doesn't currently work with animated specs (it'll generate an image with without filtering, i.e. all the frames show at once). I imagine this is probably because the animated specs are getting run through an older version of the compiler before we added animation. I'd appreciate some guidance on what I need to do to fix this. We can't push the docs until then because presumably running the script will over-write the pngs with incorrect ones even if we put correct ones in manually.