Git_Mirror/Terminal.Gui
1
0
Fork 0
mirror of https://github.com/gui-cs/Terminal.Gui.git synced 2025-12-27 16:27:55 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
62ec263b02094031c3cf2c62d07b270fc8bbef43
Terminal.Gui/docs/api/Terminal.Gui/Terminal.Gui.Graphs.VerticalAxis.html

380 lines
16 KiB
HTML
Raw Blame History

<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>Class VerticalAxis
</title>
<meta name="viewport" content="width=device-width">
<meta name="title" content="Class VerticalAxis
">
<meta name="generator" content="docfx 2.59.0.0">
<link rel="shortcut icon" href="../../favicon.ico">
<link rel="stylesheet" href="../../styles/docfx.vendor.css">
<link rel="stylesheet" href="../../styles/docfx.css">
<link rel="stylesheet" href="../../styles/main.css">
<meta property="docfx:navrel" content="../../toc.html">
<meta property="docfx:tocrel" content="toc.html">
<meta property="docfx:rel" content="../../">
</head>
<body data-spy="scroll" data-target="#affix" data-offset="120">
<div id="wrapper">
<header>
<nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
<div class="container">
<div class="navbar-header">
<button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
<span class="sr-only">Toggle navigation</span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
<span class="icon-bar"></span>
</button>
<a class="navbar-brand" href="../../index.html">
<img id="logo" class="svg" src="../../images/logo48.png" alt="">
</a>
</div>
<div class="collapse navbar-collapse" id="navbar">
<form class="navbar-form navbar-right" role="search" id="search">
<div class="form-group">
<input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
</div>
</form>
</div>
</div>
</nav>
<div class="subnav navbar navbar-default">
<div class="container hide-when-search" id="breadcrumb">
<ul class="breadcrumb">
<li></li>
</ul>
</div>
</div>
</header>
<div class="container body-content">
<div id="search-results">
<div class="search-list">Search Results for <span></span></div>
<div class="sr-items">
<p><i class="glyphicon glyphicon-refresh index-loading"></i></p>
</div>
<ul id="pagination" data-first="First" data-prev="Previous" data-next="Next" data-last="Last"></ul>
</div>
</div>
<div role="main" class="container body-content hide-when-search">
<div class="sidenav hide-when-search">
<a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
<div class="sidetoggle collapse" id="sidetoggle">
<div id="sidetoc"></div>
</div>
</div>
<div class="article row grid-right">
<div class="col-md-10">
<article class="content wrap" id="_content" data-uid="Terminal.Gui.Graphs.VerticalAxis">
<h1 id="Terminal_Gui_Graphs_VerticalAxis" data-uid="Terminal.Gui.Graphs.VerticalAxis" class="text-break">Class VerticalAxis
</h1>
<div class="markdown level0 summary">
The vertical (i.e. Y axis) of a <a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a>
</div>
<div class="markdown level0 conceptual"></div>
<div class="inheritance">
<h5>Inheritance</h5>
<div class="level0"><span class="xref">System.Object</span></div>
<div class="level1"><a class="xref" href="Terminal.Gui.Graphs.Axis.html">Axis</a></div>
<div class="level2"><span class="xref">VerticalAxis</span></div>
</div>
<div class="inheritedMembers">
<h5>Inherited Members</h5>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Axis.Orientation</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Axis.Increment</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_ShowLabelsEvery">Axis.ShowLabelsEvery</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Visible">Axis.Visible</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_LabelGetter">Axis.LabelGetter</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Text">Axis.Text</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Minimum">Axis.Minimum</a>
</div>
<div>
<a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Reset">Axis.Reset()</a>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object)</span>
</div>
<div>
<span class="xref">System.Object.Equals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.GetHashCode()</span>
</div>
<div>
<span class="xref">System.Object.GetType()</span>
</div>
<div>
<span class="xref">System.Object.MemberwiseClone()</span>
</div>
<div>
<span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
</div>
<div>
<span class="xref">System.Object.ToString()</span>
</div>
</div>
<h6><strong>Namespace</strong>: <a class="xref" href="Terminal.Gui.Graphs.html">Terminal.Gui.Graphs</a></h6>
<h6><strong>Assembly</strong>: Terminal.Gui.dll</h6>
<h5 id="Terminal_Gui_Graphs_VerticalAxis_syntax">Syntax</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public class VerticalAxis : Axis</code></pre>
</div>
<h3 id="constructors">Constructors
</h3>
<a id="Terminal_Gui_Graphs_VerticalAxis__ctor_" data-uid="Terminal.Gui.Graphs.VerticalAxis.#ctor*"></a>
<h4 id="Terminal_Gui_Graphs_VerticalAxis__ctor" data-uid="Terminal.Gui.Graphs.VerticalAxis.#ctor">VerticalAxis()</h4>
<div class="markdown level1 summary">
Creates a new <a class="xref" href="Terminal.Gui.Graphs.Orientation.html#Terminal_Gui_Graphs_Orientation_Vertical">Vertical</a> axis
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public VerticalAxis()</code></pre>
</div>
<h3 id="methods">Methods
</h3>
<a id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLabel_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLabel*"></a>
<h4 id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLabel_Terminal_Gui_GraphView_System_Int32_System_String_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLabel(Terminal.Gui.GraphView,System.Int32,System.String)">DrawAxisLabel(GraphView, Int32, String)</h4>
<div class="markdown level1 summary">
Draws the given <code data-dev-comment-type="paramref" class="paramref">text</code> on the axis at y <code data-dev-comment-type="paramref" class="paramref">screenPosition</code>.
For the screen x position use <a class="xref" href="Terminal.Gui.Graphs.VerticalAxis.html#Terminal_Gui_Graphs_VerticalAxis_GetAxisXPosition_Terminal_Gui_GraphView_">GetAxisXPosition(GraphView)</a>
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void DrawAxisLabel(GraphView graph, int screenPosition, string text)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
<td><span class="parametername">graph</span></td>
<td>Graph being drawn onto</td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">screenPosition</span></td>
<td>Number of rows from the top of the screen (i.e. down the axis) before rendering</td>
</tr>
<tr>
<td><span class="xref">System.String</span></td>
<td><span class="parametername">text</span></td>
<td>Text to render to the left of the axis tick. Ensure to
set <a class="xref" href="Terminal.Gui.GraphView.html#Terminal_Gui_GraphView_MarginLeft">MarginLeft</a> or <a class="xref" href="Terminal.Gui.GraphView.html#Terminal_Gui_GraphView_ScrollOffset">ScrollOffset</a> sufficient that it is visible</td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<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>
<a id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLabels_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLabels*"></a>
<h4 id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLabels_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLabels(Terminal.Gui.GraphView)">DrawAxisLabels(GraphView)</h4>
<div class="markdown level1 summary">
Draws axis <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a> markers and labels
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void DrawAxisLabels(GraphView graph)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
<td><span class="parametername">graph</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_DrawAxisLabels_Terminal_Gui_GraphView_">Axis.DrawAxisLabels(GraphView)</a></div>
<a id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLine*"></a>
<h4 id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLine_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLine(Terminal.Gui.GraphView)">DrawAxisLine(GraphView)</h4>
<div class="markdown level1 summary">
Draws the vertical axis line
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public override void DrawAxisLine(GraphView graph)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
<td><span class="parametername">graph</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<div><a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_DrawAxisLine_Terminal_Gui_GraphView_">Axis.DrawAxisLine(GraphView)</a></div>
<a id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLine*"></a>
<h4 id="Terminal_Gui_Graphs_VerticalAxis_DrawAxisLine_Terminal_Gui_GraphView_System_Int32_System_Int32_" data-uid="Terminal.Gui.Graphs.VerticalAxis.DrawAxisLine(Terminal.Gui.GraphView,System.Int32,System.Int32)">DrawAxisLine(GraphView, Int32, Int32)</h4>
<div class="markdown level1 summary">
Draws a vertical 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>
screen coordinates
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">protected override void DrawAxisLine(GraphView graph, int x, int y)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
<td><span class="parametername">graph</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">x</span></td>
<td></td>
</tr>
<tr>
<td><span class="xref">System.Int32</span></td>
<td><span class="parametername">y</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="overrides">Overrides</h5>
<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>
<a id="Terminal_Gui_Graphs_VerticalAxis_GetAxisXPosition_" data-uid="Terminal.Gui.Graphs.VerticalAxis.GetAxisXPosition*"></a>
<h4 id="Terminal_Gui_Graphs_VerticalAxis_GetAxisXPosition_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.VerticalAxis.GetAxisXPosition(Terminal.Gui.GraphView)">GetAxisXPosition(GraphView)</h4>
<div class="markdown level1 summary">
Returns the X screen position of the origin (typically 0,0) of graph space.
Return value is bounded by the screen i.e. the axis is always rendered even
if the origin is offscreen.
</div>
<div class="markdown level1 conceptual"></div>
<h5 class="decalaration">Declaration</h5>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public int GetAxisXPosition(GraphView graph)</code></pre>
</div>
<h5 class="parameters">Parameters</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><a class="xref" href="Terminal.Gui.GraphView.html">GraphView</a></td>
<td><span class="parametername">graph</span></td>
<td></td>
</tr>
</tbody>
</table>
<h5 class="returns">Returns</h5>
<table class="table table-bordered table-striped table-condensed">
<thead>
<tr>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><span class="xref">System.Int32</span></td>
<td></td>
</tr>
</tbody>
</table>
</article>
</div>
<div class="hidden-sm col-md-2" role="complementary">
<div class="sideaffix">
<nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
<h5>In This Article</h5>
<div></div>
</nav>
</div>
</div>
</div>
</div>
<footer>
<div class="grad-bottom"></div>
<div class="footer">
<div class="container">
<span class="pull-right">
<a href="#top">Back to top</a>
</span>
<span>Generated by <strong>DocFX</strong></span>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="../../styles/docfx.vendor.js"></script>
<script type="text/javascript" src="../../styles/docfx.js"></script>
<script type="text/javascript" src="../../styles/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink