chartjs / chartjs/Chart.js

Progressive line sample does not seem to match documentation and fails type check

Open
#10,369 2 comments 5 reactions 0 assignees View on GitHub
type: documentation type: types
Dominant language
JavaScript
Stars
67.7k
Forks
11.9k
Avg merge
7h 39m
Merged PRs (30d)
5

Description

### Documentation Is:

- [ ] Missing or needed?
- [X] Confusing
- [ ] Not sure?

### Please Explain in Detail...

The progressive line sample (https://www.chartjs.org/docs/latest/samples/animations/progressive-line.html) seem to run, but the code itself does not match the API described by the documentation on https://www.chartjs.org/docs/latest/configuration/animations.html#animation, and TS fails the type check.

### Your Proposal for Changes

If it is possible to configure each individual property separately then the type for `animation` should probably be something along the lines of `Record>` instead

### Example

https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAbzgYQBYENYBo4EEB2o6MwE+AymAKYDGcAvnAGZQQhwDkNGsAdAFYBnDgG4AsAChJAN0xwaMAB5wAvHAAmEGgFcQVfDF4BzKjACiAGyp6DAIQCeASXUAKAEQh7aTDDcBKOHRBOAAJABUAWQAZZHR8WUFLa30YcSkJGjJBeHVidFU4AG0AXTTM-GyNPIAmApK0q3gwKCppAoBGAAZOhtM4ZtbatQAOHskmaDgXRrhgAp7ZuAAeOC7ukVmAak2AhEk4fpa2zbUAVjgAWjgI4lReKDjNEBcAgCpVsYkD3Jh0XjBtIJUC4EIoAFyzHD2CEDaT0PxpA6w2onODnK43GB3B74J4vODvLqIqq-ar-QHA0EQ4BQmFHarwtL0SSScqVGAQX4WAAi2geJDIHW661ZWRyVAs6HstlMAHcqPoAAoQYAGYJqDlc3n80j4OAAehJfys+CMWLKYsOrVIgIAmgUXApFAEVAA+eRKXiq9RUZQqf1wTpwAD8HsUvG4Pl4gho6Csgl49mMpkVwEUEoAYtAAGpx7RUFxrAIQp0RniGEwwbl5QSmCKmdCOz0-IKmRy431+Xgtwql72+y6rYrJmCK1hgQQuQocewcYo4GBQfNd+wWirwOJEAX4CEELe6yi0JYcCyqqgcd1qPZfODgxD7A5wGD2agQjj4XQAIyoUA4WAfBxUEEqpGG+p74EBv7-je3x8sQuoQj6krSnKCr4MqqowII0GPswrAgBCABy6CETg+qGliVD9CqBizMEqrACQcYWPYcCCAA1sAYDUOoAEaBKUpNs694wY+wBMFMpbPtQcAAIQBhwLYcHAAA+KlhrwijkL8sBUOoux8bhLQwHyeqfLhBzMqJByllpOkwHpBSLvmxJGaYpkaf2yjvEhUoyjA8pKjRWGuQwD70DhcDQiJuHSVQb4fiA35QXxQGCCBYFnpgf58eocHbohAkoQFaEYWqkUHCwbB0taEB2hV-HIUJBnWbMElCbwcVyQpSmqeppb2NpPh6S1FmPsZHnmRZVljQNQ26eoTlLlQoUHBNUB6n2HbeY1fmoUFmGCKFM1hRI9BpDIcieN4sAFBBsooOWQk4NesUvvFnDgeeDUthCr1jXAkrfhYggQoUbgAEp6W4OBuLYFj5jDcBuLaEoWBAspI24ADiLT6Fjip8mAVhYwA8jiJhuPOhmPi2tZYWD-0A4+QMSm+ADEcAQBJ2aclQwgNczv1FO01Q4O0ACcOAAMw4KcOBi3A0vU61lnFHxEV8RAYDbqDMUWZuIDwWQgtsbG8Z-TTBx3kzANWwwpsHNFttjfbJ24e7p2MkAA

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.