Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Contribute to GitLab
Sign in
Toggle navigation
F
flot
Project
Project
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Charts
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
HS-public
flot
Commits
54cde197
Commit
54cde197
authored
Jul 16, 2012
by
David Schnur
Browse files
Options
Browse Files
Download
Plain Diff
Merge pull request #62 from ablfx/master
Correct GitHub Syntax Highlighting in API markdown file
parents
d51a1013
4fa6e380
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
356 additions
and
374 deletions
+356
-374
API.md
API.md
+356
-374
No files found.
API.md
View file @
54cde197
...
@@ -2,9 +2,9 @@ Flot Reference
...
@@ -2,9 +2,9 @@ Flot Reference
--------------
--------------
Consider a call to the plot function:
Consider a call to the plot function:
```
js
var plot = $.plot(placeholder, data, options)
var
plot
=
$
.
plot
(
placeholder
,
data
,
options
)
```
The placeholder is a jQuery object or DOM element or jQuery expression
The placeholder is a jQuery object or DOM element or jQuery expression
that the plot will be put into. This placeholder needs to have its
that the plot will be put into. This placeholder needs to have its
width and height set as explained in the README (go read that now if
width and height set as explained in the README (go read that now if
...
@@ -27,18 +27,18 @@ Data Format
...
@@ -27,18 +27,18 @@ Data Format
-----------
-----------
The data is an array of data series:
The data is an array of data series:
```
js
[ series1, series2, ... ]
[
series1
,
series2
,
...
]
```
A series can either be raw data or an object with properties. The raw
A series can either be raw data or an object with properties. The raw
data format is an array of points:
data format is an array of points:
```
js
[
[
x1
,
y1
],
[
x2
,
y2
],
...
]
[
[
x1
,
y1
],
[
x2
,
y2
],
...
]
```
E.g.
E.g.
```
js
[
[
1
,
3
],
[
2
,
14.01
],
[
3.5
,
3.14
]
]
[
[
1
,
3
],
[
2
,
14.01
],
[
3.5
,
3.14
]
]
```
Note that to simplify the internal logic in Flot both the x and y
Note that to simplify the internal logic in Flot both the x and y
values must be numbers (even if specifying time series, see below for
values must be numbers (even if specifying time series, see below for
how to do this). This is a common problem because you might retrieve
how to do this). This is a common problem because you might retrieve
...
@@ -57,30 +57,29 @@ can specify a third coordinate which is the bottom of the filled
...
@@ -57,30 +57,29 @@ can specify a third coordinate which is the bottom of the filled
area/bar (defaults to 0).
area/bar (defaults to 0).
The format of a single series object is as follows:
The format of a single series object is as follows:
```
js
{
{
color: color or number
color
:
color
or
number
data: rawdata
data
:
rawdata
label: string
label
:
string
lines: specific lines options
lines
:
specific
lines
options
bars: specific bars options
bars
:
specific
bars
options
points: specific points options
points
:
specific
points
options
xaxis: number
xaxis
:
number
yaxis: number
yaxis
:
number
clickable: boolean
clickable
:
boolean
hoverable: boolean
hoverable
:
boolean
shadowSize: number
shadowSize
:
number
}
}
```
You don't have to specify any of them except the data, the rest are
You don't have to specify any of them except the data, the rest are
options that will get default values. Typically you'd only specify
options that will get default values. Typically you'd only specify
label and data, like this:
label and data, like this:
```
js
{
{
label: "y = 3",
label
:
"y = 3"
,
data: [[0, 3], [10, 3]]
}
}
```
The label is used for the legend, if you don't specify one, the series
The label is used for the legend, if you don't specify one, the series
will not show up in the legend.
will not show up in the legend.
...
@@ -107,54 +106,52 @@ commmand. When you specify them for a specific data series, they will
...
@@ -107,54 +106,52 @@ commmand. When you specify them for a specific data series, they will
override the default options for the plot for that data series.
override the default options for the plot for that data series.
Here's a complete example of a simple data specification:
Here's a complete example of a simple data specification:
```
js
[
{
label
:
"Foo"
,
data
:
[
[
10
,
1
],
[
17
,
-
14
],
[
30
,
5
]
]
},
[
{
label
:
"Foo"
,
data
:
[
[
10
,
1
],
[
17
,
-
14
],
[
30
,
5
]
]
},
{ label: "Bar", data: [ [11, 13], [19, 11], [30, -7] ] } ]
{
label
:
"Bar"
,
data
:
[
[
11
,
13
],
[
19
,
11
],
[
30
,
-
7
]
]
}
]
```
Plot Options
Plot Options
------------
------------
All options are completely optional. They are documented individually
All options are completely optional. They are documented individually
below, to change them you just specify them in an object, e.g.
below, to change them you just specify them in an object, e.g.
```
js
var options = {
var
options
=
{
series: {
series
:
{
lines: { show: true },
lines
:
{
show
:
true
},
points: { show: true }
points
:
{
show
:
true
}
}
}
};
};
$.plot(placeholder, data, options);
$
.
plot
(
placeholder
,
data
,
options
);
```
Customizing the legend
Customizing the legend
======================
======================
```js
legend: {
legend: {
show: boolean
show: boolean
labelFormatter: null or (fn: string, series object -> string)
labelFormatter: null or (fn: string, series object -> string)
labelBoxBorderColor: color
labelBoxBorderColor: color
noColumns: number
noColumns: number
position: "ne" or "nw" or "se" or "sw"
position: "ne" or "nw" or "se" or "sw"
margin: number of pixels or
[
x margin, y margin
]
margin: number of pixels or [x margin, y margin]
backgroundColor: null or color
backgroundColor: null or color
backgroundOpacity: number between 0 and 1
backgroundOpacity: number between 0 and 1
container: null or jQuery object/DOM element/jQuery expression
container: null or jQuery object/DOM element/jQuery expression
sorted: null/false, true, "ascending", "descending" or a comparator
}
}
```
The legend is generated as a table with the data series labels and
The legend is generated as a table with the data series labels and
small label boxes with the color of the series. If you want to format
small label boxes with the color of the series. If you want to format
the labels in some way, e.g. make them to links, you can pass in a
the labels in some way, e.g. make them to links, you can pass in a
function for "labelFormatter". Here's an example that makes them
function for "labelFormatter". Here's an example that makes them
clickable:
clickable:
```
js
labelFormatter: function(label, series) {
labelFormatter
:
function
(
label
,
series
)
{
// series is the series object for the label
// series is the series object for the label
return '<a href="#' + label + '">' + label + '</a>';
return
'<a href="#'
+
label
+
'">'
+
label
+
'</a>'
;
}
}
```
"noColumns" is the number of columns to divide the legend table into.
"noColumns" is the number of columns to divide the legend table into.
"position" specifies the overall placement of the legend within the
"position" specifies the overall placement of the legend within the
plot (top-right, top-left, etc.) and margin the distance to the plot
plot (top-right, top-left, etc.) and margin the distance to the plot
...
@@ -168,57 +165,42 @@ specify "container" as a jQuery object/expression to put the legend
...
@@ -168,57 +165,42 @@ specify "container" as a jQuery object/expression to put the legend
table into. The "position" and "margin" etc. options will then be
table into. The "position" and "margin" etc. options will then be
ignored. Note that Flot will overwrite the contents of the container.
ignored. Note that Flot will overwrite the contents of the container.
Legend entries appear in the same order as their series by default. To
sort them alphabetically, you can specify "sorted" as tue, "ascending"
or "descending", where true and "ascending" are equivalent.
You can also provide your own comparator function that accepts two
objects with "label" and "color" properties, and returns zero if they
are equal, a positive value if the first is greater than the second,
and a negative value if the first is less than the second.
sorted: function(a, b) {
// sort alphabetically in ascending order
return a.label == b.label ? 0 : (
a.label > b.label ? 1 : -1
)
}
Customizing the axes
Customizing the axes
====================
====================
```js
xaxis, yaxis: {
show: null or true/false
position: "bottom" or "top" or "left" or "right"
mode: null or "time" ("time" requires jquery.flot.time.js plugin)
timezone: null, "browser" or timezone (only makes sense for mode: "time")
color: null or color spec
tickColor: null or color spec
font: null or font spec object
min: null or number
max: null or number
autoscaleMargin: null or number
transform: null or fn: number -> number
inverseTransform: null or fn: number -> number
ticks: null or number or ticks array or (fn: axis -> ticks array)
tickSize: number or array
minTickSize: number or array
tickFormatter: (fn: number, object -> string) or string
tickDecimals: null or number
labelWidth: null or number
labelHeight: null or number
reserveSpace: null or true
tickLength: null or number
xaxis, yaxis: {
alignTicksWithAxis: null or number
show: null or true/false
}
position: "bottom" or "top" or "left" or "right"
```
mode: null or "time" ("time" requires jquery.flot.time.js plugin)
timezone: null, "browser" or timezone (only makes sense for mode: "time")
color: null or color spec
tickColor: null or color spec
font: null or font spec object
min: null or number
max: null or number
autoscaleMargin: null or number
transform: null or fn: number -> number
inverseTransform: null or fn: number -> number
ticks: null or number or ticks array or (fn: axis -> ticks array)
tickSize: number or array
minTickSize: number or array
tickFormatter: (fn: number, object -> string) or string
tickDecimals: null or number
labelWidth: null or number
labelHeight: null or number
reserveSpace: null or true
tickLength: null or number
alignTicksWithAxis: null or number
}
All axes have the same kind of options. The following describes how to
All axes have the same kind of options. The following describes how to
configure one axis, see below for what to do if you've got more than
configure one axis, see below for what to do if you've got more than
one x axis or y axis.
one x axis or y axis.
...
@@ -246,15 +228,15 @@ directly with "font". The default value of null means that the font is
...
@@ -246,15 +228,15 @@ directly with "font". The default value of null means that the font is
read from the font style on the placeholder element (80% the size of
read from the font style on the placeholder element (80% the size of
that to be precise). If you set it directly with "font: { ... }", the
that to be precise). If you set it directly with "font: { ... }", the
format is like this:
format is like this:
```
js
{
{
size: 11,
size
:
11
,
style: "italic",
style
:
"italic"
,
weight: "bold",
weight
:
"bold"
,
family: "sans-serif",
family
:
"sans-serif"
,
variant: "small-caps"
variant
:
"small-caps"
}
}
```
The options "min"/"max" are the precise minimum/maximum value on the
The options "min"/"max" are the precise minimum/maximum value on the
scale. If you don't specify either of them, a value will automatically
scale. If you don't specify either of them, a value will automatically
be chosen based on the minimum/maximum data values. Note that Flot
be chosen based on the minimum/maximum data values. Note that Flot
...
@@ -277,20 +259,20 @@ suppress weekends or compress far away points with a logarithm or some
...
@@ -277,20 +259,20 @@ suppress weekends or compress far away points with a logarithm or some
other means. When Flot draws the plot, each value is first put through
other means. When Flot draws the plot, each value is first put through
the transform function. Here's an example, the x axis can be turned
the transform function. Here's an example, the x axis can be turned
into a natural logarithm axis with the following code:
into a natural logarithm axis with the following code:
```
js
xaxis: {
xaxis
:
{
transform: function (v) { return Math.log(v); },
transform
:
function
(
v
)
{
return
Math
.
log
(
v
);
},
inverseTransform: function (v) { return Math.exp(v); }
inverseTransform
:
function
(
v
)
{
return
Math
.
exp
(
v
);
}
}
}
```
Similarly, for reversing the y axis so the values appear in inverse
Similarly, for reversing the y axis so the values appear in inverse
order:
order:
```
js
yaxis: {
yaxis
:
{
transform: function (v) { return -v; },
transform
:
function
(
v
)
{
return
-
v
;
},
inverseTransform: function (v) { return -v; }
inverseTransform
:
function
(
v
)
{
return
-
v
;
}
}
}
```
Note that for finding extrema, Flot assumes that the transform
Note that for finding extrema, Flot assumes that the transform
function does not reorder values (it should be monotone).
function does not reorder values (it should be monotone).
...
@@ -323,13 +305,13 @@ see the next section.
...
@@ -323,13 +305,13 @@ see the next section.
If you want to completely override the tick algorithm, you can specify
If you want to completely override the tick algorithm, you can specify
an array for "ticks", either like this:
an array for "ticks", either like this:
```
js
ticks: [0, 1.2, 2.4]
ticks
:
[
0
,
1.2
,
2.4
]
```
Or like this where the labels are also customized:
Or like this where the labels are also customized:
```
js
ticks: [[0, "zero"], [1.2, "one mark"], [2.4, "two marks"]]
ticks
:
[[
0
,
"zero"
],
[
1.2
,
"one mark"
],
[
2.4
,
"two marks"
]]
```
You can mix the two if you like.
You can mix the two if you like.
For extra flexibility you can specify a function as the "ticks"
For extra flexibility you can specify a function as the "ticks"
...
@@ -337,18 +319,18 @@ parameter. The function will be called with an object with the axis
...
@@ -337,18 +319,18 @@ parameter. The function will be called with an object with the axis
min and max and should return a ticks array. Here's a simplistic tick
min and max and should return a ticks array. Here's a simplistic tick
generator that spits out intervals of pi, suitable for use on the x
generator that spits out intervals of pi, suitable for use on the x
axis for trigonometric functions:
axis for trigonometric functions:
```
js
function piTickGenerator(axis) {
function
piTickGenerator
(
axis
)
{
var res = [], i = Math.floor(axis.min / Math.PI);
var
res
=
[],
i
=
Math
.
floor
(
axis
.
min
/
Math
.
PI
);
do {
do
{
var v = i * Math.PI;
var
v
=
i
*
Math
.
PI
;
res.push([v, i + "\u03c0"]);
res
.
push
([
v
,
i
+
"
\
u03c0"
]);
++i;
++
i
;
} while (v < axis.max);
}
while
(
v
<
axis
.
max
);
return res;
return
res
;
}
}
```
You can control how the ticks look like with "tickDecimals", the
You can control how the ticks look like with "tickDecimals", the
number of decimals to display (default is auto-detected).
number of decimals to display (default is auto-detected).
...
@@ -356,26 +338,26 @@ Alternatively, for ultimate control over how ticks are formatted you can
...
@@ -356,26 +338,26 @@ Alternatively, for ultimate control over how ticks are formatted you can
provide a function to "tickFormatter". The function is passed two
provide a function to "tickFormatter". The function is passed two
parameters, the tick value and an axis object with information, and
parameters, the tick value and an axis object with information, and
should return a string. The default formatter looks like this:
should return a string. The default formatter looks like this:
```
js
function formatter(val, axis) {
function
formatter
(
val
,
axis
)
{
return val.toFixed(axis.tickDecimals);
return
val
.
toFixed
(
axis
.
tickDecimals
);
}
}
```
The axis object has "min" and "max" with the range of the axis,
The axis object has "min" and "max" with the range of the axis,
"tickDecimals" with the number of decimals to round the value to and
"tickDecimals" with the number of decimals to round the value to and
"tickSize" with the size of the interval between ticks as calculated
"tickSize" with the size of the interval between ticks as calculated
by the automatic axis scaling algorithm (or specified by you). Here's
by the automatic axis scaling algorithm (or specified by you). Here's
an example of a custom formatter:
an example of a custom formatter:
```
js
function suffixFormatter(val, axis) {
function
suffixFormatter
(
val
,
axis
)
{
if (val > 1000000)
if
(
val
>
1000000
)
return (val / 1000000).toFixed(axis.tickDecimals) + " MB";
return
(
val
/
1000000
).
toFixed
(
axis
.
tickDecimals
)
+
" MB"
;
else if (val > 1000)
else
if
(
val
>
1000
)
return (val / 1000).toFixed(axis.tickDecimals) + " kB";
return
(
val
/
1000
).
toFixed
(
axis
.
tickDecimals
)
+
" kB"
;
else
else
return val.toFixed(axis.tickDecimals) + " B";
return
val
.
toFixed
(
axis
.
tickDecimals
)
+
" B"
;
}
}
```
"labelWidth" and "labelHeight" specifies a fixed size of the tick
"labelWidth" and "labelHeight" specifies a fixed size of the tick
labels in pixels. They're useful in case you need to align several
labels in pixels. They're useful in case you need to align several
plots. "reserveSpace" means that even if an axis isn't shown, Flot
plots. "reserveSpace" means that even if an axis isn't shown, Flot
...
@@ -407,18 +389,18 @@ that a series should be plotted against the second y axis.
...
@@ -407,18 +389,18 @@ that a series should be plotted against the second y axis.
To actually configure that axis, you can't use the xaxis/yaxis options
To actually configure that axis, you can't use the xaxis/yaxis options
directly - instead there are two arrays in the options:
directly - instead there are two arrays in the options:
```
js
xaxes: []
xaxes
:
[]
yaxes: []
yaxes
:
[]
```
Here's an example of configuring a single x axis and two y axes (we
Here's an example of configuring a single x axis and two y axes (we
can leave options of the first y axis empty as the defaults are fine):
can leave options of the first y axis empty as the defaults are fine):
```
js
{
{
xaxes: [ { position: "top" } ],
xaxes
:
[
{
position
:
"top"
}
],
yaxes: [ { }, { position: "right", min: 20 } ]
yaxes
:
[
{
},
{
position
:
"right"
,
min
:
20
}
]
}
}
```
The arrays get their default values from the xaxis/yaxis settings, so
The arrays get their default values from the xaxis/yaxis settings, so
say you want to have all y axes start at zero, you can simply specify
say you want to have all y axes start at zero, you can simply specify
yaxis: { min: 0 } instead of adding a min parameter to all the axes.
yaxis: { min: 0 } instead of adding a min parameter to all the axes.
...
@@ -448,10 +430,10 @@ Javascript timestamp is the number of milliseconds since January 1,
...
@@ -448,10 +430,10 @@ Javascript timestamp is the number of milliseconds since January 1,
in milliseconds, so remember to multiply by 1000!
in milliseconds, so remember to multiply by 1000!
You can see a timestamp like this
You can see a timestamp like this
```
js
alert((new Date()).getTime())
alert
((
new
Date
()).
getTime
())
```
There are different schools of thought when it comes to di
s
play of
There are different schools of thought when it comes to diplay of
timestamps. Many will want the timestamps to be displayed according to
timestamps. Many will want the timestamps to be displayed according to
a certain time zone, usually the time zone in which the data has been
a certain time zone, usually the time zone in which the data has been
produced. Some want the localized experience, where the timestamps are
produced. Some want the localized experience, where the timestamps are
...
@@ -474,14 +456,14 @@ In PHP you can get an appropriate timestamp with
...
@@ -474,14 +456,14 @@ In PHP you can get an appropriate timestamp with
'strtotime("2002-02-20 UTC")
*
1000', in Python with
'strtotime("2002-02-20 UTC")
*
1000', in Python with
'calendar.timegm(datetime_object.timetuple())
*
1000', in .NET with
'calendar.timegm(datetime_object.timetuple())
*
1000', in .NET with
something like:
something like:
```
js
public static int GetJavascriptTimestamp(System.DateTime input)
public
static
int
GetJavascriptTimestamp
(
System
.
DateTime
input
)
{
{
System.TimeSpan span = new System.TimeSpan(System.DateTime.Parse("1/1/1970").Ticks);
System
.
TimeSpan
span
=
new
System
.
TimeSpan
(
System
.
DateTime
.
Parse
(
"1/1/1970"
).
Ticks
);
System.DateTime time = input.Subtract(span);
System
.
DateTime
time
=
input
.
Subtract
(
span
);
return (long)(time.Ticks / 10000);
return
(
long
)(
time
.
Ticks
/
10000
);
}
}
```
Javascript also has some support for parsing date strings, so it is
Javascript also has some support for parsing date strings, so it is
possible to generate the timestamps manually client-side.
possible to generate the timestamps manually client-side.
...
@@ -513,49 +495,49 @@ Date objects.
...
@@ -513,49 +495,49 @@ Date objects.
Tick generation and formatting can also be controlled separately
Tick generation and formatting can also be controlled separately
through the following axis options:
through the following axis options:
```
js
minTickSize: array
minTickSize
:
array
timeformat: null or format string
timeformat
:
null
or
format
string
monthNames: null or array of size 12 of strings
monthNames
:
null
or
array
of
size
12
of
strings
dayNames: null or array of size 7 of strings
dayNames
:
null
or
array
of
size
7
of
strings
twelveHourClock: boolean
twelveHourClock
:
boolean
```
Here "timeformat" is a format string to use. You might use it like
Here "timeformat" is a format string to use. You might use it like
this:
this:
```
js
xaxis: {
xaxis
:
{
mode: "time"
mode
:
"time"
timeformat: "%Y/%m/%d"
timeformat
:
"%Y/%m/%d"
}
}
```
This will result in tick labels like "2000/12/24". A subset of the
This will result in tick labels like "2000/12/24". A subset of the
standard strftime specifiers are supported:
standard strftime specifiers are supported:
```
js
%a: weekday name (customizable)
%
a
:
weekday
name
(
customizable
)
%b: month name (customizable)
%
b
:
month
name
(
customizable
)
%d: day of month, zero-padded (01-31)
%
d
:
day
of
month
,
zero
-
padded
(
01
-
31
)
%e: day of month, space-padded ( 1-31)
%
e
:
day
of
month
,
space
-
padded
(
1
-
31
)
%H: hours, 24-hour time, zero-padded (00-23)
%
H
:
hours
,
24
-
hour
time
,
zero
-
padded
(
00
-
23
)
%I: hours, 12-hour time, zero-padded (01-12)
%
I
:
hours
,
12
-
hour
time
,
zero
-
padded
(
01
-
12
)
%m: month, zero-padded (01-12)
%
m
:
month
,
zero
-
padded
(
01
-
12
)
%M: minutes, zero-padded (00-59)
%
M
:
minutes
,
zero
-
padded
(
00
-
59
)
%S: seconds, zero-padded (00-59)
%
S
:
seconds
,
zero
-
padded
(
00
-
59
)
%y: year (two digits)
%
y
:
year
(
two
digits
)
%Y: year (four digits)
%
Y
:
year
(
four
digits
)
%p: am/pm
%
p
:
am
/
pm
%P: AM/PM (uppercase version of %p)
%
P
:
AM
/
PM
(
uppercase
version
of
%
p
)
%w: weekday as number (0-6, 0 being Sunday)
%
w
:
weekday
as
number
(
0
-
6
,
0
being
Sunday
)
```
You can customize the month names with the "monthNames" option. For
You can customize the month names with the "monthNames" option. For
instance, for Danish you might specify:
instance, for Danish you might specify:
```
js
monthNames: ["jan", "feb", "mar", "apr", "maj", "jun", "jul", "aug", "sep", "okt", "nov", "dec"]
monthNames
:
[
"jan"
,
"feb"
,
"mar"
,
"apr"
,
"maj"
,
"jun"
,
"jul"
,
"aug"
,
"sep"
,
"okt"
,
"nov"
,
"dec"
]
```
Similarly you can customize the weekday names with the "dayNames"
Similarly you can customize the weekday names with the "dayNames"
option. An example in French:
option. An example in French:
```
js
dayNames: ["dim", "lun", "mar", "mer", "jeu", "ven", "sam"]
dayNames
:
[
"dim"
,
"lun"
,
"mar"
,
"mer"
,
"jeu"
,
"ven"
,
"sam"
]
```
If you set "twelveHourClock" to true, the autogenerated timestamps
If you set "twelveHourClock" to true, the autogenerated timestamps
will use 12 hour AM/PM timestamps instead of 24 hour. This only
will use 12 hour AM/PM timestamps instead of 24 hour. This only
applies if you have not set "timeformat". Use the "%I" and "%p" or
applies if you have not set "timeformat". Use the "%I" and "%p" or
...
@@ -570,19 +552,19 @@ more powerful date/time formatting.
...
@@ -570,19 +552,19 @@ more powerful date/time formatting.
If everything else fails, you can control the formatting by specifying
If everything else fails, you can control the formatting by specifying
a custom tick formatter function as usual. Here's a simple example
a custom tick formatter function as usual. Here's a simple example
which will format December 24 as 24/12:
which will format December 24 as 24/12:
```
js
tickFormatter: function (val, axis) {
tickFormatter
:
function
(
val
,
axis
)
{
var d = new Date(val);
var
d
=
new
Date
(
val
);
return d.getUTCDate() + "/" + (d.getUTCMonth() + 1);
return
d
.
getUTCDate
()
+
"/"
+
(
d
.
getUTCMonth
()
+
1
);
}
}
```
Note that for the time mode "tickSize" and "minTickSize" are a bit
Note that for the time mode "tickSize" and "minTickSize" are a bit
special in that they are arrays on the form "
[
value, unit
]
" where unit
special in that they are arrays on the form "
[
value, unit
]
" where unit
is one of "second", "minute", "hour", "day", "month" and "year". So
is one of "second", "minute", "hour", "day", "month" and "year". So
you can specify
you can specify
```
js
minTickSize: [1, "month"]
minTickSize
:
[
1
,
"month"
]
```
to get a tick interval size of at least 1 month and correspondingly,
to get a tick interval size of at least 1 month and correspondingly,
if axis.tickSize is
[
2, "day"
]
in the tick formatter, the ticks have
if axis.tickSize is
[
2, "day"
]
in the tick formatter, the ticks have
been produced with two days in-between.
been produced with two days in-between.
...
@@ -591,35 +573,35 @@ been produced with two days in-between.
...
@@ -591,35 +573,35 @@ been produced with two days in-between.
Customizing the data series
Customizing the data series
===========================
===========================
```js
series: {
lines, points, bars: {
show: boolean
lineWidth: number
fill: boolean or number
fillColor: null or color/gradient
}
series: {
points: {
lines, points, bars: {
radius: number
show: boolean
symbol: "circle" or function
lineWidth: number
}
fill: boolean or number
fillColor: null or color/gradient
bars: {
}
barWidth: number
align: "left", "right" or "center"
points: {
horizontal: boolean
radius: number
}
symbol: "circle" or function
}
lines: {
steps: boolean
bars: {
barWidth: number
align: "left", "right" or "center"
horizontal: boolean
}
lines: {
steps: boolean
}
shadowSize: number
}
}
colors: [ color1, color2, ... ]
shadowSize: number
}
colors: [ color1, color2, ... ]
```
The options inside "series: {}" are copied to each of the series. So
The options inside "series: {}" are copied to each of the series. So
you can specify that all series should have bars by putting it in the
you can specify that all series should have bars by putting it in the
global options, or override it for individual series by specifying
global options, or override it for individual series by specifying
...
@@ -632,14 +614,14 @@ default to showing lines (you can turn this off with
...
@@ -632,14 +614,14 @@ default to showing lines (you can turn this off with
lines: { show: false }). You can specify the various types
lines: { show: false }). You can specify the various types
independently of each other, and Flot will happily draw each of them
independently of each other, and Flot will happily draw each of them
in turn (this is probably only useful for lines and points), e.g.
in turn (this is probably only useful for lines and points), e.g.
```
js
var options = {
var
options
=
{
series: {
series
:
{
lines: { show: true, fill: true, fillColor: "rgba(255, 255, 255, 0.8)" },
lines
:
{
show
:
true
,
fill
:
true
,
fillColor
:
"rgba(255, 255, 255, 0.8)"
},
points: { show: true, fill: false }
points
:
{
show
:
true
,
fill
:
false
}
}
}
};
};
```
"lineWidth" is the thickness of the line or outline in pixels. You can
"lineWidth" is the thickness of the line or outline in pixels. You can
set it to 0 to prevent a line or outline from being drawn; this will
set it to 0 to prevent a line or outline from being drawn; this will
also hide the shadow.
also hide the shadow.
...
@@ -672,15 +654,15 @@ data by adding extra points.
...
@@ -672,15 +654,15 @@ data by adding extra points.
For points, you can specify the radius and the symbol. The only
For points, you can specify the radius and the symbol. The only
built-in symbol type is circles, for other types you can use a plugin
built-in symbol type is circles, for other types you can use a plugin
or define them yourself by specifying a callback:
or define them yourself by specifying a callback:
```
js
function cross(ctx, x, y, radius, shadow) {
function
cross
(
ctx
,
x
,
y
,
radius
,
shadow
)
{
var
size
=
radius
*
Math
.
sqrt
(
Math
.
PI
)
/
2
;
var
size
=
radius
*
Math
.
sqrt
(
Math
.
PI
)
/
2
;
ctx
.
moveTo
(
x
-
size
,
y
-
size
);
ctx
.
moveTo
(
x
-
size
,
y
-
size
);
ctx
.
lineTo
(
x
+
size
,
y
+
size
);
ctx
.
lineTo
(
x
+
size
,
y
+
size
);
ctx
.
moveTo
(
x
-
size
,
y
+
size
);
ctx
.
moveTo
(
x
-
size
,
y
+
size
);
ctx
.
lineTo
(
x
+
size
,
y
-
size
);
ctx
.
lineTo
(
x
+
size
,
y
-
size
);
}
}
```
The parameters are the drawing context, x and y coordinates of the
The parameters are the drawing context, x and y coordinates of the
center of the point, a radius which corresponds to what the circle
center of the point, a radius which corresponds to what the circle
would have used and whether the call is to draw a shadow (due to
would have used and whether the call is to draw a shadow (due to
...
@@ -695,38 +677,38 @@ remove shadows.
...
@@ -695,38 +677,38 @@ remove shadows.
The "colors" array specifies a default color theme to get colors for
The "colors" array specifies a default color theme to get colors for
the data series from. You can specify as many colors as you like, like
the data series from. You can specify as many colors as you like, like
this:
this:
```
js
colors: ["#d18b2c", "#dba255", "#919733"]
colors
:
[
"#d18b2c"
,
"#dba255"
,
"#919733"
]
```
If there are more data series than colors, Flot will try to generate
If there are more data series than colors, Flot will try to generate
extra colors by lightening and darkening colors in the theme.
extra colors by lightening and darkening colors in the theme.
Customizing the grid
Customizing the grid
====================
====================
```js
grid: {
grid: {
show: boolean
show: boolean
aboveData: boolean
aboveData: boolean
color: color
color: color
backgroundColor: color/gradient or null
backgroundColor: color/gradient or null
margin: number or margin object
margin: number or margin object
labelMargin: number
labelMargin: number
axisMargin: number
axisMargin: number
markings: array of markings or (fn: axes -> array of markings)
markings: array of markings or (fn: axes -> array of markings)
borderWidth: number
borderWidth: number
borderColor: color or null
borderColor: color or null
minBorderMargin: number or null
minBorderMargin: number or null
clickable: boolean
clickable: boolean
hoverable: boolean
hoverable: boolean
autoHighlight: boolean
autoHighlight: boolean
mouseActiveRadius: number
mouseActiveRadius: number
}
}
interaction: {
interaction: {
redrawOverlayInterval: number or -1
redrawOverlayInterval: number or -1
}
}
```
The grid is the thing with the axes and a number of ticks. Many of the
The grid is the thing with the axes and a number of ticks. Many of the
things in the grid are configured under the individual axes, but not
things in the grid are configured under the individual axes, but not
all. "color" is the color of the grid itself whereas "backgroundColor"
all. "color" is the color of the grid itself whereas "backgroundColor"
...
@@ -741,14 +723,14 @@ above the data or below (below is default).
...
@@ -741,14 +723,14 @@ above the data or below (below is default).
"margin" is the space in pixels between the canvas edge and the grid,
"margin" is the space in pixels between the canvas edge and the grid,
which can be either a number or an object with individual margins for
which can be either a number or an object with individual margins for
each side, in the form:
each side, in the form:
```
js
margin: {
margin
:
{
top: top margin in pixels
top
:
top
margin
in
pixels
left: left margin in pixels
left
:
left
margin
in
pixels
bottom: bottom margin in pixels
bottom
:
bottom
margin
in
pixels
right: right margin in pixels
right
:
right
margin
in
pixels
}
}
```
"labelMargin" is the space in pixels between tick labels and axis
"labelMargin" is the space in pixels between tick labels and axis
line, and "axisMargin" is the space in pixels between axes when there
line, and "axisMargin" is the space in pixels between axes when there
are two next to each other.
are two next to each other.
...
@@ -770,30 +752,30 @@ the axes for the plot in an object as the first parameter.
...
@@ -770,30 +752,30 @@ the axes for the plot in an object as the first parameter.
You can set the color of markings by specifying "color" in the ranges
You can set the color of markings by specifying "color" in the ranges
object. Here's an example array:
object. Here's an example array:
```
js
markings: [ { xaxis: { from: 0, to: 2 }, yaxis: { from: 10, to: 10 }, color: "#bb0000" }, ... ]
markings
:
[
{
xaxis
:
{
from
:
0
,
to
:
2
},
yaxis
:
{
from
:
10
,
to
:
10
},
color
:
"#bb0000"
},
...
]
```
If you leave out one of the values, that value is assumed to go to the
If you leave out one of the values, that value is assumed to go to the
border of the plot. So for example if you only specify { xaxis: {
border of the plot. So for example if you only specify { xaxis: {
from: 0, to: 2 } } it means an area that extends from the top to the
from: 0, to: 2 } } it means an area that extends from the top to the
bottom of the plot in the x range 0-2.
bottom of the plot in the x range 0-2.
A line is drawn if from and to are the same, e.g.
A line is drawn if from and to are the same, e.g.
```
js
markings: [ { yaxis: { from: 1, to: 1 } }, ... ]
markings
:
[
{
yaxis
:
{
from
:
1
,
to
:
1
}
},
...
]
```
would draw a line parallel to the x axis at y = 1. You can control the
would draw a line parallel to the x axis at y = 1. You can control the
line width with "lineWidth" in the range object.
line width with "lineWidth" in the range object.
An example function that makes vertical stripes might look like this:
An example function that makes vertical stripes might look like this:
```
js
markings: function (axes) {
markings
:
function
(
axes
)
{
var markings = [];
var
markings
=
[];
for (var x = Math.floor(axes.xaxis.min); x < axes.xaxis.max; x += 2)
for
(
var
x
=
Math
.
floor
(
axes
.
xaxis
.
min
);
x
<
axes
.
xaxis
.
max
;
x
+=
2
)
markings.push({ xaxis: { from: x, to: x + 1 } });
markings
.
push
({
xaxis
:
{
from
:
x
,
to
:
x
+
1
}
});
return markings;
return
markings
;
}
}
```
If you set "clickable" to true, the plot will listen for click events
If you set "clickable" to true, the plot will listen for click events
on the plot area and fire a "plotclick" event on the placeholder with
on the plot area and fire a "plotclick" event on the placeholder with
...
@@ -809,34 +791,34 @@ If needed, you can disable highlighting and control it yourself with
...
@@ -809,34 +791,34 @@ If needed, you can disable highlighting and control it yourself with
the highlight/unhighlight plot methods described elsewhere.
the highlight/unhighlight plot methods described elsewhere.
You can use "plotclick" and "plothover" events like this:
You can use "plotclick" and "plothover" events like this:
```
js
$
.
plot
(
$
(
"#placeholder"
),
[
d
],
{
grid
:
{
clickable
:
true
}
});
$
.
plot
(
$
(
"#placeholder"
),
[
d
],
{
grid
:
{
clickable
:
true
}
});
$
(
"#placeholder"
).
bind
(
"plotclick"
,
function
(
event
,
pos
,
item
)
{
$
(
"#placeholder"
).
bind
(
"plotclick"
,
function
(
event
,
pos
,
item
)
{
alert("You clicked at " + pos.x + ", " + pos.y);
alert
(
"You clicked at "
+
pos
.
x
+
", "
+
pos
.
y
);
// axis coordinates for other axes, if present, are in pos.x2, pos.x3, ...
// axis coordinates for other axes, if present, are in pos.x2, pos.x3, ...
// if you need global screen coordinates, they are pos.pageX, pos.pageY
// if you need global screen coordinates, they are pos.pageX, pos.pageY
if (item) {
if
(
item
)
{
highlight(item.series, item.datapoint);
highlight
(
item
.
series
,
item
.
datapoint
);
alert("You clicked a point!");
alert
(
"You clicked a point!"
);
}
}
});
});
```
The item object in this example is either null or a nearby object on the form:
The item object in this example is either null or a nearby object on the form:
```
js
item: {
item
:
{
datapoint
:
the
point
,
e
.
g
.
[
0
,
2
]
datapoint
:
the
point
,
e
.
g
.
[
0
,
2
]
dataIndex
:
the
index
of
the
point
in
the
data
array
dataIndex
:
the
index
of
the
point
in
the
data
array
series
:
the
series
object
series
:
the
series
object
seriesIndex
:
the
index
of
the
series
seriesIndex
:
the
index
of
the
series
pageX
,
pageY
:
the
global
screen
coordinates
of
the
point
pageX
,
pageY
:
the
global
screen
coordinates
of
the
point
}
}
```
For instance, if you have specified the data like this
For instance, if you have specified the data like this
```
js
$
.
plot
(
$
(
"#placeholder"
),
[
{
label
:
"Foo"
,
data
:
[[
0
,
10
],
[
7
,
3
]]
}
],
...);
$
.
plot
(
$
(
"#placeholder"
),
[
{
label
:
"Foo"
,
data
:
[[
0
,
10
],
[
7
,
3
]]
}
],
...);
```
and the mouse is near the point (7, 3), "datapoint" is
[
7, 3
]
,
and the mouse is near the point (7, 3), "datapoint" is
[
7, 3
]
,
"dataIndex" will be 1, "series" is a normalized series object with
"dataIndex" will be 1, "series" is a normalized series object with
among other things the "Foo" label in series.label and the color in
among other things the "Foo" label in series.label and the color in
...
@@ -867,33 +849,33 @@ Specifying gradients
...
@@ -867,33 +849,33 @@ Specifying gradients
====================
====================
A gradient is specified like this:
A gradient is specified like this:
```
js
{ colors: [ color1, color2, ... ] }
{
colors
:
[
color1
,
color2
,
...
]
}
```
For instance, you might specify a background on the grid going from
For instance, you might specify a background on the grid going from
black to gray like this:
black to gray like this:
```
js
grid: {
grid
:
{
backgroundColor: { colors: ["#000", "#999"] }
backgroundColor
:
{
colors
:
[
"#000"
,
"#999"
]
}
}
}
```
For the series you can specify the gradient as an object that
For the series you can specify the gradient as an object that
specifies the scaling of the brightness and the opacity of the series
specifies the scaling of the brightness and the opacity of the series
color, e.g.
color, e.g.
```
js
{
colors
:
[{
opacity
:
0.8
},
{
brightness
:
0.6
,
opacity
:
0.8
}
]
}
{
colors
:
[{
opacity
:
0.8
},
{
brightness
:
0.6
,
opacity
:
0.8
}
]
}
```
where the first color simply has its alpha scaled, whereas the second
where the first color simply has its alpha scaled, whereas the second
is also darkened. For instance, for bars the following makes the bars
is also darkened. For instance, for bars the following makes the bars
gradually disappear, without outline:
gradually disappear, without outline:
```
js
bars: {
bars
:
{
show
:
true
,
show
:
true
,
lineWidth
:
0
,
lineWidth
:
0
,
fill
:
true
,
fill
:
true
,
fillColor
:
{
colors
:
[
{
opacity
:
0.8
},
{
opacity
:
0.1
}
]
}
fillColor
:
{
colors
:
[
{
opacity
:
0.8
},
{
opacity
:
0.1
}
]
}
}
}
```
Flot currently only supports vertical gradients drawn from top to
Flot currently only supports vertical gradients drawn from top to
bottom because that's what works with IE.
bottom because that's what works with IE.
...
@@ -977,8 +959,8 @@ can call:
...
@@ -977,8 +959,8 @@ can call:
space within the placeholder div. If you are working with multiple
space within the placeholder div. If you are working with multiple
axes, you can specify the x and y axis references, e.g.
axes, you can specify the x and y axis references, e.g.
o = pointOffset({ x: xpos, y: ypos, xaxis: 2, yaxis: 3 })
o = pointOffset({ x: xpos, y: ypos, xaxis: 2, yaxis: 3 })
// o.left and o.top now contains the offset within the div
// o.left and o.top now contains the offset within the div
-
resize()
-
resize()
...
@@ -1004,11 +986,11 @@ Flot to keep track of its state, so be careful.
...
@@ -1004,11 +986,11 @@ Flot to keep track of its state, so be careful.
form with missing settings filled in according to the global
form with missing settings filled in according to the global
options. So for instance to find out what color Flot has assigned
options. So for instance to find out what color Flot has assigned
to the data series, you could do this:
to the data series, you could do this:
```js
var series = plot.getData();
var series = plot.getData();
for (var i = 0; i < series.length; ++i)
for (var i = 0; i < series.length; ++i)
alert(series[i].color);
alert(series[i].color);
```
A notable other interesting field besides color is datapoints
A notable other interesting field besides color is datapoints
which has a field "points" with the normalized data points in a
which has a field "points" with the normalized data points in a
flat array (the field "pointsize" is the increment in the flat
flat array (the field "pointsize" is the increment in the flat
...
@@ -1095,14 +1077,14 @@ You can add them through the "hooks" option, and they are also available
...
@@ -1095,14 +1077,14 @@ You can add them through the "hooks" option, and they are also available
after the plot is constructed as the "hooks" attribute on the returned
after the plot is constructed as the "hooks" attribute on the returned
plot object, e.g.
plot object, e.g.
// define a simple draw hook
// define a simple draw hook
function hellohook(plot, canvascontext) { alert("hello!"); };
function hellohook(plot, canvascontext) { alert("hello!"); };
// pass it in, in an array since we might want to specify several
// pass it in, in an array since we might want to specify several
var plot = $.plot(placeholder, data, { hooks: { draw: [hellohook] } });
var plot = $.plot(placeholder, data, { hooks: { draw:
[
hellohook
]
} });
// we can now find it again in plot.hooks.draw[0] unless a plugin
// we can now find it again in plot.hooks.draw
[
0
]
unless a plugin
// has added other hooks
// has added other hooks
The available hooks are described below. All hook callbacks get the
The available hooks are described below. All hook callbacks get the
plot object as first parameter. You can find some examples of defined
plot object as first parameter. You can find some examples of defined
...
@@ -1132,12 +1114,12 @@ hooks in the plugins bundled with Flot.
...
@@ -1132,12 +1114,12 @@ hooks in the plugins bundled with Flot.
how it interferes with axis scaling.
how it interferes with axis scaling.
The default format array for points is something along the lines of:
The default format array for points is something along the lines of:
```
js
[
[
{ x: true, number: true, required: true },
{
x
:
true
,
number
:
true
,
required
:
true
},
{ y: true, number: true, required: true }
{
y
:
true
,
number
:
true
,
required
:
true
}
]
]
```
The first object means that for the first coordinate it should be
The first object means that for the first coordinate it should be
taken into account when scaling the x axis, that it must be a
taken into account when scaling the x axis, that it must be a
number, and that it is required - so if it is null or cannot be
number, and that it is required - so if it is null or cannot be
...
@@ -1149,22 +1131,22 @@ hooks in the plugins bundled with Flot.
...
@@ -1149,22 +1131,22 @@ hooks in the plugins bundled with Flot.
-
processDatapoints
[
phase 3
]
-
processDatapoints
[
phase 3
]
```
js
function
(
plot
,
series
,
datapoints
)
function
(
plot
,
series
,
datapoints
)
```
Called after normalization of the given series but before finding
Called after normalization of the given series but before finding
min/max of the data points. This hook is useful for implementing data
min/max of the data points. This hook is useful for implementing data
transformations. "datapoints" contains the normalized data points in
transformations. "datapoints" contains the normalized data points in
a flat array as datapoints.points with the size of a single point
a flat array as datapoints.points with the size of a single point
given in datapoints.pointsize. Here's a simple transform that
given in datapoints.pointsize. Here's a simple transform that
multiplies all y coordinates by 2:
multiplies all y coordinates by 2:
```
js
function multiply(plot, series, datapoints) {
function multiply(plot, series, datapoints) {
var points = datapoints.points, ps = datapoints.pointsize;
var points = datapoints.points, ps = datapoints.pointsize;
for (var i = 0; i < points.length; i += ps)
for (var i = 0; i < points.length; i += ps)
points[i + 1] *= 2;
points
[
i + 1
]
*
= 2;
}
}
```
Note that you must leave datapoints in a good condition as Flot
Note that you must leave datapoints in a good condition as Flot
doesn't check it or do any normalization on it afterwards.
doesn't check it or do any normalization on it afterwards.
...
@@ -1214,13 +1196,13 @@ hooks in the plugins bundled with Flot.
...
@@ -1214,13 +1196,13 @@ hooks in the plugins bundled with Flot.
Called after Flot has setup its event handlers. Should set any
Called after Flot has setup its event handlers. Should set any
necessary event handlers on eventHolder, a jQuery object with the
necessary event handlers on eventHolder, a jQuery object with the
canvas, e.g.
canvas, e.g.
```
js
function (plot, eventHolder) {
function (plot, eventHolder) {
eventHolder.mousedown(function (e) {
eventHolder.mousedown(function (e) {
alert("You pressed the mouse at " + e.pageX + " " + e.pageY);
alert("You pressed the mouse at " + e.pageX + " " + e.pageY);
});
});
}
}
```
Interesting events include click, mousemove, mouseup/down. You can
Interesting events include click, mousemove, mouseup/down. You can
use all jQuery events. Usually, the event handlers will update the
use all jQuery events. Usually, the event handlers will update the
state by drawing something (add a drawOverlay hook and call
state by drawing something (add a drawOverlay hook and call
...
@@ -1242,7 +1224,7 @@ hooks in the plugins bundled with Flot.
...
@@ -1242,7 +1224,7 @@ hooks in the plugins bundled with Flot.
-
drawOverlay
[
phase 7
]
-
drawOverlay
[
phase 7
]
function(plot, canvascontext)
function
(plot, canvascontext)
The drawOverlay hook is used for interactive things that need a
The drawOverlay hook is used for interactive things that need a
canvas to draw on. The model currently used by Flot works the way
canvas to draw on. The model currently used by Flot works the way
...
@@ -1259,7 +1241,7 @@ hooks in the plugins bundled with Flot.
...
@@ -1259,7 +1241,7 @@ hooks in the plugins bundled with Flot.
-
shutdown
[
phase 8
]
-
shutdown
[
phase 8
]
function(plot, eventHolder)
function
(plot, eventHolder)
Run when plot.shutdown() is called, which usually only happens in
Run when plot.shutdown() is called, which usually only happens in
case a plot is overwritten by a new plot. If you're writing a
case a plot is overwritten by a new plot. If you're writing a
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment