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.

Sign up for GitHub

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

Jump to bottom

fix: series fill & stroke being inconsistent for last data time < render time #138

Merged
merged 16 commits into from Dec 7, 2021
Merged

fix: series fill & stroke being inconsistent for last data time < render time #138

Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
a6d7bc2
fix: a memory leak appearing when some `timeSeries.disabled === true`
WofWca Sep 7, 2021
85cb245
docs: update changelog
WofWca Sep 7, 2021
f7d2f9e
perf: improve `render()` performance a bit
WofWca Sep 24, 2021
73c3877
perf: improve `render()` performance a bit
WofWca Sep 24, 2021
9d606d8
perf: improve `.append()` performance a bit
WofWca Sep 28, 2021
6ae1d1c
perf: improve `render()` performance a bit
WofWca Oct 6, 2021
42b26b1
perf: labels: use a variable for a commonly accessed property
WofWca Oct 6, 2021
13bfabd
perf: improve `render` performance for `TimeSeries` with no stroke
WofWca Oct 6, 2021
f7b488e
perf: remove unnecessary `context.save()`& `context.restore()`
WofWca Oct 6, 2021
cd380b6
perf: don't access `canvas.clientWidth` on each `render()`
WofWca Oct 7, 2021
5464706
perf: improve `updateTooltip` performance
WofWca Oct 6, 2021
465976b
perf: render: don't check interpolation unnecessarily
WofWca Oct 7, 2021
6641ce5
perf: remove unnecessary `closePath`
WofWca Oct 8, 2021
7f108bc
docs: update changelog
WofWca Oct 8, 2021
cedec28
fix: series fill & stroke being inconsistent for last data time < ren…
WofWca Oct 8, 2021
fd47202
docs: update changelog
WofWca Oct 8, 2021
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
272 changes: 143 additions & 129 deletions smoothie.js
View file
Open in desktop
Expand Up @@ -95,6 +95,9 @@
* Add title option, by @mesca
* Fix data drop stoppage by rejecting NaNs in append(), by @timdrysdale
* Allow setting interpolation per time series, by @WofWca (#123)
* Fix a memory leak appearing when some `timeSeries.disabled === true`, by @WofWca (#132)
* Improve performance, by @WofWca (#135)
* Fix series fill & stroke being inconsistent for last data time < render time, by @WofWca (#138)
*/

;(function(exports) {
Expand Down Expand Up @@ -214,30 +217,42 @@
if (isNaN(timestamp) || isNaN(value)){
return
}
// Rewind until we hit an older timestamp
var i = this.data.length - 1;
while (i >= 0 && this.data[i][0] > timestamp) {
i--;
}

if (i === -1) {
// This new item is the oldest data
this.data.splice(0, 0, [timestamp, value]);
} else if (this.data.length > 0 && this.data[i][0] === timestamp) {
// Update existing values in the array
if (sumRepeatedTimeStampValues) {
// Sum this value into the existing 'bucket'
this.data[i][1] += value;
value = this.data[i][1];
} else {
// Replace the previous value
this.data[i][1] = value;
var lastI = this.data.length - 1;
if (lastI >= 0) {
// Rewind until we find the place for the new data
var i = lastI;
while (true) {
var iThData = this.data[i];
if (timestamp >= iThData[0]) {
if (timestamp === iThData[0]) {
// Update existing values in the array
if (sumRepeatedTimeStampValues) {
// Sum this value into the existing 'bucket'
iThData[1] += value;
value = iThData[1];
} else {
// Replace the previous value
iThData[1] = value;
}
} else {
// Splice into the correct position to keep timestamps in order
this.data.splice(i + 1, 0, [timestamp, value]);
}

break;
}

i--;
if (i < 0) {
// This new item is the oldest data
this.data.splice(0, 0, [timestamp, value]);

break;
}
}
} else if (i < this.data.length - 1) {
// Splice into the correct position to keep timestamps in order
this.data.splice(i + 1, 0, [timestamp, value]);
} else {
// Add to the end of the array
// It's the first element
this.data.push([timestamp, value]);
}

Expand Down Expand Up @@ -542,6 +557,10 @@
*/
SmoothieChart.prototype.streamTo = function(canvas, delayMillis) {
this.canvas = canvas;

this.clientWidth = parseInt(this.canvas.getAttribute('width'));
this.clientHeight = parseInt(this.canvas.getAttribute('height'));

this.delay = delayMillis;
this.start();
};
Expand Down Expand Up @@ -575,7 +594,7 @@
// x pixel to time
var t = this.options.scrollBackwards
? time - this.mouseX * this.options.millisPerPixel
: time - (this.canvas.offsetWidth - this.mouseX) * this.options.millisPerPixel;
: time - (this.clientWidth - this.mouseX) * this.options.millisPerPixel;

var data = [];

Expand Down Expand Up @@ -645,24 +664,33 @@
this.canvas.setAttribute('height', (Math.floor(height * dpr)).toString());
this.canvas.getContext('2d').scale(dpr, dpr);
}
} else if (dpr !== 1) {
// Older behaviour: use the canvas's inner dimensions and scale the element's size
// according to that size and the device pixel ratio (eg: high DPI)

this.clientWidth = width;
this.clientHeight = height;
} else {
width = parseInt(this.canvas.getAttribute('width'));
height = parseInt(this.canvas.getAttribute('height'));

if (!this.originalWidth || (Math.floor(this.originalWidth * dpr) !== width)) {
this.originalWidth = width;
this.canvas.setAttribute('width', (Math.floor(width * dpr)).toString());
this.canvas.style.width = width + 'px';
this.canvas.getContext('2d').scale(dpr, dpr);
}
if (dpr !== 1) {
// Older behaviour: use the canvas's inner dimensions and scale the element's size
// according to that size and the device pixel ratio (eg: high DPI)

if (!this.originalHeight || (Math.floor(this.originalHeight * dpr) !== height)) {
this.originalHeight = height;
this.canvas.setAttribute('height', (Math.floor(height * dpr)).toString());
this.canvas.style.height = height + 'px';
this.canvas.getContext('2d').scale(dpr, dpr);
if (Math.floor(this.clientWidth * dpr) !== width) {
this.canvas.setAttribute('width', (Math.floor(width * dpr)).toString());
this.canvas.style.width = width + 'px';
this.clientWidth = width;
this.canvas.getContext('2d').scale(dpr, dpr);
}

if (Math.floor(this.clientHeight * dpr) !== height) {
this.canvas.setAttribute('height', (Math.floor(height * dpr)).toString());
this.canvas.style.height = height + 'px';
this.clientHeight = height;
this.canvas.getContext('2d').scale(dpr, dpr);
}
} else {
this.clientWidth = width;
this.clientHeight = height;
}
}
};
Expand Down Expand Up @@ -811,7 +839,8 @@

var context = canvas.getContext('2d'),
chartOptions = this.options,
dimensions = { top: 0, left: 0, width: canvas.clientWidth, height: canvas.clientHeight },
// Using `this.clientWidth` instead of `canvas.clientWidth` because the latter is slow.
dimensions = { top: 0, left: 0, width: this.clientWidth, height: this.clientHeight },
// Calculate the threshold time for the oldest data points.
oldestValidTime = time - (dimensions.width * chartOptions.millisPerPixel),
valueToYPixel = function(value) {
Expand All @@ -831,10 +860,6 @@

context.font = chartOptions.labels.fontSize + 'px ' + chartOptions.labels.fontFamily;

// Save the state of the canvas context, any transformations applied in this method
// will get removed from the stack at the end of this method when .restore() is called.
context.save();

// Move the origin.
context.translate(dimensions.left, dimensions.top);

Expand All @@ -846,14 +871,11 @@
context.clip();

// Clear the working area.
context.save();
context.fillStyle = chartOptions.grid.fillStyle;
context.clearRect(0, 0, dimensions.width, dimensions.height);
context.fillRect(0, 0, dimensions.width, dimensions.height);
context.restore();

// Grid lines...
context.save();
context.lineWidth = chartOptions.grid.lineWidth;
context.strokeStyle = chartOptions.grid.strokeStyle;
// Vertical (time) dividers.
Expand Down Expand Up @@ -891,7 +913,6 @@
context.strokeRect(0, 0, dimensions.width, dimensions.height);
context.closePath();
}
context.restore();

// Draw any horizontal lines...
if (chartOptions.horizontalLines && chartOptions.horizontalLines.length) {
Expand All @@ -910,95 +931,89 @@

// For each data set...
for (var d = 0; d < this.seriesSet.length; d++) {
context.save();
var timeSeries = this.seriesSet[d].timeSeries;
if (timeSeries.disabled) {
continue;
}

var dataSet = timeSeries.data,
seriesOptions = this.seriesSet[d].options;
var timeSeries = this.seriesSet[d].timeSeries,
dataSet = timeSeries.data;

// Delete old data that's moved off the left of the chart.
timeSeries.dropOldData(oldestValidTime, chartOptions.maxDataSetLength);
if (dataSet.length <= 1 || timeSeries.disabled) {
continue;
}

var seriesOptions = this.seriesSet[d].options;

// Set style for this dataSet.
context.lineWidth = seriesOptions.lineWidth;
context.strokeStyle = seriesOptions.strokeStyle;
// Draw the line...
context.beginPath();
// Retain lastX, lastY for calculating the control points of bezier curves.
var firstX = 0, firstY = 0, lastX = 0, lastY = 0;
for (var i = 0; i < dataSet.length && dataSet.length !== 1; i++) {
var x = timeToXPixel(dataSet[i][0]),
y = valueToYPixel(dataSet[i][1]);

if (i === 0) {
firstX = x;
firstY = y;
context.moveTo(x, y);
} else {
switch (seriesOptions.interpolation || chartOptions.interpolation) {
case "linear":
case "line": {
context.lineTo(x,y);
break;
}
case "bezier":
default: {
// Great explanation of Bezier curves: http://en.wikipedia.org/wiki/Bezier_curve#Quadratic_curves
//
// Assuming A was the last point in the line plotted and B is the new point,
// we draw a curve with control points P and Q as below.
//
// A---P
// |
// |
// |
// Q---B
//
// Importantly, A and P are at the same y coordinate, as are B and Q. This is
// so adjacent curves appear to flow as one.
//
context.bezierCurveTo( // startPoint (A) is implicit from last iteration of loop
Math.round((lastX + x) / 2), lastY, // controlPoint1 (P)
Math.round((lastX + x)) / 2, y, // controlPoint2 (Q)
x, y); // endPoint (B)
break;
}
case "step": {
context.lineTo(x,lastY);
context.lineTo(x,y);
break;
}
var firstX = timeToXPixel(dataSet[0][0]),
firstY = valueToYPixel(dataSet[0][1]),
lastX = firstX,
lastY = firstY,
draw;
context.moveTo(firstX, firstY);
switch (seriesOptions.interpolation || chartOptions.interpolation) {
case "linear":
case "line": {
draw = function(x, y, lastX, lastY) {
context.lineTo(x,y);
}
break;
}
case "bezier":
default: {
// Great explanation of Bezier curves: http://en.wikipedia.org/wiki/Bezier_curve#Quadratic_curves
//
// Assuming A was the last point in the line plotted and B is the new point,
// we draw a curve with control points P and Q as below.
//
// A---P
// |
// |
// |
// Q---B
//
// Importantly, A and P are at the same y coordinate, as are B and Q. This is
// so adjacent curves appear to flow as one.
//
draw = function(x, y, lastX, lastY) {
context.bezierCurveTo( // startPoint (A) is implicit from last iteration of loop
Math.round((lastX + x) / 2), lastY, // controlPoint1 (P)
Math.round((lastX + x)) / 2, y, // controlPoint2 (Q)
x, y); // endPoint (B)
}
break;
}
case "step": {
draw = function(x, y, lastX, lastY) {
context.lineTo(x,lastY);
context.lineTo(x,y);
}
break;
}
}

for (var i = 1; i < dataSet.length; i++) {
var iThData = dataSet[i],
x = timeToXPixel(iThData[0]),
y = valueToYPixel(iThData[1]);
draw(x, y, lastX, lastY);
lastX = x; lastY = y;
}

if (dataSet.length > 1) {
if (seriesOptions.fillStyle) {
// Close up the fill region.
if (chartOptions.scrollBackwards) {
context.lineTo(lastX, dimensions.height + seriesOptions.lineWidth);
context.lineTo(firstX, dimensions.height + seriesOptions.lineWidth);
context.lineTo(firstX, firstY);
} else {
context.lineTo(dimensions.width + seriesOptions.lineWidth + 1, lastY);
context.lineTo(dimensions.width + seriesOptions.lineWidth + 1, dimensions.height + seriesOptions.lineWidth + 1);
context.lineTo(firstX, dimensions.height + seriesOptions.lineWidth);
}
context.fillStyle = seriesOptions.fillStyle;
context.fill();
}
if (seriesOptions.strokeStyle && seriesOptions.strokeStyle !== 'none') {
context.lineWidth = seriesOptions.lineWidth;
context.strokeStyle = seriesOptions.strokeStyle;
context.stroke();
}

if (seriesOptions.strokeStyle && seriesOptions.strokeStyle !== 'none') {
context.stroke();
}
context.closePath();
if (seriesOptions.fillStyle) {
// Close up the fill region.
context.lineTo(lastX, dimensions.height + seriesOptions.lineWidth + 1);
context.lineTo(firstX, dimensions.height + seriesOptions.lineWidth + 1);

context.fillStyle = seriesOptions.fillStyle;
context.fill();
}
context.restore();
}

if (chartOptions.tooltip && this.mouseX >= 0) {
Expand All @@ -1013,19 +1028,20 @@
}
this.updateTooltip();

var labelsOptions = chartOptions.labels;
// Draw the axis values on the chart.
if (!chartOptions.labels.disabled && !isNaN(this.valueRange.min) && !isNaN(this.valueRange.max)) {
var maxValueString = chartOptions.yMaxFormatter(this.valueRange.max, chartOptions.labels.precision),
minValueString = chartOptions.yMinFormatter(this.valueRange.min, chartOptions.labels.precision),
if (!labelsOptions.disabled && !isNaN(this.valueRange.min) && !isNaN(this.valueRange.max)) {
var maxValueString = chartOptions.yMaxFormatter(this.valueRange.max, labelsOptions.precision),
minValueString = chartOptions.yMinFormatter(this.valueRange.min, labelsOptions.precision),
maxLabelPos = chartOptions.scrollBackwards ? 0 : dimensions.width - context.measureText(maxValueString).width - 2,
minLabelPos = chartOptions.scrollBackwards ? 0 : dimensions.width - context.measureText(minValueString).width - 2;
context.fillStyle = chartOptions.labels.fillStyle;
context.fillText(maxValueString, maxLabelPos, chartOptions.labels.fontSize);
context.fillStyle = labelsOptions.fillStyle;
context.fillText(maxValueString, maxLabelPos, labelsOptions.fontSize);
context.fillText(minValueString, minLabelPos, dimensions.height - 2);
}

// Display intermediate y axis labels along y-axis to the left of the chart
if ( chartOptions.labels.showIntermediateLabels
if ( labelsOptions.showIntermediateLabels
&& !isNaN(this.valueRange.min) && !isNaN(this.valueRange.max)
&& chartOptions.grid.verticalSections > 0) {
// show a label above every vertical section divider
Expand All @@ -1036,10 +1052,10 @@
if (chartOptions.grid.sharpLines) {
gy -= 0.5;
}
var yValue = chartOptions.yIntermediateFormatter(this.valueRange.min + (v * step), chartOptions.labels.precision);
var yValue = chartOptions.yIntermediateFormatter(this.valueRange.min + (v * step), labelsOptions.precision);
//left of right axis?
intermediateLabelPos =
chartOptions.labels.intermediateLabelSameAxis
labelsOptions.intermediateLabelSameAxis
? (chartOptions.scrollBackwards ? 0 : dimensions.width - context.measureText(yValue).width - 2)
: (chartOptions.scrollBackwards ? dimensions.width - context.measureText(yValue).width - 2 : 0);

Expand Down Expand Up @@ -1095,8 +1111,6 @@
context.fillStyle = chartOptions.title.fillStyle;
context.fillText(chartOptions.title.text, titleXPos, titleYPos);
}

context.restore(); // See .save() above.
};

// Sample timestamp formatting function
Expand Down