added allowZoom pre-condition to filter out unnecessary zoom events #329
Conversation
This file contains hidden or 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
…gnature of `(chart: Chart, scale: ChartElement, originalOptions: ScalesOptions, changes: ScalesOptionsPendingChanges) => boolean` option as zooming pre-condition evaluator.
benmccann
changed the title
benmccann
reviewed
Mar 23, 2020
| * @param {Scale} scale - Scale/Axis being zoomed (x/y, method will be called for each axis) | ||
| * @param {ChartOptions} options - Original chart options before any zoom values applied. | ||
| * @param {PendingScaleChanges} changes - Changes that will be applied to chart options if method returns true. | ||
| allowZoom: function(chart, scale, options, changes) { |
There was a problem hiding this comment.
Most Chart.js options that take functions have those functions take a single object argument. Can you make these parameters properties on an object that is passed to the function instead?
benmccann
reviewed
Mar 23, 2020
| * @property {MinMaxValue} time - new options.time values (may be undefined) | ||
| */ | ||
| /** | ||
| * This function may be used to filter unnessecary zoom events. Returns true to allow zooming, false to prevent. |
|
Great adjustment, much in need of it. When do you expect this to be available in the official plugin? |
|
@nullifiedtsk this PR needs to be rebased |
benmccann
changed the title
|
Closing in favor of #487 |
|
Can we have this fix for version 0.7.7? Some users can't upgrade to later versions (IE issues) |
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.
Extended zoom plugin options with parameter
options.plugins.zoom.allowZoom. It is function with signature ofMay be used to prevent unnecessary zooming operations (e.g. chart is zoomed too near).
If function is defined and returns false, chart scale options will be restored as before calculating new time/ticks value (before calling chart.update).
p.s. Added example of usage to README