YouPlot/UnicodePlot.html

251 lines
6.2 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Module: UnicodePlot
&mdash; Documentation by YARD 0.9.27
</title>
<link rel="stylesheet" href="css/style.css" type="text/css" />
<link rel="stylesheet" href="css/common.css" type="text/css" />
<script type="text/javascript">
pathId = "UnicodePlot";
relpath = '';
</script>
<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
</head>
<body>
<div class="nav_wrap">
<iframe id="nav" src="class_list.html?1"></iframe>
<div id="resizer"></div>
</div>
<div id="main" tabindex="-1">
<div id="header">
<div id="menu">
<a href="_index.html">Index (U)</a> &raquo;
<span class="title">UnicodePlot</span>
</div>
<div id="search">
<a class="full_list_link" id="class_list_link"
href="class_list.html">
<svg width="24" height="24">
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
</svg>
</a>
</div>
<div class="clear"></div>
</div>
<div id="content"><h1>Module: UnicodePlot
</h1>
<div class="box_info">
<dl>
<dt>Defined in:</dt>
<dd>lib/youplot/backends/unicode_plot.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>If the line color is specified as a number, the program will display an error message to the user and exit. Remove this patch when UnicodePlot is improved.</p>
</div>
</div>
<div class="tags">
</div>
<h2>
Class Method Summary
<small><a href="#" class="summary_toggle">collapse</a></small>
</h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#lineplot-class_method" title="lineplot (class method)">.<strong>lineplot</strong>(*args, **kw) &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#lineplot_original-class_method" title="lineplot_original (class method)">.<strong>lineplot_original</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'></div></span>
</li>
</ul>
<div id="class_method_details" class="method_details_list">
<h2>Class Method Details</h2>
<div class="method_details first">
<h3 class="signature first" id="lineplot-class_method">
.<strong>lineplot</strong>(*args, **kw) &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
15
16
17
18
19
20
21
22
23
24
25
26</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/backends/unicode_plot.rb', line 15</span>
<span class='kw'>def</span> <span class='id identifier rubyid_lineplot'>lineplot</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kw'>kw</span><span class='rparen'>)</span>
<span class='kw'>if</span> <span class='id identifier rubyid_kw'>kw</span><span class='lbracket'>[</span><span class='symbol'>:color</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id identifier rubyid_is_a?'>is_a?</span> <span class='const'>Numeric</span>
<span class='id identifier rubyid_warn'>warn</span> <span class='heredoc_beg'>&lt;&lt;~EOS</span>
<span class='tstring_content'> YouPlot: Line colors cannot be specified by numerical values.
</span><span class='tstring_content'>
</span><span class='tstring_content'> For more information, please see the following issue.
</span><span class='tstring_content'> https://github.com/red-data-tools/unicode_plot.rb/issues/34
</span><span class='heredoc_end'> EOS
</span> <span class='const'><span class='object_link'><a href="YouPlot.html" title="YouPlot (module)">YouPlot</a></span></span><span class='period'>.</span><span class='id identifier rubyid_run_as_executable'><span class='object_link'><a href="YouPlot.html#run_as_executable-class_method" title="YouPlot.run_as_executable (method)">run_as_executable</a></span></span> <span class='op'>?</span> <span class='id identifier rubyid_exit'>exit</span><span class='lparen'>(</span><span class='int'>1</span><span class='rparen'>)</span> <span class='op'>:</span> <span class='id identifier rubyid_raise'>raise</span><span class='lparen'>(</span><span class='const'>Error</span><span class='rparen'>)</span>
<span class='kw'>end</span>
<span class='id identifier rubyid_lineplot_original'>lineplot_original</span><span class='lparen'>(</span><span class='op'>*</span><span class='id identifier rubyid_args'>args</span><span class='comma'>,</span> <span class='op'>**</span><span class='id identifier rubyid_kw'>kw</span><span class='rparen'>)</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<div class="method_details ">
<h3 class="signature " id="lineplot_original-class_method">
.<strong>lineplot_original</strong> &#x21d2; <tt>Object</tt>
</h3><table class="source_code">
<tr>
<td>
<pre class="lines">
14</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/backends/unicode_plot.rb', line 14</span>
<span class='kw'>alias</span> <span class='id identifier rubyid_lineplot_original'>lineplot_original</span> <span class='id identifier rubyid_lineplot'>lineplot</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Wed May 25 07:07:34 2022 by
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.27 (ruby-3.1.2).
</div>
</div>
</body>
</html>