summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorFrank Wuerthwein <fkw@ucsd.edu>2009-02-13 00:39:48 +0000
committerFrank Wuerthwein <fkw@ucsd.edu>2009-02-13 00:39:48 +0000
commit29e18aa39b34621813edb730875ea607fbace789 (patch)
tree3963fc05bf1e561e9ff5bfe1390a7713d7525d0d /doc
parent6abeb8fd73ee84b36b0d9b52c778c7b5046a4d2e (diff)
Document changes in the interface
Diffstat (limited to 'doc')
-rw-r--r--doc/lib/rrdFile_js.html16
1 files changed, 9 insertions, 7 deletions
diff --git a/doc/lib/rrdFile_js.html b/doc/lib/rrdFile_js.html
index 8283cf5..ba8991e 100644
--- a/doc/lib/rrdFile_js.html
+++ b/doc/lib/rrdFile_js.html
@@ -114,23 +114,25 @@ thrown.</P>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
- <P>getDS(n)</P>
+ <P>getDSNames()</P>
</TD>
<TD WIDTH=80%>
- <P>Return an object of type <A HREF="#RRDDS">RRDDS</A> holding
- the information about the n-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
- Source</A>.</P>
+ <P>Return the names of the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Sources</A> present in the RRD file.
+ </P>
</TD>
</TR>
<TR VALIGN=TOP>
<TD WIDTH=20%>
- <P>getDSbyName(name)</P>
+ <P>getDS(id)</P>
</TD>
<TD WIDTH=80%>
- <P>Return an object of type <A HREF="#RRDDS">RRDDS</A> holding
+ <P>If id is a number, return an object of type <A HREF="#RRDDS">RRDDS</A> holding
+ the information about the id-th <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
+ Source</A>.</P>
+ <P>If id is a string, return an object of type <A HREF="#RRDDS">RRDDS</A> holding
the information about the <A HREF="http://oss.oetiker.ch/rrdtool/doc/rrdcreate.en.html#IDS_ds_name_DST_dst_arguments">Data
Source</A> with the requested name.</P>
- <P>If no DS has such name, <I>undefined</I> is returned.</P>
</TD>
</TR>
<TR VALIGN=TOP>