Terminal.Gui.Graphs.Axis.html 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486
  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 Axis
  8. </title>
  9. <meta name="viewport" content="width=device-width">
  10. <meta name="title" content="Class Axis
  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. <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.Axis">
  73. <h1 id="Terminal_Gui_Graphs_Axis" data-uid="Terminal.Gui.Graphs.Axis" class="text-break">Class Axis
  74. </h1>
  75. <div class="markdown level0 summary">
  76. Renders a continuous line with grid line ticks and labels
  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"><span class="xref">Axis</span></div>
  83. <div class="level2"><a class="xref" href="Terminal.Gui.Graphs.HorizontalAxis.html">HorizontalAxis</a></div>
  84. <div class="level2"><a class="xref" href="Terminal.Gui.Graphs.VerticalAxis.html">VerticalAxis</a></div>
  85. </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_Axis_syntax">Syntax</h5>
  89. <div class="codewrapper">
  90. <pre><code class="lang-csharp hljs">public abstract class Axis : Object</code></pre>
  91. </div>
  92. <h3 id="constructors">Constructors
  93. </h3>
  94. <a id="Terminal_Gui_Graphs_Axis__ctor_" data-uid="Terminal.Gui.Graphs.Axis.#ctor*"></a>
  95. <h4 id="Terminal_Gui_Graphs_Axis__ctor_Terminal_Gui_Graphs_Orientation_" data-uid="Terminal.Gui.Graphs.Axis.#ctor(Terminal.Gui.Graphs.Orientation)">Axis(Orientation)</h4>
  96. <div class="markdown level1 summary">
  97. Populates base properties and sets the read only <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Orientation</a>
  98. </div>
  99. <div class="markdown level1 conceptual"></div>
  100. <h5 class="decalaration">Declaration</h5>
  101. <div class="codewrapper">
  102. <pre><code class="lang-csharp hljs">protected Axis(Orientation orientation)</code></pre>
  103. </div>
  104. <h5 class="parameters">Parameters</h5>
  105. <table class="table table-bordered table-striped table-condensed">
  106. <thead>
  107. <tr>
  108. <th>Type</th>
  109. <th>Name</th>
  110. <th>Description</th>
  111. </tr>
  112. </thead>
  113. <tbody>
  114. <tr>
  115. <td><a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a></td>
  116. <td><span class="parametername">orientation</span></td>
  117. <td></td>
  118. </tr>
  119. </tbody>
  120. </table>
  121. <h3 id="fields">Fields
  122. </h3>
  123. <h4 id="Terminal_Gui_Graphs_Axis_LabelGetter" data-uid="Terminal.Gui.Graphs.Axis.LabelGetter">LabelGetter</h4>
  124. <div class="markdown level1 summary">
  125. Allows you to control what label text is rendered for a given <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a>
  126. when <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_ShowLabelsEvery">ShowLabelsEvery</a> is above 0
  127. </div>
  128. <div class="markdown level1 conceptual"></div>
  129. <h5 class="decalaration">Declaration</h5>
  130. <div class="codewrapper">
  131. <pre><code class="lang-csharp hljs">public LabelGetterDelegate LabelGetter</code></pre>
  132. </div>
  133. <h5 class="fieldValue">Field Value</h5>
  134. <table class="table table-bordered table-striped table-condensed">
  135. <thead>
  136. <tr>
  137. <th>Type</th>
  138. <th>Description</th>
  139. </tr>
  140. </thead>
  141. <tbody>
  142. <tr>
  143. <td><a class="xref" href="Terminal.Gui.Graphs.LabelGetterDelegate.html">LabelGetterDelegate</a></td>
  144. <td></td>
  145. </tr>
  146. </tbody>
  147. </table>
  148. <h3 id="properties">Properties
  149. </h3>
  150. <a id="Terminal_Gui_Graphs_Axis_Increment_" data-uid="Terminal.Gui.Graphs.Axis.Increment*"></a>
  151. <h4 id="Terminal_Gui_Graphs_Axis_Increment" data-uid="Terminal.Gui.Graphs.Axis.Increment">Increment</h4>
  152. <div class="markdown level1 summary">
  153. Number of units of graph space between ticks on axis. 0 for no ticks
  154. </div>
  155. <div class="markdown level1 conceptual"></div>
  156. <h5 class="decalaration">Declaration</h5>
  157. <div class="codewrapper">
  158. <pre><code class="lang-csharp hljs">public float Increment { get; set; }</code></pre>
  159. </div>
  160. <h5 class="propertyValue">Property Value</h5>
  161. <table class="table table-bordered table-striped table-condensed">
  162. <thead>
  163. <tr>
  164. <th>Type</th>
  165. <th>Description</th>
  166. </tr>
  167. </thead>
  168. <tbody>
  169. <tr>
  170. <td><span class="xref">System.Single</span></td>
  171. <td></td>
  172. </tr>
  173. </tbody>
  174. </table>
  175. <a id="Terminal_Gui_Graphs_Axis_Minimum_" data-uid="Terminal.Gui.Graphs.Axis.Minimum*"></a>
  176. <h4 id="Terminal_Gui_Graphs_Axis_Minimum" data-uid="Terminal.Gui.Graphs.Axis.Minimum">Minimum</h4>
  177. <div class="markdown level1 summary">
  178. The minimum axis point to show. Defaults to null (no minimum)
  179. </div>
  180. <div class="markdown level1 conceptual"></div>
  181. <h5 class="decalaration">Declaration</h5>
  182. <div class="codewrapper">
  183. <pre><code class="lang-csharp hljs">public Nullable&lt;float&gt; Minimum { get; set; }</code></pre>
  184. </div>
  185. <h5 class="propertyValue">Property Value</h5>
  186. <table class="table table-bordered table-striped table-condensed">
  187. <thead>
  188. <tr>
  189. <th>Type</th>
  190. <th>Description</th>
  191. </tr>
  192. </thead>
  193. <tbody>
  194. <tr>
  195. <td><span class="xref">System.Nullable</span>&lt;<span class="xref">System.Single</span>&gt;</td>
  196. <td></td>
  197. </tr>
  198. </tbody>
  199. </table>
  200. <a id="Terminal_Gui_Graphs_Axis_Orientation_" data-uid="Terminal.Gui.Graphs.Axis.Orientation*"></a>
  201. <h4 id="Terminal_Gui_Graphs_Axis_Orientation" data-uid="Terminal.Gui.Graphs.Axis.Orientation">Orientation</h4>
  202. <div class="markdown level1 summary">
  203. Direction of the axis
  204. </div>
  205. <div class="markdown level1 conceptual"></div>
  206. <h5 class="decalaration">Declaration</h5>
  207. <div class="codewrapper">
  208. <pre><code class="lang-csharp hljs">public Orientation Orientation { get; }</code></pre>
  209. </div>
  210. <h5 class="propertyValue">Property Value</h5>
  211. <table class="table table-bordered table-striped table-condensed">
  212. <thead>
  213. <tr>
  214. <th>Type</th>
  215. <th>Description</th>
  216. </tr>
  217. </thead>
  218. <tbody>
  219. <tr>
  220. <td><a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a></td>
  221. <td></td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <a id="Terminal_Gui_Graphs_Axis_ShowLabelsEvery_" data-uid="Terminal.Gui.Graphs.Axis.ShowLabelsEvery*"></a>
  226. <h4 id="Terminal_Gui_Graphs_Axis_ShowLabelsEvery" data-uid="Terminal.Gui.Graphs.Axis.ShowLabelsEvery">ShowLabelsEvery</h4>
  227. <div class="markdown level1 summary">
  228. The number of <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a> before an label is added.
  229. 0 = never show labels
  230. </div>
  231. <div class="markdown level1 conceptual"></div>
  232. <h5 class="decalaration">Declaration</h5>
  233. <div class="codewrapper">
  234. <pre><code class="lang-csharp hljs">public uint ShowLabelsEvery { get; set; }</code></pre>
  235. </div>
  236. <h5 class="propertyValue">Property Value</h5>
  237. <table class="table table-bordered table-striped table-condensed">
  238. <thead>
  239. <tr>
  240. <th>Type</th>
  241. <th>Description</th>
  242. </tr>
  243. </thead>
  244. <tbody>
  245. <tr>
  246. <td><span class="xref">System.UInt32</span></td>
  247. <td></td>
  248. </tr>
  249. </tbody>
  250. </table>
  251. <a id="Terminal_Gui_Graphs_Axis_Text_" data-uid="Terminal.Gui.Graphs.Axis.Text*"></a>
  252. <h4 id="Terminal_Gui_Graphs_Axis_Text" data-uid="Terminal.Gui.Graphs.Axis.Text">Text</h4>
  253. <div class="markdown level1 summary">
  254. Displayed below/to left of labels (see <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Orientation</a>).
  255. If text is not visible, check <a class="xref" href="Terminal.Gui.GraphView.html#Terminal_Gui_GraphView_MarginBottom">MarginBottom</a> / <a class="xref" href="Terminal.Gui.GraphView.html#Terminal_Gui_GraphView_MarginLeft">MarginLeft</a>
  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">public string Text { get; set; }</code></pre>
  261. </div>
  262. <h5 class="propertyValue">Property Value</h5>
  263. <table class="table table-bordered table-striped table-condensed">
  264. <thead>
  265. <tr>
  266. <th>Type</th>
  267. <th>Description</th>
  268. </tr>
  269. </thead>
  270. <tbody>
  271. <tr>
  272. <td><span class="xref">System.String</span></td>
  273. <td></td>
  274. </tr>
  275. </tbody>
  276. </table>
  277. <a id="Terminal_Gui_Graphs_Axis_Visible_" data-uid="Terminal.Gui.Graphs.Axis.Visible*"></a>
  278. <h4 id="Terminal_Gui_Graphs_Axis_Visible" data-uid="Terminal.Gui.Graphs.Axis.Visible">Visible</h4>
  279. <div class="markdown level1 summary">
  280. True to render axis. Defaults to true
  281. </div>
  282. <div class="markdown level1 conceptual"></div>
  283. <h5 class="decalaration">Declaration</h5>
  284. <div class="codewrapper">
  285. <pre><code class="lang-csharp hljs">public bool Visible { get; set; }</code></pre>
  286. </div>
  287. <h5 class="propertyValue">Property Value</h5>
  288. <table class="table table-bordered table-striped table-condensed">
  289. <thead>
  290. <tr>
  291. <th>Type</th>
  292. <th>Description</th>
  293. </tr>
  294. </thead>
  295. <tbody>
  296. <tr>
  297. <td><span class="xref">System.Boolean</span></td>
  298. <td></td>
  299. </tr>
  300. </tbody>
  301. </table>
  302. <h3 id="methods">Methods
  303. </h3>
  304. <a id="Terminal_Gui_Graphs_Axis_DrawAxisLabel_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabel*"></a>
  305. <h4 id="Terminal_Gui_Graphs_Axis_DrawAxisLabel_Terminal_Gui_GraphView_System_Int32_System_String_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabel(Terminal.Gui.GraphView,System.Int32,System.String)">DrawAxisLabel(GraphView, Int32, String)</h4>
  306. <div class="markdown level1 summary">
  307. Draws a custom label <code data-dev-comment-type="paramref" class="paramref">text</code> at <code data-dev-comment-type="paramref" class="paramref">screenPosition</code> units
  308. along the axis (X or Y depending on <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Orientation</a>)
  309. </div>
  310. <div class="markdown level1 conceptual"></div>
  311. <h5 class="decalaration">Declaration</h5>
  312. <div class="codewrapper">
  313. <pre><code class="lang-csharp hljs">public abstract void DrawAxisLabel(GraphView graph, int screenPosition, string text)</code></pre>
  314. </div>
  315. <h5 class="parameters">Parameters</h5>
  316. <table class="table table-bordered table-striped table-condensed">
  317. <thead>
  318. <tr>
  319. <th>Type</th>
  320. <th>Name</th>
  321. <th>Description</th>
  322. </tr>
  323. </thead>
  324. <tbody>
  325. <tr>
  326. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  327. <td><span class="parametername">graph</span></td>
  328. <td></td>
  329. </tr>
  330. <tr>
  331. <td><span class="xref">System.Int32</span></td>
  332. <td><span class="parametername">screenPosition</span></td>
  333. <td></td>
  334. </tr>
  335. <tr>
  336. <td><span class="xref">System.String</span></td>
  337. <td><span class="parametername">text</span></td>
  338. <td></td>
  339. </tr>
  340. </tbody>
  341. </table>
  342. <a id="Terminal_Gui_Graphs_Axis_DrawAxisLabels_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabels*"></a>
  343. <h4 id="Terminal_Gui_Graphs_Axis_DrawAxisLabels_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabels(Terminal.Gui.GraphView)">DrawAxisLabels(GraphView)</h4>
  344. <div class="markdown level1 summary">
  345. Draws labels and axis <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a> ticks
  346. </div>
  347. <div class="markdown level1 conceptual"></div>
  348. <h5 class="decalaration">Declaration</h5>
  349. <div class="codewrapper">
  350. <pre><code class="lang-csharp hljs">public abstract void DrawAxisLabels(GraphView graph)</code></pre>
  351. </div>
  352. <h5 class="parameters">Parameters</h5>
  353. <table class="table table-bordered table-striped table-condensed">
  354. <thead>
  355. <tr>
  356. <th>Type</th>
  357. <th>Name</th>
  358. <th>Description</th>
  359. </tr>
  360. </thead>
  361. <tbody>
  362. <tr>
  363. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  364. <td><span class="parametername">graph</span></td>
  365. <td></td>
  366. </tr>
  367. </tbody>
  368. </table>
  369. <a id="Terminal_Gui_Graphs_Axis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine*"></a>
  370. <h4 id="Terminal_Gui_Graphs_Axis_DrawAxisLine_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine(Terminal.Gui.GraphView)">DrawAxisLine(GraphView)</h4>
  371. <div class="markdown level1 summary">
  372. Draws the solid line of the axis
  373. </div>
  374. <div class="markdown level1 conceptual"></div>
  375. <h5 class="decalaration">Declaration</h5>
  376. <div class="codewrapper">
  377. <pre><code class="lang-csharp hljs">public abstract void DrawAxisLine(GraphView graph)</code></pre>
  378. </div>
  379. <h5 class="parameters">Parameters</h5>
  380. <table class="table table-bordered table-striped table-condensed">
  381. <thead>
  382. <tr>
  383. <th>Type</th>
  384. <th>Name</th>
  385. <th>Description</th>
  386. </tr>
  387. </thead>
  388. <tbody>
  389. <tr>
  390. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  391. <td><span class="parametername">graph</span></td>
  392. <td></td>
  393. </tr>
  394. </tbody>
  395. </table>
  396. <a id="Terminal_Gui_Graphs_Axis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine*"></a>
  397. <h4 id="Terminal_Gui_Graphs_Axis_DrawAxisLine_Terminal_Gui_GraphView_System_Int32_System_Int32_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine(Terminal.Gui.GraphView,System.Int32,System.Int32)">DrawAxisLine(GraphView, Int32, Int32)</h4>
  398. <div class="markdown level1 summary">
  399. Draws a single cell of the solid line of the axis
  400. </div>
  401. <div class="markdown level1 conceptual"></div>
  402. <h5 class="decalaration">Declaration</h5>
  403. <div class="codewrapper">
  404. <pre><code class="lang-csharp hljs">protected abstract void DrawAxisLine(GraphView graph, int x, int y)</code></pre>
  405. </div>
  406. <h5 class="parameters">Parameters</h5>
  407. <table class="table table-bordered table-striped table-condensed">
  408. <thead>
  409. <tr>
  410. <th>Type</th>
  411. <th>Name</th>
  412. <th>Description</th>
  413. </tr>
  414. </thead>
  415. <tbody>
  416. <tr>
  417. <td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
  418. <td><span class="parametername">graph</span></td>
  419. <td></td>
  420. </tr>
  421. <tr>
  422. <td><span class="xref">System.Int32</span></td>
  423. <td><span class="parametername">x</span></td>
  424. <td></td>
  425. </tr>
  426. <tr>
  427. <td><span class="xref">System.Int32</span></td>
  428. <td><span class="parametername">y</span></td>
  429. <td></td>
  430. </tr>
  431. </tbody>
  432. </table>
  433. <a id="Terminal_Gui_Graphs_Axis_Reset_" data-uid="Terminal.Gui.Graphs.Axis.Reset*"></a>
  434. <h4 id="Terminal_Gui_Graphs_Axis_Reset" data-uid="Terminal.Gui.Graphs.Axis.Reset">Reset()</h4>
  435. <div class="markdown level1 summary">
  436. Resets all configurable properties of the axis to default values
  437. </div>
  438. <div class="markdown level1 conceptual"></div>
  439. <h5 class="decalaration">Declaration</h5>
  440. <div class="codewrapper">
  441. <pre><code class="lang-csharp hljs">public virtual void Reset()</code></pre>
  442. </div>
  443. </article>
  444. </div>
  445. <div class="hidden-sm col-md-2" role="complementary">
  446. <div class="sideaffix">
  447. <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
  448. <h5>In This Article</h5>
  449. <div></div>
  450. </nav>
  451. </div>
  452. </div>
  453. </div>
  454. </div>
  455. <footer>
  456. <div class="grad-bottom"></div>
  457. <div class="footer">
  458. <div class="container">
  459. <span class="pull-right">
  460. <a href="#top">Back to top</a>
  461. </span>
  462. <span>Generated by <strong>DocFX</strong></span>
  463. </div>
  464. </div>
  465. </footer>
  466. </div>
  467. <script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
  468. <script type="text/javascript" src="../../styles/docfx.js"></script>
  469. <script type="text/javascript" src="../../styles/main.js"></script>
  470. </body>
  471. </html>