Terminal.Gui.Graphs.MultiBarSeries.html 18 KB

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