mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2025-12-28 00:38:00 +01:00
19b438ca74
* tweaked version # for v1.0.0-beta.10 * tweaked version # for v1.0.0-beta.11 * Updated readme and revision history for 1.0 * tweaked rel notes * Regenerated docs for v1.0.0.0 * updating build docs * updating docs * updated readme * updated readme * more docs * more docs * Refactored for clarity * tweaks * updated info on versioning * merged with main. updated relnotes * updated api docs * updated README to point to new docs * adjusting publish workflow * adjusting publish workflow2 * adjusting publish workflow 3 * adjusting publish workflow 4 * adjusting publish workflow 5 * final fix to yaml * code coverage docs * regenerated api docs * Updated relnotes for v1.0.0-rc.9 * fixed spelling and grammar * rel notes for v1.0.0-rc.10 * relnotes for v1.0.0-rc.11 * relnotes for v1.0.0-rc.12 * v1.0.0-rc.13 * relnotes, readme, api doc regen * updated sample.gif
355 lines
13 KiB
HTML
355 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE]><![endif]-->
|
|
<html>
|
|
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
|
|
<title>Class LegendAnnotation
|
|
</title>
|
|
<meta name="viewport" content="width=device-width">
|
|
<meta name="title" content="Class LegendAnnotation
|
|
">
|
|
<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.LegendAnnotation">
|
|
|
|
|
|
<h1 id="Terminal_Gui_Graphs_LegendAnnotation" data-uid="Terminal.Gui.Graphs.LegendAnnotation" class="text-break">Class LegendAnnotation
|
|
</h1>
|
|
<div class="markdown level0 summary">
|
|
A box containing symbol definitions e.g. meanings for colors in a graph.
|
|
The 'Key' to the graph
|
|
</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">LegendAnnotation</span></div>
|
|
</div>
|
|
<div classs="implements">
|
|
<h5>Implements</h5>
|
|
<div><a class="xref" href="Terminal.Gui.Graphs.IAnnotation.html">IAnnotation</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_LegendAnnotation_syntax">Syntax</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public class LegendAnnotation : IAnnotation</code></pre>
|
|
</div>
|
|
<h3 id="constructors">Constructors
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_Graphs_LegendAnnotation__ctor_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.#ctor*"></a>
|
|
<h4 id="Terminal_Gui_Graphs_LegendAnnotation__ctor_Terminal_Gui_Rect_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.#ctor(Terminal.Gui.Rect)">LegendAnnotation(Rect)</h4>
|
|
<div class="markdown level1 summary">
|
|
Creates a new empty legend at the given screen coordinates
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public LegendAnnotation(Rect legendBounds)</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">legendBounds</span></td>
|
|
<td>Defines the area available for the legend to render in
|
|
(within the graph). This is in screen units (i.e. not graph space)</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="properties">Properties
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_Graphs_LegendAnnotation_BeforeSeries_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.BeforeSeries*"></a>
|
|
<h4 id="Terminal_Gui_Graphs_LegendAnnotation_BeforeSeries" data-uid="Terminal.Gui.Graphs.LegendAnnotation.BeforeSeries">BeforeSeries</h4>
|
|
<div class="markdown level1 summary">
|
|
Returns false i.e. Lengends render after series
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool BeforeSeries { 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><span class="xref">System.Boolean</span></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_Graphs_LegendAnnotation_Border_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.Border*"></a>
|
|
<h4 id="Terminal_Gui_Graphs_LegendAnnotation_Border" data-uid="Terminal.Gui.Graphs.LegendAnnotation.Border">Border</h4>
|
|
<div class="markdown level1 summary">
|
|
True to draw a solid border around the legend.
|
|
Defaults to true. This border will be within the
|
|
<a class="xref" href="Terminal.Gui.Graphs.LegendAnnotation.html#Terminal_Gui_Graphs_LegendAnnotation_Bounds">Bounds</a> and so reduces the width/height
|
|
available for text by 2
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public bool Border { 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>
|
|
|
|
|
|
<a id="Terminal_Gui_Graphs_LegendAnnotation_Bounds_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.Bounds*"></a>
|
|
<h4 id="Terminal_Gui_Graphs_LegendAnnotation_Bounds" data-uid="Terminal.Gui.Graphs.LegendAnnotation.Bounds">Bounds</h4>
|
|
<div class="markdown level1 summary">
|
|
Defines the screen area available for the legend to render in
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public Rect Bounds { 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><a class="xref" href="Terminal.Gui.Rect.html">Rect</a></td>
|
|
<td></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
<h3 id="methods">Methods
|
|
</h3>
|
|
|
|
|
|
<a id="Terminal_Gui_Graphs_LegendAnnotation_AddEntry_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.AddEntry*"></a>
|
|
<h4 id="Terminal_Gui_Graphs_LegendAnnotation_AddEntry_Terminal_Gui_Graphs_GraphCellToRender_System_String_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.AddEntry(Terminal.Gui.Graphs.GraphCellToRender,System.String)">AddEntry(GraphCellToRender, String)</h4>
|
|
<div class="markdown level1 summary">
|
|
Adds an entry into the legend. Duplicate entries are permissable
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void AddEntry(GraphCellToRender graphCellToRender, 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.Graphs.GraphCellToRender.html">GraphCellToRender</a></td>
|
|
<td><span class="parametername">graphCellToRender</span></td>
|
|
<td>The symbol appearing on the graph that should appear in the legend</td>
|
|
</tr>
|
|
<tr>
|
|
<td><span class="xref">System.String</span></td>
|
|
<td><span class="parametername">text</span></td>
|
|
<td>Text to render on this line of the legend. Will be truncated
|
|
if outside of Legend <a class="xref" href="Terminal.Gui.Graphs.LegendAnnotation.html#Terminal_Gui_Graphs_LegendAnnotation_Bounds">Bounds</a></td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<a id="Terminal_Gui_Graphs_LegendAnnotation_Render_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.Render*"></a>
|
|
<h4 id="Terminal_Gui_Graphs_LegendAnnotation_Render_Terminal_Gui_GraphView_" data-uid="Terminal.Gui.Graphs.LegendAnnotation.Render(Terminal.Gui.GraphView)">Render(GraphView)</h4>
|
|
<div class="markdown level1 summary">
|
|
Draws the Legend and all entries into the area within <a class="xref" href="Terminal.Gui.Graphs.LegendAnnotation.html#Terminal_Gui_Graphs_LegendAnnotation_Bounds">Bounds</a>
|
|
</div>
|
|
<div class="markdown level1 conceptual"></div>
|
|
<h5 class="decalaration">Declaration</h5>
|
|
<div class="codewrapper">
|
|
<pre><code class="lang-csharp hljs">public void Render(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>
|
|
<h3 id="implements">Implements</h3>
|
|
<div>
|
|
<a class="xref" href="Terminal.Gui.Graphs.IAnnotation.html">IAnnotation</a>
|
|
</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>
|