YouPlot/YouPlot/Options.html
2023-01-09 11:38:06 +00:00

1113 lines
18 KiB
HTML

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>
Class: YouPlot::Options
&mdash; Documentation by YARD 0.9.28
</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 = "YouPlot::Options";
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 (O)</a> &raquo;
<span class='title'><span class='object_link'><a href="../YouPlot.html" title="YouPlot (module)">YouPlot</a></span></span>
&raquo;
<span class="title">Options</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>Class: YouPlot::Options
</h1>
<div class="box_info">
<dl>
<dt>Inherits:</dt>
<dd>
<span class="inheritName">Struct</span>
<ul class="fullTree">
<li>Object</li>
<li class="next">Struct</li>
<li class="next">YouPlot::Options</li>
</ul>
<a href="#" class="inheritanceTree">show all</a>
</dd>
</dl>
<dl>
<dt>Defined in:</dt>
<dd>lib/youplot/options.rb</dd>
</dl>
</div>
<h2>Overview</h2><div class="docstring">
<div class="discussion">
<p>Command line options that are not Plot parameters</p>
</div>
</div>
<div class="tags">
</div>
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
<ul class="summary">
<li class="public ">
<span class="summary_signature">
<a href="#color_names-instance_method" title="#color_names (instance method)">#<strong>color_names</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute color_names.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#debug-instance_method" title="#debug (instance method)">#<strong>debug</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute debug.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#delimiter-instance_method" title="#delimiter (instance method)">#<strong>delimiter</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute delimiter.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#encoding-instance_method" title="#encoding (instance method)">#<strong>encoding</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute encoding.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#fmt-instance_method" title="#fmt (instance method)">#<strong>fmt</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute fmt.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#headers-instance_method" title="#headers (instance method)">#<strong>headers</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute headers.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#output-instance_method" title="#output (instance method)">#<strong>output</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute output.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#pass-instance_method" title="#pass (instance method)">#<strong>pass</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute pass.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#progressive-instance_method" title="#progressive (instance method)">#<strong>progressive</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute progressive.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#reverse-instance_method" title="#reverse (instance method)">#<strong>reverse</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute reverse.</p>
</div></span>
</li>
<li class="public ">
<span class="summary_signature">
<a href="#transpose-instance_method" title="#transpose (instance method)">#<strong>transpose</strong> &#x21d2; Object </a>
</span>
<span class="summary_desc"><div class='inline'>
<p>Returns the value of attribute transpose.</p>
</div></span>
</li>
</ul>
<div id="instance_attr_details" class="attr_details">
<h2>Instance Attribute Details</h2>
<span id="color_names=-instance_method"></span>
<div class="method_details first">
<h3 class="signature first" id="color_names-instance_method">
#<strong>color_names</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute color_names</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of color_names</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_color_names'>color_names</span>
<span class='ivar'>@color_names</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="debug=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="debug-instance_method">
#<strong>debug</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute debug</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of debug</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_debug'>debug</span>
<span class='ivar'>@debug</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="delimiter=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="delimiter-instance_method">
#<strong>delimiter</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute delimiter</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of delimiter</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_delimiter'>delimiter</span>
<span class='ivar'>@delimiter</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="encoding=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="encoding-instance_method">
#<strong>encoding</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute encoding</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of encoding</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_encoding'>encoding</span>
<span class='ivar'>@encoding</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="fmt=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="fmt-instance_method">
#<strong>fmt</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute fmt</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of fmt</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_fmt'>fmt</span>
<span class='ivar'>@fmt</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="headers=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="headers-instance_method">
#<strong>headers</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute headers</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of headers</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_headers'>headers</span>
<span class='ivar'>@headers</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="output=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="output-instance_method">
#<strong>output</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute output</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of output</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_output'>output</span>
<span class='ivar'>@output</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="pass=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="pass-instance_method">
#<strong>pass</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute pass</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of pass</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_pass'>pass</span>
<span class='ivar'>@pass</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="progressive=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="progressive-instance_method">
#<strong>progressive</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute progressive</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of progressive</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_progressive'>progressive</span>
<span class='ivar'>@progressive</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="reverse=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="reverse-instance_method">
#<strong>reverse</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute reverse</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of reverse</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_reverse'>reverse</span>
<span class='ivar'>@reverse</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
<span id="transpose=-instance_method"></span>
<div class="method_details ">
<h3 class="signature " id="transpose-instance_method">
#<strong>transpose</strong> &#x21d2; <tt>Object</tt>
</h3><div class="docstring">
<div class="discussion">
<p>Returns the value of attribute transpose</p>
</div>
</div>
<div class="tags">
<p class="tag_title">Returns:</p>
<ul class="return">
<li>
<span class='type'>(<tt>Object</tt>)</span>
&mdash;
<div class='inline'>
<p>the current value of transpose</p>
</div>
</li>
</ul>
</div><table class="source_code">
<tr>
<td>
<pre class="lines">
5
6
7</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'lib/youplot/options.rb', line 5</span>
<span class='kw'>def</span> <span class='id identifier rubyid_transpose'>transpose</span>
<span class='ivar'>@transpose</span>
<span class='kw'>end</span></pre>
</td>
</tr>
</table>
</div>
</div>
</div>
<div id="footer">
Generated on Mon Jan 9 11:38:05 2023 by
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
0.9.28 (ruby-3.2.0).
</div>
</div>
</body>
</html>