Terminal.Gui.Graphs.HorizontalAxis.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378
  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 HorizontalAxis
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class HorizontalAxis
  11. ">
  12. <meta name="generator" content="docfx 2.59.2.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.HorizontalAxis">
  73. <h1 id="Terminal_Gui_Graphs_HorizontalAxis" data-uid="Terminal.Gui.Graphs.HorizontalAxis" class="text-break">Class HorizontalAxis
  74. </h1>
  75. <div class="markdown level0 summary">
  76. The horizontal (x axis) of a <a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a>
  77. </div>
  78. <div class="markdown level0 conceptual"></div>
  79. <div class="inheritance">
  80. <h5>Inheritance</h5>
  81. <div class="level0"><span class="xref">System.Object</span></div>
  82. <div class="level1"><a class="xref" href="Terminal.Gui.Graphs.Axis.html">Axis</a></div>
  83. <div class="level2"><span class="xref">HorizontalAxis</span></div>
  84. </div>
  85. <div class="inheritedMembers">
  86. <h5>Inherited Members</h5>
  87. <div>
  88. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Axis.Orientation</a>
  89. </div>
  90. <div>
  91. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Axis.Increment</a>
  92. </div>
  93. <div>
  94. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_ShowLabelsEvery">Axis.ShowLabelsEvery</a>
  95. </div>
  96. <div>
  97. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Visible">Axis.Visible</a>
  98. </div>
  99. <div>
  100. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_LabelGetter">Axis.LabelGetter</a>
  101. </div>
  102. <div>
  103. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Text">Axis.Text</a>
  104. </div>
  105. <div>
  106. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Minimum">Axis.Minimum</a>
  107. </div>
  108. <div>
  109. <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Reset">Axis.Reset()</a>
  110. </div>
  111. <div>
  112. <span class="xref">System.Object.Equals(System.Object)</span>
  113. </div>
  114. <div>
  115. <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
  116. </div>
  117. <div>
  118. <span class="xref">System.Object.GetHashCode()</span>
  119. </div>
  120. <div>
  121. <span class="xref">System.Object.GetType()</span>
  122. </div>
  123. <div>
  124. <span class="xref">System.Object.MemberwiseClone()</span>
  125. </div>
  126. <div>
  127. <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
  128. </div>
  129. <div>
  130. <span class="xref">System.Object.ToString()</span>
  131. </div>
  132. </div>
  133. <h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
  134. <h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
  135. <h5 id="Terminal_Gui_Graphs_HorizontalAxis_syntax">Syntax</h5>
  136. <div class="codewrapper">
  137. <pre><code class="lang-csharp hljs">public class HorizontalAxis : Axis</code></pre>
  138. </div>
  139. <h3 id="constructors">Constructors
  140. </h3>
  141. <a id="Terminal_Gui_Graphs_HorizontalAxis__ctor_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.#ctor*"></a>
  142. <h4 id="Terminal_Gui_Graphs_HorizontalAxis__ctor" data-uid="Terminal.Gui.Graphs.HorizontalAxis.#ctor">HorizontalAxis()</h4>
  143. <div class="markdown level1 summary">
  144. Creates a new instance of axis with an <a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a> of <a class="xref" href="Terminal.Gui.Graphs.Orientation.html#Terminal_Gui_Graphs_Orientation_Horizontal">Horizontal</a>
  145. </div>
  146. <div class="markdown level1 conceptual"></div>
  147. <h5 class="decalaration">Declaration</h5>
  148. <div class="codewrapper">
  149. <pre><code class="lang-csharp hljs">public HorizontalAxis()</code></pre>
  150. </div>
  151. <h3 id="methods">Methods
  152. </h3>
  153. <a id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLabel_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLabel*"></a>
  154. <h4 id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLabel_Terminal_Gui_GraphView_System_Int32_System_String_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLabel(Terminal.Gui.GraphView,System.Int32,System.String)">DrawAxisLabel(GraphView, Int32, String)</h4>
  155. <div class="markdown level1 summary">
  156. Draws the given <code data-dev-comment-type="paramref" class="paramref">text</code> on the axis at x <code data-dev-comment-type="paramref" class="paramref">screenPosition</code>.
  157. For the screen y position use <a class="xref" href="Terminal.Gui.Graphs.HorizontalAxis.html#Terminal_Gui_Graphs_HorizontalAxis_GetAxisYPosition_Terminal_Gui_GraphView_">GetAxisYPosition(GraphView)</a>
  158. </div>
  159. <div class="markdown level1 conceptual"></div>
  160. <h5 class="decalaration">Declaration</h5>
  161. <div class="codewrapper">
  162. <pre><code class="lang-csharp hljs">public override void DrawAxisLabel(GraphView graph, int screenPosition, string text)</code></pre>
  163. </div>
  164. <h5 class="parameters">Parameters</h5>
  165. <table class="table table-bordered table-striped table-condensed">
  166. <thead>
  167. <tr>
  168. <th>Type</th>
  169. <th>Name</th>
  170. <th>Description</th>
  171. </tr>
  172. </thead>
  173. <tbody>
  174. <tr>
  175. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  176. <td><span class="parametername">graph</span></td>
  177. <td>Graph being drawn onto</td>
  178. </tr>
  179. <tr>
  180. <td><span class="xref">System.Int32</span></td>
  181. <td><span class="parametername">screenPosition</span></td>
  182. <td>Number of screen columns along the axis to take before rendering</td>
  183. </tr>
  184. <tr>
  185. <td><span class="xref">System.String</span></td>
  186. <td><span class="parametername">text</span></td>
  187. <td>Text to render under the axis tick</td>
  188. </tr>
  189. </tbody>
  190. </table>
  191. <h5 class="overrides">Overrides</h5>
  192. <div><a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_DrawAxisLabel_Terminal_Gui_GraphView_System_Int32_System_String_">Axis.DrawAxisLabel(GraphView, Int32, String)</a></div>
  193. <a id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLabels_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLabels*"></a>
  194. <h4 id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLabels_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLabels(Terminal.Gui.GraphView)">DrawAxisLabels(GraphView)</h4>
  195. <div class="markdown level1 summary">
  196. Draws the horizontal x axis labels and <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a> ticks
  197. </div>
  198. <div class="markdown level1 conceptual"></div>
  199. <h5 class="decalaration">Declaration</h5>
  200. <div class="codewrapper">
  201. <pre><code class="lang-csharp hljs">public override void DrawAxisLabels(GraphView graph)</code></pre>
  202. </div>
  203. <h5 class="parameters">Parameters</h5>
  204. <table class="table table-bordered table-striped table-condensed">
  205. <thead>
  206. <tr>
  207. <th>Type</th>
  208. <th>Name</th>
  209. <th>Description</th>
  210. </tr>
  211. </thead>
  212. <tbody>
  213. <tr>
  214. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  215. <td><span class="parametername">graph</span></td>
  216. <td></td>
  217. </tr>
  218. </tbody>
  219. </table>
  220. <h5 class="overrides">Overrides</h5>
  221. <div><a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_DrawAxisLabels_Terminal_Gui_GraphView_">Axis.DrawAxisLabels(GraphView)</a></div>
  222. <a id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLine*"></a>
  223. <h4 id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLine_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLine(Terminal.Gui.GraphView)">DrawAxisLine(GraphView)</h4>
  224. <div class="markdown level1 summary">
  225. Draws the horizontal axis line
  226. </div>
  227. <div class="markdown level1 conceptual"></div>
  228. <h5 class="decalaration">Declaration</h5>
  229. <div class="codewrapper">
  230. <pre><code class="lang-csharp hljs">public override void DrawAxisLine(GraphView graph)</code></pre>
  231. </div>
  232. <h5 class="parameters">Parameters</h5>
  233. <table class="table table-bordered table-striped table-condensed">
  234. <thead>
  235. <tr>
  236. <th>Type</th>
  237. <th>Name</th>
  238. <th>Description</th>
  239. </tr>
  240. </thead>
  241. <tbody>
  242. <tr>
  243. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  244. <td><span class="parametername">graph</span></td>
  245. <td></td>
  246. </tr>
  247. </tbody>
  248. </table>
  249. <h5 class="overrides">Overrides</h5>
  250. <div><a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_DrawAxisLine_Terminal_Gui_GraphView_">Axis.DrawAxisLine(GraphView)</a></div>
  251. <a id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLine*"></a>
  252. <h4 id="Terminal_Gui_Graphs_HorizontalAxis_DrawAxisLine_Terminal_Gui_GraphView_System_Int32_System_Int32_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.DrawAxisLine(Terminal.Gui.GraphView,System.Int32,System.Int32)">DrawAxisLine(GraphView, Int32, Int32)</h4>
  253. <div class="markdown level1 summary">
  254. Draws a horizontal axis line at the given <code data-dev-comment-type="paramref" class="paramref">x</code>, <code data-dev-comment-type="paramref" class="paramref">y</code>
  255. screen coordinates
  256. </div>
  257. <div class="markdown level1 conceptual"></div>
  258. <h5 class="decalaration">Declaration</h5>
  259. <div class="codewrapper">
  260. <pre><code class="lang-csharp hljs">protected override void DrawAxisLine(GraphView graph, int x, int y)</code></pre>
  261. </div>
  262. <h5 class="parameters">Parameters</h5>
  263. <table class="table table-bordered table-striped table-condensed">
  264. <thead>
  265. <tr>
  266. <th>Type</th>
  267. <th>Name</th>
  268. <th>Description</th>
  269. </tr>
  270. </thead>
  271. <tbody>
  272. <tr>
  273. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  274. <td><span class="parametername">graph</span></td>
  275. <td></td>
  276. </tr>
  277. <tr>
  278. <td><span class="xref">System.Int32</span></td>
  279. <td><span class="parametername">x</span></td>
  280. <td></td>
  281. </tr>
  282. <tr>
  283. <td><span class="xref">System.Int32</span></td>
  284. <td><span class="parametername">y</span></td>
  285. <td></td>
  286. </tr>
  287. </tbody>
  288. </table>
  289. <h5 class="overrides">Overrides</h5>
  290. <div><a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_DrawAxisLine_Terminal_Gui_GraphView_System_Int32_System_Int32_">Axis.DrawAxisLine(GraphView, Int32, Int32)</a></div>
  291. <a id="Terminal_Gui_Graphs_HorizontalAxis_GetAxisYPosition_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.GetAxisYPosition*"></a>
  292. <h4 id="Terminal_Gui_Graphs_HorizontalAxis_GetAxisYPosition_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.HorizontalAxis.GetAxisYPosition(Terminal.Gui.GraphView)">GetAxisYPosition(GraphView)</h4>
  293. <div class="markdown level1 summary">
  294. Returns the Y screen position of the origin (typically 0,0) of graph space.
  295. Return value is bounded by the screen i.e. the axis is always rendered even
  296. if the origin is offscreen.
  297. </div>
  298. <div class="markdown level1 conceptual"></div>
  299. <h5 class="decalaration">Declaration</h5>
  300. <div class="codewrapper">
  301. <pre><code class="lang-csharp hljs">public int GetAxisYPosition(GraphView graph)</code></pre>
  302. </div>
  303. <h5 class="parameters">Parameters</h5>
  304. <table class="table table-bordered table-striped table-condensed">
  305. <thead>
  306. <tr>
  307. <th>Type</th>
  308. <th>Name</th>
  309. <th>Description</th>
  310. </tr>
  311. </thead>
  312. <tbody>
  313. <tr>
  314. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  315. <td><span class="parametername">graph</span></td>
  316. <td></td>
  317. </tr>
  318. </tbody>
  319. </table>
  320. <h5 class="returns">Returns</h5>
  321. <table class="table table-bordered table-striped table-condensed">
  322. <thead>
  323. <tr>
  324. <th>Type</th>
  325. <th>Description</th>
  326. </tr>
  327. </thead>
  328. <tbody>
  329. <tr>
  330. <td><span class="xref">System.Int32</span></td>
  331. <td></td>
  332. </tr>
  333. </tbody>
  334. </table>
  335. </article>
  336. </div>
  337. <div class="hidden-sm col-md-2" role="complementary">
  338. <div class="sideaffix">
  339. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  340. <h5>In This Article</h5>
  341. <div></div>
  342. </nav>
  343. </div>
  344. </div>
  345. </div>
  346. </div>
  347. <footer>
  348. <div class="grad-bottom"></div>
  349. <div class="footer">
  350. <div class="container">
  351. <span class="pull-right">
  352. <a href="#top">Back to top</a>
  353. </span>
  354. <span>Generated by <strong>DocFX</strong></span>
  355. </div>
  356. </div>
  357. </footer>
  358. </div>
  359. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  360. <script type="text/javascript" src="../../styles/docfx.js"></script>
  361. <script type="text/javascript" src="../../styles/main.js"></script>
  362. </body>
  363. </html>