csharp
/
gui-cs.Terminal.Gui
mirror of https://github.com/gui-cs/Terminal.Gui.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class Axis
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class Axis
   ">
    <meta name="generator" content="docfx 2.56.7.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.Axis">
  
  
  <h1 id="Terminal_Gui_Graphs_Axis" data-uid="Terminal.Gui.Graphs.Axis" class="text-break">Class Axis
  </h1>
  <div class="markdown level0 summary">
Renders a continuous line with grid line ticks and labels
</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"><span class="xref">Axis</span></div>
      <div class="level2"><a class="xref" href="Terminal.Gui.Graphs.HorizontalAxis.html">HorizontalAxis</a></div>
      <div class="level2"><a class="xref" href="Terminal.Gui.Graphs.VerticalAxis.html">VerticalAxis</a></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <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_Axis_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract class Axis</code></pre>
  </div>
  <h3 id="constructors">Constructors
  </h3>
  
  
  <a id="Terminal_Gui_Graphs_Axis__ctor_" data-uid="Terminal.Gui.Graphs.Axis.#ctor*"></a>
  <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>
  <div class="markdown level1 summary">
Populates base properties and sets the read only <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Orientation</a>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected Axis(Orientation orientation)</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.Graphs.Orientation.html">Orientation</a></td>
        <td><span class="parametername">orientation</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="fields">Fields
  </h3>
  
  
  <h4 id="Terminal_Gui_Graphs_Axis_LabelGetter" data-uid="Terminal.Gui.Graphs.Axis.LabelGetter">LabelGetter</h4>
  <div class="markdown level1 summary">
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>
when <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_ShowLabelsEvery">ShowLabelsEvery</a> is above 0
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public LabelGetterDelegate LabelGetter</code></pre>
  </div>
  <h5 class="fieldValue">Field Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Terminal.Gui.Graphs.LabelGetterDelegate.html">LabelGetterDelegate</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <h4 id="Terminal_Gui_Graphs_Axis_Text" data-uid="Terminal.Gui.Graphs.Axis.Text">Text</h4>
  <div class="markdown level1 summary">
Displayed below/to left of labels (see <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Orientation</a>).
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>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public string Text</code></pre>
  </div>
  <h5 class="fieldValue">Field Value</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.String</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  
  
  <a id="Terminal_Gui_Graphs_Axis_Increment_" data-uid="Terminal.Gui.Graphs.Axis.Increment*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_Increment" data-uid="Terminal.Gui.Graphs.Axis.Increment">Increment</h4>
  <div class="markdown level1 summary">
Number of units of graph space between ticks on axis. 0 for no ticks
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public float Increment { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</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.Single</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_Gui_Graphs_Axis_Minimum_" data-uid="Terminal.Gui.Graphs.Axis.Minimum*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_Minimum" data-uid="Terminal.Gui.Graphs.Axis.Minimum">Minimum</h4>
  <div class="markdown level1 summary">
The minimum axis point to show.  Defaults to null (no minimum)
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public float? Minimum { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</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.Nullable</span>&lt;<span class="xref">System.Single</span>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_Gui_Graphs_Axis_Orientation_" data-uid="Terminal.Gui.Graphs.Axis.Orientation*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_Orientation" data-uid="Terminal.Gui.Graphs.Axis.Orientation">Orientation</h4>
  <div class="markdown level1 summary">
Direction of the axis
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Orientation Orientation { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_Gui_Graphs_Axis_ShowLabelsEvery_" data-uid="Terminal.Gui.Graphs.Axis.ShowLabelsEvery*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_ShowLabelsEvery" data-uid="Terminal.Gui.Graphs.Axis.ShowLabelsEvery">ShowLabelsEvery</h4>
  <div class="markdown level1 summary">
The number of <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a> before an label is added.
0 = never show labels
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public uint ShowLabelsEvery { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</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.UInt32</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_Gui_Graphs_Axis_Visible_" data-uid="Terminal.Gui.Graphs.Axis.Visible*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_Visible" data-uid="Terminal.Gui.Graphs.Axis.Visible">Visible</h4>
  <div class="markdown level1 summary">
True to render axis.  Defaults to true
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public bool Visible { get; set; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</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.Boolean</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  
  
  <a id="Terminal_Gui_Graphs_Axis_DrawAxisLabel_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabel*"></a>
  <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>
  <div class="markdown level1 summary">
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
along the axis (X or Y depending on <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Orientation">Orientation</a>)
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract 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></td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">screenPosition</span></td>
        <td></td>
      </tr>
      <tr>
        <td><span class="xref">System.String</span></td>
        <td><span class="parametername">text</span></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  
  
  <a id="Terminal_Gui_Graphs_Axis_DrawAxisLabels_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabels*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_DrawAxisLabels_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLabels(Terminal.Gui.GraphView)">DrawAxisLabels(GraphView)</h4>
  <div class="markdown level1 summary">
Draws labels and axis <a class="xref" href="Terminal.Gui.Graphs.Axis.html#Terminal_Gui_Graphs_Axis_Increment">Increment</a> ticks
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract 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>
  
  
  <a id="Terminal_Gui_Graphs_Axis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_DrawAxisLine_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine(Terminal.Gui.GraphView)">DrawAxisLine(GraphView)</h4>
  <div class="markdown level1 summary">
Draws the solid line of the axis
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public abstract 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>
  
  
  <a id="Terminal_Gui_Graphs_Axis_DrawAxisLine_" data-uid="Terminal.Gui.Graphs.Axis.DrawAxisLine*"></a>
  <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>
  <div class="markdown level1 summary">
Draws a single cell of the solid line of the axis
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">protected abstract 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>
  
  
  <a id="Terminal_Gui_Graphs_Axis_Reset_" data-uid="Terminal.Gui.Graphs.Axis.Reset*"></a>
  <h4 id="Terminal_Gui_Graphs_Axis_Reset" data-uid="Terminal.Gui.Graphs.Axis.Reset">Reset()</h4>
  <div class="markdown level1 summary">
Resets all configurable properties of the axis to default values
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public virtual void Reset()</code></pre>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <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>