Terminal.Gui.Graphs.BarSeries.html 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457
  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 BarSeries
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class BarSeries
  11. ">
  12. <meta name="generator" content="docfx 2.59.3.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.BarSeries">
  74. <h1 id="Terminal_Gui_Graphs_BarSeries" data-uid="Terminal.Gui.Graphs.BarSeries" class="text-break">Class BarSeries
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Series of bars positioned at regular intervals
  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">BarSeries</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. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
  90. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  91. <h5 id="Terminal_Gui_Graphs_BarSeries_syntax">Syntax</h5>
  92. <div class="codewrapper">
  93. <pre><code class="lang-csharp hljs">public class BarSeries : Object, ISeries</code></pre>
  94. </div>
  95. <h3 id="constructors">Constructors
  96. </h3>
  97. <a id="Terminal_Gui_Graphs_BarSeries__ctor_" data-uid="Terminal.Gui.Graphs.BarSeries.#ctor*"></a>
  98. <h4 id="Terminal_Gui_Graphs_BarSeries__ctor" data-uid="Terminal.Gui.Graphs.BarSeries.#ctor">BarSeries()</h4>
  99. <div class="markdown level1 summary"></div>
  100. <div class="markdown level1 conceptual"></div>
  101. <h5 class="decalaration">Declaration</h5>
  102. <div class="codewrapper">
  103. <pre><code class="lang-csharp hljs">public BarSeries()</code></pre>
  104. </div>
  105. <h3 id="properties">Properties
  106. </h3>
  107. <a id="Terminal_Gui_Graphs_BarSeries_BarEvery_" data-uid="Terminal.Gui.Graphs.BarSeries.BarEvery*"></a>
  108. <h4 id="Terminal_Gui_Graphs_BarSeries_BarEvery" data-uid="Terminal.Gui.Graphs.BarSeries.BarEvery">BarEvery</h4>
  109. <div class="markdown level1 summary">
  110. Determines the spacing of bars along the axis. Defaults to 1 i.e.
  111. every 1 unit of graph space a bar is rendered. Note that you should
  112. also consider <a class="xref" href="Terminal.Gui.GraphView.html#Terminal_Gui_GraphView_CellSize">CellSize</a> when changing this.
  113. </div>
  114. <div class="markdown level1 conceptual"></div>
  115. <h5 class="decalaration">Declaration</h5>
  116. <div class="codewrapper">
  117. <pre><code class="lang-csharp hljs">public float BarEvery { get; set; }</code></pre>
  118. </div>
  119. <h5 class="propertyValue">Property Value</h5>
  120. <table class="table table-bordered table-striped table-condensed">
  121. <thead>
  122. <tr>
  123. <th>Type</th>
  124. <th>Description</th>
  125. </tr>
  126. </thead>
  127. <tbody>
  128. <tr>
  129. <td><span class="xref">System.Single</span></td>
  130. <td></td>
  131. </tr>
  132. </tbody>
  133. </table>
  134. <a id="Terminal_Gui_Graphs_BarSeries_Bars_" data-uid="Terminal.Gui.Graphs.BarSeries.Bars*"></a>
  135. <h4 id="Terminal_Gui_Graphs_BarSeries_Bars" data-uid="Terminal.Gui.Graphs.BarSeries.Bars">Bars</h4>
  136. <div class="markdown level1 summary">
  137. Ordered collection of graph bars to position along axis
  138. </div>
  139. <div class="markdown level1 conceptual"></div>
  140. <h5 class="decalaration">Declaration</h5>
  141. <div class="codewrapper">
  142. <pre><code class="lang-csharp hljs">public List&lt;BarSeries.Bar&gt; Bars { get; set; }</code></pre>
  143. </div>
  144. <h5 class="propertyValue">Property Value</h5>
  145. <table class="table table-bordered table-striped table-condensed">
  146. <thead>
  147. <tr>
  148. <th>Type</th>
  149. <th>Description</th>
  150. </tr>
  151. </thead>
  152. <tbody>
  153. <tr>
  154. <td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Terminal.Gui.Graphs.BarSeries.Bar.html">BarSeries.Bar</a>&gt;</td>
  155. <td></td>
  156. </tr>
  157. </tbody>
  158. </table>
  159. <a id="Terminal_Gui_Graphs_BarSeries_DrawLabels_" data-uid="Terminal.Gui.Graphs.BarSeries.DrawLabels*"></a>
  160. <h4 id="Terminal_Gui_Graphs_BarSeries_DrawLabels" data-uid="Terminal.Gui.Graphs.BarSeries.DrawLabels">DrawLabels</h4>
  161. <div class="markdown level1 summary">
  162. True to draw <a class="xref" href="Terminal.Gui.Graphs.BarSeries.Bar.html#Terminal_Gui_Graphs_BarSeries_Bar_Text">Text</a> along the axis under the bar. Defaults
  163. to true.
  164. </div>
  165. <div class="markdown level1 conceptual"></div>
  166. <h5 class="decalaration">Declaration</h5>
  167. <div class="codewrapper">
  168. <pre><code class="lang-csharp hljs">public bool DrawLabels { get; set; }</code></pre>
  169. </div>
  170. <h5 class="propertyValue">Property Value</h5>
  171. <table class="table table-bordered table-striped table-condensed">
  172. <thead>
  173. <tr>
  174. <th>Type</th>
  175. <th>Description</th>
  176. </tr>
  177. </thead>
  178. <tbody>
  179. <tr>
  180. <td><span class="xref">System.Boolean</span></td>
  181. <td></td>
  182. </tr>
  183. </tbody>
  184. </table>
  185. <a id="Terminal_Gui_Graphs_BarSeries_Offset_" data-uid="Terminal.Gui.Graphs.BarSeries.Offset*"></a>
  186. <h4 id="Terminal_Gui_Graphs_BarSeries_Offset" data-uid="Terminal.Gui.Graphs.BarSeries.Offset">Offset</h4>
  187. <div class="markdown level1 summary">
  188. The number of units of graph space along the axis before rendering the first bar
  189. (and subsequent bars - see <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html#Terminal_Gui_Graphs_BarSeries_BarEvery">BarEvery</a>). Defaults to 0
  190. </div>
  191. <div class="markdown level1 conceptual"></div>
  192. <h5 class="decalaration">Declaration</h5>
  193. <div class="codewrapper">
  194. <pre><code class="lang-csharp hljs">public float Offset { get; set; }</code></pre>
  195. </div>
  196. <h5 class="propertyValue">Property Value</h5>
  197. <table class="table table-bordered table-striped table-condensed">
  198. <thead>
  199. <tr>
  200. <th>Type</th>
  201. <th>Description</th>
  202. </tr>
  203. </thead>
  204. <tbody>
  205. <tr>
  206. <td><span class="xref">System.Single</span></td>
  207. <td></td>
  208. </tr>
  209. </tbody>
  210. </table>
  211. <a id="Terminal_Gui_Graphs_BarSeries_Orientation_" data-uid="Terminal.Gui.Graphs.BarSeries.Orientation*"></a>
  212. <h4 id="Terminal_Gui_Graphs_BarSeries_Orientation" data-uid="Terminal.Gui.Graphs.BarSeries.Orientation">Orientation</h4>
  213. <div class="markdown level1 summary">
  214. Direction bars protrude from the corresponding axis.
  215. Defaults to vertical
  216. </div>
  217. <div class="markdown level1 conceptual"></div>
  218. <h5 class="decalaration">Declaration</h5>
  219. <div class="codewrapper">
  220. <pre><code class="lang-csharp hljs">public Orientation Orientation { get; set; }</code></pre>
  221. </div>
  222. <h5 class="propertyValue">Property Value</h5>
  223. <table class="table table-bordered table-striped table-condensed">
  224. <thead>
  225. <tr>
  226. <th>Type</th>
  227. <th>Description</th>
  228. </tr>
  229. </thead>
  230. <tbody>
  231. <tr>
  232. <td><a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a></td>
  233. <td></td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <a id="Terminal_Gui_Graphs_BarSeries_OverrideBarColor_" data-uid="Terminal.Gui.Graphs.BarSeries.OverrideBarColor*"></a>
  238. <h4 id="Terminal_Gui_Graphs_BarSeries_OverrideBarColor" data-uid="Terminal.Gui.Graphs.BarSeries.OverrideBarColor">OverrideBarColor</h4>
  239. <div class="markdown level1 summary">
  240. Overrides the <a class="xref" href="Terminal.Gui.Graphs.BarSeries.Bar.html#Terminal_Gui_Graphs_BarSeries_Bar_Fill">Fill</a> with a fixed color
  241. </div>
  242. <div class="markdown level1 conceptual"></div>
  243. <h5 class="decalaration">Declaration</h5>
  244. <div class="codewrapper">
  245. <pre><code class="lang-csharp hljs">public Nullable&lt;Attribute&gt; OverrideBarColor { get; set; }</code></pre>
  246. </div>
  247. <h5 class="propertyValue">Property Value</h5>
  248. <table class="table table-bordered table-striped table-condensed">
  249. <thead>
  250. <tr>
  251. <th>Type</th>
  252. <th>Description</th>
  253. </tr>
  254. </thead>
  255. <tbody>
  256. <tr>
  257. <td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>&gt;</td>
  258. <td></td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. <h3 id="methods">Methods
  263. </h3>
  264. <a id="Terminal_Gui_Graphs_BarSeries_AdjustColor_" data-uid="Terminal.Gui.Graphs.BarSeries.AdjustColor*"></a>
  265. <h4 id="Terminal_Gui_Graphs_BarSeries_AdjustColor_Terminal_Gui_Graphs_GraphCellToRender_" data-uid="Terminal.Gui.Graphs.BarSeries.AdjustColor(Terminal.Gui.Graphs.GraphCellToRender)">AdjustColor(GraphCellToRender)</h4>
  266. <div class="markdown level1 summary">
  267. Applies any color overriding
  268. </div>
  269. <div class="markdown level1 conceptual"></div>
  270. <h5 class="decalaration">Declaration</h5>
  271. <div class="codewrapper">
  272. <pre><code class="lang-csharp hljs">protected virtual GraphCellToRender AdjustColor(GraphCellToRender graphCellToRender)</code></pre>
  273. </div>
  274. <h5 class="parameters">Parameters</h5>
  275. <table class="table table-bordered table-striped table-condensed">
  276. <thead>
  277. <tr>
  278. <th>Type</th>
  279. <th>Name</th>
  280. <th>Description</th>
  281. </tr>
  282. </thead>
  283. <tbody>
  284. <tr>
  285. <td><a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html">GraphCellToRender</a></td>
  286. <td><span class="parametername">graphCellToRender</span></td>
  287. <td></td>
  288. </tr>
  289. </tbody>
  290. </table>
  291. <h5 class="returns">Returns</h5>
  292. <table class="table table-bordered table-striped table-condensed">
  293. <thead>
  294. <tr>
  295. <th>Type</th>
  296. <th>Description</th>
  297. </tr>
  298. </thead>
  299. <tbody>
  300. <tr>
  301. <td><a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html">GraphCellToRender</a></td>
  302. <td></td>
  303. </tr>
  304. </tbody>
  305. </table>
  306. <a id="Terminal_Gui_Graphs_BarSeries_DrawBarLine_" data-uid="Terminal.Gui.Graphs.BarSeries.DrawBarLine*"></a>
  307. <h4 id="Terminal_Gui_Graphs_BarSeries_DrawBarLine_Terminal_Gui_GraphView_Terminal_Gui_Point_Terminal_Gui_Point_Terminal_Gui_Graphs_BarSeries_Bar_" data-uid="Terminal.Gui.Graphs.BarSeries.DrawBarLine(Terminal.Gui.GraphView,Terminal.Gui.Point,Terminal.Gui.Point,Terminal.Gui.Graphs.BarSeries.Bar)">DrawBarLine(GraphView, Point, Point, BarSeries.Bar)</h4>
  308. <div class="markdown level1 summary">
  309. Override to do custom drawing of the bar e.g. to apply varying color or changing the fill
  310. symbol mid bar.
  311. </div>
  312. <div class="markdown level1 conceptual"></div>
  313. <h5 class="decalaration">Declaration</h5>
  314. <div class="codewrapper">
  315. <pre><code class="lang-csharp hljs">protected virtual void DrawBarLine(GraphView graph, Point start, Point end, BarSeries.Bar beingDrawn)</code></pre>
  316. </div>
  317. <h5 class="parameters">Parameters</h5>
  318. <table class="table table-bordered table-striped table-condensed">
  319. <thead>
  320. <tr>
  321. <th>Type</th>
  322. <th>Name</th>
  323. <th>Description</th>
  324. </tr>
  325. </thead>
  326. <tbody>
  327. <tr>
  328. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  329. <td><span class="parametername">graph</span></td>
  330. <td></td>
  331. </tr>
  332. <tr>
  333. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  334. <td><span class="parametername">start</span></td>
  335. <td>Screen position of the start of the bar</td>
  336. </tr>
  337. <tr>
  338. <td><a class="xref" href="Terminal.Gui.Point.html">Point</a></td>
  339. <td><span class="parametername">end</span></td>
  340. <td>Screen position of the end of the bar</td>
  341. </tr>
  342. <tr>
  343. <td><a class="xref" href="Terminal.Gui.Graphs.BarSeries.Bar.html">BarSeries.Bar</a></td>
  344. <td><span class="parametername">beingDrawn</span></td>
  345. <td>The Bar that occupies this space and is being drawn</td>
  346. </tr>
  347. </tbody>
  348. </table>
  349. <a id="Terminal_Gui_Graphs_BarSeries_DrawSeries_" data-uid="Terminal.Gui.Graphs.BarSeries.DrawSeries*"></a>
  350. <h4 id="Terminal_Gui_Graphs_BarSeries_DrawSeries_Terminal_Gui_GraphView_Terminal_Gui_Rect_Terminal_Gui_RectangleF_" data-uid="Terminal.Gui.Graphs.BarSeries.DrawSeries(Terminal.Gui.GraphView,Terminal.Gui.Rect,Terminal.Gui.RectangleF)">DrawSeries(GraphView, Rect, RectangleF)</h4>
  351. <div class="markdown level1 summary">
  352. Draws bars that are currently in the <code data-dev-comment-type="paramref" class="paramref">drawBounds</code>
  353. </div>
  354. <div class="markdown level1 conceptual"></div>
  355. <h5 class="decalaration">Declaration</h5>
  356. <div class="codewrapper">
  357. <pre><code class="lang-csharp hljs">public virtual void DrawSeries(GraphView graph, Rect drawBounds, RectangleF graphBounds)</code></pre>
  358. </div>
  359. <h5 class="parameters">Parameters</h5>
  360. <table class="table table-bordered table-striped table-condensed">
  361. <thead>
  362. <tr>
  363. <th>Type</th>
  364. <th>Name</th>
  365. <th>Description</th>
  366. </tr>
  367. </thead>
  368. <tbody>
  369. <tr>
  370. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  371. <td><span class="parametername">graph</span></td>
  372. <td></td>
  373. </tr>
  374. <tr>
  375. <td><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
  376. <td><span class="parametername">drawBounds</span></td>
  377. <td>Screen area of the graph excluding margins</td>
  378. </tr>
  379. <tr>
  380. <td><a class="xref" href="Terminal.Gui.RectangleF.html">RectangleF</a></td>
  381. <td><span class="parametername">graphBounds</span></td>
  382. <td>Graph space area that should be drawn into <code data-dev-comment-type="paramref" class="paramref">drawBounds</code></td>
  383. </tr>
  384. </tbody>
  385. </table>
  386. <h3 id="implements">Implements</h3>
  387. <div>
  388. <a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a>
  389. </div>
  390. </article>
  391. </div>
  392. <div class="hidden-sm col-md-2" role="complementary">
  393. <div class="sideaffix">
  394. <div class="contribution">
  395. <ul class="nav">
  396. </ul>
  397. </div>
  398. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  399. <h5>In This Article</h5>
  400. <div></div>
  401. </nav>
  402. </div>
  403. </div>
  404. </div>
  405. </div>
  406. <footer>
  407. <div class="grad-bottom"></div>
  408. <div class="footer">
  409. <div class="container">
  410. <span class="pull-right">
  411. <a href="#top">Back to top</a>
  412. </span>
  413. <span>Generated by <strong>DocFX</strong></span>
  414. </div>
  415. </div>
  416. </footer>
  417. </div>
  418. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  419. <script type="text/javascript" src="../../styles/docfx.js"></script>
  420. <script type="text/javascript" src="../../styles/main.js"></script>
  421. </body>
  422. </html>