Terminal.Gui.Graphs.IAnnotation.html 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  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>Interface IAnnotation
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Interface IAnnotation
  11. ">
  12. <meta name="generator" content="docfx 2.59.0.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. <meta property="docfx:navrel" content="../../toc.html">
  18. <meta property="docfx:tocrel" content="toc.html">
  19. <meta property="docfx:rel" content="../../">
  20. </head>
  21. <body data-spy="scroll" data-target="#affix" data-offset="120">
  22. <div id="wrapper">
  23. <header>
  24. <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
  25. <div class="container">
  26. <div class="navbar-header">
  27. <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
  28. <span class="sr-only">Toggle navigation</span>
  29. <span class="icon-bar"></span>
  30. <span class="icon-bar"></span>
  31. <span class="icon-bar"></span>
  32. </button>
  33. <a class="navbar-brand" href="../../index.html">
  34. <img id="logo" class="svg" src="../../images/logo48.png" alt="">
  35. </a>
  36. </div>
  37. <div class="collapse navbar-collapse" id="navbar">
  38. <form class="navbar-form navbar-right" role="search" id="search">
  39. <div class="form-group">
  40. <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
  41. </div>
  42. </form>
  43. </div>
  44. </div>
  45. </nav>
  46. <div class="subnav navbar navbar-default">
  47. <div class="container hide-when-search" id="breadcrumb">
  48. <ul class="breadcrumb">
  49. <li></li>
  50. </ul>
  51. </div>
  52. </div>
  53. </header>
  54. <div class="container body-content">
  55. <div id="search-results">
  56. <div class="search-list">Search Results for <span></span></div>
  57. <div class="sr-items">
  58. <p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
  59. </div>
  60. <ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
  61. </div>
  62. </div>
  63. <div role="main" class="container body-content hide-when-search">
  64. <div class="sidenav hide-when-search">
  65. <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
  66. <div class="sidetoggle collapse" id="sidetoggle">
  67. <div id="sidetoc"></div>
  68. </div>
  69. </div>
  70. <div class="article row grid-right">
  71. <div class="col-md-10">
  72. <article class="content wrap" id="_content" data-uid="Terminal.Gui.Graphs.IAnnotation">
  73. <h1 id="Terminal_Gui_Graphs_IAnnotation" data-uid="Terminal.Gui.Graphs.IAnnotation" class="text-break">Interface IAnnotation
  74. </h1>
  75. <div class="markdown level0 summary">
  76. <p>Describes an overlay element that is rendered either before or
  77. after a series.</p>
  78. <p>Annotations can be positioned either in screen space (e.g.
  79. a legend) or in graph space (e.g. a line showing high point)
  80. </p>
  81. <p>Unlike <a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a>, annotations are allowed to
  82. draw into graph margins
  83. </p>
  84. </div>
  85. <div class="markdown level0 conceptual"></div>
  86. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
  87. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  88. <h5 id="Terminal_Gui_Graphs_IAnnotation_syntax">Syntax</h5>
  89. <div class="codewrapper">
  90. <pre><code class="lang-csharp hljs">public interface IAnnotation</code></pre>
  91. </div>
  92. <h3 id="properties">Properties
  93. </h3>
  94. <a id="Terminal_Gui_Graphs_IAnnotation_BeforeSeries_" data-uid="Terminal.Gui.Graphs.IAnnotation.BeforeSeries*"></a>
  95. <h4 id="Terminal_Gui_Graphs_IAnnotation_BeforeSeries" data-uid="Terminal.Gui.Graphs.IAnnotation.BeforeSeries">BeforeSeries</h4>
  96. <div class="markdown level1 summary">
  97. True if annotation should be drawn before <a class="xref" href="Terminal.Gui.Graphs.ISeries.html">ISeries</a>. This
  98. allowes Series and later annotations to potentially draw over the top
  99. of this annotation.
  100. </div>
  101. <div class="markdown level1 conceptual"></div>
  102. <h5 class="decalaration">Declaration</h5>
  103. <div class="codewrapper">
  104. <pre><code class="lang-csharp hljs">bool BeforeSeries { get; }</code></pre>
  105. </div>
  106. <h5 class="propertyValue">Property Value</h5>
  107. <table class="table table-bordered table-striped table-condensed">
  108. <thead>
  109. <tr>
  110. <th>Type</th>
  111. <th>Description</th>
  112. </tr>
  113. </thead>
  114. <tbody>
  115. <tr>
  116. <td><span class="xref">System.Boolean</span></td>
  117. <td></td>
  118. </tr>
  119. </tbody>
  120. </table>
  121. <h3 id="methods">Methods
  122. </h3>
  123. <a id="Terminal_Gui_Graphs_IAnnotation_Render_" data-uid="Terminal.Gui.Graphs.IAnnotation.Render*"></a>
  124. <h4 id="Terminal_Gui_Graphs_IAnnotation_Render_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.IAnnotation.Render(Terminal.Gui.GraphView)">Render(GraphView)</h4>
  125. <div class="markdown level1 summary">
  126. Called once after series have been rendered (or before if <a class="xref" href="Terminal.Gui.Graphs.IAnnotation.html#Terminal_Gui_Graphs_IAnnotation_BeforeSeries">BeforeSeries</a> is true).
  127. Use <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Driver">Driver</a> to draw and <a class="xref" href="Terminal.Gui.View.html#Terminal_Gui_View_Bounds">Bounds</a> to avoid drawing outside of
  128. graph
  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">void Render(GraphView graph)</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><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  147. <td><span class="parametername">graph</span></td>
  148. <td></td>
  149. </tr>
  150. </tbody>
  151. </table>
  152. </article>
  153. </div>
  154. <div class="hidden-sm col-md-2" role="complementary">
  155. <div class="sideaffix">
  156. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  157. <h5>In This Article</h5>
  158. <div></div>
  159. </nav>
  160. </div>
  161. </div>
  162. </div>
  163. </div>
  164. <footer>
  165. <div class="grad-bottom"></div>
  166. <div class="footer">
  167. <div class="container">
  168. <span class="pull-right">
  169. <a href="#top">Back to top</a>
  170. </span>
  171. <span>Generated by <strong>DocFX</strong></span>
  172. </div>
  173. </div>
  174. </footer>
  175. </div>
  176. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  177. <script type="text/javascript" src="../../styles/docfx.js"></script>
  178. <script type="text/javascript" src="../../styles/main.js"></script>
  179. </body>
  180. </html>