Terminal.Gui.Graphs.BarSeries.Bar.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315
  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.Bar
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class BarSeries.Bar
  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.BarSeries.Bar">
  74. <h1 id="Terminal_Gui_Graphs_BarSeries_Bar" data-uid="Terminal.Gui.Graphs.BarSeries.Bar" class="text-break">Class BarSeries.Bar
  75. </h1>
  76. <div class="markdown level0 summary">
  77. A single bar in a <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html">BarSeries</a>
  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.Bar</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <span class="xref">System.Object.Equals(System.Object)</span>
  89. </div>
  90. <div>
  91. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  92. </div>
  93. <div>
  94. <span class="xref">System.Object.GetHashCode()</span>
  95. </div>
  96. <div>
  97. <span class="xref">System.Object.GetType()</span>
  98. </div>
  99. <div>
  100. <span class="xref">System.Object.MemberwiseClone()</span>
  101. </div>
  102. <div>
  103. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  104. </div>
  105. <div>
  106. <span class="xref">System.Object.ToString()</span>
  107. </div>
  108. </div>
  109. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
  110. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  111. <h5 id="Terminal_Gui_Graphs_BarSeries_Bar_syntax">Syntax</h5>
  112. <div class="codewrapper">
  113. <pre><code class="lang-csharp hljs">public class Bar</code></pre>
  114. </div>
  115. <h3 id="constructors">Constructors
  116. </h3>
  117. <span class="small pull-right mobile-hide">
  118. <span class="divider">|</span>
  119. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_BarSeries_Bar__ctor_System_String_Terminal_Gui_Graphs_GraphCellToRender_System_Single_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.BarSeries.Bar.%23ctor(System.String%2CTerminal.Gui.Graphs.GraphCellToRender%2CSystem.Single)%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>
  120. </span>
  121. <span class="small pull-right mobile-hide">
  122. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/Series.cs/#L315">View Source</a>
  123. </span>
  124. <a id="Terminal_Gui_Graphs_BarSeries_Bar__ctor_" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.#ctor*"></a>
  125. <h4 id="Terminal_Gui_Graphs_BarSeries_Bar__ctor_System_String_Terminal_Gui_Graphs_GraphCellToRender_System_Single_" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.#ctor(System.String,Terminal.Gui.Graphs.GraphCellToRender,System.Single)">Bar(String, GraphCellToRender, Single)</h4>
  126. <div class="markdown level1 summary">
  127. Creates a new instance of a single bar rendered in the given <code data-dev-comment-type="paramref" class="paramref">fill</code> that extends
  128. out <code data-dev-comment-type="paramref" class="paramref">value</code> graph space units in the default <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html#Terminal_Gui_Graphs_BarSeries_Orientation">Orientation</a>
  129. </div>
  130. <div class="markdown level1 conceptual"></div>
  131. <h5 class="decalaration">Declaration</h5>
  132. <div class="codewrapper">
  133. <pre><code class="lang-csharp hljs">public Bar(string text, GraphCellToRender fill, float value)</code></pre>
  134. </div>
  135. <h5 class="parameters">Parameters</h5>
  136. <table class="table table-bordered table-striped table-condensed">
  137. <thead>
  138. <tr>
  139. <th>Type</th>
  140. <th>Name</th>
  141. <th>Description</th>
  142. </tr>
  143. </thead>
  144. <tbody>
  145. <tr>
  146. <td><span class="xref">System.String</span></td>
  147. <td><span class="parametername">text</span></td>
  148. <td></td>
  149. </tr>
  150. <tr>
  151. <td><a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html">GraphCellToRender</a></td>
  152. <td><span class="parametername">fill</span></td>
  153. <td></td>
  154. </tr>
  155. <tr>
  156. <td><span class="xref">System.Single</span></td>
  157. <td><span class="parametername">value</span></td>
  158. <td></td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <h3 id="properties">Properties
  163. </h3>
  164. <span class="small pull-right mobile-hide">
  165. <span class="divider">|</span>
  166. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_BarSeries_Bar_Fill.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.BarSeries.Bar.Fill%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>
  167. </span>
  168. <span class="small pull-right mobile-hide">
  169. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/Series.cs/#L301">View Source</a>
  170. </span>
  171. <a id="Terminal_Gui_Graphs_BarSeries_Bar_Fill_" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.Fill*"></a>
  172. <h4 id="Terminal_Gui_Graphs_BarSeries_Bar_Fill" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.Fill">Fill</h4>
  173. <div class="markdown level1 summary">
  174. The color and character that will be rendered in the console
  175. when the bar extends over it
  176. </div>
  177. <div class="markdown level1 conceptual"></div>
  178. <h5 class="decalaration">Declaration</h5>
  179. <div class="codewrapper">
  180. <pre><code class="lang-csharp hljs">public GraphCellToRender Fill { get; set; }</code></pre>
  181. </div>
  182. <h5 class="propertyValue">Property Value</h5>
  183. <table class="table table-bordered table-striped table-condensed">
  184. <thead>
  185. <tr>
  186. <th>Type</th>
  187. <th>Description</th>
  188. </tr>
  189. </thead>
  190. <tbody>
  191. <tr>
  192. <td><a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html">GraphCellToRender</a></td>
  193. <td></td>
  194. </tr>
  195. </tbody>
  196. </table>
  197. <span class="small pull-right mobile-hide">
  198. <span class="divider">|</span>
  199. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_BarSeries_Bar_Text.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.BarSeries.Bar.Text%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>
  200. </span>
  201. <span class="small pull-right mobile-hide">
  202. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/Series.cs/#L295">View Source</a>
  203. </span>
  204. <a id="Terminal_Gui_Graphs_BarSeries_Bar_Text_" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.Text*"></a>
  205. <h4 id="Terminal_Gui_Graphs_BarSeries_Bar_Text" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.Text">Text</h4>
  206. <div class="markdown level1 summary">
  207. Optional text that describes the bar. This will be rendered on the corresponding
  208. <a class="xref" href="Terminal.Gui.Graphs.Axis.html">Axis</a> unless <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html#Terminal_Gui_Graphs_BarSeries_DrawLabels">DrawLabels</a> is false
  209. </div>
  210. <div class="markdown level1 conceptual"></div>
  211. <h5 class="decalaration">Declaration</h5>
  212. <div class="codewrapper">
  213. <pre><code class="lang-csharp hljs">public string Text { get; set; }</code></pre>
  214. </div>
  215. <h5 class="propertyValue">Property Value</h5>
  216. <table class="table table-bordered table-striped table-condensed">
  217. <thead>
  218. <tr>
  219. <th>Type</th>
  220. <th>Description</th>
  221. </tr>
  222. </thead>
  223. <tbody>
  224. <tr>
  225. <td><span class="xref">System.String</span></td>
  226. <td></td>
  227. </tr>
  228. </tbody>
  229. </table>
  230. <span class="small pull-right mobile-hide">
  231. <span class="divider">|</span>
  232. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_BarSeries_Bar_Value.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.BarSeries.Bar.Value%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>
  233. </span>
  234. <span class="small pull-right mobile-hide">
  235. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/Series.cs/#L306">View Source</a>
  236. </span>
  237. <a id="Terminal_Gui_Graphs_BarSeries_Bar_Value_" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.Value*"></a>
  238. <h4 id="Terminal_Gui_Graphs_BarSeries_Bar_Value" data-uid="Terminal.Gui.Graphs.BarSeries.Bar.Value">Value</h4>
  239. <div class="markdown level1 summary">
  240. The value in graph space X/Y (depending on <a class="xref" href="Terminal.Gui.Graphs.BarSeries.html#Terminal_Gui_Graphs_BarSeries_Orientation">Orientation</a>) to which the bar extends.
  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 float Value { get; }</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.Single</span></td>
  258. <td></td>
  259. </tr>
  260. </tbody>
  261. </table>
  262. </article>
  263. </div>
  264. <div class="hidden-sm col-md-2" role="complementary">
  265. <div class="sideaffix">
  266. <div class="contribution">
  267. <ul class="nav">
  268. <li>
  269. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_BarSeries_Bar.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.BarSeries.Bar%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>
  270. </li>
  271. <li>
  272. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/Series.cs/#L289" class="contribution-link">View Source</a>
  273. </li>
  274. </ul>
  275. </div>
  276. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  277. <h5>In This Article</h5>
  278. <div></div>
  279. </nav>
  280. </div>
  281. </div>
  282. </div>
  283. </div>
  284. <footer>
  285. <div class="grad-bottom"></div>
  286. <div class="footer">
  287. <div class="container">
  288. <span class="pull-right">
  289. <a href="#top">Back to top</a>
  290. </span>
  291. <span>Generated by <strong>DocFX</strong></span>
  292. </div>
  293. </div>
  294. </footer>
  295. </div>
  296. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  297. <script type="text/javascript" src="../../styles/docfx.js"></script>
  298. <script type="text/javascript" src="../../styles/main.js"></script>
  299. </body>
  300. </html>