Commit 877db70f authored by Adam Mckaig's avatar Adam Mckaig

Rename README to markdown.

parent 1a99246c
About About
----- -----
Flot is a Javascript plotting library for jQuery. Read more at the Flot is a Javascript plotting library for jQuery.
website: Read more at the website: <http://code.google.com/p/flot/>
http://code.google.com/p/flot/
Take a look at the examples linked from above, they should give a good Take a look at the examples linked from above, they should give a good
impression of what Flot can do and the source code of the examples is impression of what Flot can do and the source code of the examples is
...@@ -19,21 +17,22 @@ Just include the Javascript file after you've included jQuery. ...@@ -19,21 +17,22 @@ Just include the Javascript file after you've included jQuery.
Generally, all browsers that support the HTML5 canvas tag are Generally, all browsers that support the HTML5 canvas tag are
supported. supported.
For support for Internet Explorer < 9, you can use Excanvas, a canvas For support for Internet Explorer < 9, you can use [Excanvas]
emulator; this is used in the examples bundled with Flot. You just [excanvas], a canvas emulator; this is used in the examples bundled
include the excanvas script like this: with Flot. You just include the excanvas script like this:
<!--[if lte IE 8]><script language="javascript" type="text/javascript" src="excanvas.min.js"></script><![endif]--> ```html
<!--[if lte IE 8]><script language="javascript" type="text/javascript" src="excanvas.min.js"></script><![endif]-->
```
If it's not working on your development IE 6.0, check that it has If it's not working on your development IE 6.0, check that it has
support for VML which Excanvas is relying on. It appears that some support for VML which Excanvas is relying on. It appears that some
stripped down versions used for test environments on virtual machines stripped down versions used for test environments on virtual machines
lack the VML support. lack the VML support.
You can also try using Flashcanvas (see You can also try using [Flashcanvas] [flashcanvas], which uses Flash to
http://code.google.com/p/flashcanvas/), which uses Flash to do the do the emulation. Although Flash can be a bit slower to load than VML,
emulation. Although Flash can be a bit slower to load than VML, if if you've got a lot of points, the Flash version can be much faster
you've got a lot of points, the Flash version can be much faster
overall. Flot contains some wrapper code for activating Excanvas which overall. Flot contains some wrapper code for activating Excanvas which
Flashcanvas is compatible with. Flashcanvas is compatible with.
...@@ -46,13 +45,17 @@ Basic usage ...@@ -46,13 +45,17 @@ Basic usage
Create a placeholder div to put the graph in: Create a placeholder div to put the graph in:
<div id="placeholder"></div> ```html
<div id="placeholder"></div>
```
You need to set the width and height of this div, otherwise the plot You need to set the width and height of this div, otherwise the plot
library doesn't know how to scale the graph. You can do it inline like library doesn't know how to scale the graph. You can do it inline like
this: this:
<div id="placeholder" style="width:600px;height:300px"></div> ```html
<div id="placeholder" style="width:600px;height:300px"></div>
```
You can also do it with an external stylesheet. Make sure that the You can also do it with an external stylesheet. Make sure that the
placeholder isn't within something with a display:none CSS property - placeholder isn't within something with a display:none CSS property -
...@@ -63,15 +66,19 @@ placeholder dimensions which is fatal (it'll throw an exception). ...@@ -63,15 +66,19 @@ placeholder dimensions which is fatal (it'll throw an exception).
Then when the div is ready in the DOM, which is usually on document Then when the div is ready in the DOM, which is usually on document
ready, run the plot function: ready, run the plot function:
$.plot($("#placeholder"), data, options); ```js
$.plot($("#placeholder"), data, options);
```
Here, data is an array of data series and options is an object with Here, data is an array of data series and options is an object with
settings if you want to customize the plot. Take a look at the settings if you want to customize the plot. Take a look at the
examples for some ideas of what to put in or look at the reference examples for some ideas of what to put in or look at the reference
in the file "API.txt". Here's a quick example that'll draw a line from in the file `API.txt`. Here's a quick example that'll draw a line from
(0, 0) to (1, 1): (0, 0) to (1, 1):
$.plot($("#placeholder"), [ [[0, 0], [1, 1]] ], { yaxis: { max: 1 } }); ```js
$.plot($("#placeholder"), [ [[0, 0], [1, 1]] ], { yaxis: { max: 1 } });
```
The plot function immediately draws the chart and then returns a plot The plot function immediately draws the chart and then returns a plot
object with a couple of methods. object with a couple of methods.
...@@ -88,3 +95,6 @@ And if you look up "flot" in a Danish-to-English dictionary, some up ...@@ -88,3 +95,6 @@ And if you look up "flot" in a Danish-to-English dictionary, some up
the words that come up are "good-looking", "attractive", "stylish", the words that come up are "good-looking", "attractive", "stylish",
"smart", "impressive", "extravagant". One of the main goals with Flot "smart", "impressive", "extravagant". One of the main goals with Flot
is pretty looks. is pretty looks.
[excanvas]: http://code.google.com/p/explorercanvas/
[flashcanvas]: http://code.google.com/p/flashcanvas/
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