Terminal.Gui.Graphs.PathAnnotation.html 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300
  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 PathAnnotation
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class PathAnnotation
  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.PathAnnotation">
  74. <h1 id="Terminal_Gui_Graphs_PathAnnotation" data-uid="Terminal.Gui.Graphs.PathAnnotation" class="text-break">Class PathAnnotation
  75. </h1>
  76. <div class="markdown level0 summary">
  77. Sequence of lines to connect points e.g. of a <a class="xref" href="Terminal.Gui.Graphs.ScatterSeries.html">ScatterSeries</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">PathAnnotation</span></div>
  84. </div>
  85. <div class="implements">
  86. <h5>Implements</h5>
  87. <div><a class="xref" href="Terminal.Gui.Graphs.IAnnotation.html">IAnnotation</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_PathAnnotation_syntax">Syntax</h5>
  92. <div class="codewrapper">
  93. <pre><code class="lang-csharp hljs">public class PathAnnotation : Object, IAnnotation</code></pre>
  94. </div>
  95. <h3 id="constructors">Constructors
  96. </h3>
  97. <a id="Terminal_Gui_Graphs_PathAnnotation__ctor_" data-uid="Terminal.Gui.Graphs.PathAnnotation.#ctor*"></a>
  98. <h4 id="Terminal_Gui_Graphs_PathAnnotation__ctor" data-uid="Terminal.Gui.Graphs.PathAnnotation.#ctor">PathAnnotation()</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 PathAnnotation()</code></pre>
  104. </div>
  105. <h3 id="properties">Properties
  106. </h3>
  107. <a id="Terminal_Gui_Graphs_PathAnnotation_BeforeSeries_" data-uid="Terminal.Gui.Graphs.PathAnnotation.BeforeSeries*"></a>
  108. <h4 id="Terminal_Gui_Graphs_PathAnnotation_BeforeSeries" data-uid="Terminal.Gui.Graphs.PathAnnotation.BeforeSeries">BeforeSeries</h4>
  109. <div class="markdown level1 summary">
  110. True to add line before plotting series. Defaults to false
  111. </div>
  112. <div class="markdown level1 conceptual"></div>
  113. <h5 class="decalaration">Declaration</h5>
  114. <div class="codewrapper">
  115. <pre><code class="lang-csharp hljs">public bool BeforeSeries { get; set; }</code></pre>
  116. </div>
  117. <h5 class="propertyValue">Property Value</h5>
  118. <table class="table table-bordered table-striped table-condensed">
  119. <thead>
  120. <tr>
  121. <th>Type</th>
  122. <th>Description</th>
  123. </tr>
  124. </thead>
  125. <tbody>
  126. <tr>
  127. <td><span class="xref">System.Boolean</span></td>
  128. <td></td>
  129. </tr>
  130. </tbody>
  131. </table>
  132. <a id="Terminal_Gui_Graphs_PathAnnotation_LineColor_" data-uid="Terminal.Gui.Graphs.PathAnnotation.LineColor*"></a>
  133. <h4 id="Terminal_Gui_Graphs_PathAnnotation_LineColor" data-uid="Terminal.Gui.Graphs.PathAnnotation.LineColor">LineColor</h4>
  134. <div class="markdown level1 summary">
  135. Color for the line that connects points
  136. </div>
  137. <div class="markdown level1 conceptual"></div>
  138. <h5 class="decalaration">Declaration</h5>
  139. <div class="codewrapper">
  140. <pre><code class="lang-csharp hljs">public Nullable&lt;Attribute&gt; LineColor { get; set; }</code></pre>
  141. </div>
  142. <h5 class="propertyValue">Property Value</h5>
  143. <table class="table table-bordered table-striped table-condensed">
  144. <thead>
  145. <tr>
  146. <th>Type</th>
  147. <th>Description</th>
  148. </tr>
  149. </thead>
  150. <tbody>
  151. <tr>
  152. <td><span class="xref">System.Nullable</span>&lt;<a class="xref" href="Terminal.Gui.Attribute.html">Attribute</a>&gt;</td>
  153. <td></td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. <a id="Terminal_Gui_Graphs_PathAnnotation_LineRune_" data-uid="Terminal.Gui.Graphs.PathAnnotation.LineRune*"></a>
  158. <h4 id="Terminal_Gui_Graphs_PathAnnotation_LineRune" data-uid="Terminal.Gui.Graphs.PathAnnotation.LineRune">LineRune</h4>
  159. <div class="markdown level1 summary">
  160. The symbol that gets drawn along the line, defaults to &apos;.&apos;
  161. </div>
  162. <div class="markdown level1 conceptual"></div>
  163. <h5 class="decalaration">Declaration</h5>
  164. <div class="codewrapper">
  165. <pre><code class="lang-csharp hljs">public Rune LineRune { get; set; }</code></pre>
  166. </div>
  167. <h5 class="propertyValue">Property Value</h5>
  168. <table class="table table-bordered table-striped table-condensed">
  169. <thead>
  170. <tr>
  171. <th>Type</th>
  172. <th>Description</th>
  173. </tr>
  174. </thead>
  175. <tbody>
  176. <tr>
  177. <td><span class="xref">System.Rune</span></td>
  178. <td></td>
  179. </tr>
  180. </tbody>
  181. </table>
  182. <a id="Terminal_Gui_Graphs_PathAnnotation_Points_" data-uid="Terminal.Gui.Graphs.PathAnnotation.Points*"></a>
  183. <h4 id="Terminal_Gui_Graphs_PathAnnotation_Points" data-uid="Terminal.Gui.Graphs.PathAnnotation.Points">Points</h4>
  184. <div class="markdown level1 summary">
  185. Points that should be connected. Lines will be drawn between points in the order
  186. they appear in the list
  187. </div>
  188. <div class="markdown level1 conceptual"></div>
  189. <h5 class="decalaration">Declaration</h5>
  190. <div class="codewrapper">
  191. <pre><code class="lang-csharp hljs">public List&lt;PointF&gt; Points { get; set; }</code></pre>
  192. </div>
  193. <h5 class="propertyValue">Property Value</h5>
  194. <table class="table table-bordered table-striped table-condensed">
  195. <thead>
  196. <tr>
  197. <th>Type</th>
  198. <th>Description</th>
  199. </tr>
  200. </thead>
  201. <tbody>
  202. <tr>
  203. <td><span class="xref">System.Collections.Generic.List</span>&lt;<a class="xref" href="Terminal.Gui.PointF.html">PointF</a>&gt;</td>
  204. <td></td>
  205. </tr>
  206. </tbody>
  207. </table>
  208. <h3 id="methods">Methods
  209. </h3>
  210. <a id="Terminal_Gui_Graphs_PathAnnotation_Render_" data-uid="Terminal.Gui.Graphs.PathAnnotation.Render*"></a>
  211. <h4 id="Terminal_Gui_Graphs_PathAnnotation_Render_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.PathAnnotation.Render(Terminal.Gui.GraphView)">Render(GraphView)</h4>
  212. <div class="markdown level1 summary">
  213. Draws lines connecting each of the <a class="xref" href="Terminal.Gui.Graphs.PathAnnotation.html#Terminal_Gui_Graphs_PathAnnotation_Points">Points</a>
  214. </div>
  215. <div class="markdown level1 conceptual"></div>
  216. <h5 class="decalaration">Declaration</h5>
  217. <div class="codewrapper">
  218. <pre><code class="lang-csharp hljs">public void Render(GraphView graph)</code></pre>
  219. </div>
  220. <h5 class="parameters">Parameters</h5>
  221. <table class="table table-bordered table-striped table-condensed">
  222. <thead>
  223. <tr>
  224. <th>Type</th>
  225. <th>Name</th>
  226. <th>Description</th>
  227. </tr>
  228. </thead>
  229. <tbody>
  230. <tr>
  231. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  232. <td><span class="parametername">graph</span></td>
  233. <td></td>
  234. </tr>
  235. </tbody>
  236. </table>
  237. <h3 id="implements">Implements</h3>
  238. <div>
  239. <a class="xref" href="Terminal.Gui.Graphs.IAnnotation.html">IAnnotation</a>
  240. </div>
  241. </article>
  242. </div>
  243. <div class="hidden-sm col-md-2" role="complementary">
  244. <div class="sideaffix">
  245. <div class="contribution">
  246. <ul class="nav">
  247. </ul>
  248. </div>
  249. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  250. <h5>In This Article</h5>
  251. <div></div>
  252. </nav>
  253. </div>
  254. </div>
  255. </div>
  256. </div>
  257. <footer>
  258. <div class="grad-bottom"></div>
  259. <div class="footer">
  260. <div class="container">
  261. <span class="pull-right">
  262. <a href="#top">Back to top</a>
  263. </span>
  264. <span>Generated by <strong>DocFX</strong></span>
  265. </div>
  266. </div>
  267. </footer>
  268. </div>
  269. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  270. <script type="text/javascript" src="../../styles/docfx.js"></script>
  271. <script type="text/javascript" src="../../styles/main.js"></script>
  272. </body>
  273. </html>