summaryrefslogtreecommitdiff
path: root/doc/lib/index.html
blob: 4fdfbca68f7b5579d467604a105a814684bc0bbd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
	<META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=utf-8">
	<TITLE>javascriptRRD libraries</TITLE>
	<META NAME="GENERATOR" CONTENT="OpenOffice.org 3.0  (Linux)">
	<META NAME="CREATED" CONTENT="0;0">
	<META NAME="CHANGED" CONTENT="20090209;19413900">
	<STYLE TYPE="text/css">
	<!--
		@page { margin: 0.79in }
		H1 { margin-bottom: 0.08in }
		H1.western { font-family: "Liberation Sans", sans-serif; font-size: 22pt }
		P { margin-bottom: 0.08in }
		A:link { so-language: zxx }
	-->
	</STYLE>
</HEAD>
<BODY LANG="en-US" DIR="LTR">
<H1 CLASS="western">javascriptRRD libraries</H1>
<P>The javascriptRRD package contains base three javascript modules:</P>
<UL>
	<LI><P>The <A HREF="rrdFile_js.html">rrdFile module</A>, used to
	extract information from <A HREF="http://oss.oetiker.ch/rrdtool/">RRD
	archives</A> loaded as binary file objects.</P>
        <LI><P>The <A HREF="rrdMultiFile_js.html">rrdMultiFile module</A>, 
        used to combine many rrdFile objects.</P>
	<LI><P>The <A HREF="binaryXHR_js.html">binaryXHR module</A>, used to
	retrieve binary files using the <A HREF="http://en.wikipedia.org/wiki/XMLHttpRequest">XMLHttpRequest</A>
	API.</P>
</UL>
<P>Together they can be used to implement AJAX style applications.</P>

<P> The <A HREF="rrdFilter_js.html">rrdFilter module</A> can be used to filter datasources (DSs) and apply user-customized filter objects such as mathematical operations. This module also has methods to Filter RRAs for time shifts (for timezone implementation) and/or Averaging (for creating new, averaged RRAs with different step sizes). See the <A HREF="../../src/examples/rrdJFlotFilter.html">rrdJFlotFilter.html (DS Filters) example</A> and the <A HREF="../../src/examples/rrdJFlotFilterRRA.html">rrdJFlotFilterRRA (RRA Filters) example</A>.</P>

<P>The package also provides two classes, based on
   <A HREF="http://www.flotcharts.org/">Flot</A>,
   that automate most of the graphing needs:</P>
<UL>
	<LI><P>The <A HREF="rrdFlot_js.html">rrdFlot module</A> can be used to plot a single RRD file.<BR>
               See also the <A HREF="../../src/examples/rrdJFlot.html">rrdJFlot.html example</A> and the <A HREF="../../src/examples/rrdJFlotDefaults.html">same graph with all rrdflot_defaults available options shown.</A></P>
	<LI><P>The <A HREF="rrdFlotMatrix_js.html">rrdFlotMatrix module</A> can be used to plot a list of RRD files.<BR>
               See also the <A HREF="../../src/examples/rrdMatrixFlot.html">rrdMatrixFlot.html example</A>.</P>

        <LI><P>More examples can be found on the
               <A HREF="../../src/examples/index.html">examples web page</a>, with mode helpful comments in the code.</P>
</UL>

<TABLE WIDTH=50% CELLPADDING=2 CELLSPACING=2>
        <TR>
                <TD>
                        <HR>
                        <P>The javascriptRRD package
                        is hosted at <A HREF="http://javascriptrrd.sourceforge.net/">http://javascriptrrd.sourceforge.net</A>.
                        <BR>It is licensed under the <A HREF="http://www.opensource.org/licenses/mit-license.php">MIT
                        license</A>.
                        </P>
                        <HR>
                </TD>
        </TR>
</TABLE>

</BODY>
</HTML>