XYSeriesLabelGenerator.html 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244
  1. <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
  2. <!-- NewPage -->
  3. <html lang="en">
  4. <head>
  5. <!-- Generated by javadoc (1.8.0_05) on Thu Jul 31 14:50:31 CEST 2014 -->
  6. <title>XYSeriesLabelGenerator (JFreeChart Class Library (version 1.0.19-fx))</title>
  7. <meta name="date" content="2014-07-31">
  8. <link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
  9. <script type="text/javascript" src="../../../../script.js"></script>
  10. </head>
  11. <body>
  12. <script type="text/javascript"><!--
  13. try {
  14. if (location.href.indexOf('is-external=true') == -1) {
  15. parent.document.title="XYSeriesLabelGenerator (JFreeChart Class Library (version 1.0.19-fx))";
  16. }
  17. }
  18. catch(err) {
  19. }
  20. //-->
  21. var methods = {"i0":6};
  22. var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
  23. var altColor = "altColor";
  24. var rowColor = "rowColor";
  25. var tableTab = "tableTab";
  26. var activeTableTab = "activeTableTab";
  27. </script>
  28. <noscript>
  29. <div>JavaScript is disabled on your browser.</div>
  30. </noscript>
  31. <!-- ========= START OF TOP NAVBAR ======= -->
  32. <div class="topNav"><a name="navbar.top">
  33. <!-- -->
  34. </a>
  35. <div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
  36. <a name="navbar.top.firstrow">
  37. <!-- -->
  38. </a>
  39. <ul class="navList" title="Navigation">
  40. <li><a href="../../../../overview-summary.html">Overview</a></li>
  41. <li><a href="package-summary.html">Package</a></li>
  42. <li class="navBarCell1Rev">Class</li>
  43. <li><a href="class-use/XYSeriesLabelGenerator.html">Use</a></li>
  44. <li><a href="package-tree.html">Tree</a></li>
  45. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  46. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  47. <li><a href="../../../../help-doc.html">Help</a></li>
  48. </ul>
  49. </div>
  50. <div class="subNav">
  51. <ul class="navList">
  52. <li><a href="../../../../org/jfree/chart/labels/XYItemLabelGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  53. <li><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  54. </ul>
  55. <ul class="navList">
  56. <li><a href="../../../../index.html?org/jfree/chart/labels/XYSeriesLabelGenerator.html" target="_top">Frames</a></li>
  57. <li><a href="XYSeriesLabelGenerator.html" target="_top">No&nbsp;Frames</a></li>
  58. </ul>
  59. <ul class="navList" id="allclasses_navbar_top">
  60. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  61. </ul>
  62. <div>
  63. <script type="text/javascript"><!--
  64. allClassesLink = document.getElementById("allclasses_navbar_top");
  65. if(window==top) {
  66. allClassesLink.style.display = "block";
  67. }
  68. else {
  69. allClassesLink.style.display = "none";
  70. }
  71. //-->
  72. </script>
  73. </div>
  74. <div>
  75. <ul class="subNavList">
  76. <li>Summary:&nbsp;</li>
  77. <li>Nested&nbsp;|&nbsp;</li>
  78. <li>Field&nbsp;|&nbsp;</li>
  79. <li>Constr&nbsp;|&nbsp;</li>
  80. <li><a href="#method.summary">Method</a></li>
  81. </ul>
  82. <ul class="subNavList">
  83. <li>Detail:&nbsp;</li>
  84. <li>Field&nbsp;|&nbsp;</li>
  85. <li>Constr&nbsp;|&nbsp;</li>
  86. <li><a href="#method.detail">Method</a></li>
  87. </ul>
  88. </div>
  89. <a name="skip.navbar.top">
  90. <!-- -->
  91. </a></div>
  92. <!-- ========= END OF TOP NAVBAR ========= -->
  93. <!-- ======== START OF CLASS DATA ======== -->
  94. <div class="header">
  95. <div class="subTitle">org.jfree.chart.labels</div>
  96. <h2 title="Interface XYSeriesLabelGenerator" class="title">Interface XYSeriesLabelGenerator</h2>
  97. </div>
  98. <div class="contentContainer">
  99. <div class="description">
  100. <ul class="blockList">
  101. <li class="blockList">
  102. <dl>
  103. <dt>All Known Implementing Classes:</dt>
  104. <dd><a href="../../../../org/jfree/chart/labels/MultipleXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels">MultipleXYSeriesLabelGenerator</a>, <a href="../../../../org/jfree/chart/labels/StandardXYSeriesLabelGenerator.html" title="class in org.jfree.chart.labels">StandardXYSeriesLabelGenerator</a></dd>
  105. </dl>
  106. <hr>
  107. <br>
  108. <pre>public interface <a href="../../../../src-html/org/jfree/chart/labels/XYSeriesLabelGenerator.html#line.55">XYSeriesLabelGenerator</a></pre>
  109. <div class="block">A generator that creates labels for the series in an <a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy"><code>XYDataset</code></a>.
  110. <P>
  111. Classes that implement this interface should be either (a) immutable, or
  112. (b) cloneable via the <code>PublicCloneable</code> interface (defined in
  113. the JCommon class library). This provides a mechanism for the referring
  114. renderer to clone the generator if necessary.</div>
  115. </li>
  116. </ul>
  117. </div>
  118. <div class="summary">
  119. <ul class="blockList">
  120. <li class="blockList">
  121. <!-- ========== METHOD SUMMARY =========== -->
  122. <ul class="blockList">
  123. <li class="blockList"><a name="method.summary">
  124. <!-- -->
  125. </a>
  126. <h3>Method Summary</h3>
  127. <table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
  128. <caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
  129. <tr>
  130. <th class="colFirst" scope="col">Modifier and Type</th>
  131. <th class="colLast" scope="col">Method and Description</th>
  132. </tr>
  133. <tr id="i0" class="altColor">
  134. <td class="colFirst"><code>java.lang.String</code></td>
  135. <td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/jfree/chart/labels/XYSeriesLabelGenerator.html#generateLabel-org.jfree.data.xy.XYDataset-int-">generateLabel</a></span>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  136. int&nbsp;series)</code>
  137. <div class="block">Generates a label for the specified series.</div>
  138. </td>
  139. </tr>
  140. </table>
  141. </li>
  142. </ul>
  143. </li>
  144. </ul>
  145. </div>
  146. <div class="details">
  147. <ul class="blockList">
  148. <li class="blockList">
  149. <!-- ============ METHOD DETAIL ========== -->
  150. <ul class="blockList">
  151. <li class="blockList"><a name="method.detail">
  152. <!-- -->
  153. </a>
  154. <h3>Method Detail</h3>
  155. <a name="generateLabel-org.jfree.data.xy.XYDataset-int-">
  156. <!-- -->
  157. </a>
  158. <ul class="blockListLast">
  159. <li class="blockList">
  160. <h4>generateLabel</h4>
  161. <pre>java.lang.String&nbsp;<a href="../../../../src-html/org/jfree/chart/labels/XYSeriesLabelGenerator.html#line.66">generateLabel</a>(<a href="../../../../org/jfree/data/xy/XYDataset.html" title="interface in org.jfree.data.xy">XYDataset</a>&nbsp;dataset,
  162. int&nbsp;series)</pre>
  163. <div class="block">Generates a label for the specified series. This label will be
  164. used for the chart legend.</div>
  165. <dl>
  166. <dt><span class="paramLabel">Parameters:</span></dt>
  167. <dd><code>dataset</code> - the dataset (<code>null</code> not permitted).</dd>
  168. <dd><code>series</code> - the series.</dd>
  169. <dt><span class="returnLabel">Returns:</span></dt>
  170. <dd>A series label.</dd>
  171. </dl>
  172. </li>
  173. </ul>
  174. </li>
  175. </ul>
  176. </li>
  177. </ul>
  178. </div>
  179. </div>
  180. <!-- ========= END OF CLASS DATA ========= -->
  181. <!-- ======= START OF BOTTOM NAVBAR ====== -->
  182. <div class="bottomNav"><a name="navbar.bottom">
  183. <!-- -->
  184. </a>
  185. <div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
  186. <a name="navbar.bottom.firstrow">
  187. <!-- -->
  188. </a>
  189. <ul class="navList" title="Navigation">
  190. <li><a href="../../../../overview-summary.html">Overview</a></li>
  191. <li><a href="package-summary.html">Package</a></li>
  192. <li class="navBarCell1Rev">Class</li>
  193. <li><a href="class-use/XYSeriesLabelGenerator.html">Use</a></li>
  194. <li><a href="package-tree.html">Tree</a></li>
  195. <li><a href="../../../../deprecated-list.html">Deprecated</a></li>
  196. <li><a href="../../../../index-files/index-1.html">Index</a></li>
  197. <li><a href="../../../../help-doc.html">Help</a></li>
  198. </ul>
  199. </div>
  200. <div class="subNav">
  201. <ul class="navList">
  202. <li><a href="../../../../org/jfree/chart/labels/XYItemLabelGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
  203. <li><a href="../../../../org/jfree/chart/labels/XYToolTipGenerator.html" title="interface in org.jfree.chart.labels"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
  204. </ul>
  205. <ul class="navList">
  206. <li><a href="../../../../index.html?org/jfree/chart/labels/XYSeriesLabelGenerator.html" target="_top">Frames</a></li>
  207. <li><a href="XYSeriesLabelGenerator.html" target="_top">No&nbsp;Frames</a></li>
  208. </ul>
  209. <ul class="navList" id="allclasses_navbar_bottom">
  210. <li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
  211. </ul>
  212. <div>
  213. <script type="text/javascript"><!--
  214. allClassesLink = document.getElementById("allclasses_navbar_bottom");
  215. if(window==top) {
  216. allClassesLink.style.display = "block";
  217. }
  218. else {
  219. allClassesLink.style.display = "none";
  220. }
  221. //-->
  222. </script>
  223. </div>
  224. <div>
  225. <ul class="subNavList">
  226. <li>Summary:&nbsp;</li>
  227. <li>Nested&nbsp;|&nbsp;</li>
  228. <li>Field&nbsp;|&nbsp;</li>
  229. <li>Constr&nbsp;|&nbsp;</li>
  230. <li><a href="#method.summary">Method</a></li>
  231. </ul>
  232. <ul class="subNavList">
  233. <li>Detail:&nbsp;</li>
  234. <li>Field&nbsp;|&nbsp;</li>
  235. <li>Constr&nbsp;|&nbsp;</li>
  236. <li><a href="#method.detail">Method</a></li>
  237. </ul>
  238. </div>
  239. <a name="skip.navbar.bottom">
  240. <!-- -->
  241. </a></div>
  242. <!-- ======== END OF BOTTOM NAVBAR ======= -->
  243. </body>
  244. </html>