/doc/com/googlecode/charts4j/Line.html

http://charts4j.googlecode.com/ · HTML · 286 lines · 235 code · 31 blank · 20 comment · 0 complexity · ed64fde658f1c536efc490c490c636dd MD5 · raw file

  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!--NewPage-->
  3. <HTML>
  4. <HEAD>
  5. <!-- Generated by javadoc (build 1.5.0_16) on Tue May 19 12:59:31 MDT 2009 -->
  6. <TITLE>
  7. Line (charts4j - 1.2)
  8. </TITLE>
  9. <META NAME="keywords" CONTENT="com.googlecode.charts4j.Line interface">
  10. <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../stylesheet.css" TITLE="Style">
  11. <SCRIPT type="text/javascript">
  12. function windowTitle()
  13. {
  14. parent.document.title="Line (charts4j - 1.2)";
  15. }
  16. </SCRIPT>
  17. <NOSCRIPT>
  18. </NOSCRIPT>
  19. </HEAD>
  20. <BODY BGCOLOR="white" onload="windowTitle();">
  21. <!-- ========= START OF TOP NAVBAR ======= -->
  22. <A NAME="navbar_top"><!-- --></A>
  23. <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
  24. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  25. <TR>
  26. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  27. <A NAME="navbar_top_firstrow"><!-- --></A>
  28. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  29. <TR ALIGN="center" VALIGN="top">
  30. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  31. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/googlecode/charts4j/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  32. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  33. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  34. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  35. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  36. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  37. </TR>
  38. </TABLE>
  39. </TD>
  40. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  41. </EM>
  42. </TD>
  43. </TR>
  44. <TR>
  45. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  46. &nbsp;<A HREF="../../../com/googlecode/charts4j/LegendPosition.html" title="enum in com.googlecode.charts4j"><B>PREV CLASS</B></A>&nbsp;
  47. &nbsp;<A HREF="../../../com/googlecode/charts4j/LinearGradientFill.html" title="class in com.googlecode.charts4j"><B>NEXT CLASS</B></A></FONT></TD>
  48. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  49. <A HREF="../../../index.html?com/googlecode/charts4j/Line.html" target="_top"><B>FRAMES</B></A> &nbsp;
  50. &nbsp;<A HREF="Line.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  51. &nbsp;<SCRIPT type="text/javascript">
  52. <!--
  53. if(window==top) {
  54. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  55. }
  56. //-->
  57. </SCRIPT>
  58. <NOSCRIPT>
  59. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  60. </NOSCRIPT>
  61. </FONT></TD>
  62. </TR>
  63. <TR>
  64. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  65. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  66. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  67. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  68. </TR>
  69. </TABLE>
  70. <A NAME="skip-navbar_top"></A>
  71. <!-- ========= END OF TOP NAVBAR ========= -->
  72. <HR>
  73. <!-- ======== START OF CLASS DATA ======== -->
  74. <H2>
  75. <FONT SIZE="-1">
  76. com.googlecode.charts4j</FONT>
  77. <BR>
  78. Interface Line</H2>
  79. <HR>
  80. <DL>
  81. <DT><PRE>public interface <B>Line</B></DL>
  82. </PRE>
  83. <P>
  84. Encapsulates data and plot decorations that will be rendered in a
  85. <A HREF="../../../com/googlecode/charts4j/LineChart.html" title="class in com.googlecode.charts4j"><CODE>LineChart</CODE></A>. Construct with <A HREF="../../../com/googlecode/charts4j/Plots.html" title="class in com.googlecode.charts4j"><CODE>Plots</CODE></A> static factory class.
  86. <P>
  87. <P>
  88. <DL>
  89. <DT><B>Author:</B></DT>
  90. <DD>Julien Chastang (julien.c.chastang at gmail dot com)</DD>
  91. <DT><B>See Also:</B><DD><A HREF="../../../com/googlecode/charts4j/Data.html" title="class in com.googlecode.charts4j"><CODE>Data</CODE></A>,
  92. <A HREF="../../../com/googlecode/charts4j/DataUtil.html" title="class in com.googlecode.charts4j"><CODE>DataUtil</CODE></A>,
  93. <A HREF="../../../com/googlecode/charts4j/LineChart.html" title="class in com.googlecode.charts4j"><CODE>LineChart</CODE></A></DL>
  94. <HR>
  95. <P>
  96. <!-- ========== METHOD SUMMARY =========== -->
  97. <A NAME="method_summary"><!-- --></A>
  98. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  99. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  100. <TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
  101. <B>Method Summary</B></FONT></TH>
  102. </TR>
  103. <TR BGCOLOR="white" CLASS="TableRowColor">
  104. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  105. <CODE>&nbsp;void</CODE></FONT></TD>
  106. <TD><CODE><B><A HREF="../../../com/googlecode/charts4j/Line.html#setFillAreaColor(com.googlecode.charts4j.Color)">setFillAreaColor</A></B>(<A HREF="../../../com/googlecode/charts4j/Color.html" title="class in com.googlecode.charts4j">Color</A>&nbsp;color)</CODE>
  107. <BR>
  108. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Define a fill area color below this plot.</TD>
  109. </TR>
  110. <TR BGCOLOR="white" CLASS="TableRowColor">
  111. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  112. <CODE>&nbsp;void</CODE></FONT></TD>
  113. <TD><CODE><B><A HREF="../../../com/googlecode/charts4j/Line.html#setLineStyle(com.googlecode.charts4j.LineStyle)">setLineStyle</A></B>(<A HREF="../../../com/googlecode/charts4j/LineStyle.html" title="class in com.googlecode.charts4j">LineStyle</A>&nbsp;lineStyle)</CODE>
  114. <BR>
  115. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the line style.</TD>
  116. </TR>
  117. <TR BGCOLOR="white" CLASS="TableRowColor">
  118. <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
  119. <CODE>&nbsp;void</CODE></FONT></TD>
  120. <TD><CODE><B><A HREF="../../../com/googlecode/charts4j/Line.html#setPriority(com.googlecode.charts4j.Priority)">setPriority</A></B>(<A HREF="../../../com/googlecode/charts4j/Priority.html" title="enum in com.googlecode.charts4j">Priority</A>&nbsp;priority)</CODE>
  121. <BR>
  122. &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Set the priority.</TD>
  123. </TR>
  124. </TABLE>
  125. &nbsp;<A NAME="methods_inherited_from_class_com.googlecode.charts4j.Plot"><!-- --></A>
  126. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  127. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  128. <TH ALIGN="left"><B>Methods inherited from interface com.googlecode.charts4j.<A HREF="../../../com/googlecode/charts4j/Plot.html" title="interface in com.googlecode.charts4j">Plot</A></B></TH>
  129. </TR>
  130. <TR BGCOLOR="white" CLASS="TableRowColor">
  131. <TD><CODE><A HREF="../../../com/googlecode/charts4j/Plot.html#addMarker(com.googlecode.charts4j.Marker, int)">addMarker</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addMarkers(com.googlecode.charts4j.Marker)">addMarkers</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addMarkers(com.googlecode.charts4j.Marker, int)">addMarkers</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addMarkers(com.googlecode.charts4j.Marker, int, int)">addMarkers</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addMarkers(com.googlecode.charts4j.Marker, int, int, int)">addMarkers</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addShapeMarker(com.googlecode.charts4j.Shape, com.googlecode.charts4j.Color, int, int)">addShapeMarker</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addShapeMarkers(com.googlecode.charts4j.Shape, com.googlecode.charts4j.Color, int)">addShapeMarkers</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#addTextMarker(java.lang.String, com.googlecode.charts4j.Color, int, int)">addTextMarker</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#setColor(com.googlecode.charts4j.Color)">setColor</A>, <A HREF="../../../com/googlecode/charts4j/Plot.html#setLegend(java.lang.String)">setLegend</A></CODE></TD>
  132. </TR>
  133. </TABLE>
  134. &nbsp;<A NAME="methods_inherited_from_class_com.googlecode.charts4j.Kloneable"><!-- --></A>
  135. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  136. <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
  137. <TH ALIGN="left"><B>Methods inherited from interface com.googlecode.charts4j.<A HREF="../../../com/googlecode/charts4j/Kloneable.html" title="interface in com.googlecode.charts4j">Kloneable</A></B></TH>
  138. </TR>
  139. <TR BGCOLOR="white" CLASS="TableRowColor">
  140. <TD><CODE><A HREF="../../../com/googlecode/charts4j/Kloneable.html#klone()">klone</A></CODE></TD>
  141. </TR>
  142. </TABLE>
  143. &nbsp;
  144. <P>
  145. <!-- ============ METHOD DETAIL ========== -->
  146. <A NAME="method_detail"><!-- --></A>
  147. <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
  148. <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
  149. <TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
  150. <B>Method Detail</B></FONT></TH>
  151. </TR>
  152. </TABLE>
  153. <A NAME="setLineStyle(com.googlecode.charts4j.LineStyle)"><!-- --></A><H3>
  154. setLineStyle</H3>
  155. <PRE>
  156. void <B>setLineStyle</B>(<A HREF="../../../com/googlecode/charts4j/LineStyle.html" title="class in com.googlecode.charts4j">LineStyle</A>&nbsp;lineStyle)</PRE>
  157. <DL>
  158. <DD>Set the line style.
  159. <P>
  160. <DD><DL>
  161. </DL>
  162. </DD>
  163. <DD><DL>
  164. <DT><B>Parameters:</B><DD><CODE>lineStyle</CODE> - The line style to set. Cannot be null.</DL>
  165. </DD>
  166. </DL>
  167. <HR>
  168. <A NAME="setPriority(com.googlecode.charts4j.Priority)"><!-- --></A><H3>
  169. setPriority</H3>
  170. <PRE>
  171. void <B>setPriority</B>(<A HREF="../../../com/googlecode/charts4j/Priority.html" title="enum in com.googlecode.charts4j">Priority</A>&nbsp;priority)</PRE>
  172. <DL>
  173. <DD>Set the priority.
  174. <P>
  175. <DD><DL>
  176. </DL>
  177. </DD>
  178. <DD><DL>
  179. <DT><B>Parameters:</B><DD><CODE>priority</CODE> - for this plot. Cannot be null.</DL>
  180. </DD>
  181. </DL>
  182. <HR>
  183. <A NAME="setFillAreaColor(com.googlecode.charts4j.Color)"><!-- --></A><H3>
  184. setFillAreaColor</H3>
  185. <PRE>
  186. void <B>setFillAreaColor</B>(<A HREF="../../../com/googlecode/charts4j/Color.html" title="class in com.googlecode.charts4j">Color</A>&nbsp;color)</PRE>
  187. <DL>
  188. <DD>Define a fill area color below this plot. Order is important! If you have
  189. multiple plots, you may have your fill areas obscure each other. You may
  190. have to experiment to get the result you want.
  191. <P>
  192. <DD><DL>
  193. </DL>
  194. </DD>
  195. <DD><DL>
  196. <DT><B>Parameters:</B><DD><CODE>color</CODE> - The color of the fill area that will appear below this
  197. particular plot. cannot be null.</DL>
  198. </DD>
  199. </DL>
  200. <!-- ========= END OF CLASS DATA ========= -->
  201. <HR>
  202. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  203. <A NAME="navbar_bottom"><!-- --></A>
  204. <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
  205. <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
  206. <TR>
  207. <TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
  208. <A NAME="navbar_bottom_firstrow"><!-- --></A>
  209. <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
  210. <TR ALIGN="center" VALIGN="top">
  211. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
  212. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../com/googlecode/charts4j/package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
  213. <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
  214. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
  215. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
  216. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
  217. <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
  218. </TR>
  219. </TABLE>
  220. </TD>
  221. <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
  222. </EM>
  223. </TD>
  224. </TR>
  225. <TR>
  226. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  227. &nbsp;<A HREF="../../../com/googlecode/charts4j/LegendPosition.html" title="enum in com.googlecode.charts4j"><B>PREV CLASS</B></A>&nbsp;
  228. &nbsp;<A HREF="../../../com/googlecode/charts4j/LinearGradientFill.html" title="class in com.googlecode.charts4j"><B>NEXT CLASS</B></A></FONT></TD>
  229. <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
  230. <A HREF="../../../index.html?com/googlecode/charts4j/Line.html" target="_top"><B>FRAMES</B></A> &nbsp;
  231. &nbsp;<A HREF="Line.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
  232. &nbsp;<SCRIPT type="text/javascript">
  233. <!--
  234. if(window==top) {
  235. document.writeln('<A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>');
  236. }
  237. //-->
  238. </SCRIPT>
  239. <NOSCRIPT>
  240. <A HREF="../../../allclasses-noframe.html"><B>All Classes</B></A>
  241. </NOSCRIPT>
  242. </FONT></TD>
  243. </TR>
  244. <TR>
  245. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  246. SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
  247. <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
  248. DETAIL:&nbsp;FIELD&nbsp;|&nbsp;CONSTR&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
  249. </TR>
  250. </TABLE>
  251. <A NAME="skip-navbar_bottom"></A>
  252. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  253. <HR>
  254. </BODY>
  255. </HTML>