Commit e9807f87 authored by Michael's avatar Michael

Update README.md

parent 10266639
## What it is ## ### What it is ###
CurvedLines is a plugin for flot, which displays lines in a smooth curved way. This is achieved by adding additional points in between the "real" data points. See the test files for examples. CurvedLines is a plugin for flot, which displays lines in a smooth curved way. This is achieved by adding additional points in between the "real" data points. See the test files for examples.
Feel free to add additional features and correct errors. Feel free to add additional features and correct errors.
...@@ -6,7 +6,7 @@ Feel free to add additional features and correct errors. ...@@ -6,7 +6,7 @@ Feel free to add additional features and correct errors.
Regards Michael Regards Michael
## Hermite Splines v1.x.y ## ### Hermite Splines v1.x.y ###
With the new version 1.x.y the original curve computation (nergal.dev's code) has been replaced by a new algorithm which computes hermite splines. With the new version 1.x.y the original curve computation (nergal.dev's code) has been replaced by a new algorithm which computes hermite splines.
In general the result should be closer to the data however the old implementation is still accessible through the legacyOverride option. In general the result should be closer to the data however the old implementation is still accessible through the legacyOverride option.
...@@ -16,10 +16,11 @@ and I hope that the new nrSplinePoints needs less manual adjustment (basically o ...@@ -16,10 +16,11 @@ and I hope that the new nrSplinePoints needs less manual adjustment (basically o
The old fit option has been replaced with monotonicFit, which if set, enforces the use of the Fritsch-Carlson method (anti wiggle no overshooting / undershooting). The old fit option has been replaced with monotonicFit, which if set, enforces the use of the Fritsch-Carlson method (anti wiggle no overshooting / undershooting).
## Hands on ## ### Hands on ###
* * * * * * * * * * * * * * * * * * * * * * * *
how to use it: how to use it:
____________________________________________________ * * * * * * * * * * * * * * * * * * * * * * * *
var d1 = [[5,5],[7,3],[9,12]]; var d1 = [[5,5],[7,3],[9,12]];
...@@ -27,26 +28,32 @@ The old fit option has been replaced with monotonicFit, which if set, enforces t ...@@ -27,26 +28,32 @@ The old fit option has been replaced with monotonicFit, which if set, enforces t
$.plot($("#placeholder"), [{data: d1, lines: { show: true}, curvedLines: {apply: true}}], options); $.plot($("#placeholder"), [{data: d1, lines: { show: true}, curvedLines: {apply: true}}], options);
_____________________________________________________
* * * * * * * * * * * * * * * * * * * * * * * *
options: options:
_____________________________________________________ * * * * * * * * * * * * * * * * * * * * * * * *
active: bool true => plugin can be used | parameter | type | effect |
apply: bool true => series will be drawn as curved line |----------------|------|--------------------------------------------------------------------------------------------------|
monotonicFit: bool true => uses monotone cubic interpolation (preserve monotonicity) | active | bool | true => plugin can be used |
tension: int defines the tension parameter of the hermite spline interpolation (no effect if monotonicFit is set) | apply | bool | true => series will be drawn as curved line |
nrSplinePoints: int defines the number of sample points (of the spline) in between two consecutive points | monotonicFit | bool | true => uses monotone cubic interpolation (preserve monotonicity) |
| tension | int | defines the tension parameter of the hermite spline interpolation (only if monotonicFit = false) |
| nrSplinePoints | int | defines the number of sample points (of the spline) in between two consecutive points |
deprecated options from flot prior to 1.0.0: deprecated options from flot prior to 1.0.0:
------------------------------------------------ * * * * * * * * * * * * * * * * * * * * * * * *
legacyOverride bool true => use old default
OR | parameter | type | effect |
legacyOverride optionArray |----------------|------|---------------------------------------------------------------------------------------------------------------------------------------------|
{ | legacyOverride | bool | true => use old default |
fit: bool true => forces the max,mins of the curve to be on the datapoints
curvePointFactor int defines how many "virtual" points are used per "real" data point to <br></br>
emulate the curvedLines (points total = real points * curvePointFactor) or to get more control set legacy as option array with:
fitPointDist: int defines the x axis distance of the additional two points that are used <br></br>
to enforce the min max condition.
} | parameter | type | effect |
|----------------|------|---------------------------------------------------------------------------------------------------------------------------------------------|
| fit | bool | true => forces the max,mins of the curve to be on the datapoints |
| curvePointFactor | int | defines how many "virtual" points are used per "real" data point to emulate the curvedLines (points total = real points * curvePointFactor) |
| fitPointDist | int | defines the x axis distance of the additional two points that are used to enforce the min max condition. |
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment