diff options
Diffstat (limited to 'doc/Axlsx/CatAxis.html')
| -rw-r--r-- | doc/Axlsx/CatAxis.html | 766 |
1 files changed, 766 insertions, 0 deletions
diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html new file mode 100644 index 00000000..235e4a50 --- /dev/null +++ b/doc/Axlsx/CatAxis.html @@ -0,0 +1,766 @@ +<!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::CatAxis + + — Documentation by YARD 0.7.3 + +</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 (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">CatAxis</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::CatAxis + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next"><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></li> + + <li class="next">Axlsx::CatAxis</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/drawing/cat_axis.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +A CatAxis object defines a chart category axis +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + <h2>Constant Summary</h2> + + <dl class="constants"> + + <dt id="LBL_OFFSET_REGEX-constant" class="">LBL_OFFSET_REGEX = + <div class="docstring"> + <div class="discussion"> + <p> +regex for validating label offset +</p> + + + </div> +</div> +<div class="tags"> + + +</div> + </dt> + <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-9][0-9][0-9])|1000)%/</span> +</pre></dd> + + </dl> + + + + + + + + <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="#auto-instance_method" title="#auto (instance method)">- (Boolean) <strong>auto</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +From the docs: This element specifies that this axis is a date or text axis +based on the data that is used for the axis labels, not a specific choice. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#lblAlgn-instance_method" title="#lblAlgn (instance method)">- (Symbol) <strong>lblAlgn</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +specifies how the perpendicular axis is crossed must be one of [:ctr, :l, +:r]. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#lblOffset-instance_method" title="#lblOffset (instance method)">- (Integer) <strong>lblOffset</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The offset of the labels must be between a string between 0 and 1000. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + + <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></h3> + <p class="inherited"><span class='object_link'><a href="Axis.html#axId-instance_method" title="Axlsx::Axis#axId (method)">axId</a></span>, <span class='object_link'><a href="Axis.html#axPos-instance_method" title="Axlsx::Axis#axPos (method)">axPos</a></span>, <span class='object_link'><a href="Axis.html#crossAx-instance_method" title="Axlsx::Axis#crossAx (method)">crossAx</a></span>, <span class='object_link'><a href="Axis.html#crosses-instance_method" title="Axlsx::Axis#crosses (method)">crosses</a></span>, <span class='object_link'><a href="Axis.html#format_code-instance_method" title="Axlsx::Axis#format_code (method)">format_code</a></span>, <span class='object_link'><a href="Axis.html#scaling-instance_method" title="Axlsx::Axis#scaling (method)">scaling</a></span>, <span class='object_link'><a href="Axis.html#tickLblPos-instance_method" title="Axlsx::Axis#tickLblPos (method)">tickLblPos</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)">- (CatAxis) <strong>initialize</strong>(axId, crossAx, options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new CatAxis object. +</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 category axis. +</p> +</div></span> + +</li> + + + </ul> + + + + + + + + <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::CatAxis (class)">CatAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new CatAxis object +</p> + + + </div> +</div> +<div class="tags"> + <h3>Parameters:</h3> +<ul class="param"> + + <li> + + <span class='name'>axId</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of this axis +</p> +</div> + + </li> + + <li> + + <span class='name'>crossAx</span> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + — + <div class='inline'><p> +the id of the perpendicular axis +</p> +</div> + + </li> + + <li> + + <span class='name'>options</span> + + + <span class='type'>(<tt>Hash</tt>)</span> + + + <em class="default">(defaults to: <tt>{}</tt>)</em> + + + — + <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">axPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">tickLblPos</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">crosses</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">auto</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">lblAlgn</span> + <span class="type">(<tt>Symbol</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">lblOffset</span> + <span class="type">(<tt>Integer</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +30 +31 +32 +33 +34 +35 +36 +37 +38</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 30</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</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='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='auto identifier id'>auto</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblAlgn identifier id'>lblAlgn</span> <span class='assign token'>=</span> <span class='symbol val'>:ctr</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblOffset identifier id'>lblOffset</span> <span class='assign token'>=</span> <span class='string val'>"100%"</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</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="auto=-instance_method"></span> + <span id="auto-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="auto-instance_method"> + + - (<tt>Boolean</tt>) <strong>auto</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +From the docs: This element specifies that this axis is a date or text axis +based on the data that is used for the axis labels, not a specific choice. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +6 +7 +8</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='auto identifier id'>auto</span> + <span class='@auto ivar id'>@auto</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="lblAlgn=-instance_method"></span> + <span id="lblAlgn-instance_method"></span> + <div class="method_details "> + <p class="signature " id="lblAlgn-instance_method"> + + - (<tt>Symbol</tt>) <strong>lblAlgn</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +specifies how the perpendicular axis is crossed must be one of [:ctr, :l, +:r] +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Symbol</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +11 +12 +13</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 11</span> + +<span class='def def kw'>def</span> <span class='lblAlgn identifier id'>lblAlgn</span> + <span class='@lblAlgn ivar id'>@lblAlgn</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="lblOffset=-instance_method"></span> + <span id="lblOffset-instance_method"></span> + <div class="method_details "> + <p class="signature " id="lblOffset-instance_method"> + + - (<tt>Integer</tt>) <strong>lblOffset</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The offset of the labels must be between a string between 0 and 1000 +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Integer</tt>)</span> + + + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +16 +17 +18</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 16</span> + +<span class='def def kw'>def</span> <span class='lblOffset identifier id'>lblOffset</span> + <span class='@lblOffset ivar id'>@lblOffset</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 category axis +</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> + + + + — + <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"> + + +47 +48 +49 +50 +51 +52 +53 +54</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 47</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='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:catAx'</span><span class='rparen token'>)</span> <span class='lbrace 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='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:auto'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@auto ivar id'>@auto</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:lblAlgn'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@lblAlgn ivar id'>@lblAlgn</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:lblOffset'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@lblOffset ivar id'>@lblOffset</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + </div> + +</div> + + <div id="footer"> + Generated on Sun Nov 20 23:44:03 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 |