diff options
| author | Randy Morgan <[email protected]> | 2011-12-01 14:11:42 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-12-01 14:11:42 +0900 |
| commit | 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 (patch) | |
| tree | 9c5a214c0ac49b56d08be769fbe0634ac1e5b0a4 /doc/Axlsx/Xf.html | |
| parent | 076be316935180341d7ee7a9335281a4b18d1fa9 (diff) | |
| download | caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip | |
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx/Xf.html')
| -rw-r--r-- | doc/Axlsx/Xf.html | 1743 |
1 files changed, 0 insertions, 1743 deletions
diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html deleted file mode 100644 index 4c839a3e..00000000 --- a/doc/Axlsx/Xf.html +++ /dev/null @@ -1,1743 +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::Xf - - — 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 (X)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Xf</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::Xf - - - -</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::Xf</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/xf.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Xf class defines a formatting record for use in Styles. The recommended -way to manage styles for your workbook is with Styles#add_style</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Styles.html#add_style-instance_method" title="Axlsx::Styles#add_style (method)">Styles#add_style</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="#alignment-instance_method" title="#alignment (instance method)">- (CellAlignment) <strong>alignment</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The cell alignment for this style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#applyAlignment-instance_method" title="#applyAlignment (instance method)">- (Boolean) <strong>applyAlignment</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the alignment options should be applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#applyBorder-instance_method" title="#applyBorder (instance method)">- (Boolean) <strong>applyBorder</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if the borderId should be applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#applyFill-instance_method" title="#applyFill (instance method)">- (Boolean) <strong>applyFill</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if the fillId should be applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#applyFont-instance_method" title="#applyFont (instance method)">- (Boolean) <strong>applyFont</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if the fontId should be applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#applyNumberFormat-instance_method" title="#applyNumberFormat (instance method)">- (Boolean) <strong>applyNumberFormat</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if the numFmtId should be applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#applyProtection-instance_method" title="#applyProtection (instance method)">- (Boolean) <strong>applyProtection</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the protection options should be applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#borderId-instance_method" title="#borderId (instance method)">- (Integer) <strong>borderId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of the border to be used in this style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#fillId-instance_method" title="#fillId (instance method)">- (Integer) <strong>fillId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of the fill to be used in this style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#fontId-instance_method" title="#fontId (instance method)">- (Integer) <strong>fontId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of the font to be used in this style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#numFmtId-instance_method" title="#numFmtId (instance method)">- (Integer) <strong>numFmtId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>id of the numFmt to apply to this style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pivotButton-instance_method" title="#pivotButton (instance method)">- (Boolean) <strong>pivotButton</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if the cell has a pivot table drop down button.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#protection-instance_method" title="#protection (instance method)">- (CellProtection) <strong>protection</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The cell protection for this style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#quotePrefix-instance_method" title="#quotePrefix (instance method)">- (Boolean) <strong>quotePrefix</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indecates if text should be prefixed by a single quote in the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#xfId-instance_method" title="#xfId (instance method)">- (Integer) <strong>xfId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>index (0 based) of cellStylesXfs item to be used in this style.</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)">- (Xf) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Xf 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 xf elemen.</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::Xf (class)">Xf</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Xf object</p> - - - </div> -</div> -<div class="tags"> - <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">numFmtId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">fontId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">fillId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">borderId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">xfId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">quotePrefix</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">pivotButton</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">applyNumberFormat</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">applyFont</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">applyFill</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">applyBorder</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">applyAlignment</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">applyProtection</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">alignment</span> - <span class="type">(<tt><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">protection</span> - <span class="type">(<tt><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span></tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -85 -86 -87 -88 -89</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 85</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='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="alignment=-instance_method"></span> - <span id="alignment-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="alignment-instance_method"> - - - (<tt><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></tt>) <strong>alignment</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The cell alignment for this style</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="CellAlignment.html" title="Axlsx::CellAlignment (class)">CellAlignment</a></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/stylesheet/xf.rb', line 10</span> - -<span class='def def kw'>def</span> <span class='alignment identifier id'>alignment</span> - <span class='@alignment ivar id'>@alignment</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="applyAlignment=-instance_method"></span> - <span id="applyAlignment-instance_method"></span> - <div class="method_details "> - <p class="signature " id="applyAlignment-instance_method"> - - - (<tt>Boolean</tt>) <strong>applyAlignment</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the alignment options should be applied</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"> - - -63 -64 -65</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 63</span> - -<span class='def def kw'>def</span> <span class='applyAlignment identifier id'>applyAlignment</span> - <span class='@applyAlignment ivar id'>@applyAlignment</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="applyBorder=-instance_method"></span> - <span id="applyBorder-instance_method"></span> - <div class="method_details "> - <p class="signature " id="applyBorder-instance_method"> - - - (<tt>Boolean</tt>) <strong>applyBorder</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if the borderId should be applied</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"> - - -59 -60 -61</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 59</span> - -<span class='def def kw'>def</span> <span class='applyBorder identifier id'>applyBorder</span> - <span class='@applyBorder ivar id'>@applyBorder</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="applyFill=-instance_method"></span> - <span id="applyFill-instance_method"></span> - <div class="method_details "> - <p class="signature " id="applyFill-instance_method"> - - - (<tt>Boolean</tt>) <strong>applyFill</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if the fillId should be applied</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"> - - -55 -56 -57</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 55</span> - -<span class='def def kw'>def</span> <span class='applyFill identifier id'>applyFill</span> - <span class='@applyFill ivar id'>@applyFill</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="applyFont=-instance_method"></span> - <span id="applyFont-instance_method"></span> - <div class="method_details "> - <p class="signature " id="applyFont-instance_method"> - - - (<tt>Boolean</tt>) <strong>applyFont</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if the fontId should be applied</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"> - - -51 -52 -53</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 51</span> - -<span class='def def kw'>def</span> <span class='applyFont identifier id'>applyFont</span> - <span class='@applyFont ivar id'>@applyFont</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="applyNumberFormat=-instance_method"></span> - <span id="applyNumberFormat-instance_method"></span> - <div class="method_details "> - <p class="signature " id="applyNumberFormat-instance_method"> - - - (<tt>Boolean</tt>) <strong>applyNumberFormat</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if the numFmtId should be applied</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"> - - -47 -48 -49</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 47</span> - -<span class='def def kw'>def</span> <span class='applyNumberFormat identifier id'>applyNumberFormat</span> - <span class='@applyNumberFormat ivar id'>@applyNumberFormat</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="applyProtection=-instance_method"></span> - <span id="applyProtection-instance_method"></span> - <div class="method_details "> - <p class="signature " id="applyProtection-instance_method"> - - - (<tt>Boolean</tt>) <strong>applyProtection</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the protection options should be applied</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"> - - -67 -68 -69</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 67</span> - -<span class='def def kw'>def</span> <span class='applyProtection identifier id'>applyProtection</span> - <span class='@applyProtection ivar id'>@applyProtection</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="borderId=-instance_method"></span> - <span id="borderId-instance_method"></span> - <div class="method_details "> - <p class="signature " id="borderId-instance_method"> - - - (<tt>Integer</tt>) <strong>borderId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>index (0 based) of the border to be used in this style</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"> - - -31 -32 -33</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 31</span> - -<span class='def def kw'>def</span> <span class='borderId identifier id'>borderId</span> - <span class='@borderId ivar id'>@borderId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="fillId=-instance_method"></span> - <span id="fillId-instance_method"></span> - <div class="method_details "> - <p class="signature " id="fillId-instance_method"> - - - (<tt>Integer</tt>) <strong>fillId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>index (0 based) of the fill to be used in this style</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"> - - -27 -28 -29</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 27</span> - -<span class='def def kw'>def</span> <span class='fillId identifier id'>fillId</span> - <span class='@fillId ivar id'>@fillId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="fontId=-instance_method"></span> - <span id="fontId-instance_method"></span> - <div class="method_details "> - <p class="signature " id="fontId-instance_method"> - - - (<tt>Integer</tt>) <strong>fontId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>index (0 based) of the font to be used in this style</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"> - - -23 -24 -25</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='fontId identifier id'>fontId</span> - <span class='@fontId ivar id'>@fontId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="numFmtId=-instance_method"></span> - <span id="numFmtId-instance_method"></span> - <div class="method_details "> - <p class="signature " id="numFmtId-instance_method"> - - - (<tt>Integer</tt>) <strong>numFmtId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>id of the numFmt to apply to this style</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"> - - -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 19</span> - -<span class='def def kw'>def</span> <span class='numFmtId identifier id'>numFmtId</span> - <span class='@numFmtId ivar id'>@numFmtId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="pivotButton=-instance_method"></span> - <span id="pivotButton-instance_method"></span> - <div class="method_details "> - <p class="signature " id="pivotButton-instance_method"> - - - (<tt>Boolean</tt>) <strong>pivotButton</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if the cell has a pivot table drop down button</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"> - - -43 -44 -45</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 43</span> - -<span class='def def kw'>def</span> <span class='pivotButton identifier id'>pivotButton</span> - <span class='@pivotButton ivar id'>@pivotButton</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="protection=-instance_method"></span> - <span id="protection-instance_method"></span> - <div class="method_details "> - <p class="signature " id="protection-instance_method"> - - - (<tt><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span></tt>) <strong>protection</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The cell protection for this style</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="CellProtection.html" title="Axlsx::CellProtection (class)">CellProtection</a></span></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/xf.rb', line 15</span> - -<span class='def def kw'>def</span> <span class='protection identifier id'>protection</span> - <span class='@protection ivar id'>@protection</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="quotePrefix=-instance_method"></span> - <span id="quotePrefix-instance_method"></span> - <div class="method_details "> - <p class="signature " id="quotePrefix-instance_method"> - - - (<tt>Boolean</tt>) <strong>quotePrefix</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indecates if text should be prefixed by a single quote in the cell</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"> - - -39 -40 -41</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 39</span> - -<span class='def def kw'>def</span> <span class='quotePrefix identifier id'>quotePrefix</span> - <span class='@quotePrefix ivar id'>@quotePrefix</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="xfId=-instance_method"></span> - <span id="xfId-instance_method"></span> - <div class="method_details "> - <p class="signature " id="xfId-instance_method"> - - - (<tt>Integer</tt>) <strong>xfId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>index (0 based) of cellStylesXfs item to be used in this style. Only -applies to cellXfs items</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"> - - -35 -36 -37</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 35</span> - -<span class='def def kw'>def</span> <span class='xfId identifier id'>xfId</span> - <span class='@xfId ivar id'>@xfId</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 xf elemen</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"> - - -131 -132 -133 -134 -135 -136</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/xf.rb', line 131</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='xf identifier id'>xf</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='reject identifier id'>reject</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'>:alignment</span><span class='comma token'>,</span> <span class='symbol val'>:protection</span><span class='comma token'>,</span> <span class='symbol val'>:extList</span><span class='comma token'>,</span> <span class='symbol val'>:name</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='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='alignment identifier id'>alignment</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='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span> - <span class='protection identifier id'>protection</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='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='protection identifier id'>protection</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 Wed Nov 30 08:46:37 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 |