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


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
							<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class LineCanvas
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class LineCanvas
   ">
    <meta name="generator" content="docfx 2.59.4.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">
    <link href="https://fonts.googleapis.com/css?family=Source Sans Pro" rel="stylesheet"> 
    <link href="https://fonts.googleapis.com/css?family=Source Code Pro" rel="stylesheet"> 
    <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.LineCanvas">
  
  
  <h1 id="Terminal_Gui_Graphs_LineCanvas" data-uid="Terminal.Gui.Graphs.LineCanvas" class="text-break">Class LineCanvas
  </h1>
  <div class="markdown level0 summary">
Facilitates box drawing and line intersection detection
and rendering.  Does not support diagonal lines.
</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">LineCanvas</span></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_LineCanvas_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class LineCanvas</code></pre>
  </div>
  <h3 id="methods">Methods
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_LineCanvas_AddLine_Terminal_Gui_Point_System_Int32_Terminal_Gui_Graphs_Orientation_Terminal_Gui_BorderStyle_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.LineCanvas.AddLine(Terminal.Gui.Point%2CSystem.Int32%2CTerminal.Gui.Graphs.Orientation%2CTerminal.Gui.BorderStyle)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Graphs/LineCanvas.cs/#L45">View Source</a>
  </span>
  <a id="Terminal_Gui_Graphs_LineCanvas_AddLine_" data-uid="Terminal.Gui.Graphs.LineCanvas.AddLine*"></a>
  <h4 id="Terminal_Gui_Graphs_LineCanvas_AddLine_Terminal_Gui_Point_System_Int32_Terminal_Gui_Graphs_Orientation_Terminal_Gui_BorderStyle_" data-uid="Terminal.Gui.Graphs.LineCanvas.AddLine(Terminal.Gui.Point,System.Int32,Terminal.Gui.Graphs.Orientation,Terminal.Gui.BorderStyle)">AddLine(Point, Int32, Orientation, BorderStyle)</h4>
  <div class="markdown level1 summary">
Add a new line to the canvas starting at <code data-dev-comment-type="paramref" class="paramref">from</code>.
Use positive <code data-dev-comment-type="paramref" class="paramref">length</code> for Right and negative for Left
when <a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a> is <a class="xref" href="Terminal.Gui.Graphs.Orientation.html#Terminal_Gui_Graphs_Orientation_Horizontal">Horizontal</a>.
Use positive <code data-dev-comment-type="paramref" class="paramref">length</code> for Down and negative for Up
when <a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a> is <a class="xref" href="Terminal.Gui.Graphs.Orientation.html#Terminal_Gui_Graphs_Orientation_Vertical">Vertical</a>.
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void AddLine(Point from, int length, Orientation orientation, BorderStyle style)</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.Point.html">Point</a></td>
        <td><span class="parametername">from</span></td>
        <td>Starting point.</td>
      </tr>
      <tr>
        <td><span class="xref">System.Int32</span></td>
        <td><span class="parametername">length</span></td>
        <td>Length of line.  0 for a dot.  
Positive for Down/Right.  Negative for Up/Left.</td>
      </tr>
      <tr>
        <td><a class="xref" href="Terminal.Gui.Graphs.Orientation.html">Orientation</a></td>
        <td><span class="parametername">orientation</span></td>
        <td>Direction of the line.</td>
      </tr>
      <tr>
        <td><a class="xref" href="Terminal.Gui.BorderStyle.html">BorderStyle</a></td>
        <td><span class="parametername">style</span></td>
        <td>The style of line to use</td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_LineCanvas_GenerateImage_Terminal_Gui_Rect_.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.LineCanvas.GenerateImage(Terminal.Gui.Rect)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Graphs/LineCanvas.cs/#L60">View Source</a>
  </span>
  <a id="Terminal_Gui_Graphs_LineCanvas_GenerateImage_" data-uid="Terminal.Gui.Graphs.LineCanvas.GenerateImage*"></a>
  <h4 id="Terminal_Gui_Graphs_LineCanvas_GenerateImage_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Graphs.LineCanvas.GenerateImage(Terminal.Gui.Rect)">GenerateImage(Rect)</h4>
  <div class="markdown level1 summary">
Evaluate all currently defined lines that lie within 
<code data-dev-comment-type="paramref" class="paramref">inArea</code> and map that
shows what characters (if any) should be rendered at each
point so that all lines connect up correctly with appropriate
intersection symbols.
<returns></returns>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public Dictionary&lt;Point, Rune&gt; GenerateImage(Rect inArea)</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.Rect.html">Rect</a></td>
        <td><span class="parametername">inArea</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.Collections.Generic.Dictionary</span>&lt;<a class="xref" href="Terminal.Gui.Point.html">Point</a>, <span class="xref">Rune</span>&gt;</td>
        <td>Mapping of all the points within <code data-dev-comment-type="paramref" class="paramref">inArea</code> to
line or intersection runes which should be drawn there.</td>
      </tr>
    </tbody>
  </table>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/gui-cs/Terminal.Gui/new/develop/docfx/overrides/new?filename=Terminal_Gui_Graphs_LineCanvas.md&amp;value=---%0Auid%3A%20Terminal.Gui.Graphs.LineCanvas%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                  </li>
                  <li>
                    <a href="https://github.com/gui-cs/Terminal.Gui/blob/develop/Terminal.Gui/Core/Graphs/LineCanvas.cs/#L12" class="contribution-link">View Source</a>
                  </li>
                </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>