2
0

Terminal.Gui.Graphs.GraphCellToRender.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349
  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. <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.GraphCellToRender">
  74. <h1 id="Terminal_Gui_Graphs_GraphCellToRender" data-uid="Terminal.Gui.Graphs.GraphCellToRender" class="text-break">Class GraphCellToRender
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Describes how to render a single row/column of a <a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a> based
  78. on the value(s) in <a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a> at that location
  79. </div>
  80. <div class="markdown level0 conceptual"></div>
  81. <div class="inheritance">
  82. <h5>Inheritance</h5>
  83. <div class="level0"><span class="xref">System.Object</span></div>
  84. <div class="level1"><span class="xref">GraphCellToRender</span></div>
  85. </div>
  86. <div class="inheritedMembers">
  87. <h5>Inherited Members</h5>
  88. <div>
  89. <span class="xref">System.Object.Equals(System.Object)</span>
  90. </div>
  91. <div>
  92. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  93. </div>
  94. <div>
  95. <span class="xref">System.Object.GetHashCode()</span>
  96. </div>
  97. <div>
  98. <span class="xref">System.Object.GetType()</span>
  99. </div>
  100. <div>
  101. <span class="xref">System.Object.MemberwiseClone()</span>
  102. </div>
  103. <div>
  104. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  105. </div>
  106. <div>
  107. <span class="xref">System.Object.ToString()</span>
  108. </div>
  109. </div>
  110. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
  111. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  112. <h5 id="Terminal_Gui_Graphs_GraphCellToRender_syntax">Syntax</h5>
  113. <div class="codewrapper">
  114. <pre><code class="lang-csharp hljs">public class GraphCellToRender</code></pre>
  115. </div>
  116. <h3 id="constructors">Constructors
  117. </h3>
  118. <span class="small pull-right mobile-hide">
  119. <span class="divider">|</span>
  120. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.%23ctor(System.Rune)%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>
  121. </span>
  122. <span class="small pull-right mobile-hide">
  123. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L24">View Source</a>
  124. </span>
  125. <a id="Terminal_Gui_Graphs_GraphCellToRender__ctor_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor*"></a>
  126. <h4 id="Terminal_Gui_Graphs_GraphCellToRender__ctor_System_Rune_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor(System.Rune)">GraphCellToRender(Rune)</h4>
  127. <div class="markdown level1 summary">
  128. Creates instance and sets <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> with default graph coloring
  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 GraphCellToRender(Rune rune)</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.Rune</span></td>
  147. <td><span class="parametername">rune</span></td>
  148. <td></td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. <span class="small pull-right mobile-hide">
  153. <span class="divider">|</span>
  154. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/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'*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>
  155. </span>
  156. <span class="small pull-right mobile-hide">
  157. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L40">View Source</a>
  158. </span>
  159. <a id="Terminal_Gui_Graphs_GraphCellToRender__ctor_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor*"></a>
  160. <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, Nullable&lt;Attribute&gt;)</h4>
  161. <div class="markdown level1 summary">
  162. 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)
  163. </div>
  164. <div class="markdown level1 conceptual"></div>
  165. <h5 class="decalaration">Declaration</h5>
  166. <div class="codewrapper">
  167. <pre><code class="lang-csharp hljs">public GraphCellToRender(Rune rune, Attribute? color)</code></pre>
  168. </div>
  169. <h5 class="parameters">Parameters</h5>
  170. <table class="table table-bordered table-striped table-condensed">
  171. <thead>
  172. <tr>
  173. <th>Type</th>
  174. <th>Name</th>
  175. <th>Description</th>
  176. </tr>
  177. </thead>
  178. <tbody>
  179. <tr>
  180. <td><span class="xref">System.Rune</span></td>
  181. <td><span class="parametername">rune</span></td>
  182. <td></td>
  183. </tr>
  184. <tr>
  185. <td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>&gt;</td>
  186. <td><span class="parametername">color</span></td>
  187. <td></td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <span class="small pull-right mobile-hide">
  192. <span class="divider">|</span>
  193. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/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'*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>
  194. </span>
  195. <span class="small pull-right mobile-hide">
  196. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L33">View Source</a>
  197. </span>
  198. <a id="Terminal_Gui_Graphs_GraphCellToRender__ctor_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.#ctor*"></a>
  199. <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>
  200. <div class="markdown level1 summary">
  201. Creates instance and sets <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> with custom graph coloring
  202. </div>
  203. <div class="markdown level1 conceptual"></div>
  204. <h5 class="decalaration">Declaration</h5>
  205. <div class="codewrapper">
  206. <pre><code class="lang-csharp hljs">public GraphCellToRender(Rune rune, Attribute color)</code></pre>
  207. </div>
  208. <h5 class="parameters">Parameters</h5>
  209. <table class="table table-bordered table-striped table-condensed">
  210. <thead>
  211. <tr>
  212. <th>Type</th>
  213. <th>Name</th>
  214. <th>Description</th>
  215. </tr>
  216. </thead>
  217. <tbody>
  218. <tr>
  219. <td><span class="xref">System.Rune</span></td>
  220. <td><span class="parametername">rune</span></td>
  221. <td></td>
  222. </tr>
  223. <tr>
  224. <td><a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a></td>
  225. <td><span class="parametername">color</span></td>
  226. <td></td>
  227. </tr>
  228. </tbody>
  229. </table>
  230. <h3 id="properties">Properties
  231. </h3>
  232. <span class="small pull-right mobile-hide">
  233. <span class="divider">|</span>
  234. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_GraphCellToRender_Color.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.Color%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>
  235. </span>
  236. <span class="small pull-right mobile-hide">
  237. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L18">View Source</a>
  238. </span>
  239. <a id="Terminal_Gui_Graphs_GraphCellToRender_Color_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Color*"></a>
  240. <h4 id="Terminal_Gui_Graphs_GraphCellToRender_Color" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Color">Color</h4>
  241. <div class="markdown level1 summary">
  242. Optional color to render the <a class="xref" href="Terminal.Gui.Graphs.GraphCellToRender.html#Terminal_Gui_Graphs_GraphCellToRender_Rune">Rune</a> with
  243. </div>
  244. <div class="markdown level1 conceptual"></div>
  245. <h5 class="decalaration">Declaration</h5>
  246. <div class="codewrapper">
  247. <pre><code class="lang-csharp hljs">public Attribute? Color { get; set; }</code></pre>
  248. </div>
  249. <h5 class="propertyValue">Property Value</h5>
  250. <table class="table table-bordered table-striped table-condensed">
  251. <thead>
  252. <tr>
  253. <th>Type</th>
  254. <th>Description</th>
  255. </tr>
  256. </thead>
  257. <tbody>
  258. <tr>
  259. <td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>&gt;</td>
  260. <td></td>
  261. </tr>
  262. </tbody>
  263. </table>
  264. <span class="small pull-right mobile-hide">
  265. <span class="divider">|</span>
  266. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_GraphCellToRender_Rune.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender.Rune%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>
  267. </span>
  268. <span class="small pull-right mobile-hide">
  269. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L13">View Source</a>
  270. </span>
  271. <a id="Terminal_Gui_Graphs_GraphCellToRender_Rune_" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Rune*"></a>
  272. <h4 id="Terminal_Gui_Graphs_GraphCellToRender_Rune" data-uid="Terminal.Gui.Graphs.GraphCellToRender.Rune">Rune</h4>
  273. <div class="markdown level1 summary">
  274. The character to render in the console
  275. </div>
  276. <div class="markdown level1 conceptual"></div>
  277. <h5 class="decalaration">Declaration</h5>
  278. <div class="codewrapper">
  279. <pre><code class="lang-csharp hljs">public Rune Rune { get; set; }</code></pre>
  280. </div>
  281. <h5 class="propertyValue">Property Value</h5>
  282. <table class="table table-bordered table-striped table-condensed">
  283. <thead>
  284. <tr>
  285. <th>Type</th>
  286. <th>Description</th>
  287. </tr>
  288. </thead>
  289. <tbody>
  290. <tr>
  291. <td><span class="xref">System.Rune</span></td>
  292. <td></td>
  293. </tr>
  294. </tbody>
  295. </table>
  296. </article>
  297. </div>
  298. <div class="hidden-sm col-md-2" role="complementary">
  299. <div class="sideaffix">
  300. <div class="contribution">
  301. <ul class="nav">
  302. <li>
  303. <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/apidoc/new?filename=Terminal_Gui_Graphs_GraphCellToRender.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.GraphCellToRender%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>
  304. </li>
  305. <li>
  306. <a href="tig:tig/gui.cs/blob/main/Terminal.Gui/Core/Graphs/GraphCellToRender.cs/#L8" class="contribution-link">View Source</a>
  307. </li>
  308. </ul>
  309. </div>
  310. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  311. <h5>In This Article</h5>
  312. <div></div>
  313. </nav>
  314. </div>
  315. </div>
  316. </div>
  317. </div>
  318. <footer>
  319. <div class="grad-bottom"></div>
  320. <div class="footer">
  321. <div class="container">
  322. <span class="pull-right">
  323. <a href="#top">Back to top</a>
  324. </span>
  325. <span>Generated by <strong>DocFX</strong></span>
  326. </div>
  327. </div>
  328. </footer>
  329. </div>
  330. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  331. <script type="text/javascript" src="../../styles/docfx.js"></script>
  332. <script type="text/javascript" src="../../styles/main.js"></script>
  333. </body>
  334. </html>