summaryrefslogtreecommitdiffhomepage
path: root/doc/Axlsx/LineSeries.html
diff options
context:
space:
mode:
authorRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
committerRandy Morgan <[email protected]>2011-12-01 14:11:42 +0900
commit8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch)
tree9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/LineSeries.html
parent076be316935180341d7ee7a9335281a4b18d1fa9 (diff)
downloadcaxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz
caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/LineSeries.html')
-rw-r--r--doc/Axlsx/LineSeries.html593
1 files changed, 0 insertions, 593 deletions
diff --git a/doc/Axlsx/LineSeries.html b/doc/Axlsx/LineSeries.html
deleted file mode 100644
index f45ede72..00000000
--- a/doc/Axlsx/LineSeries.html
+++ /dev/null
@@ -1,593 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
-<title>
- Class: Axlsx::LineSeries
-
- &mdash; AXLSX
-
-</title>
-
- <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" />
-
- <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" />
-
-<script type="text/javascript" charset="utf-8">
- relpath = '..';
- if (relpath != '') 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>
- <script type="text/javascript" charset="utf-8">
- if (window.top.frames.main) document.body.className = 'frames';
- </script>
-
- <div id="header">
- <div id="menu">
-
- <a href="../_index.html">Index (L)</a> &raquo;
- <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span>
- &raquo;
- <span class="title">LineSeries</span>
-
-
- <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
-</div>
-
- <div id="search">
-
- <a id="class_list_link" href="#">Class List</a>
-
- <a id="method_list_link" href="#">Method List</a>
-
- <a id="file_list_link" href="#">File List</a>
-
-</div>
- <div class="clear"></div>
- </div>
-
- <iframe id="search_frame"></iframe>
-
- <div id="content"><h1>Class: Axlsx::LineSeries
-
-
-
-</h1>
-
-<dl class="box">
-
- <dt class="r1">Inherits:</dt>
- <dd class="r1">
- <span class="inheritName"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></span>
-
- <ul class="fullTree">
- <li>Object</li>
-
- <li class="next"><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li>
-
- <li class="next">Axlsx::LineSeries</li>
-
- </ul>
- <a href="#" class="inheritanceTree">show all</a>
-
- </dd>
-
-
-
-
-
-
-
-
-
- <dt class="r2 last">Defined in:</dt>
- <dd class="r2 last">lib/axlsx/drawing/line_series.rb</dd>
-
-</dl>
-<div class="clear"></div>
-
-<h2>Overview</h2><div class="docstring">
- <div class="discussion">
-
- <div class="note notetag">
- <strong>Note:</strong>
- <div class='inline'>
-<p>The recommended way to manage series is to use Chart#add_series</p>
-</div>
- </div>
-
-
-<p>A LineSeries defines the title, data and labels for line charts</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-
- <h3>See Also:</h3>
- <ul class="see">
-
- <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li>
-
- <li><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">Chart#add_series</a></span></li>
-
- </ul>
-
-</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="#data-instance_method" title="#data (instance method)">- (ValAxisData) <strong>data</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>The data for this series.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#labels-instance_method" title="#labels (instance method)">- (CatAxisData) <strong>labels</strong> </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>The labels for this series.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
-
-
-
-
-
-
- <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="Series.html#chart-instance_method" title="Axlsx::Series#chart (method)">chart</a></span>, <span class='object_link'><a href="Series.html#title-instance_method" title="Axlsx::Series#title (method)">title</a></span></p>
-
-
-
- <h2>
- Instance Method Summary
- <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
- </h2>
-
- <ul class="summary">
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#initialize-instance_method" title="#initialize (instance method)">- (LineSeries) <strong>initialize</strong>(chart, options = {}) </a>
-
-
-
- </span>
-
- <span class="note title constructor">constructor</span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Creates a new series.</p>
-</div></span>
-
-</li>
-
-
- <li class="public ">
- <span class="summary_signature">
-
- <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (String) <strong>to_xml</strong>(xml) </a>
-
-
-
- </span>
-
-
-
-
-
-
-
-
- <span class="summary_desc"><div class='inline'>
-<p>Serializes the series.</p>
-</div></span>
-
-</li>
-
-
- </ul>
-
-
-
-
-
-
-
-
-
-
- <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></h3>
- <p class="inherited"><span class='object_link'><a href="Series.html#index-instance_method" title="Axlsx::Series#index (method)">#index</a></span>, <span class='object_link'><a href="Series.html#order-instance_method" title="Axlsx::Series#order (method)">#order</a></span>, <span class='object_link'><a href="Series.html#order%3D-instance_method" title="Axlsx::Series#order= (method)">#order=</a></span></p>
-<div id="constructor_details" class="method_details_list">
- <h2>Constructor Details</h2>
-
- <div class="method_details first">
- <p class="signature first" id="initialize-instance_method">
-
- - (<tt><span class='object_link'><a href="" title="Axlsx::LineSeries (class)">LineSeries</a></span></tt>) <strong>initialize</strong>(chart, options = {})
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Creates a new series</p>
-
-
- </div>
-</div>
-<div class="tags">
- <h3>Parameters:</h3>
-<ul class="param">
-
- <li>
-
- <span class='name'>chart</span>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span>
-
-
-
- </li>
-
- <li>
-
- <span class='name'>options</span>
-
-
- <span class='type'>(<tt>Hash</tt>)</span>
-
-
- <em class="default">(defaults to: <tt>{}</tt>)</em>
-
-
- &mdash;
- <div class='inline'>
-<p>a customizable set of options</p>
-</div>
-
- </li>
-
-</ul>
-
-
-
-
-
-
- <h3>Options Hash (<tt>options</tt>):</h3>
- <ul class="option">
-
- <li>
- <span class="name">data</span>
- <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- <li>
- <span class="name">labels</span>
- <span class="type">(<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span>
- <span class="default">
-
- </span>
-
- </li>
-
- </ul>
-
-
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-20
-21
-22
-23
-24
-25</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 20</span>
-
-<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span>
- <span class='@labels ivar id'>@labels</span><span class='comma token'>,</span> <span class='@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span>
- <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='chart identifier id'>chart</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span>
- <span class='@labels ivar id'>@labels</span> <span class='assign token'>=</span> <span class='CatAxisData constant id'>CatAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:labels</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
- <span class='@data ivar id'>@data</span> <span class='assign token'>=</span> <span class='ValAxisData constant id'>ValAxisData</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:data</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-</div>
-
- <div id="instance_attr_details" class="attr_details">
- <h2>Instance Attribute Details</h2>
-
-
- <span id="data=-instance_method"></span>
- <span id="data-instance_method"></span>
- <div class="method_details first">
- <p class="signature first" id="data-instance_method">
-
- - (<tt><span class='object_link'><a href="ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span></tt>) <strong>data</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>The data for this series.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<h3>Returns:</h3>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span></tt>)</span>
-
-
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-10
-11
-12</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 10</span>
-
-<span class='def def kw'>def</span> <span class='data identifier id'>data</span>
- <span class='@data ivar id'>@data</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
-
- <span id="labels=-instance_method"></span>
- <span id="labels-instance_method"></span>
- <div class="method_details ">
- <p class="signature " id="labels-instance_method">
-
- - (<tt><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></tt>) <strong>labels</strong>
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>The labels for this series.</p>
-
-
- </div>
-</div>
-<div class="tags">
-
-<h3>Returns:</h3>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></tt>)</span>
-
-
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-14
-15
-16</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 14</span>
-
-<span class='def def kw'>def</span> <span class='labels identifier id'>labels</span>
- <span class='@labels ivar id'>@labels</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-
- <div id="instance_method_details" class="method_details_list">
- <h2>Instance Method Details</h2>
-
-
- <div class="method_details first">
- <p class="signature first" id="to_xml-instance_method">
-
- - (<tt>String</tt>) <strong>to_xml</strong>(xml)
-
-
-
-</p><div class="docstring">
- <div class="discussion">
-
-<p>Serializes the series</p>
-
-
- </div>
-</div>
-<div class="tags">
- <h3>Parameters:</h3>
-<ul class="param">
-
- <li>
-
- <span class='name'>xml</span>
-
-
- <span class='type'>(<tt>Nokogiri::XML::Builder</tt>)</span>
-
-
-
- &mdash;
- <div class='inline'>
-<p>The document builder instance this objects xml will be added to.</p>
-</div>
-
- </li>
-
-</ul>
-
-<h3>Returns:</h3>
-<ul class="return">
-
- <li>
-
-
- <span class='type'>(<tt>String</tt>)</span>
-
-
-
- </li>
-
-</ul>
-
-</div><table class="source_code">
- <tr>
- <td>
- <pre class="lines">
-
-
-30
-31
-32
-33
-34
-35</pre>
- </td>
- <td>
- <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 30</span>
-
-<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span>
- <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml_inner identifier id'>xml_inner</span><span class='bitor op'>|</span>
- <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@labels ivar id'>@labels</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
- <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml_inner identifier id'>xml_inner</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@data ivar id'>@data</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span>
- <span class='end end kw'>end</span>
-<span class='end end kw'>end</span>
-</pre>
- </td>
- </tr>
-</table>
-</div>
-
- </div>
-
-</div>
-
- <div id="footer">
- Generated on Wed Nov 30 08:46:34 2011 by
- <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
- 0.7.3 (ruby-1.8.7).
-</div>
-
- </body>
-</html> \ No newline at end of file