Skip to content

Commit

Permalink
Release 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
chartjs-ci committed Jan 11, 2018
1 parent 62d697b commit bb46a30
Show file tree
Hide file tree
Showing 3 changed files with 213 additions and 0 deletions.
8 changes: 8 additions & 0 deletions bower.json
@@ -0,0 +1,8 @@
{
"name": "chartjs-plugin-deferred",
"description": "Chart.js plugin to defer initial chart updates",
"homepage": "https://chartjs-plugin-deferred.netlify.com",
"license": "MIT",
"version": "1.0.0",
"main": "distchartjs-plugin-deferred.js"
}
194 changes: 194 additions & 0 deletions dist/chartjs-plugin-deferred.js
@@ -0,0 +1,194 @@
/*
* @license
* chartjs-plugin-deferred
* http://chartjs.org/
* Version: 1.0.0
*
* Copyright 2018 Simon Brunel
* Released under the MIT license
* https://github.com/chartjs/chartjs-plugin-deferred/blob/master/LICENSE.md
*/
(function (global, factory) {
typeof exports === 'object' && typeof module !== 'undefined' ? factory(require('chart.js')) :
typeof define === 'function' && define.amd ? define(['chart.js'], factory) :
(factory(global.Chart));
}(this, (function (Chart) { 'use strict';

Chart = Chart && Chart.hasOwnProperty('default') ? Chart['default'] : Chart;

'use strict';

var helpers = Chart.helpers;
var STUB_KEY = '$chartjs_deferred';
var MODEL_KEY = '$deferred';

/**
* Plugin based on discussion from Chart.js issue #2745.
* @see https://github.com/chartjs/Chart.js/issues/2745
*/
Chart.defaults.global.plugins.deferred = {
xOffset: 0,
yOffset: 0,
delay: 0
};

function defer(fn, delay) {
if (delay) {
window.setTimeout(fn, delay);
} else {
helpers.requestAnimFrame.call(window, fn);
}
}

function computeOffset(value, base) {
var number = parseInt(value, 10);
if (isNaN(number)) {
return 0;
} else if (typeof value === 'string' && value.indexOf('%') !== -1) {
return number / 100 * base;
}
return number;
}

function chartInViewport(chart) {
var options = chart[MODEL_KEY].options;
var canvas = chart.chart.canvas;

// http://stackoverflow.com/a/21696585
if (!canvas || canvas.offsetParent === null) {
return false;
}

var rect = canvas.getBoundingClientRect();
var dy = computeOffset(options.yOffset || 0, rect.height);
var dx = computeOffset(options.xOffset || 0, rect.width);

return rect.right - dx >= 0
&& rect.bottom - dy >= 0
&& rect.left + dx <= window.innerWidth
&& rect.top + dy <= window.innerHeight;
}

function onScroll(event) {
var node = event.target;
var stub = node[STUB_KEY];
if (stub.ticking) {
return;
}

stub.ticking = true;
defer(function() {
var charts = stub.charts.slice();
var ilen = charts.length;
var chart, i;

for (i = 0; i < ilen; ++i) {
chart = charts[i];
if (chartInViewport(chart)) {
unwatch(chart); // eslint-disable-line
chart[MODEL_KEY].appeared = true;
chart.update();
}
}

stub.ticking = false;
});
}

function isScrollable(node) {
var type = node.nodeType;
if (type === Node.ELEMENT_NODE) {
var overflowX = helpers.getStyle(node, 'overflow-x');
var overflowY = helpers.getStyle(node, 'overflow-y');
return overflowX === 'auto' || overflowX === 'scroll'
|| overflowY === 'auto' || overflowY === 'scroll';
}

return node.nodeType === Node.DOCUMENT_NODE;
}

function watch(chart) {
var canvas = chart.chart.canvas;
var parent = canvas.parentElement;
var stub, charts;

while (parent) {
if (isScrollable(parent)) {
stub = parent[STUB_KEY] || (parent[STUB_KEY] = {});
charts = stub.charts || (stub.charts = []);
if (charts.length === 0) {
parent.addEventListener('scroll', onScroll, {passive: true});
}

charts.push(chart);
chart[MODEL_KEY].elements.push(parent);
}

parent = parent.parentElement || parent.ownerDocument;
}
}

function unwatch(chart) {
chart[MODEL_KEY].elements.forEach(function(element) {
var charts = element[STUB_KEY].charts;
charts.splice(charts.indexOf(chart), 1);
if (!charts.length) {
helpers.removeEvent(element, 'scroll', onScroll);
delete element[STUB_KEY];
}
});

chart[MODEL_KEY].elements = [];
}

Chart.plugins.register({
id: 'deferred',

beforeInit: function(chart, options) {
chart[MODEL_KEY] = {
options: options,
appeared: false,
delayed: false,
loaded: false,
elements: []
};

watch(chart);
},

beforeDatasetsUpdate: function(chart, options) {
var model = chart[MODEL_KEY];
if (!model.loaded) {
if (!model.appeared && !chartInViewport(chart)) {
// cancel the datasets update
return false;
}

model.appeared = true;
model.loaded = true;
unwatch(chart);

if (options.delay > 0) {
model.delayed = true;
defer(function() {
model.delayed = false;
chart.update();
}, options.delay);

return false;
}
}

if (model.delayed) {
// in case of delayed update, ensure to block external requests, such
// as interacting with the legend label, or direct calls to update()
return false;
}
},

destroy: function(chart) {
unwatch(chart);
}
});

})));
11 changes: 11 additions & 0 deletions dist/chartjs-plugin-deferred.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit bb46a30

Please sign in to comment.