diff options
Diffstat (limited to 'doc/Axlsx/Border.html')
| -rw-r--r-- | doc/Axlsx/Border.html | 775 |
1 files changed, 775 insertions, 0 deletions
diff --git a/doc/Axlsx/Border.html b/doc/Axlsx/Border.html new file mode 100644 index 00000000..413ee9c1 --- /dev/null +++ b/doc/Axlsx/Border.html @@ -0,0 +1,775 @@ +<!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::Border + + — 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 (B)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">Border</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::Border + + + +</h1> + +<dl class="box"> + + <dt class="r1">Inherits:</dt> + <dd class="r1"> + <span class="inheritName">Object</span> + + <ul class="fullTree"> + <li>Object</li> + + <li class="next">Axlsx::Border</li> + + </ul> + <a href="#" class="inheritanceTree">show all</a> + + </dd> + + + + + + + + + + <dt class="r2 last">Defined in:</dt> + <dd class="r2 last">lib/axlsx/stylesheet/border.rb</dd> + +</dl> +<div class="clear"></div> + +<h2>Overview</h2><div class="docstring"> + <div class="discussion"> + <p> +This class details a border used in Office Open XML spreadsheet styles. +</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="#diagonalDown-instance_method" title="#diagonalDown (instance method)">- (Boolean) <strong>diagonalDown</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The diagonal down property for the border that indicates if the border +should include a diagonal line from the top left to the top right of the +cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#diagonalUp-instance_method" title="#diagonalUp (instance method)">- (Boolean) <strong>diagonalUp</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#outline-instance_method" title="#outline (instance method)">- (Boolean) <strong>outline</strong> </a> + + + + </span> + + + + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +The outline property for the border indicating that top, left, right and +bottom borders should only be applied to the outside border of a range of +cells. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#prs-instance_method" title="#prs (instance method)">- (SimpleTypedList) <strong>prs</strong> </a> + + + + </span> + + + <span class="note title readonly">readonly</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +A list of BorderPr objects for this border. +</p> +</div></span> + +</li> + + + </ul> + + + + + + <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)">- (Border) <strong>initialize</strong>(options = {}) </a> + + + + </span> + + <span class="note title constructor">constructor</span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Creates a new Border object. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + + <a href="#to_xml-instance_method" title="#to_xml (instance method)">- (Object) <strong>to_xml</strong>(xml) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +Serializes the border element. +</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::Border (class)">Border</a></span></tt>) <strong>initialize</strong>(options = {}) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Creates a new Border object +</p> + + + </div> +</div> +<div class="tags"> + + <div class="examples"> + <h3>Examples:</h3> + + <h4><div class='inline'><p> +Making a border +</p> +</div></h4> + <pre class="example code"><span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='red_border identifier id'>red_border</span> <span class='assign token'>=</span> <span class='Border constant id'>Border</span><span class='dot token'>.</span><span class='new identifier id'>new</span> +<span class='lbrack token'>[</span><span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='rbrack token'>]</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='item identifier id'>item</span><span class='bitor op'>|</span> + <span class='red_border identifier id'>red_border</span><span class='dot token'>.</span><span class='prs identifier id'>prs</span> <span class='lshft op'><<</span> <span class='BorderPr constant id'>BorderPr</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='symbol val'>:thin</span><span class='comma token'>,</span> <span class='symbol val'>:color=</span><span class='gt op'>></span><span class='Color constant id'>Color</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:rgb=</span><span class='gt op'>></span><span class='string val'>"FFFF0000"</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='comment val'># </span> +<span class='end end kw'>end</span> +<span class='comment val'># this sets red_border to be the index for the created border.</span> +<span class='red_border identifier id'>red_border</span> <span class='assign token'>=</span> <span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='@borders ivar id'>@borders</span> <span class='lshft op'><<</span> <span class='red_border identifier id'>red_border</span> +<span class='comment val'>#used in row creation as follows. This will add a red border to each of the cells in the row.</span> +<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='symbol val'>:values=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='integer val'>2</span><span class='comma token'>,</span><span class='integer val'>3</span><span class='rbrack token'>]</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='red_border identifier id'>red_border</span> +</pre> + + </div> +<h3>Parameters:</h3> +<ul class="param"> + + <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">diagonalUp</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">diagonalDown</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + <li> + <span class="name">outline</span> + <span class="type">(<tt>Boolean</tt>)</span> + <span class="default"> + + </span> + + </li> + + </ul> + + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +31 +32 +33 +34 +35 +36</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 31</span> + +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen 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='@prs ivar id'>@prs</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='BorderPr constant id'>BorderPr</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="diagonalDown=-instance_method"></span> + <span id="diagonalDown-instance_method"></span> + <div class="method_details first"> + <p class="signature first" id="diagonalDown-instance_method"> + + - (<tt>Boolean</tt>) <strong>diagonalDown</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The diagonal down property for the border that indicates if the border +should include a diagonal line from the top left to the top right of the +cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The diagonal down property for the border that indicates if the border +should include a diagonal line from the top left to the top right of the +cell. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +9 +10 +11</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 9</span> + +<span class='def def kw'>def</span> <span class='diagonalDown identifier id'>diagonalDown</span> + <span class='@diagonalDown ivar id'>@diagonalDown</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="diagonalUp=-instance_method"></span> + <span id="diagonalUp-instance_method"></span> + <div class="method_details "> + <p class="signature " id="diagonalUp-instance_method"> + + - (<tt>Boolean</tt>) <strong>diagonalUp</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The diagonal up property for the border that indicates if the border should +include a diagonal line from the bottom left to the top right of the cell. +</p> +</div> + + </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/stylesheet/border.rb', line 6</span> + +<span class='def def kw'>def</span> <span class='diagonalUp identifier id'>diagonalUp</span> + <span class='@diagonalUp ivar id'>@diagonalUp</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id="outline=-instance_method"></span> + <span id="outline-instance_method"></span> + <div class="method_details "> + <p class="signature " id="outline-instance_method"> + + - (<tt>Boolean</tt>) <strong>outline</strong> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +The outline property for the border indicating that top, left, right and +bottom borders should only be applied to the outside border of a range of +cells. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>Boolean</tt>)</span> + + + + — + <div class='inline'><p> +The outline property for the border indicating that top, left, right and +bottom borders should only be applied to the outside border of a range of +cells. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +12 +13 +14</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 12</span> + +<span class='def def kw'>def</span> <span class='outline identifier id'>outline</span> + <span class='@outline ivar id'>@outline</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + + <span id=""></span> + <span id="prs-instance_method"></span> + <div class="method_details "> + <p class="signature " id="prs-instance_method"> + + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>prs</strong> <span class="extras">(readonly)</span> + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +A list of BorderPr objects for this border. +</p> + + + </div> +</div> +<div class="tags"> + +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> + + + + — + <div class='inline'><p> +A list of BorderPr objects for this border. +</p> +</div> + + </li> + +</ul> + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +15 +16 +17</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 15</span> + +<span class='def def kw'>def</span> <span class='prs identifier id'>prs</span> + <span class='@prs ivar id'>@prs</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>Object</tt>) <strong>to_xml</strong>(xml) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +Serializes the border element +</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> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +44 +45 +46 +47 +48 +49 +50</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.rb', line 44</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='border identifier id'>border</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='dot token'>.</span><span class='select identifier id'>select</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</span> <span class='lbrack token'>[</span><span class='symbol val'>:diagonalUp</span><span class='comma token'>,</span> <span class='symbol val'>:diagonalDown</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='lbrack token'>[</span><span class='symbol val'>:start</span><span class='comma token'>,</span> <span class='symbol val'>:end</span><span class='comma token'>,</span> <span class='symbol val'>:left</span><span class='comma token'>,</span> <span class='symbol val'>:right</span><span class='comma token'>,</span> <span class='symbol val'>:top</span><span class='comma token'>,</span> <span class='symbol val'>:bottom</span><span class='comma token'>,</span> <span class='symbol val'>:diagonal</span><span class='comma token'>,</span> <span class='symbol val'>:vertical</span><span class='comma token'>,</span> <span class='symbol val'>:horizontal</span><span class='rbrack token'>]</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='k identifier id'>k</span><span class='bitor op'>|</span> + <span class='@prs ivar id'>@prs</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='pr identifier id'>pr</span><span class='bitor op'>|</span> <span class='pr identifier id'>pr</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='eq op'>==</span> <span class='k identifier id'>k</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='pr identifier id'>pr</span><span class='bitor op'>|</span> <span class='pr identifier id'>pr</span><span class='dot token'>.</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='rbrace token'>}</span> + <span class='end end kw'>end</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:43:58 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 |