Terminal.Gui.Graphs.GraphCellToRender.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337
  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 GraphCellToRender
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class GraphCellToRender
  11. ">
  12. <link rel="shortcut icon" href="../../favicon.ico">
  13. <link rel="stylesheet" href="../../styles/docfx.vendor.min.css">
  14. <link rel="stylesheet" href="../../styles/docfx.css">
  15. <link rel="stylesheet" href="../../styles/main.css">
  16. <meta property="docfx:navrel" content="../../toc.html">
  17. <meta property="docfx:tocrel" content="toc.html">
  18. <meta property="docfx:rel" content="../../">
  19. </head>
  20. <body data-spy="scroll" data-target="#affix" data-offset="120">
  21. <div id="wrapper">
  22. <header>
  23. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  24. <div class="container">
  25. <div class="navbar-header">
  26. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  27. <span class="sr-only">Toggle navigation</span>
  28. <span class="icon-bar"></span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. </button>
  32. <a class="navbar-brand" href="../../index.html">
  33. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  34. </a>
  35. </div>
  36. <div class="collapse navbar-collapse" id="navbar">
  37. <form class="navbar-form navbar-right" role="search" id="search">
  38. <div class="form-group">
  39. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  40. </div>
  41. </form>
  42. </div>
  43. </div>
  44. </nav>
  45. <div class="subnav navbar navbar-default">
  46. <div class="container hide-when-search" id="breadcrumb">
  47. <ul class="breadcrumb">
  48. <li></li>
  49. </ul>
  50. </div>
  51. </div>
  52. </header>
  53. <div class="container body-content">
  54. <div id="search-results">
  55. <div class="search-list">Search Results for <span></span></div>
  56. <div class="sr-items">
  57. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  58. </div>
  59. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  60. </div>
  61. </div>
  62. <div role="main" class="container body-content hide-when-search">
  63. <div class="sidenav hide-when-search">
  64. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  65. <div class="sidetoggle collapse" id="sidetoggle">
  66. <div id="sidetoc"></div>
  67. </div>
  68. </div>
  69. <div class="article row grid-right">
  70. <div class="col-md-10">
  71. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Graphs.GraphCellToRender">
  72. <h1 id="Terminal_Gui_Graphs_GraphCellToRender" data-uid="Terminal.Gui.Graphs.GraphCellToRender" class="text-break">Class GraphCellToRender
  73. </h1>
  74. <div class="markdown level0 summary">Describes how to render a single row/column of a <a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a> based
  75. on the value(s) in <a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a> at that location</div>
  76. <div class="markdown level0 conceptual"></div>
  77. <div class="inheritance">
  78. <h5>Inheritance</h5>
  79. <div class="level0"><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
  80. <div class="level1"><span class="xref">GraphCellToRender</span></div>
  81. </div>
  82. <div class="inheritedMembers">
  83. <h5>Inherited Members</h5>
  84. <div>
  85. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
  86. </div>
  87. <div>
  88. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
  104. </div>
  105. </div>
  106. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.html">Terminal</a>.<a class="xref" href="Terminal.Gui.html">Gui</a>.<a class="xref" href="Terminal.Gui.Graphs.html">Graphs</a></h6>
  107. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  108. <h5 id="Terminal_Gui_Graphs_GraphCellToRender_syntax">Syntax</h5>
  109. <div class="codewrapper">
  110. <pre><code class="lang-csharp hljs">public class GraphCellToRender</code></pre>
  111. </div>
  112. <h3 id="constructors">Constructors
  113. </h3>
  114. <span class="small pull-right mobile-hide">
  115. <span class="divider">|</span>
  116. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.%23ctor(System.Rune)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  117. </span>
  118. <span class="small pull-right mobile-hide">
  119. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L24">View Source</a>
  120. </span>
  121. <a id="Terminal_Gui_Graphs_GraphCellToRender__ctor_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor*"></a>
  122. <h4 id="Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor(System.Rune)">GraphCellToRender(Rune)</h4>
  123. <div class="markdown level1 summary">Creates instance and sets <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> with default graph coloring</div>
  124. <div class="markdown level1 conceptual"></div>
  125. <h5 class="declaration">Declaration</h5>
  126. <div class="codewrapper">
  127. <pre><code class="lang-csharp hljs">public GraphCellToRender(Rune rune)</code></pre>
  128. </div>
  129. <h5 class="parameters">Parameters</h5>
  130. <table class="table table-bordered table-condensed">
  131. <thead>
  132. <tr>
  133. <th>Type</th>
  134. <th>Name</th>
  135. <th>Description</th>
  136. </tr>
  137. </thead>
  138. <tbody>
  139. <tr>
  140. <td><span class="xref">Rune</span></td>
  141. <td><span class="parametername">rune</span></td>
  142. <td></td>
  143. </tr>
  144. </tbody>
  145. </table>
  146. <span class="small pull-right mobile-hide">
  147. <span class="divider">|</span>
  148. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_System_Nullable_Terminal_Gui_Attribute__.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.%23ctor(System.Rune%2CSystem.Nullable%7BTerminal.Gui.Attribute%7D)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  149. </span>
  150. <span class="small pull-right mobile-hide">
  151. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L40">View Source</a>
  152. </span>
  153. <a id="Terminal_Gui_Graphs_GraphCellToRender__ctor_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor*"></a>
  154. <h4 id="Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_System_Nullable_Terminal_Gui_Attribute__" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor(System.Rune,System.Nullable{Terminal.Gui.Attribute})">GraphCellToRender(Rune, Attribute?)</h4>
  155. <div class="markdown level1 summary">Creates instance and sets <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> and <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Color">Color</a> (or default if null)</div>
  156. <div class="markdown level1 conceptual"></div>
  157. <h5 class="declaration">Declaration</h5>
  158. <div class="codewrapper">
  159. <pre><code class="lang-csharp hljs">public GraphCellToRender(Rune rune, Attribute? color)</code></pre>
  160. </div>
  161. <h5 class="parameters">Parameters</h5>
  162. <table class="table table-bordered table-condensed">
  163. <thead>
  164. <tr>
  165. <th>Type</th>
  166. <th>Name</th>
  167. <th>Description</th>
  168. </tr>
  169. </thead>
  170. <tbody>
  171. <tr>
  172. <td><span class="xref">Rune</span></td>
  173. <td><span class="parametername">rune</span></td>
  174. <td></td>
  175. </tr>
  176. <tr>
  177. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>?</td>
  178. <td><span class="parametername">color</span></td>
  179. <td></td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <span class="small pull-right mobile-hide">
  184. <span class="divider">|</span>
  185. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_Terminal_Gui_Attribute_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.%23ctor(System.Rune%2CTerminal.Gui.Attribute)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  186. </span>
  187. <span class="small pull-right mobile-hide">
  188. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L33">View Source</a>
  189. </span>
  190. <a id="Terminal_Gui_Graphs_GraphCellToRender__ctor_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor*"></a>
  191. <h4 id="Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_Terminal_Gui_Attribute_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor(System.Rune,Terminal.Gui.Attribute)">GraphCellToRender(Rune, Attribute)</h4>
  192. <div class="markdown level1 summary">Creates instance and sets <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> with custom graph coloring</div>
  193. <div class="markdown level1 conceptual"></div>
  194. <h5 class="declaration">Declaration</h5>
  195. <div class="codewrapper">
  196. <pre><code class="lang-csharp hljs">public GraphCellToRender(Rune rune, Attribute color)</code></pre>
  197. </div>
  198. <h5 class="parameters">Parameters</h5>
  199. <table class="table table-bordered table-condensed">
  200. <thead>
  201. <tr>
  202. <th>Type</th>
  203. <th>Name</th>
  204. <th>Description</th>
  205. </tr>
  206. </thead>
  207. <tbody>
  208. <tr>
  209. <td><span class="xref">Rune</span></td>
  210. <td><span class="parametername">rune</span></td>
  211. <td></td>
  212. </tr>
  213. <tr>
  214. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  215. <td><span class="parametername">color</span></td>
  216. <td></td>
  217. </tr>
  218. </tbody>
  219. </table>
  220. <h3 id="properties">Properties
  221. </h3>
  222. <span class="small pull-right mobile-hide">
  223. <span class="divider">|</span>
  224. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_GraphCellToRender_Color.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.Color%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  225. </span>
  226. <span class="small pull-right mobile-hide">
  227. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L18">View Source</a>
  228. </span>
  229. <a id="Terminal_Gui_Graphs_GraphCellToRender_Color_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Color*"></a>
  230. <h4 id="Terminal_Gui_Graphs_GraphCellToRender_Color" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Color">Color</h4>
  231. <div class="markdown level1 summary">Optional color to render the <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> with</div>
  232. <div class="markdown level1 conceptual"></div>
  233. <h5 class="declaration">Declaration</h5>
  234. <div class="codewrapper">
  235. <pre><code class="lang-csharp hljs">public Attribute? Color { get; set; }</code></pre>
  236. </div>
  237. <h5 class="propertyValue">Property Value</h5>
  238. <table class="table table-bordered table-condensed">
  239. <thead>
  240. <tr>
  241. <th>Type</th>
  242. <th>Description</th>
  243. </tr>
  244. </thead>
  245. <tbody>
  246. <tr>
  247. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>?</td>
  248. <td></td>
  249. </tr>
  250. </tbody>
  251. </table>
  252. <span class="small pull-right mobile-hide">
  253. <span class="divider">|</span>
  254. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_GraphCellToRender_Rune.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.Rune%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
  255. </span>
  256. <span class="small pull-right mobile-hide">
  257. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L13">View Source</a>
  258. </span>
  259. <a id="Terminal_Gui_Graphs_GraphCellToRender_Rune_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Rune*"></a>
  260. <h4 id="Terminal_Gui_Graphs_GraphCellToRender_Rune" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Rune">Rune</h4>
  261. <div class="markdown level1 summary">The character to render in the console</div>
  262. <div class="markdown level1 conceptual"></div>
  263. <h5 class="declaration">Declaration</h5>
  264. <div class="codewrapper">
  265. <pre><code class="lang-csharp hljs">public Rune Rune { get; set; }</code></pre>
  266. </div>
  267. <h5 class="propertyValue">Property Value</h5>
  268. <table class="table table-bordered table-condensed">
  269. <thead>
  270. <tr>
  271. <th>Type</th>
  272. <th>Description</th>
  273. </tr>
  274. </thead>
  275. <tbody>
  276. <tr>
  277. <td><span class="xref">Rune</span></td>
  278. <td></td>
  279. </tr>
  280. </tbody>
  281. </table>
  282. </article>
  283. </div>
  284. <div class="hidden-sm col-md-2" role="complementary">
  285. <div class="sideaffix">
  286. <div class="contribution">
  287. <ul class="nav">
  288. <li>
  289. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_GraphCellToRender.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
  290. </li>
  291. <li>
  292. <a href="tig:tig/Terminal.Gui/blob/v2_develop/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L8" class="contribution-link">View Source</a>
  293. </li>
  294. </ul>
  295. </div>
  296. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  297. <h5>In this article</h5>
  298. <div></div>
  299. </nav>
  300. </div>
  301. </div>
  302. </div>
  303. </div>
  304. <footer>
  305. <div class="grad-bottom"></div>
  306. <div class="footer">
  307. <div class="container">
  308. <span class="pull-right">
  309. <a href="#top">Back to top</a>
  310. </span>
  311. <span>Generated by <strong>DocFX</strong></span>
  312. </div>
  313. </div>
  314. </footer>
  315. </div>
  316. <script type="text/javascript" src="../../styles/docfx.vendor.min.js"></script>
  317. <script type="text/javascript" src="../../styles/docfx.js"></script>
  318. <script type="text/javascript" src="../../styles/main.js"></script>
  319. </body>
  320. </html>