Terminal.Gui.Graphs.MultiBarSeries.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340
  1. <!DOCTYPE html>
  2. <!--[if IE]><![endif]-->
  3. <html>
  4. <head>
  5. <meta charset="utf-8">
  6. <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
  7. <title>Class MultiBarSeries
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class MultiBarSeries
  11. ">
  12. <meta name="generator" content="docfx 2.59.2.0">
  13. <link rel="shortcut icon" href="../../favicon.ico">
  14. <link rel="stylesheet" href="../../styles/docfx.vendor.css">
  15. <link rel="stylesheet" href="../../styles/docfx.css">
  16. <link rel="stylesheet" href="../../styles/main.css">
  17. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Graphs.MultiBarSeries">
  73. <h1 id="Terminal_Gui_Graphs_MultiBarSeries" data-uid="Terminal.Gui.Graphs.MultiBarSeries" class="text-break">Class MultiBarSeries
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Collection of <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html">BarSeries</a> in which bars are clustered by category
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><span class="xref">MultiBarSeries</span></div>
  83. </div>
  84. <div classs="implements">
  85. <h5>Implements</h5>
  86. <div><a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a></div>
  87. </div>
  88. <div class="inheritedMembers">
  89. <h5>Inherited Members</h5>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetHashCode()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.GetType()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.MemberwiseClone()</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  107. </div>
  108. <div>
  109. <span class="xref">System.Object.ToString()</span>
  110. </div>
  111. </div>
  112. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
  113. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  114. <h5 id="Terminal_Gui_Graphs_MultiBarSeries_syntax">Syntax</h5>
  115. <div class="codewrapper">
  116. <pre><code class="lang-csharp hljs">public class MultiBarSeries : ISeries</code></pre>
  117. </div>
  118. <h3 id="constructors">Constructors
  119. </h3>
  120. <a id="Terminal_Gui_Graphs_MultiBarSeries__ctor_" data-uid="Terminal.Gui.Graphs.MultiBarSeries.#ctor*"></a>
  121. <h4 id="Terminal_Gui_Graphs_MultiBarSeries__ctor_System_Int32_System_Single_System_Single_Terminal_Gui_Attribute___" data-uid="Terminal.Gui.Graphs.MultiBarSeries.#ctor(System.Int32,System.Single,System.Single,Terminal.Gui.Attribute[])">MultiBarSeries(Int32, Single, Single, Attribute[])</h4>
  122. <div class="markdown level1 summary">
  123. Creates a new series of clustered bars.
  124. </div>
  125. <div class="markdown level1 conceptual"></div>
  126. <h5 class="decalaration">Declaration</h5>
  127. <div class="codewrapper">
  128. <pre><code class="lang-csharp hljs">public MultiBarSeries(int numberOfBarsPerCategory, float barsEvery, float spacing, Attribute[] colors = null)</code></pre>
  129. </div>
  130. <h5 class="parameters">Parameters</h5>
  131. <table class="table table-bordered table-striped table-condensed">
  132. <thead>
  133. <tr>
  134. <th>Type</th>
  135. <th>Name</th>
  136. <th>Description</th>
  137. </tr>
  138. </thead>
  139. <tbody>
  140. <tr>
  141. <td><span class="xref">System.Int32</span></td>
  142. <td><span class="parametername">numberOfBarsPerCategory</span></td>
  143. <td>Each category has this many bars</td>
  144. </tr>
  145. <tr>
  146. <td><span class="xref">System.Single</span></td>
  147. <td><span class="parametername">barsEvery</span></td>
  148. <td>How far appart to put each category (in graph space)</td>
  149. </tr>
  150. <tr>
  151. <td><span class="xref">System.Single</span></td>
  152. <td><span class="parametername">spacing</span></td>
  153. <td>How much spacing between bars in a category (should be less than <code data-dev-comment-type="paramref" class="paramref">barsEvery</code>/<code data-dev-comment-type="paramref" class="paramref">numberOfBarsPerCategory</code>)</td>
  154. </tr>
  155. <tr>
  156. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>[]</td>
  157. <td><span class="parametername">colors</span></td>
  158. <td>Array of colors that define bar color in each category. Length must match <code data-dev-comment-type="paramref" class="paramref">numberOfBarsPerCategory</code></td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h3 id="properties">Properties
  163. </h3>
  164. <a id="Terminal_Gui_Graphs_MultiBarSeries_Spacing_" data-uid="Terminal.Gui.Graphs.MultiBarSeries.Spacing*"></a>
  165. <h4 id="Terminal_Gui_Graphs_MultiBarSeries_Spacing" data-uid="Terminal.Gui.Graphs.MultiBarSeries.Spacing">Spacing</h4>
  166. <div class="markdown level1 summary">
  167. The number of units of graph space between bars. Should be
  168. less than <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html#Terminal_Gui_Graphs_BarSeries_BarEvery">BarEvery</a>
  169. </div>
  170. <div class="markdown level1 conceptual"></div>
  171. <h5 class="decalaration">Declaration</h5>
  172. <div class="codewrapper">
  173. <pre><code class="lang-csharp hljs">public float Spacing { get; }</code></pre>
  174. </div>
  175. <h5 class="propertyValue">Property Value</h5>
  176. <table class="table table-bordered table-striped table-condensed">
  177. <thead>
  178. <tr>
  179. <th>Type</th>
  180. <th>Description</th>
  181. </tr>
  182. </thead>
  183. <tbody>
  184. <tr>
  185. <td><span class="xref">System.Single</span></td>
  186. <td></td>
  187. </tr>
  188. </tbody>
  189. </table>
  190. <a id="Terminal_Gui_Graphs_MultiBarSeries_SubSeries_" data-uid="Terminal.Gui.Graphs.MultiBarSeries.SubSeries*"></a>
  191. <h4 id="Terminal_Gui_Graphs_MultiBarSeries_SubSeries" data-uid="Terminal.Gui.Graphs.MultiBarSeries.SubSeries">SubSeries</h4>
  192. <div class="markdown level1 summary">
  193. Sub collections. Each series contains the bars for a different category. Thus
  194. SubSeries[0].Bars[0] is the first bar on the axis and SubSeries[1].Bars[0] is the
  195. second etc
  196. </div>
  197. <div class="markdown level1 conceptual"></div>
  198. <h5 class="decalaration">Declaration</h5>
  199. <div class="codewrapper">
  200. <pre><code class="lang-csharp hljs">public IReadOnlyCollection&lt;BarSeries&gt; SubSeries { get; }</code></pre>
  201. </div>
  202. <h5 class="propertyValue">Property Value</h5>
  203. <table class="table table-bordered table-striped table-condensed">
  204. <thead>
  205. <tr>
  206. <th>Type</th>
  207. <th>Description</th>
  208. </tr>
  209. </thead>
  210. <tbody>
  211. <tr>
  212. <td><span class="xref">System.Collections.Generic.IReadOnlyCollection</span>&lt;<a class="xref" href="Terminal.Gui.Graphs.BarSeries.html">BarSeries</a>&gt;</td>
  213. <td></td>
  214. </tr>
  215. </tbody>
  216. </table>
  217. <h3 id="methods">Methods
  218. </h3>
  219. <a id="Terminal_Gui_Graphs_MultiBarSeries_AddBars_" data-uid="Terminal.Gui.Graphs.MultiBarSeries.AddBars*"></a>
  220. <h4 id="Terminal_Gui_Graphs_MultiBarSeries_AddBars_System_String_System_Rune_System_Single___" data-uid="Terminal.Gui.Graphs.MultiBarSeries.AddBars(System.String,System.Rune,System.Single[])">AddBars(String, Rune, Single[])</h4>
  221. <div class="markdown level1 summary">
  222. Adds a new cluster of bars
  223. </div>
  224. <div class="markdown level1 conceptual"></div>
  225. <h5 class="decalaration">Declaration</h5>
  226. <div class="codewrapper">
  227. <pre><code class="lang-csharp hljs">public void AddBars(string label, Rune fill, params float[] values)</code></pre>
  228. </div>
  229. <h5 class="parameters">Parameters</h5>
  230. <table class="table table-bordered table-striped table-condensed">
  231. <thead>
  232. <tr>
  233. <th>Type</th>
  234. <th>Name</th>
  235. <th>Description</th>
  236. </tr>
  237. </thead>
  238. <tbody>
  239. <tr>
  240. <td><span class="xref">System.String</span></td>
  241. <td><span class="parametername">label</span></td>
  242. <td></td>
  243. </tr>
  244. <tr>
  245. <td><span class="xref">System.Rune</span></td>
  246. <td><span class="parametername">fill</span></td>
  247. <td></td>
  248. </tr>
  249. <tr>
  250. <td><span class="xref">System.Single</span>[]</td>
  251. <td><span class="parametername">values</span></td>
  252. <td>Values for each bar in category, must match the number of bars per category</td>
  253. </tr>
  254. </tbody>
  255. </table>
  256. <a id="Terminal_Gui_Graphs_MultiBarSeries_DrawSeries_" data-uid="Terminal.Gui.Graphs.MultiBarSeries.DrawSeries*"></a>
  257. <h4 id="Terminal_Gui_Graphs_MultiBarSeries_DrawSeries_Terminal_Gui_GraphView_Terminal_Gui_Rect_Terminal_Gui_RectangleF_" data-uid="Terminal.Gui.Graphs.MultiBarSeries.DrawSeries(Terminal.Gui.GraphView,Terminal.Gui.Rect,Terminal.Gui.RectangleF)">DrawSeries(GraphView, Rect, RectangleF)</h4>
  258. <div class="markdown level1 summary">
  259. Draws all <a class="xref" href="Terminal.Gui.Graphs.MultiBarSeries.html#Terminal_Gui_Graphs_MultiBarSeries_SubSeries">SubSeries</a>
  260. </div>
  261. <div class="markdown level1 conceptual"></div>
  262. <h5 class="decalaration">Declaration</h5>
  263. <div class="codewrapper">
  264. <pre><code class="lang-csharp hljs">public void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds)</code></pre>
  265. </div>
  266. <h5 class="parameters">Parameters</h5>
  267. <table class="table table-bordered table-striped table-condensed">
  268. <thead>
  269. <tr>
  270. <th>Type</th>
  271. <th>Name</th>
  272. <th>Description</th>
  273. </tr>
  274. </thead>
  275. <tbody>
  276. <tr>
  277. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  278. <td><span class="parametername">graph</span></td>
  279. <td></td>
  280. </tr>
  281. <tr>
  282. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  283. <td><span class="parametername">drawBounds</span></td>
  284. <td></td>
  285. </tr>
  286. <tr>
  287. <td><a class="xref" href="Terminal.Gui.RectangleF.html">RectangleF</a></td>
  288. <td><span class="parametername">graphBounds</span></td>
  289. <td></td>
  290. </tr>
  291. </tbody>
  292. </table>
  293. <h3 id="implements">Implements</h3>
  294. <div>
  295. <a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a>
  296. </div>
  297. </article>
  298. </div>
  299. <div class="hidden-sm col-md-2" role="complementary">
  300. <div class="sideaffix">
  301. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  302. <h5>In This Article</h5>
  303. <div></div>
  304. </nav>
  305. </div>
  306. </div>
  307. </div>
  308. </div>
  309. <footer>
  310. <div class="grad-bottom"></div>
  311. <div class="footer">
  312. <div class="container">
  313. <span class="pull-right">
  314. <a href="#top">Back to top</a>
  315. </span>
  316. <span>Generated by <strong>DocFX</strong></span>
  317. </div>
  318. </div>
  319. </footer>
  320. </div>
  321. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  322. <script type="text/javascript" src="../../styles/docfx.js"></script>
  323. <script type="text/javascript" src="../../styles/main.js"></script>
  324. </body>
  325. </html>