Skip to content
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

Support configurable update #4362

Merged
merged 6 commits into from Jun 11, 2017
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/developers/api.md
Expand Up @@ -17,7 +17,7 @@ This must be called before the canvas is reused for a new chart.
myLineChart.destroy();
```

## .update(duration, lazy)
## .update(config)

Triggers an update of the chart. This can be safely called after updating the data object. This will update all scales, legends, and then re-render the chart.

Expand All @@ -30,6 +30,23 @@ myLineChart.update(); // Calling update now animates the position of March from

> **Note:** replacing the data reference (e.g. `myLineChart.data = {datasets: [...]}` only works starting **version 2.6**. Prior that, replacing the entire data object could be achieved with the following workaround: `myLineChart.config.data = {datasets: [...]}`.

A `config` object can be provided with additional configuration for the update process. This is useful when `update` is manually called inside an event handler and some different animation is desired.

The following properties are supported:
* **duration** (number): Time for the animation of the redraw in milliseconds
* **lazy** (boolean): If true, the animation can be interrupted by other animations
* **easing** (string): The animation easing function. See [Animation Easing](../configuration/animations.md) for possible values.

Example:
```javascript
myChart.update({
duration: 800,
easing: 'easeOutBounce'
})
```

> **Note:** `.update(duration, lazy)` is still supported in backwards compatibility mode.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not write about it: it still works but people should not know about it.


See [Updating Charts](updates.md) for more details.

## .reset()
Expand Down
34 changes: 27 additions & 7 deletions src/core/core.controller.js
Expand Up @@ -334,9 +334,17 @@ module.exports = function(Chart) {
this.tooltip.initialize();
},

update: function(animationDuration, lazy) {
update: function(config) {
var me = this;

if (!config || typeof config !== 'object') {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have a test, if possible, that verifies that backwards compatibility isn't broken.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can try that. Is there any other place other than core.controller.tests.js? Because that isn't testing _bufferedRender, nor render at the moment.

// backwards compatibility
config = {
duration: config,
lazy: arguments[1]
};
}

updateConfig(me);

if (plugins.notify(me, 'beforeUpdate') === false) {
Expand Down Expand Up @@ -368,11 +376,12 @@ module.exports = function(Chart) {

if (me._bufferedRender) {
me._bufferedRequest = {
lazy: lazy,
duration: animationDuration
duration: config.duration,
easing: config.easing,
lazy: config.lazy
};
} else {
me.render(animationDuration, lazy);
me.render(config);
}
},

Expand Down Expand Up @@ -442,9 +451,20 @@ module.exports = function(Chart) {
plugins.notify(me, 'afterDatasetUpdate', [args]);
},

render: function(duration, lazy) {
render: function(config) {
var me = this;

if (!config || typeof config !== 'object') {
// backwards compatibility
config = {
duration: config,
lazy: arguments[1]
};
}

var duration = config.duration;
var lazy = config.lazy;

if (plugins.notify(me, 'beforeRender') === false) {
return;
}
Expand All @@ -458,7 +478,7 @@ module.exports = function(Chart) {
if (animationOptions && ((typeof duration !== 'undefined' && duration !== 0) || (typeof duration === 'undefined' && animationOptions.duration !== 0))) {
var animation = new Chart.Animation({
numSteps: (duration || animationOptions.duration) / 16.66, // 60 fps
easing: animationOptions.easing,
easing: config.easing || animationOptions.easing,

render: function(chart, animationObject) {
var easingFunction = helpers.easingEffects[animationObject.easing];
Expand Down Expand Up @@ -771,7 +791,7 @@ module.exports = function(Chart) {
var bufferedRequest = me._bufferedRequest;
if (bufferedRequest) {
// If we have an update that was triggered, we need to do a normal render
me.render(bufferedRequest.duration, bufferedRequest.lazy);
me.render(bufferedRequest);
} else if (changed && !me.animating) {
// If entering, leaving, or changing elements, animate the change via pivot
me.stop();
Expand Down