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 | |
| parent | 076be316935180341d7ee7a9335281a4b18d1fa9 (diff) | |
| download | caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.tar.gz caxlsx-8cf0296bbc16e8eb535e9af932eed2557d5e66d2.zip | |
removing generated yard docs from repository
Diffstat (limited to 'doc/Axlsx')
60 files changed, 0 insertions, 48468 deletions
diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html deleted file mode 100644 index f7e59649..00000000 --- a/doc/Axlsx/App.html +++ /dev/null @@ -1,2562 +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::App - - — 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 (A)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">App</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::App - - - -</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::App</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/doc_props/app.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>Support is not implemented for the following complex types:</p> - -<p>HeadingPairs (VectorVariant), TitlesOfParts (VectorLpstr), HLinks -(VectorVariant), DigSig (DigSigBlob)</p> -</div> - </div> - - -<p>App represents the app.xml document. The attributes for this object are -primarily managed by the application the end user uses to edit the -document. None of the attributes are required to serialize a valid xlsx -object.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>shared-documentPropertiesExtendedshared-documentPropertiesExtended.xsd</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="#Application-instance_method" title="#Application (instance method)">- (String) <strong>Application</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of the application.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#AppVersion-instance_method" title="#AppVersion (instance method)">- (String) <strong>AppVersion</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The version of the application.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Characters-instance_method" title="#Characters (instance method)">- (Integer) <strong>Characters</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of characters in the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#CharactersWithSpaces-instance_method" title="#CharactersWithSpaces (instance method)">- (Integer) <strong>CharactersWithSpaces</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of characters in the document including spaces.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Company-instance_method" title="#Company (instance method)">- (String) <strong>Company</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of the company generating the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#DocSecurity-instance_method" title="#DocSecurity (instance method)">- (Integer) <strong>DocSecurity</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Document security.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#HiddenSlides-instance_method" title="#HiddenSlides (instance method)">- (Integer) <strong>HiddenSlides</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of hidden slides.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#HyperLinkBase-instance_method" title="#HyperLinkBase (instance method)">- (String) <strong>HyperLinkBase</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The base for hyper links in the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#HyperlinksChanged-instance_method" title="#HyperlinksChanged (instance method)">- (Boolean) <strong>HyperlinksChanged</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates that the hyper links in the document have been changed.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Lines-instance_method" title="#Lines (instance method)">- (Integer) <strong>Lines</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of lines in the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#LinksUpToDate-instance_method" title="#LinksUpToDate (instance method)">- (Boolean) <strong>LinksUpToDate</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The links in the document are up to date.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Manager-instance_method" title="#Manager (instance method)">- (String) <strong>Manager</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of the manager for the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#MMClips-instance_method" title="#MMClips (instance method)">- (Integer) <strong>MMClips</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The total number multimedia clips.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Notes-instance_method" title="#Notes (instance method)">- (Integer) <strong>Notes</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of slides that have notes.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Pages-instance_method" title="#Pages (instance method)">- (Integer) <strong>Pages</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of pages in the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Paragraphs-instance_method" title="#Paragraphs (instance method)">- (Integer) <strong>Paragraphs</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of paragraphs in the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#PresentationFormat-instance_method" title="#PresentationFormat (instance method)">- (String) <strong>PresentationFormat</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The intended format of the presentation.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#ScaleCrop-instance_method" title="#ScaleCrop (instance method)">- (Boolean) <strong>ScaleCrop</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The display mode for the document thumbnail.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#ShareDoc-instance_method" title="#ShareDoc (instance method)">- (Boolean) <strong>ShareDoc</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the document is shared.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Slides-instance_method" title="#Slides (instance method)">- (Intger) <strong>Slides</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of slides in the document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Template-instance_method" title="#Template (instance method)">- (String) <strong>Template</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of the document template.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#TotalTime-instance_method" title="#TotalTime (instance method)">- (Integer) <strong>TotalTime</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The total amount of time spent editing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Words-instance_method" title="#Words (instance method)">- (Integer) <strong>Words</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of words in the document.</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="#initalize-instance_method" title="#initalize (instance method)">- (Object) <strong>initalize</strong>(options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates an App 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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Generate an app.xml document.</p> -</div></span> - -</li> - - - </ul> - - - - <div id="instance_attr_details" class="attr_details"> - <h2>Instance Attribute Details</h2> - - - <span id="Application=-instance_method"></span> - <span id="Application-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="Application-instance_method"> - - - (<tt>String</tt>) <strong>Application</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of the application</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of the application</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -74 -75 -76</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 74</span> - -<span class='def def kw'>def</span> <span class='Application constant id'>Application</span> - <span class='@Application ivar id'>@Application</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="AppVersion=-instance_method"></span> - <span id="AppVersion-instance_method"></span> - <div class="method_details "> - <p class="signature " id="AppVersion-instance_method"> - - - (<tt>String</tt>) <strong>AppVersion</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The version of the application.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The version of the application.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -77 -78 -79</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 77</span> - -<span class='def def kw'>def</span> <span class='AppVersion constant id'>AppVersion</span> - <span class='@AppVersion ivar id'>@AppVersion</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Characters=-instance_method"></span> - <span id="Characters-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Characters-instance_method"> - - - (<tt>Integer</tt>) <strong>Characters</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of characters in the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of characters in the document.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='Characters constant id'>Characters</span> - <span class='@Characters ivar id'>@Characters</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="CharactersWithSpaces=-instance_method"></span> - <span id="CharactersWithSpaces-instance_method"></span> - <div class="method_details "> - <p class="signature " id="CharactersWithSpaces-instance_method"> - - - (<tt>Integer</tt>) <strong>CharactersWithSpaces</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of characters in the document including spaces.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of characters in the document including spaces.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -62 -63 -64</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 62</span> - -<span class='def def kw'>def</span> <span class='CharactersWithSpaces constant id'>CharactersWithSpaces</span> - <span class='@CharactersWithSpaces ivar id'>@CharactersWithSpaces</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Company=-instance_method"></span> - <span id="Company-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Company-instance_method"> - - - (<tt>String</tt>) <strong>Company</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of the company generating the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of the company generating the document.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 20</span> - -<span class='def def kw'>def</span> <span class='Company constant id'>Company</span> - <span class='@Company ivar id'>@Company</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="DocSecurity=-instance_method"></span> - <span id="DocSecurity-instance_method"></span> - <div class="method_details "> - <p class="signature " id="DocSecurity-instance_method"> - - - (<tt>Integer</tt>) <strong>DocSecurity</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Document security</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>Document security</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -80 -81 -82</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 80</span> - -<span class='def def kw'>def</span> <span class='DocSecurity constant id'>DocSecurity</span> - <span class='@DocSecurity ivar id'>@DocSecurity</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="HiddenSlides=-instance_method"></span> - <span id="HiddenSlides-instance_method"></span> - <div class="method_details "> - <p class="signature " id="HiddenSlides-instance_method"> - - - (<tt>Integer</tt>) <strong>HiddenSlides</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of hidden slides.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of hidden slides.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -50 -51 -52</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 50</span> - -<span class='def def kw'>def</span> <span class='HiddenSlides constant id'>HiddenSlides</span> - <span class='@HiddenSlides ivar id'>@HiddenSlides</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="HyperLinkBase=-instance_method"></span> - <span id="HyperLinkBase-instance_method"></span> - <div class="method_details "> - <p class="signature " id="HyperLinkBase-instance_method"> - - - (<tt>String</tt>) <strong>HyperLinkBase</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The base for hyper links in the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The base for hyper links in the document.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -68 -69 -70</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 68</span> - -<span class='def def kw'>def</span> <span class='HyperLinkBase constant id'>HyperLinkBase</span> - <span class='@HyperLinkBase ivar id'>@HyperLinkBase</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="HyperlinksChanged=-instance_method"></span> - <span id="HyperlinksChanged-instance_method"></span> - <div class="method_details "> - <p class="signature " id="HyperlinksChanged-instance_method"> - - - (<tt>Boolean</tt>) <strong>HyperlinksChanged</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates that the hyper links in the document have been changed.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p>Indicates that the hyper links in the document have been changed.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -71 -72 -73</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 71</span> - -<span class='def def kw'>def</span> <span class='HyperlinksChanged constant id'>HyperlinksChanged</span> - <span class='@HyperlinksChanged ivar id'>@HyperlinksChanged</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Lines=-instance_method"></span> - <span id="Lines-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Lines-instance_method"> - - - (<tt>Integer</tt>) <strong>Lines</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of lines in the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of lines in the document.</p> -</div> - - </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/doc_props/app.rb', line 35</span> - -<span class='def def kw'>def</span> <span class='Lines constant id'>Lines</span> - <span class='@Lines ivar id'>@Lines</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="LinksUpToDate=-instance_method"></span> - <span id="LinksUpToDate-instance_method"></span> - <div class="method_details "> - <p class="signature " id="LinksUpToDate-instance_method"> - - - (<tt>Boolean</tt>) <strong>LinksUpToDate</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The links in the document are up to date.</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 links in the document are up to date.</p> -</div> - - </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/doc_props/app.rb', line 59</span> - -<span class='def def kw'>def</span> <span class='LinksUpToDate constant id'>LinksUpToDate</span> - <span class='@LinksUpToDate ivar id'>@LinksUpToDate</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Manager=-instance_method"></span> - <span id="Manager-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Manager-instance_method"> - - - (<tt>String</tt>) <strong>Manager</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of the manager for the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of the manager for the document.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 17</span> - -<span class='def def kw'>def</span> <span class='Manager constant id'>Manager</span> - <span class='@Manager ivar id'>@Manager</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="MMClips=-instance_method"></span> - <span id="MMClips-instance_method"></span> - <div class="method_details "> - <p class="signature " id="MMClips-instance_method"> - - - (<tt>Integer</tt>) <strong>MMClips</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The total number multimedia clips</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The total number multimedia clips</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 53</span> - -<span class='def def kw'>def</span> <span class='MMClips constant id'>MMClips</span> - <span class='@MMClips ivar id'>@MMClips</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Notes=-instance_method"></span> - <span id="Notes-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Notes-instance_method"> - - - (<tt>Integer</tt>) <strong>Notes</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of slides that have notes.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of slides that have notes.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -44 -45 -46</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 44</span> - -<span class='def def kw'>def</span> <span class='Notes constant id'>Notes</span> - <span class='@Notes ivar id'>@Notes</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Pages=-instance_method"></span> - <span id="Pages-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Pages-instance_method"> - - - (<tt>Integer</tt>) <strong>Pages</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of pages in the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of pages in the document.</p> -</div> - - </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/doc_props/app.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='Pages constant id'>Pages</span> - <span class='@Pages ivar id'>@Pages</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Paragraphs=-instance_method"></span> - <span id="Paragraphs-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Paragraphs-instance_method"> - - - (<tt>Integer</tt>) <strong>Paragraphs</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of paragraphs in the document</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of paragraphs in the document</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='Paragraphs constant id'>Paragraphs</span> - <span class='@Paragraphs ivar id'>@Paragraphs</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="PresentationFormat=-instance_method"></span> - <span id="PresentationFormat-instance_method"></span> - <div class="method_details "> - <p class="signature " id="PresentationFormat-instance_method"> - - - (<tt>String</tt>) <strong>PresentationFormat</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The intended format of the presentation.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The intended format of the presentation.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -32 -33 -34</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 32</span> - -<span class='def def kw'>def</span> <span class='PresentationFormat constant id'>PresentationFormat</span> - <span class='@PresentationFormat ivar id'>@PresentationFormat</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="ScaleCrop=-instance_method"></span> - <span id="ScaleCrop-instance_method"></span> - <div class="method_details "> - <p class="signature " id="ScaleCrop-instance_method"> - - - (<tt>Boolean</tt>) <strong>ScaleCrop</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The display mode for the document thumbnail.</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 display mode for the document thumbnail.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -56 -57 -58</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 56</span> - -<span class='def def kw'>def</span> <span class='ScaleCrop constant id'>ScaleCrop</span> - <span class='@ScaleCrop ivar id'>@ScaleCrop</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="ShareDoc=-instance_method"></span> - <span id="ShareDoc-instance_method"></span> - <div class="method_details "> - <p class="signature " id="ShareDoc-instance_method"> - - - (<tt>Boolean</tt>) <strong>ShareDoc</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the document is shared.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p>Indicates if the document is shared.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -65 -66 -67</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 65</span> - -<span class='def def kw'>def</span> <span class='ShareDoc constant id'>ShareDoc</span> - <span class='@ShareDoc ivar id'>@ShareDoc</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Slides=-instance_method"></span> - <span id="Slides-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Slides-instance_method"> - - - (<tt>Intger</tt>) <strong>Slides</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of slides in the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Intger</tt>)</span> - - - - — - <div class='inline'> -<p>The number of slides in the document.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -41 -42 -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 41</span> - -<span class='def def kw'>def</span> <span class='Slides constant id'>Slides</span> - <span class='@Slides ivar id'>@Slides</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Template=-instance_method"></span> - <span id="Template-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Template-instance_method"> - - - (<tt>String</tt>) <strong>Template</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of the document template.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of the document template.</p> -</div> - - </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/doc_props/app.rb', line 14</span> - -<span class='def def kw'>def</span> <span class='Template constant id'>Template</span> - <span class='@Template ivar id'>@Template</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="TotalTime=-instance_method"></span> - <span id="TotalTime-instance_method"></span> - <div class="method_details "> - <p class="signature " id="TotalTime-instance_method"> - - - (<tt>Integer</tt>) <strong>TotalTime</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The total amount of time spent editing.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The total amount of time spent editing.</p> -</div> - - </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/doc_props/app.rb', line 47</span> - -<span class='def def kw'>def</span> <span class='TotalTime constant id'>TotalTime</span> - <span class='@TotalTime ivar id'>@TotalTime</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Words=-instance_method"></span> - <span id="Words-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Words-instance_method"> - - - (<tt>Integer</tt>) <strong>Words</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of words in the document.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The number of words in the document.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -26 -27 -28</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 26</span> - -<span class='def def kw'>def</span> <span class='Words constant id'>Words</span> - <span class='@Words ivar id'>@Words</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="initalize-instance_method"> - - - (<tt>Object</tt>) <strong>initalize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates an App 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">Template</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Manager</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Pages</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Words</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Characters</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">PresentationFormat</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Lines</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Paragraphs</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Slides</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Notes</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">TotalTime</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">HiddenSlides</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">MMClips</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">ScaleCrop</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">LinksUpToDate</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">CharactersWithSpaces</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">ShareDoc</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">HyperLinkBase</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">HyperlinksChanged</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">Application</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">AppVersion</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">DocSecurity</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -105 -106 -107 -108 -109</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 105</span> - -<span class='def def kw'>def</span> <span class='initalize identifier id'>initalize</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Generate an app.xml document</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The document as a string</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -167 -168 -169 -170 -171 -172 -173 -174 -175 -176</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/app.rb', line 167</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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='symbol val'>:Properties</span><span class='comma token'>,</span> <span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS constant id'>APP_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:vt'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='APP_NS_VT constant id'>APP_NS_VT</span><span class='rparen token'>)</span> <span class='lbrace 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='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='bitor op'>|</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='dstring node'>"ap:#{name}"</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:32 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 diff --git a/doc/Axlsx/Ar.html b/doc/Axlsx/Ar.html deleted file mode 100644 index 27b11b00..00000000 --- a/doc/Axlsx/Ar.html +++ /dev/null @@ -1,196 +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> - Module: Axlsx::Ar - - — 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 (A)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Ar</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>Module: Axlsx::Ar - - - -</h1> - -<dl class="box"> - - - - - - - - - <dt class="r1 last">Defined in:</dt> - <dd class="r1 last">lib/axlsx/ar.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Mixing module for adding acts_as_axlsx to active record base</p> - - - </div> -</div> -<div class="tags"> - - -</div><h2>Defined Under Namespace</h2> -<p class="children"> - - - <strong class="modules">Modules:</strong> <span class='object_link'><a href="Ar/ClassMethods.html" title="Axlsx::Ar::ClassMethods (module)">ClassMethods</a></span>, <span class='object_link'><a href="Ar/InstanceMethods.html" title="Axlsx::Ar::InstanceMethods (module)">InstanceMethods</a></span>, <span class='object_link'><a href="Ar/SingletonMethods.html" title="Axlsx::Ar::SingletonMethods (module)">SingletonMethods</a></span> - - - - -</p> - - - - - - - <h2> - Class Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#included-class_method" title="included (class method)">+ (Object) <strong>included</strong>(base) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Extents active record with this ojbects class method acts_as_axlsx.</p> -</div></span> - -</li> - - - </ul> - - - - - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - - <div class="method_details first"> - <p class="signature first" id="included-class_method"> - - + (<tt>Object</tt>) <strong>included</strong>(base) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Extents active record with this ojbects class method acts_as_axlsx</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 8</span> - -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id included'>included</span><span class='lparen'>(</span><span class='id base'>base</span><span class='rparen'>)</span> - <span class='id base'>base</span><span class='period'>.</span><span class='id send'>send</span> <span class='symbol'>:extend</span><span class='comma'>,</span> <span class='const'>ClassMethods</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Sun Nov 27 22:10:46 2011 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). -</div> - - </body> -</html>
\ No newline at end of file diff --git a/doc/Axlsx/Ar/ClassMethods.html b/doc/Axlsx/Ar/ClassMethods.html deleted file mode 100644 index 9107ed38..00000000 --- a/doc/Axlsx/Ar/ClassMethods.html +++ /dev/null @@ -1,188 +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> - Module: Axlsx::Ar::ClassMethods - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> - » - <span class="title">ClassMethods</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>Module: Axlsx::Ar::ClassMethods - - - -</h1> - -<dl class="box"> - - - - - - - - - <dt class="r1 last">Defined in:</dt> - <dd class="r1 last">lib/axlsx/ar.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Class methods for the mixin</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <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="#acts_as_axlsx-instance_method" title="#acts_as_axlsx (instance method)">- (Object) <strong>acts_as_axlsx</strong>(options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>adds in the instance and singleton methods.</p> -</div></span> - -</li> - - - </ul> - - - - - <div id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - - - <div class="method_details first"> - <p class="signature first" id="acts_as_axlsx-instance_method"> - - - (<tt>Object</tt>) <strong>acts_as_axlsx</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>adds in the instance and singleton methods</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -16 -17 -18 -19</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 16</span> - -<span class='kw'>def</span> <span class='id acts_as_axlsx'>acts_as_axlsx</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id include'>include</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Ar</span><span class='op'>::</span><span class='const'>InstanceMethods</span> - <span class='id extend'>extend</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Ar</span><span class='op'>::</span><span class='const'>SingletonMethods</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Sun Nov 27 22:10:46 2011 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). -</div> - - </body> -</html>
\ No newline at end of file diff --git a/doc/Axlsx/Ar/InstanceMethods.html b/doc/Axlsx/Ar/InstanceMethods.html deleted file mode 100644 index 18ab5996..00000000 --- a/doc/Axlsx/Ar/InstanceMethods.html +++ /dev/null @@ -1,108 +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> - Module: Axlsx::Ar::InstanceMethods - - — 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 (I)</a> » - <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> - » - <span class="title">InstanceMethods</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>Module: Axlsx::Ar::InstanceMethods - - - -</h1> - -<dl class="box"> - - - - - - - - - <dt class="r1 last">Defined in:</dt> - <dd class="r1 last">lib/axlsx/ar.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Empty module - I really like ruports way of allowing :include, :only, -:exclude and am looking to add something like that in the next release</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - -</div> - - <div id="footer"> - Generated on Sun Nov 27 22:10:46 2011 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). -</div> - - </body> -</html>
\ No newline at end of file diff --git a/doc/Axlsx/Ar/SingletonMethods.html b/doc/Axlsx/Ar/SingletonMethods.html deleted file mode 100644 index 58b6b29c..00000000 --- a/doc/Axlsx/Ar/SingletonMethods.html +++ /dev/null @@ -1,312 +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> - Module: Axlsx::Ar::SingletonMethods - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> » <span class='title'><span class='object_link'><a href="../Ar.html" title="Axlsx::Ar (module)">Ar</a></span></span> - » - <span class="title">SingletonMethods</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>Module: Axlsx::Ar::SingletonMethods - - - -</h1> - -<dl class="box"> - - - - - - - - - <dt class="r1 last">Defined in:</dt> - <dd class="r1 last">lib/axlsx/ar.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Singleton methods for the mixin</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <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="#to_xlsx-instance_method" title="#to_xlsx (instance method)">- (Object) <strong>to_xlsx</strong>(number = :all, options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Maps the AR class to an Axlsx package options are passed into AR find.</p> -</div></span> - -</li> - - - </ul> - - - - - <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_xlsx-instance_method"> - - - (<tt>Object</tt>) <strong>to_xlsx</strong>(number = :all, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Maps the AR class to an Axlsx package options are passed into AR find</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>Symbol,</span> - - - <span class='type'>(<tt>Symbol</tt>, <tt>:all</tt>, <tt>etc.</tt>)</span> - - - - — - <div class='inline'> -<p>:all, etc.</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">header_style</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>to apply to the first row of field names</p> -</div> - </li> - - <li> - <span class="name">an</span> - <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>array of Axlsx types for each cell in data rows or a single type that will -be applied to all types.</p> -</div> - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Integer</tt>, <tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The style to pass to Worksheet#add_row</p> -</div> - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="../Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -32 -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/ar.rb', line 32</span> - -<span class='kw'>def</span> <span class='id to_xlsx'>to_xlsx</span><span class='lparen'>(</span><span class='id number'>number</span> <span class='op'>=</span> <span class='symbol'>:all</span><span class='comma'>,</span> <span class='id options'>options</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='id row_style'>row_style</span> <span class='op'>=</span> <span class='id options'>options</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:style</span><span class='rparen'>)</span> - <span class='id header_style'>header_style</span> <span class='op'>=</span> <span class='id options'>options</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:header_style</span><span class='rparen'>)</span> <span class='op'>||</span> <span class='id row_style'>row_style</span> - <span class='id types'>types</span> <span class='op'>=</span> <span class='id options'>options</span><span class='period'>.</span><span class='id delete'>delete</span><span class='lparen'>(</span><span class='symbol'>:types</span><span class='rparen'>)</span> - - <span class='id data'>data</span> <span class='op'>=</span> <span class='lbracket'>[</span><span class='op'>*</span><span class='id find'>find</span><span class='lparen'>(</span><span class='id number'>number</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span><span class='rbracket'>]</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id compact!'>compact!</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id flatten!'>flatten!</span> - <span class='id columns'>columns</span> <span class='op'>=</span> <span class='id data'>data</span><span class='period'>.</span><span class='id first'>first</span><span class='period'>.</span><span class='id attributes'>attributes</span><span class='period'>.</span><span class='id keys'>keys</span> - <span class='id p'>p</span> <span class='op'>=</span> <span class='const'>Package</span><span class='period'>.</span><span class='id new'>new</span> - <span class='id row_style'>row_style</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='id row_style'>row_style</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id row_style'>row_style</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id header_style'>header_style</span> <span class='op'>=</span> <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id styles'>styles</span><span class='period'>.</span><span class='id add_style'>add_style</span><span class='lparen'>(</span><span class='id header_style'>header_style</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='id header_style'>header_style</span><span class='period'>.</span><span class='id nil?'>nil?</span> - - <span class='id p'>p</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id add_worksheet'>add_worksheet</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='op'>=></span><span class='id table_name'>table_name</span><span class='period'>.</span><span class='id humanize'>humanize</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='id columns'>columns</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='id header_style'>header_style</span> - <span class='id data'>data</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id r'>r</span><span class='op'>|</span> - <span class='id sheet'>sheet</span><span class='period'>.</span><span class='id add_row'>add_row</span> <span class='id r'>r</span><span class='period'>.</span><span class='id attributes'>attributes</span><span class='period'>.</span><span class='id values'>values</span><span class='comma'>,</span> <span class='symbol'>:style</span><span class='op'>=></span><span class='id row_style'>row_style</span><span class='comma'>,</span> <span class='symbol'>:types</span><span class='op'>=></span><span class='id types'>types</span> - <span class='kw'>end</span> - <span class='kw'>end</span> - <span class='id p'>p</span> -<span class='kw'>end</span></pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Sun Nov 27 22:10:46 2011 by - <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). -</div> - - </body> -</html>
\ No newline at end of file diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html deleted file mode 100644 index 11b4f2bc..00000000 --- a/doc/Axlsx/Axis.html +++ /dev/null @@ -1,1051 +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::Axis - - — 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 (A)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Axis</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::Axis - - - -</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::Axis</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/axis.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>the access class defines common properties and values for a chart axis.</p> - - - </div> -</div> -<div class="tags"> - - -</div><div id="subclasses"> - <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span>, <span class='object_link'><a href="SerAxis.html" title="Axlsx::SerAxis (class)">SerAxis</a></span>, <span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></p> -</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="#axId-instance_method" title="#axId (instance method)">- (Integer) <strong>axId</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the id of the axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#axPos-instance_method" title="#axPos (instance method)">- (Symbol) <strong>axPos</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The position of the axis must be one of [:l, :r, :t, :b].</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#crossAx-instance_method" title="#crossAx (instance method)">- (Integer) <strong>crossAx</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The perpendicular axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#crosses-instance_method" title="#crosses (instance method)">- (Symbol) <strong>crosses</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max].</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#format_code-instance_method" title="#format_code (instance method)">- (String) <strong>format_code</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number format format code for this axis default :General.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#scaling-instance_method" title="#scaling (instance method)">- (Scaling) <strong>scaling</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The scaling of the axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#tickLblPos-instance_method" title="#tickLblPos (instance method)">- (Symbol) <strong>tickLblPos</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the position of the tick labels must be one of [:nextTo, :high, :low].</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)">- (Axis) <strong>initialize</strong>(axId, crossAx, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates an Axis 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 common 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::Axis (class)">Axis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates an Axis 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">crosses</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> - - </ul> - - -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - — - <div class='inline'> -<p>If axId or crossAx are not unsigned integers</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 45</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='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='rparen token'>)</span> - <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='crossAx identifier id'>crossAx</span><span class='rparen token'>)</span> - <span class='@axId ivar id'>@axId</span> <span class='assign token'>=</span> <span class='axId identifier id'>axId</span> - <span class='@crossAx ivar id'>@crossAx</span> <span class='assign token'>=</span> <span class='crossAx identifier id'>crossAx</span> - <span class='@format_code ivar id'>@format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span> - <span class='@scaling ivar id'>@scaling</span> <span class='assign token'>=</span> <span class='Scaling constant id'>Scaling</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:orientation=</span><span class='gt op'>></span><span class='symbol val'>:minMax</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='axPos identifier id'>axPos</span> <span class='assign token'>=</span> <span class='symbol val'>:l</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='tickLblPos identifier id'>tickLblPos</span> <span class='assign token'>=</span> <span class='symbol val'>:nextTo</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='format_code identifier id'>format_code</span> <span class='assign token'>=</span> <span class='string val'>"General"</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='crosses identifier id'>crosses</span> <span class='assign token'>=</span> <span class='symbol val'>:autoZero</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=""></span> - <span id="axId-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="axId-instance_method"> - - - (<tt>Integer</tt>) <strong>axId</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the id of the axis.</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"> - - -7 -8 -9</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 7</span> - -<span class='def def kw'>def</span> <span class='axId identifier id'>axId</span> - <span class='@axId ivar id'>@axId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="axPos=-instance_method"></span> - <span id="axPos-instance_method"></span> - <div class="method_details "> - <p class="signature " id="axPos-instance_method"> - - - (<tt>Symbol</tt>) <strong>axPos</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The position of the axis must be one of [:l, :r, :t, :b]</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"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='axPos identifier id'>axPos</span> - <span class='@axPos ivar id'>@axPos</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="crossAx-instance_method"></span> - <div class="method_details "> - <p class="signature " id="crossAx-instance_method"> - - - (<tt>Integer</tt>) <strong>crossAx</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The perpendicular axis</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"> - - -11 -12 -13</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 11</span> - -<span class='def def kw'>def</span> <span class='crossAx identifier id'>crossAx</span> - <span class='@crossAx ivar id'>@crossAx</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="crosses=-instance_method"></span> - <span id="crosses-instance_method"></span> - <div class="method_details "> - <p class="signature " id="crosses-instance_method"> - - - (<tt>Symbol</tt>) <strong>crosses</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>specifies how the perpendicular axis is crossed must be one of [:autoZero, -:min, :max]</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"> - - -36 -37 -38</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 36</span> - -<span class='def def kw'>def</span> <span class='crosses identifier id'>crosses</span> - <span class='@crosses ivar id'>@crosses</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="format_code=-instance_method"></span> - <span id="format_code-instance_method"></span> - <div class="method_details "> - <p class="signature " id="format_code-instance_method"> - - - (<tt>String</tt>) <strong>format_code</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number format format code for this axis default :General</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -31 -32 -33</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 31</span> - -<span class='def def kw'>def</span> <span class='format_code identifier id'>format_code</span> - <span class='@format_code ivar id'>@format_code</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="scaling-instance_method"></span> - <div class="method_details "> - <p class="signature " id="scaling-instance_method"> - - - (<tt><span class='object_link'><a href="Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span></tt>) <strong>scaling</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The scaling of the axis</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Scaling.html" title="Axlsx::Scaling (class)">Scaling</a></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/axis.rb', line 16</span> - -<span class='def def kw'>def</span> <span class='scaling identifier id'>scaling</span> - <span class='@scaling ivar id'>@scaling</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="tickLblPos=-instance_method"></span> - <span id="tickLblPos-instance_method"></span> - <div class="method_details "> - <p class="signature " id="tickLblPos-instance_method"> - - - (<tt>Symbol</tt>) <strong>tickLblPos</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the position of the tick labels must be one of [:nextTo, :high, :low]</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"> - - -26 -27 -28</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 26</span> - -<span class='def def kw'>def</span> <span class='tickLblPos identifier id'>tickLblPos</span> - <span class='@tickLblPos ivar id'>@tickLblPos</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 common 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"> - - -79 -80 -81 -82 -83 -84 -85 -86 -87 -88</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 79</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axId ivar id'>@axId</span><span class='rparen token'>)</span> - <span class='@scaling ivar id'>@scaling</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='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:axPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@axPos ivar id'>@axPos</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:majorGridlines'</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:numFmt'</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@format_code ivar id'>@format_code</span><span class='comma token'>,</span> <span class='symbol val'>:sourceLinked=</span><span class='gt op'>></span><span class='string val'>"1"</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:tickLblPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblPos ivar id'>@tickLblPos</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:crossAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossAx ivar id'>@crossAx</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:crosses'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crosses ivar id'>@crosses</span><span class='rparen 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:25 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 diff --git a/doc/Axlsx/Bar3DChart.html b/doc/Axlsx/Bar3DChart.html deleted file mode 100644 index fb338d09..00000000 --- a/doc/Axlsx/Bar3DChart.html +++ /dev/null @@ -1,1160 +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::Bar3DChart - - — 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 (B)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Bar3DChart</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::Bar3DChart - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li class="next">Axlsx::Bar3DChart</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/bar_3D_chart.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Bar3DChart is a three dimentional barchart (who would have guessed?) -that you can add to your worksheet.</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> - - <li><span class='object_link'><a href="Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">Package#serialize</a></span></li> - - <li>for an example</li> - - </ul> - -</div> - <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT = - <div class="docstring"> - <div class="discussion"> - -<p>validation regex for gap amount percent</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</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="#barDir-instance_method" title="#barDir (instance method)">- (Symbol) <strong>barDir</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The direction of the bars in the chart must be one of [:bar, :col].</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#catAxis-instance_method" title="#catAxis (instance method)">- (CatAxis) <strong>catAxis</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#gapDepth-instance_method" title="#gapDepth (instance method)">- (String) <strong>gapDepth</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#gapWidth-instance_method" title="#gapWidth (instance method)">- (String) <strong>gapWidth</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#grouping-instance_method" title="#grouping (instance method)">- (Symbol) <strong>grouping</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>grouping for a column, line, or area chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#shape-instance_method" title="#shape (instance method)">- (Symbol) <strong>shape</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, -:cylinder, :pyramid, :pyramidToMax].</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#valAxis-instance_method" title="#valAxis (instance method)">- (ValAxis) <strong>valAxis</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the valueaxis.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">style</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</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)">- (Bar3DChart) <strong>initialize</strong>(frame, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new bar chart 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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the bar chart.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - - - <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span>, <span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">#end_at</a></span>, <span class='object_link'><a href="Chart.html#from-instance_method" title="Axlsx::Chart#from (method)">#from</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">#index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">#pn</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">#start_at</a></span>, <span class='object_link'><a href="Chart.html#to-instance_method" title="Axlsx::Chart#to (method)">#to</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::Bar3DChart (class)">Bar3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new bar chart object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>frame</span> - - - <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>The workbook that owns this chart.</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">title</span> - <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">show_legend</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">barDir</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">grouping</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">gapWidth</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">gapDepth</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">shape</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotX</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">hPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotY</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">depthPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rAngAx</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">perspective</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li><span class='object_link'><a href="View3D.html" title="Axlsx::View3D (class)">View3D</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 61</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</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='@barDir ivar id'>@barDir</span> <span class='assign token'>=</span> <span class='symbol val'>:bar</span> - <span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:clustered</span> - <span class='@gapWidth ivar id'>@gapWidth</span><span class='comma token'>,</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='comma token'>,</span> <span class='@shape ivar id'>@shape</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='comma token'>,</span> <span class='nil nil kw'>nil</span> - <span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> - <span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> - <span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> - <span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> - <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='BarSeries constant id'>BarSeries</span> - <span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:rAngAx=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rbrace token'>}</span><span class='dot token'>.</span><span class='merge identifier id'>merge</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</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="barDir=-instance_method"></span> - <span id="barDir-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="barDir-instance_method"> - - - (<tt>Symbol</tt>) <strong>barDir</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The direction of the bars in the chart must be one of [:bar, :col]</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"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='barDir identifier id'>barDir</span> - <span class='@barDir ivar id'>@barDir</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="catAxis-instance_method"></span> - <div class="method_details "> - <p class="signature " id="catAxis-instance_method"> - - - (<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>) <strong>catAxis</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the category axis</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>)</span> - - - - </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/drawing/bar_3D_chart.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span> - <span class='@catAxis ivar id'>@catAxis</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="gapDepth=-instance_method"></span> - <span id="gapDepth-instance_method"></span> - <div class="method_details "> - <p class="signature " id="gapDepth-instance_method"> - - - (<tt>String</tt>) <strong>gapDepth</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span> - <span class='@gapDepth ivar id'>@gapDepth</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="gapWidth=-instance_method"></span> - <span id="gapWidth-instance_method"></span> - <div class="method_details "> - <p class="signature " id="gapWidth-instance_method"> - - - (<tt>String</tt>) <strong>gapWidth</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='gapWidth identifier id'>gapWidth</span> - <span class='@gapWidth ivar id'>@gapWidth</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="grouping=-instance_method"></span> - <span id="grouping-instance_method"></span> - <div class="method_details "> - <p class="signature " id="grouping-instance_method"> - - - (<tt>Symbol</tt>) <strong>grouping</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>grouping for a column, line, or area chart. must be one of -[:percentStacked, :clustered, :standard, :stacked]</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"> - - -34 -35 -36</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 34</span> - -<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span> - <span class='@grouping ivar id'>@grouping</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="shape=-instance_method"></span> - <span id="shape-instance_method"></span> - <div class="method_details "> - <p class="signature " id="shape-instance_method"> - - - (<tt>Symbol</tt>) <strong>shape</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, -:cylinder, :pyramid, :pyramidToMax]</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"> - - -39 -40 -41</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 39</span> - -<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span> - <span class='@shape ivar id'>@shape</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="valAxis-instance_method"></span> - <div class="method_details "> - <p class="signature " id="valAxis-instance_method"> - - - (<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>) <strong>valAxis</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the valueaxis</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></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/bar_3D_chart.rb', line 16</span> - -<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span> - <span class='@valAxis ivar id'>@valAxis</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> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the bar chart</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -109 -110 -111 -112 -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 109</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> - <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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:bar3DChart'</span><span class='rparen token'>)</span> <span class='lbrace 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:barDir'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='barDir identifier id'>barDir</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:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</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:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> - <span class='@series ivar id'>@series</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='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</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='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:gapWidth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapWidth ivar id'>@gapWidth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapWidth ivar id'>@gapWidth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@shape ivar id'>@shape</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='@catAxis ivar id'>@catAxis</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='@valAxis ivar id'>@valAxis</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='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:31 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 diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html deleted file mode 100644 index 30362718..00000000 --- a/doc/Axlsx/BarSeries.html +++ /dev/null @@ -1,697 +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::BarSeries - - — 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 (B)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">BarSeries</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::BarSeries - - - -</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::BarSeries</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/bar_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 BarSeries defines the title, data and labels for bar 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)">- (Array, SimpleTypedList) <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)">- (Array, SimpleTypedList) <strong>labels</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The labels for this series.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#shape-instance_method" title="#shape (instance method)">- (Symbol) <strong>shape</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The shabe of the bars or columns must be one of [:percentStacked, -:clustered, :standard, :stacked].</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)">- (BarSeries) <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::BarSeries (class)">BarSeries</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> - - - — - <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> - - <li> - <span class="name">title</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">shape</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -28 -29 -30 -31 -32 -33</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 28</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='@shape ivar id'>@shape</span> <span class='assign token'>=</span> <span class='symbol val'>:box</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='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier 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='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier 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>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></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/bar_series.rb', line 11</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>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</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/drawing/bar_series.rb', line 15</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> - - - <span id="shape=-instance_method"></span> - <span id="shape-instance_method"></span> - <div class="method_details "> - <p class="signature " id="shape-instance_method"> - - - (<tt>Symbol</tt>) <strong>shape</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The shabe of the bars or columns must be one of [:percentStacked, -:clustered, :standard, :stacked]</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"> - - -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 20</span> - -<span class='def def kw'>def</span> <span class='shape identifier id'>shape</span> - <span class='@shape ivar id'>@shape</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> - - - - — - <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"> - - -45 -46 -47 -48 -49 -50 -51</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 45</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='xml_inner identifier id'>xml_inner</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:shape'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@shape ivar id'>@shape</span><span class='rparen token'>)</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:30 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 diff --git a/doc/Axlsx/Border.html b/doc/Axlsx/Border.html deleted file mode 100644 index 71a33a92..00000000 --- a/doc/Axlsx/Border.html +++ /dev/null @@ -1,759 +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::Border - - — 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 (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"> - - -47 -48 -49 -50 -51 -52 -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border.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='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='do do kw'>do</span> <span class='bitor op'>|</span><span class='part identifier id'>part</span><span class='bitor op'>|</span> - <span class='part identifier id'>part</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='end end kw'>end</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 Wed Nov 30 08:46:38 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 diff --git a/doc/Axlsx/BorderPr.html b/doc/Axlsx/BorderPr.html deleted file mode 100644 index 6daa67a9..00000000 --- a/doc/Axlsx/BorderPr.html +++ /dev/null @@ -1,691 +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::BorderPr - - — 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 (B)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">BorderPr</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::BorderPr - - - -</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::BorderPr</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_pr.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>A border part.</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-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The color of this border part.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#name-instance_method" title="#name (instance method)">- (Symbol) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of this border part.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#style-instance_method" title="#style (instance method)">- (Symbol) <strong>style</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The syle of this border part.</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)">- (BorderPr) <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 Part 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 border part.</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::BorderPr (class)">BorderPr</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Border Part 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">color</span> - <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">name</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Border.html" title="Axlsx::Border (class)">Axlsx::Border</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -46 -47 -48 -49 -50</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 46</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="color=-instance_method"></span> - <span id="color-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="color-instance_method"> - - - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The color of this border part.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>The color of this border part.</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_pr.rb', line 6</span> - -<span class='def def kw'>def</span> <span class='color identifier id'>color</span> - <span class='@color ivar id'>@color</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details "> - <p class="signature " id="name-instance_method"> - - - (<tt>Symbol</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The following are allowed</p> - -<pre class="code"><span class='symbol val'>:start</span> -<span class='symbol val'>:end</span> -<span class='symbol val'>:left</span> -<span class='symbol val'>:right</span> -<span class='symbol val'>:top</span> -<span class='symbol val'>:bottom</span> -<span class='symbol val'>:diagonal</span> -<span class='symbol val'>:vertical</span> -<span class='symbol val'>:horizontal</span> -</pre> -</div> - </div> - - -<p>The name of this border part</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Symbol</tt>)</span> - - - - — - <div class='inline'> -<p>The name of this border part</p> -</div> - - </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/border_pr.rb', line 39</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="style=-instance_method"></span> - <span id="style-instance_method"></span> - <div class="method_details "> - <p class="signature " id="style-instance_method"> - - - (<tt>Symbol</tt>) <strong>style</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The following are allowed</p> - -<pre class="code"><span class='symbol val'>:none</span> -<span class='symbol val'>:thin</span> -<span class='symbol val'>:medium</span> -<span class='symbol val'>:dashed</span> -<span class='symbol val'>:dotted</span> -<span class='symbol val'>:thick</span> -<span class='symbol val'>:double</span> -<span class='symbol val'>:hair</span> -<span class='symbol val'>:mediumDashed</span> -<span class='symbol val'>:dashDot</span> -<span class='symbol val'>:mediumDashDot</span> -<span class='symbol val'>:dashDotDot</span> -<span class='symbol val'>:mediumDashDotDot</span> -<span class='symbol val'>:slantDashDot</span> -</pre> -</div> - </div> - - -<p>The syle of this border part.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Symbol</tt>)</span> - - - - — - <div class='inline'> -<p>The syle of this border part.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='style identifier id'>style</span> - <span class='@style ivar id'>@style</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 border part</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"> - - -62 -63 -64 -65 -66</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/border_pr.rb', line 62</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='@name ivar id'>@name</span><span class='comma token'>,</span> <span class='symbol val'>:style</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@style ivar id'>@style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='@color ivar id'>@color</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='@color ivar id'>@color</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Color constant id'>Color</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:32 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 diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html deleted file mode 100644 index 51fbc5ab..00000000 --- a/doc/Axlsx/CatAxis.html +++ /dev/null @@ -1,750 +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::CatAxis - - — 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 (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. Inherited</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. Inherited</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> - — <div class='inline'> -<p>Inherited</p> -</div> - </li> - - <li> - <span class="name">tickLblPos.</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Inherited</p> -</div> - </li> - - <li> - <span class="name">crosses.</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Inherited</p> -</div> - </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"> - - -31 -32 -33 -34 -35 -36</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.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='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='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='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='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"> - - -7 -8 -9</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 7</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"> - - -12 -13 -14</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 12</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"> - - -17 -18 -19</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 17</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"> - - -52 -53 -54 -55 -56 -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 52</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 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 diff --git a/doc/Axlsx/CatAxisData.html b/doc/Axlsx/CatAxisData.html deleted file mode 100644 index 7530a7c6..00000000 --- a/doc/Axlsx/CatAxisData.html +++ /dev/null @@ -1,390 +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::CatAxisData - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">CatAxisData</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::CatAxisData - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> - - <li class="next">Axlsx::CatAxisData</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_data.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The CatAxisData class serializes the category axis data for a chart</p> - - - </div> -</div> -<div class="tags"> - - -</div><div id="subclasses"> - <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span></p> -</div> - - - - - - - - - - - - <h2>Instance Attribute Summary</h2> - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> - <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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)">- (CatAxisData) <strong>initialize</strong>(data = []) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Create a new CatAxisData 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 data.</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::CatAxisData (class)">CatAxisData</a></span></tt>) <strong>initialize</strong>(data = []) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Create a new CatAxisData object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <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> - - - <em class="default">(defaults to: <tt>[]</tt>)</em> - - - — - <div class='inline'> -<p>the data for this category axis. This can be a simple array or a simple -typed list of cells.</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -7 -8 -9 -10 -11</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 7</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='data identifier id'>data</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='super super kw'>super</span> <span class='Object constant id'>Object</span> - <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='data identifier id'>data</span> <span class='if if_mod kw'>if</span> <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> - <span class='data identifier id'>data</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='i identifier id'>i</span><span class='bitor op'>|</span> <span class='@list ivar id'>@list</span> <span class='lshft op'><<</span> <span class='i identifier id'>i</span> <span class='rbrace token'>}</span> <span class='if if_mod kw'>if</span> <span class='data identifier id'>data</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> -<div id="method_missing_details" class="method_details_list"> - <h2>Dynamic Method Handling</h2> - <p class="notice super"> - This class handles dynamic methods through the <tt>method_missing</tt> method - - in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> - - </p> - -</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 data</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"> - - -16 -17 -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.rb', line 16</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:cat'</span><span class='rparen token'>)</span> <span class='lbrace 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:strRef'</span><span class='rparen token'>)</span> <span class='lbrace 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:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='@list ivar id'>@list</span><span class='rparen token'>)</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:strCache'</span><span class='rparen token'>)</span> <span class='lbrace 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:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> - <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='item identifier id'>item</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:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace 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:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</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='rbrace 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 Wed Nov 30 08:46:24 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 diff --git a/doc/Axlsx/Cell.html b/doc/Axlsx/Cell.html deleted file mode 100644 index 59403b4a..00000000 --- a/doc/Axlsx/Cell.html +++ /dev/null @@ -1,1558 +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::Cell - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Cell</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::Cell - - - -</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::Cell</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/workbook/worksheet/cell.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 generate cells is via Worksheet#add_row</p> -</div> - </div> - - -<p>A cell in a worksheet. Cell stores inforamation requried to serialize a -single worksheet cell to xml. You must provde the Row that the cell belongs -to and the cells value. The data type will automatically be determed if you -do not specify the :type option. The default style will be applied if you -do not supply the :style option. Changing the cell’s type will recast the -value to the type specified. Altering the cell’s value via the property -accessor will also automatically cast the provided value to the cell’s -type.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>Manually creating and manipulating Cell objects</p> -</div></h4> - <pre class="example code"><span class='ws identifier id'>ws</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='add_worksheet identifier id'>add_worksheet</span> -<span class='comment val'># This is the simple, and recommended way to create cells. Data types will automatically be determined for you.</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>1</span><span class='comma token'>,</span><span class='string val'>"fish"</span><span class='comma token'>,</span><span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rbrack token'>]</span> - -<span class='comment val'># but you can also do this</span> -<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> -<span class='r identifier id'>r</span><span class='dot token'>.</span><span class='add_cell identifier id'>add_cell</span> <span class='integer val'>1</span> - -<span class='comment val'># or even this</span> -<span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> -<span class='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:value=</span><span class='gt op'>></span><span class='integer identifier id'>integer</span> - -<span class='comment val'># cells can also be accessed via Row#cells. The example here changes the cells type, which will automatically updated the value from 1 to 1.0</span> -<span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='type identifier id'>type</span> <span class='assign token'>=</span> <span class='symbol val'>:float</span> -</pre> - - </div> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</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="#row-instance_method" title="#row (instance method)">- (Row) <strong>row</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The row this cell belongs to.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#style-instance_method" title="#style (instance method)">- (Integer) <strong>style</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of the cellXfs item to be applied to this cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The cell’s data type.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#value-instance_method" title="#value (instance method)">- (Object) <strong>value</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The value of this cell.</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="#cast_value-instance_method" title="#cast_value (instance method)">- (Object) <strong>cast_value</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Cast the value into this cells data type.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#cell_type_from_value-instance_method" title="#cell_type_from_value (instance method)">- (Symbol) <strong>cell_type_from_value</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Determines the cell type based on the cell value.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#col_ref-instance_method" title="#col_ref (instance method)">- (String) <strong>col_ref</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>converts the column index into alphabetical values.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of the cell in the containing row.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Cell) <strong>initialize</strong>(row, value = "", options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A new instance of Cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#r-instance_method" title="#r (instance method)">- (String) <strong>r</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The alpha(column)numeric(row) reference for this sell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#r_abs-instance_method" title="#r_abs (instance method)">- (String) <strong>r_abs</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The absolute alpha(column)numeric(row) reference for this sell.</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 cell.</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::Cell (class)">Cell</a></span></tt>) <strong>initialize</strong>(row, value = "", options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A new instance of Cell</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>row</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>The row this cell belongs to.</p> -</div> - - </li> - - <li> - - <span class='name'>value</span> - - - <span class='type'>(<tt>Any</tt>)</span> - - - <em class="default">(defaults to: <tt>""</tt>)</em> - - - — - <div class='inline'> -<p>The value associated with this cell.</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">type</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The intended data type for this cell. If not specified the data type will -be determined internally based on the vlue provided.</p> -</div> - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The index of the cellXfs item to be applied to this cell. If not specified, -the default style (0) will be applied.</p> -</div> - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -69 -70 -71 -72 -73 -74 -75 -76 -77</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 69</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='row identifier id'>row</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</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='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span><span class='assign token'>=</span><span class='row identifier id'>row</span> - <span class='comment val'>#reference for validation</span> - <span class='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</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='@type ivar id'>@type</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:style</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> - <span class='@value ivar id'>@value</span> <span class='assign token'>=</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='rparen token'>)</span> - <span class='@row ivar id'>@row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> <span class='lshft op'><<</span> <span class='self self kw'>self</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="row=-instance_method"></span> - <span id="row-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="row-instance_method"> - - - (<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>row</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The row this cell belongs to.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='row identifier id'>row</span> - <span class='@row ivar id'>@row</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="style=-instance_method"></span> - <span id="style-instance_method"></span> - <div class="method_details "> - <p class="signature " id="style-instance_method"> - - - (<tt>Integer</tt>) <strong>style</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of the cellXfs item to be applied to this cell.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='style identifier id'>style</span> - <span class='@style ivar id'>@style</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="type=-instance_method"></span> - <span id="type-instance_method"></span> - <div class="method_details "> - <p class="signature " id="type-instance_method"> - - - (<tt>Symbol</tt>) <strong>type</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>If the value provided cannot be cast into the type specified, type is -changed to :string and the following logic is applied.</p> - -<pre class="code"><span class='symbol val'>:string</span> <span class='to identifier id'>to</span> <span class='symbol val'>:integer</span> <span class='or or kw'>or</span> <span class='symbol val'>:float</span><span class='comma token'>,</span> <span class='type identifier id'>type</span> <span class='coversions identifier id'>coversions</span> <span class='always identifier id'>always</span> <span class='return return kw'>return</span> <span class='integer val'>0</span> <span class='or or kw'>or</span> <span class='integer val'>0</span><span class='integer val'>.0</span> -<span class='symbol val'>:string</span><span class='comma token'>,</span> <span class='symbol val'>:integer</span><span class='comma token'>,</span> <span class='or or kw'>or</span> <span class='symbol val'>:float</span> <span class='to identifier id'>to</span> <span class='symbol val'>:time</span> <span class='conversions identifier id'>conversions</span> <span class='always identifier id'>always</span> <span class='return return kw'>return</span> <span class='the identifier id'>the</span> <span class='original identifier id'>original</span> <span class='value identifier id'>value</span> <span class='as identifier id'>as</span> <span class='a identifier id'>a</span> <span class='string identifier id'>string</span> <span class='and and kw'>and</span> <span class='set identifier id'>set</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='type identifier id'>type</span> <span class='to identifier id'>to</span> <span class='symbol val'>:string</span><span class='dot token'>.</span> -</pre> - -<p>No support is currently implemented for parsing time strings.</p> -</div> - </div> - - -<p>The cell’s data type. Currently only four types are supported, :time, -:float, :integer and :string. Changing the type for a cell will recast the -value into that type. If no type option is specified in the constructor, -the type is automatically determed.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Symbol</tt>)</span> - - - - — - <div class='inline'> -<p>The type of data this cell’s value is cast to.</p> -</div> - - </li> - -</ul> -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentExeption</tt>)</span> - - - - — - <div class='inline'> -<p>Cell.type must be one of [:time, :float, :integer, :string]</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#cell_type_from_value-instance_method" title="Axlsx::Cell#cell_type_from_value (method)">#cell_type_from_value</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -46 -47 -48</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 46</span> - -<span class='def def kw'>def</span> <span class='type identifier id'>type</span> - <span class='@type ivar id'>@type</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="value=-instance_method"></span> - <span id="value-instance_method"></span> - <div class="method_details "> - <p class="signature " id="value-instance_method"> - - - (<tt>Object</tt>) <strong>value</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The value of this cell.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'></span> - - - - - <div class='inline'> -<p>casted value based on cell’s type attribute.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 57</span> - -<span class='def def kw'>def</span> <span class='value identifier id'>value</span> - <span class='@value ivar id'>@value</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="cast_value-instance_method"> - - - (<tt>Object</tt>) <strong>cast_value</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>About Time - Time in OOXML is <strong>different</strong> from what you -might expect. The history as to why is interesting, but you can safely -assume that if you are generating docs on a mac, you will want to specify -Workbook.1904 as true when using time typed values.</p> -</div> - </div> - - -<p>Cast the value into this cells data type.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Axlsx#date1904</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 169</span> - -<span class='def def kw'>def</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='lparen token'>(</span><span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:to_time</span><span class='rparen token'>)</span><span class='rparen token'>)</span> - <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:to_time</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_time identifier id'>to_time</span> <span class='colon op'>:</span> <span class='v identifier id'>v</span> - <span class='comment val'># Using hardcoded offsets here as some operating systems will not except a 'negative' offset from the ruby epoc.</span> - <span class='comment val'># (1970)</span> - <span class='epoc1900 identifier id'>epoc1900</span> <span class='assign token'>=</span> <span class='integer val'>-2209021200</span> <span class='comment val'>#Time.local(1900, 1, 1) </span> - <span class='epoc1904 identifier id'>epoc1904</span> <span class='assign token'>=</span> <span class='integer val'>-2082877200</span> <span class='comment val'>#Time.local(1904, 1, 1) </span> - <span class='epoc identifier id'>epoc</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='integer val'>? </span><span class='epoc1904 identifier id'>epoc1904</span> <span class='colon op'>:</span> <span class='epoc1900 identifier id'>epoc1900</span> - <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='localtime identifier id'>localtime</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='minus op'>-</span> <span class='epoc identifier id'>epoc</span><span class='rparen token'>)</span> <span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>24.0</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> - <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:float</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> - <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:integer</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> - <span class='else else kw'>else</span> - <span class='@type ivar id'>@type</span> <span class='assign token'>=</span> <span class='symbol val'>:string</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="cell_type_from_value-instance_method"> - - - (<tt>Symbol</tt>) <strong>cell_type_from_value</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>This is only used when a cell is created but no :type option is specified, -the following rules apply:</p> -<ol><li> -<p>If the value is an instance of Time, the type is set to :time</p> -</li><li> -<p>:float and :integer types are determined by regular expression matching.</p> -</li><li> -<p>Anything that does not meet either of the above is determined to be -:string.</p> -</li></ol> -</div> - </div> - - -<p>Determines the cell type based on the cell value.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Symbol</tt>)</span> - - - - — - <div class='inline'> -<p>The determined type</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 153</span> - -<span class='def def kw'>def</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Time constant id'>Time</span> - <span class='symbol val'>:time</span> - <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#numeric</span> - <span class='symbol val'>:integer</span> - <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+\.\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#float</span> - <span class='symbol val'>:float</span> - <span class='else else kw'>else</span> - <span class='symbol val'>:string</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="col_ref-instance_method"> - - - (<tt>String</tt>) <strong>col_ref</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>This follows the standard spreadsheet convention of naming columns A to Z, -followed by AA to AZ etc.</p> -</div> - </div> - - -<p>converts the column index into alphabetical values.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148 -149 -150 -151 -152 -153 -154 -155 -156 -157 -158 -159 -160 -161 -162 -163 -164 -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185 -186 -187</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 136</span> - -<span class='def def kw'>def</span> <span class='col_ref identifier id'>col_ref</span> - <span class='chars identifier id'>chars</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> - <span class='index identifier id'>index</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='index identifier id'>index</span> - <span class='while while kw'>while</span> <span class='index identifier id'>index</span> <span class='geq op'>>=</span> <span class='integer val'>26</span> <span class='do do kw'>do</span> - <span class='chars identifier id'>chars</span> <span class='lshft op'><<</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='index identifier id'>index</span> <span class='mod op'>%</span> <span class='integer val'>26</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='integer val'>65</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chr identifier id'>chr</span> - <span class='index identifier id'>index</span> <span class='opasgn op'>/=</span> <span class='integer val'>26</span> - <span class='end end kw'>end</span> - <span class='chars identifier id'>chars</span> <span class='lshft op'><<</span> <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='chars identifier id'>chars</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> <span class='integer val'>? </span><span class='index identifier id'>index</span> <span class='colon op'>:</span> <span class='index identifier id'>index</span><span class='minus op'>-</span><span class='integer val'>1</span><span class='rparen token'>)</span> <span class='plus op'>+</span> <span class='integer val'>65</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='chr identifier id'>chr</span> - <span class='chars identifier id'>chars</span><span class='dot token'>.</span><span class='reverse identifier id'>reverse</span><span class='dot token'>.</span><span class='join identifier id'>join</span> - <span class='end end kw'>end</span> - - <span class='comment val'># Determines the cell type based on the cell value. </span> - <span class='comment val'># @note This is only used when a cell is created but no :type option is specified, the following rules apply:</span> - <span class='comment val'># 1. If the value is an instance of Time, the type is set to :time</span> - <span class='comment val'># 2. :float and :integer types are determined by regular expression matching.</span> - <span class='comment val'># 3. Anything that does not meet either of the above is determined to be :string.</span> - <span class='comment val'># @return [Symbol] The determined type</span> - <span class='def def kw'>def</span> <span class='cell_type_from_value identifier id'>cell_type_from_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Time constant id'>Time</span> - <span class='symbol val'>:time</span> - <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#numeric</span> - <span class='symbol val'>:integer</span> - <span class='elsif elsif kw'>elsif</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='match identifier id'>match</span><span class='lparen token'>(</span><span class='regexp val'>/\A[+-]?\d+\.\d+?\Z/</span><span class='rparen token'>)</span> <span class='comment val'>#float</span> - <span class='symbol val'>:float</span> - <span class='else else kw'>else</span> - <span class='symbol val'>:string</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> - - <span class='comment val'># Cast the value into this cells data type. </span> - <span class='comment val'># @note </span> - <span class='comment val'># About Time - Time in OOXML is *different* from what you might expect. The history as to why is interesting, but you can safely assume that if you are generating docs on a mac, you will want to specify Workbook.1904 as true when using time typed values.</span> - <span class='comment val'># @see Axlsx#date1904</span> - <span class='def def kw'>def</span> <span class='cast_value identifier id'>cast_value</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Time constant id'>Time</span><span class='rparen token'>)</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='lparen token'>(</span><span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:time</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:to_time</span><span class='rparen token'>)</span><span class='rparen token'>)</span> - <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:to_time</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_time identifier id'>to_time</span> <span class='colon op'>:</span> <span class='v identifier id'>v</span> - <span class='comment val'># Using hardcoded offsets here as some operating systems will not except a 'negative' offset from the ruby epoc.</span> - <span class='comment val'># (1970)</span> - <span class='epoc1900 identifier id'>epoc1900</span> <span class='assign token'>=</span> <span class='integer val'>-2209021200</span> <span class='comment val'>#Time.local(1900, 1, 1) </span> - <span class='epoc1904 identifier id'>epoc1904</span> <span class='assign token'>=</span> <span class='integer val'>-2082877200</span> <span class='comment val'>#Time.local(1904, 1, 1) </span> - <span class='epoc identifier id'>epoc</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span> <span class='integer val'>? </span><span class='epoc1904 identifier id'>epoc1904</span> <span class='colon op'>:</span> <span class='epoc1900 identifier id'>epoc1900</span> - <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='localtime identifier id'>localtime</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='minus op'>-</span> <span class='epoc identifier id'>epoc</span><span class='rparen token'>)</span> <span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>60.0</span><span class='div op'>/</span><span class='float val'>24.0</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> - <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:float</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> - <span class='elsif elsif kw'>elsif</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:integer</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_i identifier id'>to_i</span> - <span class='else else kw'>else</span> - <span class='@type ivar id'>@type</span> <span class='assign token'>=</span> <span class='symbol val'>:string</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of the cell in the containing row.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The index of the cell in the containing row.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -80 -81 -82</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 80</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@row ivar id'>@row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="r-instance_method"> - - - (<tt>String</tt>) <strong>r</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The alpha(column)numeric(row) reference for this sell.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>Relative Cell Reference</p> -</div></h4> - <pre class="example code"><span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='r identifier id'>r</span> <span class='comment val'>#=> "A1" </span> -</pre> - - </div> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The alpha(column)numeric(row) reference for this sell.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -87 -88 -89</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 87</span> - -<span class='def def kw'>def</span> <span class='r identifier id'>r</span> - <span class='dstring node'>"#{col_ref}#{@row.index+1}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="r_abs-instance_method"> - - - (<tt>String</tt>) <strong>r_abs</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The absolute alpha(column)numeric(row) reference for this sell.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>Absolute Cell Reference</p> -</div></h4> - <pre class="example code"><span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='first identifier id'>first</span><span class='dot token'>.</span><span class='r identifier id'>r</span> <span class='comment val'>#=> "$A$1" </span> -</pre> - - </div> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The absolute alpha(column)numeric(row) reference for this sell.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -94 -95 -96</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 94</span> - -<span class='def def kw'>def</span> <span class='r_abs identifier id'>r_abs</span> - <span class='dstring node'>"$#{r.split('').join('$')}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>Shared Strings are not used in this library. All values are set directly in -the each sheet.</p> -</div> - </div> - - -<p>Serializes the cell</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> - - - - — - <div class='inline'> -<p>xml text for the cell</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/cell.rb', line 114</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='comment val'># Both 1.8 and 1.9 return the same 'fast_xf'</span> - <span class='comment val'># &#12491;&#12507;&#12531;&#12468;</span> - <span class='comment val'># &#12491;&#12507;&#12531;&#12468;</span> - - <span class='comment val'># however nokogiri does a nice 'force_encoding' which we shall remove!</span> - <span class='if if kw'>if</span> <span class='@type ivar id'>@type</span> <span class='eq op'>==</span> <span class='symbol val'>:string</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='c identifier id'>c</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='symbol val'>:t=</span><span class='gt op'>></span><span class='symbol val'>:inlineStr</span><span class='comma token'>,</span> <span class='symbol val'>:s=</span><span class='gt op'>></span><span class='style identifier id'>style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='is identifier id'>is</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='t identifier id'>t</span> <span class='@value ivar id'>@value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> - <span class='else else kw'>else</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='c identifier id'>c</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='r identifier id'>r</span><span class='comma token'>,</span> <span class='symbol val'>:s</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='style identifier id'>style</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='v identifier id'>v</span> <span class='value identifier id'>value</span> <span class='rbrace token'>}</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:35 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 diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html deleted file mode 100644 index 480b145f..00000000 --- a/doc/Axlsx/CellAlignment.html +++ /dev/null @@ -1,1219 +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::CellAlignment - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">CellAlignment</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::CellAlignment - - - -</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::CellAlignment</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/cell_alignment.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>Using Styles#add_style is the recommended way to manage cell alignment.</p> -</div> - </div> - - -<p>CellAlignment stores information about the cell alignment of a style Xf -Object.</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="#horizontal-instance_method" title="#horizontal (instance method)">- (Symbol) <strong>horizontal</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The horizontal alignment of the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#indent-instance_method" title="#indent (instance method)">- (Integer) <strong>indent</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The amount of indent.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#justifyLastLine-instance_method" title="#justifyLastLine (instance method)">- (Boolean) <strong>justifyLastLine</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicate if the last line should be justified.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#readingOrder-instance_method" title="#readingOrder (instance method)">- (Integer) <strong>readingOrder</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The reading order of the text 0 Context Dependent 1 Left-to-Right 2 -Right-to-Left.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#relativeIndent-instance_method" title="#relativeIndent (instance method)">- (Integer) <strong>relativeIndent</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The amount of relativeIndent.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#shrinkToFit-instance_method" title="#shrinkToFit (instance method)">- (Boolean) <strong>shrinkToFit</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicate if the text should be shrunk to the fit in the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#textRotation-instance_method" title="#textRotation (instance method)">- (Integer) <strong>textRotation</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The textRotation of the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#vertical-instance_method" title="#vertical (instance method)">- (Symbol) <strong>vertical</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The vertical alignment of the cell.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#wrapText-instance_method" title="#wrapText (instance method)">- (Boolean) <strong>wrapText</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicate if the text of the cell should wrap.</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)">- (CellAlignment) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Create a new cell_alignment 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 cell alignment.</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::CellAlignment (class)">CellAlignment</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Create a new cell_alignment 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">horizontal</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">vertical</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">textRotation</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">wrapText</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">indent</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">relativeIndent</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">justifyLastLine</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">shrinkToFit</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">readingOrder</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -72 -73 -74 -75 -76</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 72</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="horizontal=-instance_method"></span> - <span id="horizontal-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="horizontal-instance_method"> - - - (<tt>Symbol</tt>) <strong>horizontal</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The horizontal cell alignement style must be one of</p> - -<pre class="code"><span class='symbol val'>:general</span> -<span class='symbol val'>:left</span> -<span class='symbol val'>:center</span> -<span class='symbol val'>:right</span> -<span class='symbol val'>:fill</span> -<span class='symbol val'>:justify</span> -<span class='symbol val'>:centerContinuous</span> -<span class='symbol val'>:distributed</span> -</pre> -</div> - </div> - - -<p>The horizontal alignment of the cell.</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"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='horizontal identifier id'>horizontal</span> - <span class='@horizontal ivar id'>@horizontal</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="indent=-instance_method"></span> - <span id="indent-instance_method"></span> - <div class="method_details "> - <p class="signature " id="indent-instance_method"> - - - (<tt>Integer</tt>) <strong>indent</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The amount of indent</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"> - - -41 -42 -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 41</span> - -<span class='def def kw'>def</span> <span class='indent identifier id'>indent</span> - <span class='@indent ivar id'>@indent</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="justifyLastLine=-instance_method"></span> - <span id="justifyLastLine-instance_method"></span> - <div class="method_details "> - <p class="signature " id="justifyLastLine-instance_method"> - - - (<tt>Boolean</tt>) <strong>justifyLastLine</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicate if the last line should be justified.</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"> - - -49 -50 -51</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 49</span> - -<span class='def def kw'>def</span> <span class='justifyLastLine identifier id'>justifyLastLine</span> - <span class='@justifyLastLine ivar id'>@justifyLastLine</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="readingOrder=-instance_method"></span> - <span id="readingOrder-instance_method"></span> - <div class="method_details "> - <p class="signature " id="readingOrder-instance_method"> - - - (<tt>Integer</tt>) <strong>readingOrder</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The reading order of the text 0 Context Dependent 1 Left-to-Right 2 -Right-to-Left</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"> - - -60 -61 -62</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 60</span> - -<span class='def def kw'>def</span> <span class='readingOrder identifier id'>readingOrder</span> - <span class='@readingOrder ivar id'>@readingOrder</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="relativeIndent=-instance_method"></span> - <span id="relativeIndent-instance_method"></span> - <div class="method_details "> - <p class="signature " id="relativeIndent-instance_method"> - - - (<tt>Integer</tt>) <strong>relativeIndent</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The amount of relativeIndent</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"> - - -45 -46 -47</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 45</span> - -<span class='def def kw'>def</span> <span class='relativeIndent identifier id'>relativeIndent</span> - <span class='@relativeIndent ivar id'>@relativeIndent</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="shrinkToFit=-instance_method"></span> - <span id="shrinkToFit-instance_method"></span> - <div class="method_details "> - <p class="signature " id="shrinkToFit-instance_method"> - - - (<tt>Boolean</tt>) <strong>shrinkToFit</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicate if the text should be shrunk to the fit 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"> - - -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 53</span> - -<span class='def def kw'>def</span> <span class='shrinkToFit identifier id'>shrinkToFit</span> - <span class='@shrinkToFit ivar id'>@shrinkToFit</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="textRotation=-instance_method"></span> - <span id="textRotation-instance_method"></span> - <div class="method_details "> - <p class="signature " id="textRotation-instance_method"> - - - (<tt>Integer</tt>) <strong>textRotation</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The textRotation of the cell.</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"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='textRotation identifier id'>textRotation</span> - <span class='@textRotation ivar id'>@textRotation</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="vertical=-instance_method"></span> - <span id="vertical-instance_method"></span> - <div class="method_details "> - <p class="signature " id="vertical-instance_method"> - - - (<tt>Symbol</tt>) <strong>vertical</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The vertical cell allingment style must be one of the following:</p> - -<pre class="code"><span class='symbol val'>:top</span> -<span class='symbol val'>:center</span> -<span class='symbol val'>:bottom</span> -<span class='symbol val'>:justify</span> -<span class='symbol val'>:distributed</span> -</pre> -</div> - </div> - - -<p>The vertical alignment of the cell.</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"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='vertical identifier id'>vertical</span> - <span class='@vertical ivar id'>@vertical</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="wrapText=-instance_method"></span> - <span id="wrapText-instance_method"></span> - <div class="method_details "> - <p class="signature " id="wrapText-instance_method"> - - - (<tt>Boolean</tt>) <strong>wrapText</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicate if the text of the cell should wrap</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"> - - -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='wrapText identifier id'>wrapText</span> - <span class='@wrapText ivar id'>@wrapText</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 cell alignment</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"> - - -100 -101 -102</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_alignment.rb', line 100</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='alignment identifier id'>alignment</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='rparen 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:30 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 diff --git a/doc/Axlsx/CellProtection.html b/doc/Axlsx/CellProtection.html deleted file mode 100644 index ae7793ce..00000000 --- a/doc/Axlsx/CellProtection.html +++ /dev/null @@ -1,551 +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::CellProtection - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">CellProtection</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::CellProtection - - - -</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::CellProtection</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/cell_protection.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>Using Styles#add_style is the recommended way to manage cell protection.</p> -</div> - </div> - - -<p>CellProtection stores information about locking or hiding cells in -spreadsheet.</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="#hidden-instance_method" title="#hidden (instance method)">- (Boolean) <strong>hidden</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>specifies locking for cells that have the style containing this protection.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#locked-instance_method" title="#locked (instance method)">- (Boolean) <strong>locked</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>specifies if the cells that have the style containing this protection.</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)">- (CellProtection) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new CellProtection.</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 cell protection.</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::CellProtection (class)">CellProtection</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new CellProtection</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">hidden</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>value for hidden protection</p> -</div> - </li> - - <li> - <span class="name">locked</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>value for locked protection</p> -</div> - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 18</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="hidden=-instance_method"></span> - <span id="hidden-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="hidden-instance_method"> - - - (<tt>Boolean</tt>) <strong>hidden</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>specifies locking for cells that have the style containing this protection</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"> - - -9 -10 -11</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span> - <span class='@hidden ivar id'>@hidden</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="locked=-instance_method"></span> - <span id="locked-instance_method"></span> - <div class="method_details "> - <p class="signature " id="locked-instance_method"> - - - (<tt>Boolean</tt>) <strong>locked</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>specifies if the cells that have the style containing this protection</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"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='locked identifier id'>locked</span> - <span class='@locked ivar id'>@locked</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 cell protection</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"> - - -32 -33 -34</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_protection.rb', line 32</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='protection identifier id'>protection</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='rparen 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: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 diff --git a/doc/Axlsx/CellStyle.html b/doc/Axlsx/CellStyle.html deleted file mode 100644 index b66ceaf8..00000000 --- a/doc/Axlsx/CellStyle.html +++ /dev/null @@ -1,929 +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::CellStyle - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">CellStyle</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::CellStyle - - - -</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::CellStyle</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/cell_style.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>Using Styles#add_style is the recommended way to manage cell styling.</p> -</div> - </div> - - -<p>CellStyle defines named styles that reference defined formatting records -and can be used in your worksheet.</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="#builtinId-instance_method" title="#builtinId (instance method)">- (Integer) <strong>builtinId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The buildinId to use when this named style is applied.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#customBuiltin-instance_method" title="#customBuiltin (instance method)">- (Boolean) <strong>customBuiltin</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates that the build in style reference has been customized.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#hidden-instance_method" title="#hidden (instance method)">- (Boolean) <strong>hidden</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Determines if this named style should show in the list of styles when using -excel.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#iLevel-instance_method" title="#iLevel (instance method)">- (Integer) <strong>iLevel</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Determines if this formatting is for an outline style, and what level of -the outline it is to be applied to.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of this cell style.</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>The formatting record id this named style utilizes.</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)">- (CellStyle) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creats a new CellStyle 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 cell style.</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::CellStyle (class)">CellStyle</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creats a new CellStyle 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">name</span> - <span class="type">(<tt>String</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">buildinId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">iLevel</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">hidden</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">customBuiltIn</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -39 -40 -41 -42 -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 39</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</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="builtinId=-instance_method"></span> - <span id="builtinId-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="builtinId-instance_method"> - - - (<tt>Integer</tt>) <strong>builtinId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The buildinId to use when this named style is applied</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="NumFmt.html" title="Axlsx::NumFmt (class)">NumFmt</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='builtinId identifier id'>builtinId</span> - <span class='@builtinId ivar id'>@builtinId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="customBuiltin=-instance_method"></span> - <span id="customBuiltin-instance_method"></span> - <div class="method_details "> - <p class="signature " id="customBuiltin-instance_method"> - - - (<tt>Boolean</tt>) <strong>customBuiltin</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates that the build in style reference has been customized.</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"> - - -30 -31 -32</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 30</span> - -<span class='def def kw'>def</span> <span class='customBuiltin identifier id'>customBuiltin</span> - <span class='@customBuiltin ivar id'>@customBuiltin</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="hidden=-instance_method"></span> - <span id="hidden-instance_method"></span> - <div class="method_details "> - <p class="signature " id="hidden-instance_method"> - - - (<tt>Boolean</tt>) <strong>hidden</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Determines if this named style should show in the list of styles when using -excel</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"> - - -26 -27 -28</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 26</span> - -<span class='def def kw'>def</span> <span class='hidden identifier id'>hidden</span> - <span class='@hidden ivar id'>@hidden</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="iLevel=-instance_method"></span> - <span id="iLevel-instance_method"></span> - <div class="method_details "> - <p class="signature " id="iLevel-instance_method"> - - - (<tt>Integer</tt>) <strong>iLevel</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Determines if this formatting is for an outline style, and what level of -the outline it is to be applied to.</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"> - - -22 -23 -24</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 22</span> - -<span class='def def kw'>def</span> <span class='iLevel identifier id'>iLevel</span> - <span class='@iLevel ivar id'>@iLevel</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details "> - <p class="signature " id="name-instance_method"> - - - (<tt>String</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of this cell style</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</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>The formatting record id this named style utilizes</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Xf.html" title="Axlsx::Xf (class)">Xf</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 13</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 cell style</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"> - - -60 -61 -62</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/cell_style.rb', line 60</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='cellStyle identifier id'>cellStyle</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='rparen 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:29 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 diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html deleted file mode 100644 index 2fe97954..00000000 --- a/doc/Axlsx/Chart.html +++ /dev/null @@ -1,1641 +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::Chart - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Chart</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::Chart - - - -</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::Chart</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/chart.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>Worksheet#add_chart is the recommended way to create charts for your -worksheets.</p> -</div> - </div> - - -<p>A Chart is the superclass for specific charts</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>for examples</li> - - </ul> - -</div><div id="subclasses"> - <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span>, <span class='object_link'><a href="Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span>, <span class='object_link'><a href="Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span></p> -</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="#graphic_frame-instance_method" title="#graphic_frame (instance method)">- (GraphicFrame) <strong>graphic_frame</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A reference to the graphic frame that owns this chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#series-instance_method" title="#series (instance method)">- (SimpleTypedList) <strong>series</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A collection of series objects that are applied to the chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#series_type-instance_method" title="#series_type (instance method)">- (Series) <strong>series_type</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of series to use for this chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#show_legend-instance_method" title="#show_legend (instance method)">- (Boolean) <strong>show_legend</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Show the legend in the chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#style-instance_method" title="#style (instance method)">- (Integer) <strong>style</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The style for the chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#title-instance_method" title="#title (instance method)">- (Title) <strong>title</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The title object for the chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#view3D-instance_method" title="#view3D (instance method)">- (Object) <strong>view3D</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The 3D view properties for the chart.</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="#add_series-instance_method" title="#add_series (instance method)">- (Series) <strong>add_series</strong>(options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a new series to the chart’s series collection.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#end_at-instance_method" title="#end_at (instance method)">- (Marker) <strong>end_at</strong>(x, y) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the end anchor position If you need finer -granularity in positioning use graphic_frame.anchor.to.colOff / rowOff.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#from-instance_method" title="#from (instance method)">- (Object) <strong>from</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this chart in the workbooks charts collection.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Chart) <strong>initialize</strong>(frame, options = {}) {|_self| ... }</a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new chart object.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The part name for this chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong>(x, y) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need -finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#to-instance_method" title="#to (instance method)">- (Object) <strong>to</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Chart Serialization serializes the chart.</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::Chart (class)">Chart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) {|_self| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new chart object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>frame</span> - - - <span class='type'>(<tt>GraphicalFrame</tt>)</span> - - - - — - <div class='inline'> -<p>The frame that holds this chart.</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">title</span> - <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">show_legend</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>_self</tt>)</span> - - - - </li> - -</ul> -<h3>Yield Parameters:</h3> -<ul class="yieldparam"> - - <li> - - <span class='name'>_self</span> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Chart (class)">Axlsx::Chart</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>the object that the method was called on</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 44</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</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='@style ivar id'>@style</span> <span class='assign token'>=</span> <span class='integer val'>2</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='assign token'>=</span><span class='frame identifier id'>frame</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@series ivar id'>@series</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='Series constant id'>Series</span> - <span class='@show_legend ivar id'>@show_legend</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> - <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='Series constant id'>Series</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='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> - <span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> - <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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=""></span> - <span id="graphic_frame-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="graphic_frame-instance_method"> - - - (<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>graphic_frame</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A reference to the graphic frame that owns this chart</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</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/chart.rb', line 14</span> - -<span class='def def kw'>def</span> <span class='graphic_frame identifier id'>graphic_frame</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="series-instance_method"></span> - <div class="method_details "> - <p class="signature " id="series-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>series</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A collection of series objects that are applied to the chart</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> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='series identifier id'>series</span> - <span class='@series ivar id'>@series</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="series_type-instance_method"></span> - <div class="method_details "> - <p class="signature " id="series_type-instance_method"> - - - (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>series_type</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The type of series to use for this chart.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -22 -23 -24</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 22</span> - -<span class='def def kw'>def</span> <span class='series_type identifier id'>series_type</span> - <span class='@series_type ivar id'>@series_type</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="show_legend=-instance_method"></span> - <span id="show_legend-instance_method"></span> - <div class="method_details "> - <p class="signature " id="show_legend-instance_method"> - - - (<tt>Boolean</tt>) <strong>show_legend</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Show the legend in the chart</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"> - - -38 -39 -40</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='show_legend identifier id'>show_legend</span> - <span class='@show_legend ivar id'>@show_legend</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="style=-instance_method"></span> - <span id="style-instance_method"></span> - <div class="method_details "> - <p class="signature " id="style-instance_method"> - - - (<tt>Integer</tt>) <strong>style</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The style for the chart. see ECMA Part 1 §21.2.2.196</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"> - - -34 -35 -36</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 34</span> - -<span class='def def kw'>def</span> <span class='style identifier id'>style</span> - <span class='@style ivar id'>@style</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="title=-instance_method"></span> - <span id="title-instance_method"></span> - <div class="method_details "> - <p class="signature " id="title-instance_method"> - - - (<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>) <strong>title</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The title object for the chart.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='title identifier id'>title</span> - <span class='@title ivar id'>@title</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="view3D=-instance_method"></span> - <span id="view3D-instance_method"></span> - <div class="method_details "> - <p class="signature " id="view3D-instance_method"> - - - (<tt>Object</tt>) <strong>view3D</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The 3D view properties for the chart</p> - - - </div> -</div> -<div class="tags"> - - -</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/chart.rb', line 10</span> - -<span class='def def kw'>def</span> <span class='view3D identifier id'>view3D</span> - <span class='@view3D ivar id'>@view3D</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="add_series-instance_method"> - - - (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>add_series</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Adds a new series to the chart’s series collection.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -106 -107 -108 -109</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 106</span> - -<span class='def def kw'>def</span> <span class='add_series identifier id'>add_series</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='@series_type ivar id'>@series_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='last identifier id'>last</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="end_at-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>end_at</strong>(x, y) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>This is a short cut method to set the end anchor position If you need finer -granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>x</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The column</p> -</div> - - </li> - - <li> - - <span class='name'>y</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The row</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -154 -155 -156 -157</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 154</span> - -<span class='def def kw'>def</span> <span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="from-instance_method"> - - - (<tt>Object</tt>) <strong>from</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>This will be disconinued in version 2.0.0. please use the start_at method</p> -</div> - </div> - - -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -99 -100 -101</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 99</span> - -<span class='def def kw'>def</span> <span class='from identifier id'>from</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this chart in the workbooks charts collection</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"> - - -61 -62 -63</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 61</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="pn-instance_method"> - - - (<tt>String</tt>) <strong>pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The part name for this chart</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -67 -68 -69</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 67</span> - -<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> - <span class='dstring node'>"#{CHART_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="start_at-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>start_at</strong>(x, y) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need -finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>x</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The column</p> -</div> - - </li> - - <li> - - <span class='name'>y</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The row</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -143 -144 -145 -146</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 143</span> - -<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to-instance_method"> - - - (<tt>Object</tt>) <strong>to</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>This will be disconinued in version 2.0.0. Please use the end_at method</p> -</div> - </div> - - -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -93 -94 -95</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 93</span> - -<span class='def def kw'>def</span> <span class='to identifier id'>to</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>Object</tt>) <strong>to_xml</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Chart Serialization serializes the chart</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -113 -114 -115 -116 -117 -118 -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 113</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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:chartSpace'</span><span class='comma token'>,</span><span class='symbol val'>:'xmlns:c'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace 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:date1904'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</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:style'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='style identifier id'>style</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:chart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='@title ivar id'>@title</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='unless unless_mod kw'>unless</span> <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='@view3D ivar id'>@view3D</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='unless unless_mod kw'>unless</span> <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:plotArea'</span><span class='rparen token'>)</span> <span class='lbrace 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:layout'</span><span class='rparen token'>)</span> - <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='rbrace token'>}</span> - <span class='if if kw'>if</span> <span class='@show_legend ivar id'>@show_legend</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:legend'</span><span class='rparen token'>)</span> <span class='lbrace 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:legendPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"r"</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:layout'</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='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:22 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 diff --git a/doc/Axlsx/Color.html b/doc/Axlsx/Color.html deleted file mode 100644 index 4229122e..00000000 --- a/doc/Axlsx/Color.html +++ /dev/null @@ -1,649 +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::Color - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Color</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::Color - - - -</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::Color</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/color.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The color class represents a color used for borders, fills an fonts</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="#auto-instance_method" title="#auto (instance method)">- (Boolean) <strong>auto</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Determines if the color is system color dependant.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rgb-instance_method" title="#rgb (instance method)">- (String) <strong>rgb</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The color as defined in rgb terms.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#tint-instance_method" title="#tint (instance method)">- (Float) <strong>tint</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The tint value.</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)">- (Color) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Color 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 color.</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::Color (class)">Color</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Color 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">auto</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rgb</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">tint</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -34 -35 -36 -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 34</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='@rgb ivar id'>@rgb</span> <span class='assign token'>=</span> <span class='string val'>"FF000000"</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</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>Determines if the color is system color dependant</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/stylesheet/color.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="rgb=-instance_method"></span> - <span id="rgb-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rgb-instance_method"> - - - (<tt>String</tt>) <strong>rgb</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>rgb colors need to conform to ST_UnsignedIntHex. That basically means put -‘FF’ before you color</p> -</div> - </div> - - -<p>The color as defined in rgb terms.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>rgb colors</p> -</div></h4> - <pre class="example code"><span class='string val'>"FF000000"</span> <span class='is identifier id'>is</span> <span class='black identifier id'>black</span> -<span class='string val'>"FFFFFFFF"</span> <span class='is identifier id'>is</span> <span class='white identifier id'>white</span> -</pre> - - </div> - -<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"> - - -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 19</span> - -<span class='def def kw'>def</span> <span class='rgb identifier id'>rgb</span> - <span class='@rgb ivar id'>@rgb</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="tint=-instance_method"></span> - <span id="tint-instance_method"></span> - <div class="method_details "> - <p class="signature " id="tint-instance_method"> - - - (<tt>Float</tt>) <strong>tint</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>valid values are between -1.0 and 1.0</p> -</div> - </div> - - -<p>The tint value.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -28 -29 -30</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 28</span> - -<span class='def def kw'>def</span> <span class='tint identifier id'>tint</span> - <span class='@tint ivar id'>@tint</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 color</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"> - - -57</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/color.rb', line 57</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='color identifier id'>color</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='rparen 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:28 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 diff --git a/doc/Axlsx/ContentType.html b/doc/Axlsx/ContentType.html deleted file mode 100644 index aad3a085..00000000 --- a/doc/Axlsx/ContentType.html +++ /dev/null @@ -1,329 +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::ContentType - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">ContentType</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::ContentType - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> - - <li class="next">Axlsx::ContentType</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/content_type/content_type.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>ContentTypes used in the package. This is automatcially managed by the -package package.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - - - - - - <h2>Instance Attribute Summary</h2> - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> - <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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)">- (ContentType) <strong>initialize</strong> </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A new instance of ContentType.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Generates the xml document for [Content_Types].xml.</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::ContentType (class)">ContentType</a></span></tt>) <strong>initialize</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A new instance of ContentType</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> - <span class='super super kw'>super</span> <span class='lbrack token'>[</span><span class='Override constant id'>Override</span><span class='comma token'>,</span> <span class='Default constant id'>Default</span><span class='rbrack token'>]</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> -<div id="method_missing_details" class="method_details_list"> - <h2>Dynamic Method Handling</h2> - <p class="notice super"> - This class handles dynamic methods through the <tt>method_missing</tt> method - - in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> - - </p> - -</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> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Generates the xml document for [Content_Types].xml</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The document as a string.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -14 -15 -16 -17 -18 -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/content_type.rb', line 14</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Types constant id'>Types</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='XML_NS_T constant id'>XML_NS_T</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='each identifier id'>each</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='type identifier id'>type</span><span class='bitor op'>|</span> <span class='type identifier id'>type</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='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:24 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 diff --git a/doc/Axlsx/Core.html b/doc/Axlsx/Core.html deleted file mode 100644 index 69314818..00000000 --- a/doc/Axlsx/Core.html +++ /dev/null @@ -1,456 +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::Core - - — 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 (C)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Core</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::Core - - - -</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::Core</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/doc_props/core.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>Packages manage their own core object.</p> -</div> - </div> - - -<p>The core object for the package.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Package#core</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="#creator-instance_method" title="#creator (instance method)">- (String) <strong>creator</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The author of the document.</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)">- (Core) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Core 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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the core object.</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::Core (class)">Core</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Core 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">creator</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </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/doc_props/core.rb', line 12</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='@creator ivar id'>@creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:creator</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>'axlsx'</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="creator=-instance_method"></span> - <span id="creator-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="creator-instance_method"> - - - (<tt>String</tt>) <strong>creator</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The author of the document. By default this is ‘axlsx’</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='creator identifier id'>creator</span> - <span class='@creator ivar id'>@creator</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> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the core object. The created dcterms item is set to the current -time when this method is called.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -18 -19 -20 -21 -22 -23 -24 -25 -26 -27 -28 -29 -30 -31 -32</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/doc_props/core.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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'>'cp:coreProperties'</span><span class='comma token'>,</span> - <span class='symbol val'>:"xmlns:cp"</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS constant id'>CORE_NS</span><span class='comma token'>,</span> - <span class='symbol val'>:'xmlns:dc'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='CORE_NS_DC constant id'>CORE_NS_DC</span><span class='comma token'>,</span> - <span class='symbol val'>:'xmlns:dcmitype'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCMIT constant id'>CORE_NS_DCMIT</span><span class='comma token'>,</span> - <span class='symbol val'>:'xmlns:dcterms'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_DCT constant id'>CORE_NS_DCT</span><span class='comma token'>,</span> - <span class='symbol val'>:'xmlns:xsi'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='CORE_NS_XSI constant id'>CORE_NS_XSI</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dc'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> - <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'dcterms'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='created identifier id'>created</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='dot token'>.</span><span class='strftime identifier id'>strftime</span><span class='lparen token'>(</span><span class='string val'>'%Y-%m-%dT%H:%M:%S'</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:'xsi:type'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"dcterms:W3CDTF"</span> - <span class='xml identifier id'>xml</span><span class='lbrack token'>[</span><span class='string val'>'cp'</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='revision identifier id'>revision</span> <span class='integer val'>0</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:29 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 diff --git a/doc/Axlsx/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html deleted file mode 100644 index b120e469..00000000 --- a/doc/Axlsx/DataTypeValidator.html +++ /dev/null @@ -1,316 +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::DataTypeValidator - - — 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 (D)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">DataTypeValidator</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::DataTypeValidator - - - -</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::DataTypeValidator</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/util/validators.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Validate that the class of the value provided is either an instance or the -class of the allowed types and that any specified additional validation -returns true.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <h2> - Class Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, types, v, other = lambda{|arg| true }) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Perform validation.</p> -</div></span> - -</li> - - - </ul> - - - - - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - - <div class="method_details first"> - <p class="signature first" id="validate-class_method"> - - + (<tt>Boolean</tt>) <strong>validate</strong>(name, types, v, other = lambda{|arg| true }) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Perform validation</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>name</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of what is being validated. This is included in the error message</p> -</div> - - </li> - - <li> - - <span class='name'>types</span> - - - <span class='type'>(<tt>Array</tt>, <tt>Class</tt>)</span> - - - - — - <div class='inline'> -<p>A single class or array of classes that the value is validated against.</p> -</div> - - </li> - - <li> - - <span class='name'>other</span> - - - <span class='type'>(<tt>Block</tt>)</span> - - - <em class="default">(defaults to: <tt>lambda{|arg| true }</tt>)</em> - - - — - <div class='inline'> -<p>Any block that must evaluate to true for the value to be valid</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p>true if validation succeeds.</p> -</div> - - </li> - -</ul> -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArugumentError</tt>)</span> - - - - — - <div class='inline'> -<p>Raised if the class of the value provided is not in the specified array of -types or the block passed returns false</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="../Axlsx.html#validate_boolean-class_method" title="Axlsx.validate_boolean (method)">Axlsx.validate_boolean</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -34 -35 -36 -37 -38 -39 -40 -41 -42 -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 34</span> - -<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='comma token'>,</span> <span class='other identifier id'>other</span><span class='assign token'>=</span> <span class='lambda identifier id'>lambda</span><span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='arg identifier id'>arg</span><span class='bitor op'>|</span> <span class='true true kw'>true</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> - <span class='types identifier id'>types</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='types identifier id'>types</span><span class='rbrack token'>]</span> <span class='unless unless_mod kw'>unless</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span> <span class='Array constant id'>Array</span> - <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='false false kw'>false</span> - <span class='if if kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='class identifier id'>class</span> <span class='eq op'>==</span> <span class='Class constant id'>Class</span> - <span class='types identifier id'>types</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='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='ancestors identifier id'>ancestors</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='else else kw'>else</span> - <span class='types identifier id'>types</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='t identifier id'>t</span><span class='bitor op'>|</span> <span class='valid_type identifier id'>valid_type</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='if if_mod kw'>if</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='t identifier id'>t</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_TYPE constant id'>ERR_TYPE</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='types identifier id'>types</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='other identifier id'>other</span><span class='dot token'>.</span><span class='call identifier id'>call</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='valid_type identifier id'>valid_type</span><span class='rparen 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:27 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 diff --git a/doc/Axlsx/Default.html b/doc/Axlsx/Default.html deleted file mode 100644 index 20e7aab2..00000000 --- a/doc/Axlsx/Default.html +++ /dev/null @@ -1,553 +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::Default - - — 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 (D)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Default</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::Default - - - -</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::Default</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/content_type/default.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>An default content part. These parts are automatically created by for you -based on the content of your package.</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="#ContentType-instance_method" title="#ContentType (instance method)">- (String) <strong>ContentType</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of content.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Extension-instance_method" title="#Extension (instance method)">- (String) <strong>Extension</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The extension of the content type.</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)">- (Default) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Default 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 object to xml.</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::Default (class)">Default</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Default 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">Extension</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">ContentType</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - — - <div class='inline'> -<p>An argument error is raised if both Extension and ContentType are not -specified.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19 -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 17</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='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Extension and ContentType are required"</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'>:Extension</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack 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="ContentType=-instance_method"></span> - <span id="ContentType-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="ContentType-instance_method"> - - - (<tt>String</tt>) <strong>ContentType</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The type of content.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -11 -12 -13</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 11</span> - -<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span> - <span class='@ContentType ivar id'>@ContentType</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Extension=-instance_method"></span> - <span id="Extension-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Extension-instance_method"> - - - (<tt>String</tt>) <strong>Extension</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The extension of the content type.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -7 -8 -9</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 7</span> - -<span class='def def kw'>def</span> <span class='Extension constant id'>Extension</span> - <span class='@Extension ivar id'>@Extension</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 object to xml</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"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/default.rb', line 33</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='Default constant id'>Default</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='rparen 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:28 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 diff --git a/doc/Axlsx/Drawing.html b/doc/Axlsx/Drawing.html deleted file mode 100644 index b6e3ee72..00000000 --- a/doc/Axlsx/Drawing.html +++ /dev/null @@ -1,1230 +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::Drawing - - — 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 (D)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Drawing</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::Drawing - - - -</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::Drawing</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/drawing.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 drawings is to use the Worksheet.add_chart -method.</p> -</div> - </div> - - -<p>A Drawing is a canvas for charts. Each worksheet has a single drawing that -manages anchors. The anchors reference the charts via graphical frames. -This is not a trivial relationship so please do follow the advice in the -note. see README for an example of how to create a chart.</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" title="Axlsx::Chart (class)">Chart</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="#anchors-instance_method" title="#anchors (instance method)">- (SimpleTypedList) <strong>anchors</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A collection of anchors for this drawing only TwoCellAnchors are supported -in this version.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The worksheet that owns the drawing.</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a chart to the drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds an image to the chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#charts-instance_method" title="#charts (instance method)">- (Array) <strong>charts</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>An array of charts that are associated with this drawing’s anchors.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#images-instance_method" title="#images (instance method)">- (Array) <strong>images</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>An array of image objects that are associated with this drawing’s -anchors.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this drawing in the owning workbooks’s drawings collection.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Drawing) <strong>initialize</strong>(worksheet) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Drawing object.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The part name for this drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The drawing’s relationships.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The relational part name for this drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The relation reference id for this drawing.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the drawing.</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::Drawing (class)">Drawing</a></span></tt>) <strong>initialize</strong>(worksheet) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Drawing object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>worksheet</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>The worksheet that owns this drawing</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -52 -53 -54 -55 -56 -57</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 52</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='rparen token'>)</span> - <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.worksheet"</span><span class='comma token'>,</span> <span class='Worksheet constant id'>Worksheet</span><span class='comma token'>,</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@anchors ivar id'>@anchors</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='lbrack token'>[</span><span class='TwoCellAnchor constant id'>TwoCellAnchor</span><span class='comma token'>,</span> <span class='OneCellAnchor constant id'>OneCellAnchor</span><span class='rbrack token'>]</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=""></span> - <span id="anchors-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="anchors-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>anchors</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A collection of anchors for this drawing only TwoCellAnchors are supported -in this version</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> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -48 -49 -50</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 48</span> - -<span class='def def kw'>def</span> <span class='anchors identifier id'>anchors</span> - <span class='@anchors ivar id'>@anchors</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="worksheet-instance_method"></span> - <div class="method_details "> - <p class="signature " id="worksheet-instance_method"> - - - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The worksheet that owns the drawing</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></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/drawing/drawing.rb', line 43</span> - -<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</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="add_chart-instance_method"> - - - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage charts is to use Worksheet.add_chart. Please -refer to that method for documentation.</p> -</div> - </div> - - -<p>Adds a chart to the drawing.</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> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -70 -71 -72 -73</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 70</span> - -<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</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='TwoCellAnchor constant id'>TwoCellAnchor</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="add_image-instance_method"> - - - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage images is to use Worksheet.add_image. Please -refer to that method for documentation.</p> -</div> - </div> - - -<p>Adds an image to the chart</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -62 -63 -64 -65</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 62</span> - -<span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</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='OneCellAnchor constant id'>OneCellAnchor</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='object identifier id'>object</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="charts-instance_method"> - - - (<tt>Array</tt>) <strong>charts</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>An array of charts that are associated with this drawing’s anchors</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -77 -78 -79 -80</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 77</span> - -<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> - <span class='charts identifier id'>charts</span> <span class='assign token'>=</span> <span class='@anchors ivar id'>@anchors</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='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='GraphicFrame constant id'>GraphicFrame</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="images-instance_method"> - - - (<tt>Array</tt>) <strong>images</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>An array of image objects that are associated with this drawing’s anchors</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -84 -85 -86 -87</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 84</span> - -<span class='def def kw'>def</span> <span class='images identifier id'>images</span> - <span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='@anchors ivar id'>@anchors</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='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Pic constant id'>Pic</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='images identifier id'>images</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span> <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this drawing in the owning workbooks’s drawings collection.</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"> - - -91 -92 -93</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 91</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="pn-instance_method"> - - - (<tt>String</tt>) <strong>pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The part name for this drawing</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -103 -104 -105</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 103</span> - -<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> - <span class='dstring node'>"#{DRAWING_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="relationships-instance_method"> - - - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The drawing’s relationships.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -115 -116 -117 -118 -119 -120 -121 -122 -123 -124</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 115</span> - -<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> - <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='charts identifier id'>charts</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='chart identifier id'>chart</span><span class='bitor op'>|</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='CHART_R constant id'>CHART_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{chart.pn}"</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='images identifier id'>images</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='image identifier id'>image</span><span class='bitor op'>|</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='IMAGE_R constant id'>IMAGE_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{image.pn}"</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='r identifier id'>r</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="rels_pn-instance_method"> - - - (<tt>String</tt>) <strong>rels_pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The relational part name for this drawing</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -109 -110 -111</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 109</span> - -<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> - <span class='dstring node'>"#{DRAWING_RELS_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="rId-instance_method"> - - - (<tt>String</tt>) <strong>rId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The relation reference id for this drawing</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -97 -98 -99</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 97</span> - -<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> - <span class='dstring node'>"rId#{index+1}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the drawing</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -128 -129 -130 -131 -132 -133 -134 -135</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 128</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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'>'xdr:wsDr'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:xdr'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_XDR constant id'>XML_NS_XDR</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='anchors identifier id'>anchors</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='anchor identifier id'>anchor</span><span class='bitor op'>|</span> <span class='anchor identifier id'>anchor</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='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:23 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 diff --git a/doc/Axlsx/Fill.html b/doc/Axlsx/Fill.html deleted file mode 100644 index d2ae770c..00000000 --- a/doc/Axlsx/Fill.html +++ /dev/null @@ -1,450 +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::Fill - - — 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 (F)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Fill</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::Fill - - - -</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::Fill</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/fill.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 styles in your workbook is to use -Styles#add_style.</p> -</div> - </div> - - -<p>The Fill is a formatting object that manages the background color, and -pattern for cells.</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> - - <li><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></li> - - <li><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</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="#fill_type-instance_method" title="#fill_type (instance method)">- (PatternFill, GradientFill) <strong>fill_type</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of fill.</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)">- (Fill) <strong>initialize</strong>(fill_type) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Fill 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 fill.</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::Fill (class)">Fill</a></span></tt>) <strong>initialize</strong>(fill_type) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Fill object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>fill_type</span> - - - <span class='type'>(<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>)</span> - - - - </li> - -</ul> - -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - — - <div class='inline'> -<p>if the fill_type parameter is not a PatternFill or a GradientFill instance</p> -</div> - - </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/stylesheet/fill.rb', line 16</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='fill_type identifier id'>fill_type</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='fill_type identifier id'>fill_type</span> <span class='assign token'>=</span> <span class='fill_type identifier id'>fill_type</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="fill_type=-instance_method"></span> - <span id="fill_type-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="fill_type-instance_method"> - - - (<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></tt>) <strong>fill_type</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The type of fill</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="PatternFill.html" title="Axlsx::PatternFill (class)">PatternFill</a></span></tt>, <tt><span class='object_link'><a href="GradientFill.html" title="Axlsx::GradientFill (class)">GradientFill</a></span></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/stylesheet/fill.rb', line 11</span> - -<span class='def def kw'>def</span> <span class='fill_type identifier id'>fill_type</span> - <span class='@fill_type ivar id'>@fill_type</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 fill</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"> - - -23 -24 -25</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/fill.rb', line 23</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='fill identifier id'>fill</span> <span class='lbrace token'>{</span> <span class='@fill_type ivar id'>@fill_type</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> -</pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Wed Nov 30 08:46:33 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 diff --git a/doc/Axlsx/Font.html b/doc/Axlsx/Font.html deleted file mode 100644 index efc6b488..00000000 --- a/doc/Axlsx/Font.html +++ /dev/null @@ -1,1520 +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::Font - - — 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 (F)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Font</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::Font - - - -</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::Font</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/font.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 fonts, and other styles is Styles#add_style</p> -</div> - </div> - - -<p>The Font class details a font instance for use in styling cells.</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="#b-instance_method" title="#b (instance method)">- (Boolean) <strong>b</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered in <strong>bold</strong>.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#charset-instance_method" title="#charset (instance method)">- (Integer) <strong>charset</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The charset of the font.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#color-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The color of the font.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#condense-instance_method" title="#condense (instance method)">- (Boolean) <strong>condense</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be condensed.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#extend-instance_method" title="#extend (instance method)">- (Boolean) <strong>extend</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The font’s extend property.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#family-instance_method" title="#family (instance method)">- (Integer) <strong>family</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The font’s family.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#i-instance_method" title="#i (instance method)">- (Boolean) <strong>i</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered italicized.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of the font.</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>Indicates if the font should be rendered with an outline.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#shadow-instance_method" title="#shadow (instance method)">- (Boolean) <strong>shadow</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered with a shadow.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#strike-instance_method" title="#strike (instance method)">- (Boolean) <strong>strike</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Indicates if the font should be rendered with a strikthrough.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#sz-instance_method" title="#sz (instance method)">- (Integer) <strong>sz</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The size of the font.</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)">- (Font) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Font.</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 fill.</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::Font (class)">Font</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Font</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">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">charset</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">family</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">family</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">b</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">i</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">strike</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> - - <li> - <span class="name">shadow</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">condense</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">extend</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">color</span> - <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">sz</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -98 -99 -100 -101 -102</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 98</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</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="b=-instance_method"></span> - <span id="b-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="b-instance_method"> - - - (<tt>Boolean</tt>) <strong>b</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the font should be rendered in <strong>bold</strong></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"> - - -50 -51 -52</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 50</span> - -<span class='def def kw'>def</span> <span class='b identifier id'>b</span> - <span class='@b ivar id'>@b</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="charset=-instance_method"></span> - <span id="charset-instance_method"></span> - <div class="method_details "> - <p class="signature " id="charset-instance_method"> - - - (<tt>Integer</tt>) <strong>charset</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The following values are defined in the OOXML specification and are OS -dependant values</p> - -<pre class="code"><span class='integer val'>0</span> <span class='ANSI_CHARSET constant id'>ANSI_CHARSET</span> -<span class='integer val'>1</span> <span class='DEFAULT_CHARSET constant id'>DEFAULT_CHARSET</span> -<span class='integer val'>2</span> <span class='SYMBOL_CHARSET constant id'>SYMBOL_CHARSET</span> -<span class='integer val'>77</span> <span class='MAC_CHARSET constant id'>MAC_CHARSET</span> -<span class='integer val'>128</span> <span class='SHIFTJIS_CHARSET constant id'>SHIFTJIS_CHARSET</span> -<span class='integer val'>129</span> <span class='HANGUL_CHARSET constant id'>HANGUL_CHARSET</span> -<span class='integer val'>130</span> <span class='JOHAB_CHARSET constant id'>JOHAB_CHARSET</span> -<span class='integer val'>134</span> <span class='GB2312_CHARSET constant id'>GB2312_CHARSET</span> -<span class='integer val'>136</span> <span class='CHINESEBIG5_CHARSET constant id'>CHINESEBIG5_CHARSET</span> -<span class='integer val'>161</span> <span class='GREEK_CHARSET constant id'>GREEK_CHARSET</span> -<span class='integer val'>162</span> <span class='TURKISH_CHARSET constant id'>TURKISH_CHARSET</span> -<span class='integer val'>163</span> <span class='VIETNAMESE_CHARSET constant id'>VIETNAMESE_CHARSET</span> -<span class='integer val'>177</span> <span class='HEBREW_CHARSET constant id'>HEBREW_CHARSET</span> -<span class='integer val'>178</span> <span class='ARABIC_CHARSET constant id'>ARABIC_CHARSET</span> -<span class='integer val'>186</span> <span class='BALTIC_CHARSET constant id'>BALTIC_CHARSET</span> -<span class='integer val'>204</span> <span class='RUSSIAN_CHARSET constant id'>RUSSIAN_CHARSET</span> -<span class='integer val'>222</span> <span class='THAI_CHARSET constant id'>THAI_CHARSET</span> -<span class='integer val'>238</span> <span class='EASTEUROPE_CHARSET constant id'>EASTEUROPE_CHARSET</span> -<span class='integer val'>255</span> <span class='OEM_CHARSET constant id'>OEM_CHARSET</span> -</pre> -</div> - </div> - - -<p>The charset of the font</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"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='charset identifier id'>charset</span> - <span class='@charset ivar id'>@charset</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="color=-instance_method"></span> - <span id="color-instance_method"></span> - <div class="method_details "> - <p class="signature " id="color-instance_method"> - - - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The color of the font</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -78 -79 -80</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 78</span> - -<span class='def def kw'>def</span> <span class='color identifier id'>color</span> - <span class='@color ivar id'>@color</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="condense=-instance_method"></span> - <span id="condense-instance_method"></span> - <div class="method_details "> - <p class="signature " id="condense-instance_method"> - - - (<tt>Boolean</tt>) <strong>condense</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the font should be condensed</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"> - - -70 -71 -72</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 70</span> - -<span class='def def kw'>def</span> <span class='condense identifier id'>condense</span> - <span class='@condense ivar id'>@condense</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="extend=-instance_method"></span> - <span id="extend-instance_method"></span> - <div class="method_details "> - <p class="signature " id="extend-instance_method"> - - - (<tt>Boolean</tt>) <strong>extend</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The font’s extend property</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"> - - -74 -75 -76</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 74</span> - -<span class='def def kw'>def</span> <span class='extend identifier id'>extend</span> - <span class='@extend ivar id'>@extend</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="family=-instance_method"></span> - <span id="family-instance_method"></span> - <div class="method_details "> - <p class="signature " id="family-instance_method"> - - - (<tt>Integer</tt>) <strong>family</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The following are defined OOXML specification</p> - -<pre class="code"><span class='integer val'>0</span> <span class='Not constant id'>Not</span> <span class='applicable identifier id'>applicable</span><span class='dot token'>.</span> -<span class='integer val'>1</span> <span class='Roman constant id'>Roman</span> -<span class='integer val'>2</span> <span class='Swiss constant id'>Swiss</span> -<span class='integer val'>3</span> <span class='Modern constant id'>Modern</span> -<span class='integer val'>4</span> <span class='Script constant id'>Script</span> -<span class='integer val'>5</span> <span class='Decorative constant id'>Decorative</span> -<span class='float val'>6</span><span class='dot2 op'>..</span><span class='integer val'>14</span> <span class='Reserved constant id'>Reserved</span> <span class='for for kw'>for</span> <span class='future identifier id'>future</span> <span class='use identifier id'>use</span> -</pre> -</div> - </div> - - -<p>The font’s family</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"> - - -46 -47 -48</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 46</span> - -<span class='def def kw'>def</span> <span class='family identifier id'>family</span> - <span class='@family ivar id'>@family</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="i=-instance_method"></span> - <span id="i-instance_method"></span> - <div class="method_details "> - <p class="signature " id="i-instance_method"> - - - (<tt>Boolean</tt>) <strong>i</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the font should be rendered italicized</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"> - - -54 -55 -56</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 54</span> - -<span class='def def kw'>def</span> <span class='i identifier id'>i</span> - <span class='@i ivar id'>@i</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details "> - <p class="signature " id="name-instance_method"> - - - (<tt>String</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of the font</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</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>Indicates if the font should be rendered with an outline</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"> - - -62 -63 -64</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 62</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="shadow=-instance_method"></span> - <span id="shadow-instance_method"></span> - <div class="method_details "> - <p class="signature " id="shadow-instance_method"> - - - (<tt>Boolean</tt>) <strong>shadow</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the font should be rendered with a shadow</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"> - - -66 -67 -68</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 66</span> - -<span class='def def kw'>def</span> <span class='shadow identifier id'>shadow</span> - <span class='@shadow ivar id'>@shadow</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="strike=-instance_method"></span> - <span id="strike-instance_method"></span> - <div class="method_details "> - <p class="signature " id="strike-instance_method"> - - - (<tt>Boolean</tt>) <strong>strike</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Indicates if the font should be rendered with a strikthrough</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"> - - -58 -59 -60</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 58</span> - -<span class='def def kw'>def</span> <span class='strike identifier id'>strike</span> - <span class='@strike ivar id'>@strike</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="sz=-instance_method"></span> - <span id="sz-instance_method"></span> - <div class="method_details "> - <p class="signature " id="sz-instance_method"> - - - (<tt>Integer</tt>) <strong>sz</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The size of the font.</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"> - - -82 -83 -84</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.rb', line 82</span> - -<span class='def def kw'>def</span> <span class='sz identifier id'>sz</span> - <span class='@sz ivar id'>@sz</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 fill</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 -137</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/font.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='font identifier id'>font</span> <span class='lbrace 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='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='comma token'>,</span> <span class='v identifier id'>v</span><span class='bitor op'>|</span> - <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Color constant id'>Color</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='v identifier id'>v</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='colon op'>:</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='k identifier id'>k</span><span class='comma token'>,</span> <span class='lbrace token'>{</span><span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='v identifier id'>v</span><span class='rbrace token'>}</span><span class='rparen 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 Wed Nov 30 08:46:27 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 diff --git a/doc/Axlsx/GradientFill.html b/doc/Axlsx/GradientFill.html deleted file mode 100644 index 30fa6143..00000000 --- a/doc/Axlsx/GradientFill.html +++ /dev/null @@ -1,1004 +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::GradientFill - - — 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 (G)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">GradientFill</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::GradientFill - - - -</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::GradientFill</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/gradient_fill.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>A GradientFill defines the color and positioning for gradiant cell fill.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Office XML Part 1 §18.8.24</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="#bottom-instance_method" title="#bottom (instance method)">- (Float) <strong>bottom</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Percentage format bottom.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#degree-instance_method" title="#degree (instance method)">- (Float) <strong>degree</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Angle of the linear gradient.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#left-instance_method" title="#left (instance method)">- (Float) <strong>left</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Percentage format left.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#right-instance_method" title="#right (instance method)">- (Float) <strong>right</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Percentage format right.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#stop-instance_method" title="#stop (instance method)">- (SimpleTypedList) <strong>stop</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Collection of stop objects.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#top-instance_method" title="#top (instance method)">- (Float) <strong>top</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Percentage format top.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of gradient.</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)">- (GradientFill) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new GradientFill 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 gradientFill.</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::GradientFill (class)">GradientFill</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new GradientFill 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">type</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">degree</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">left</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">right</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">top</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">bottom</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -46 -47 -48 -49 -50 -51 -52</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 46</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='lbrack token'>[</span><span class='symbol val'>:type</span><span class='rbrack token'>]</span> <span class='opasgn op'>||=</span> <span class='symbol val'>:linear</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> - <span class='end end kw'>end</span> - <span class='@stop ivar id'>@stop</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='GradientStop constant id'>GradientStop</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="bottom=-instance_method"></span> - <span id="bottom-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="bottom-instance_method"> - - - (<tt>Float</tt>) <strong>bottom</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Percentage format bottom</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='bottom identifier id'>bottom</span> - <span class='@bottom ivar id'>@bottom</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="degree=-instance_method"></span> - <span id="degree-instance_method"></span> - <div class="method_details "> - <p class="signature " id="degree-instance_method"> - - - (<tt>Float</tt>) <strong>degree</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Angle of the linear gradient</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 17</span> - -<span class='def def kw'>def</span> <span class='degree identifier id'>degree</span> - <span class='@degree ivar id'>@degree</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="left=-instance_method"></span> - <span id="left-instance_method"></span> - <div class="method_details "> - <p class="signature " id="left-instance_method"> - - - (<tt>Float</tt>) <strong>left</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Percentage format left</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='left identifier id'>left</span> - <span class='@left ivar id'>@left</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="right=-instance_method"></span> - <span id="right-instance_method"></span> - <div class="method_details "> - <p class="signature " id="right-instance_method"> - - - (<tt>Float</tt>) <strong>right</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Percentage format right</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='right identifier id'>right</span> - <span class='@right ivar id'>@right</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="stop-instance_method"></span> - <div class="method_details "> - <p class="signature " id="stop-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>stop</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Collection of stop objects</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> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='stop identifier id'>stop</span> - <span class='@stop ivar id'>@stop</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="top=-instance_method"></span> - <span id="top-instance_method"></span> - <div class="method_details "> - <p class="signature " id="top-instance_method"> - - - (<tt>Float</tt>) <strong>top</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Percentage format top</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='top identifier id'>top</span> - <span class='@top ivar id'>@top</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="type=-instance_method"></span> - <span id="type-instance_method"></span> - <div class="method_details "> - <p class="signature " id="type-instance_method"> - - - (<tt>Symbol</tt>) <strong>type</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>valid options are</p> - -<pre class="code"><span class='symbol val'>:linear</span> -<span class='symbol val'>:path</span> -</pre> -</div> - </div> - - -<p>The type of gradient.</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"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='type identifier id'>type</span> - <span class='@type ivar id'>@type</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 gradientFill</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"> - - -70 -71 -72 -73 -74</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_fill.rb', line 70</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='gradientFill identifier id'>gradientFill</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='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:stop</span> <span class='rbrace token'>}</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='@stop ivar id'>@stop</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='s identifier id'>s</span><span class='bitor op'>|</span> <span class='s identifier id'>s</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='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:27 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 diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html deleted file mode 100644 index c767a85e..00000000 --- a/doc/Axlsx/GradientStop.html +++ /dev/null @@ -1,516 +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::GradientStop - - — 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 (G)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">GradientStop</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::GradientStop - - - -</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::GradientStop</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/gradient_stop.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The GradientStop object represents a color point in a gradient.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Office XML Part 1 §18.8.24</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="#color-instance_method" title="#color (instance method)">- (Color) <strong>color</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The color for this gradient stop.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#position-instance_method" title="#position (instance method)">- (Float) <strong>position</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The position of the color.</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)">- (GradientStop) <strong>initialize</strong>(color, position) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new GradientStop 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 gradientStop.</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::GradientStop (class)">GradientStop</a></span></tt>) <strong>initialize</strong>(color, position) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new GradientStop object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>color</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - - - - </li> - - <li> - - <span class='name'>position</span> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='color identifier id'>color</span><span class='comma token'>,</span> <span class='position identifier id'>position</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</span> <span class='color identifier id'>color</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span> <span class='assign token'>=</span> <span class='position identifier id'>position</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="color=-instance_method"></span> - <span id="color-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="color-instance_method"> - - - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>color</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The color for this gradient stop</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></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/gradient_stop.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='color identifier id'>color</span> - <span class='@color ivar id'>@color</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="position=-instance_method"></span> - <span id="position-instance_method"></span> - <div class="method_details "> - <p class="signature " id="position-instance_method"> - - - (<tt>Float</tt>) <strong>position</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The position of the color</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='position identifier id'>position</span> - <span class='@position ivar id'>@position</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 gradientStop</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"> - - -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/gradient_stop.rb', line 31</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='stop identifier id'>stop</span><span class='lparen token'>(</span><span class='symbol val'>:position</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='position identifier id'>position</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span><span class='self self kw'>self</span><span class='dot token'>.</span><span class='color identifier id'>color</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> -</pre> - </td> - </tr> -</table> -</div> - - </div> - -</div> - - <div id="footer"> - Generated on Wed Nov 30 08:46:36 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 diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html deleted file mode 100644 index 60a775d8..00000000 --- a/doc/Axlsx/GraphicFrame.html +++ /dev/null @@ -1,629 +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::GraphicFrame - - — 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 (G)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">GraphicFrame</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::GraphicFrame - - - -</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::GraphicFrame</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/graphic_frame.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 charts is Worksheet#add_chart</p> -</div> - </div> - - -<p>A graphic frame defines a container for a chart object</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> - - </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="#anchor-instance_method" title="#anchor (instance method)">- (TwoCellAnchor) <strong>anchor</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A anchor that holds this frame.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#chart-instance_method" title="#chart (instance method)">- (Chart) <strong>chart</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A reference to the chart object associated with this frame.</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)">- (GraphicFrame) <strong>initialize</strong>(anchor, chart_type, options) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new GraphicFrame object.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The relationship id for this graphic.</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 graphic frame.</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::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>initialize</strong>(anchor, chart_type, options) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new GraphicFrame object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>anchor</span> - - - <span class='type'>(<tt><span class='object_link'><a href="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>)</span> - - - - </li> - - <li> - - <span class='name'>chart_type</span> - - - <span class='type'>(<tt>Class</tt>)</span> - - - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='anchor identifier id'>anchor</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.chart_type"</span><span class='comma token'>,</span> <span class='Chart constant id'>Chart</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span> - <span class='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> - <span class='@chart ivar id'>@chart</span> <span class='assign token'>=</span> <span class='chart_type identifier id'>chart_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</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=""></span> - <span id="anchor-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="anchor-instance_method"> - - - (<tt><span class='object_link'><a href="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>anchor</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A anchor that holds this frame</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> - <span class='@anchor ivar id'>@anchor</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="chart-instance_method"></span> - <div class="method_details "> - <p class="signature " id="chart-instance_method"> - - - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>chart</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A reference to the chart object associated with this frame</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> - - - - </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/drawing/graphic_frame.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> - <span class='@chart ivar id'>@chart</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="rId-instance_method"> - - - (<tt>String</tt>) <strong>rId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The relationship id for this graphic</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -26 -27 -28</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 26</span> - -<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> - <span class='dstring node'>"rId#{@anchor.index+1}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the graphic frame</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"> - - -33 -34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 33</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'>'xdr:graphicFrame'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'xdr:nvGraphicFramePr'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='integer val'>2</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='title identifier id'>title</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'>'xdr:cNvGraphicFramePr'</span><span class='rparen token'>)</span> - <span class='rbrace 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'>'xdr:xfrm'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</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'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> - <span class='rbrace 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'>'a:graphic'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:graphicData'</span><span class='comma token'>,</span> <span class='symbol val'>:uri=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</span><span class='rparen token'>)</span> <span class='lbrace 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:chart'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:c'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:id'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace 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 Wed Nov 30 08:46:28 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 diff --git a/doc/Axlsx/Line3DChart.html b/doc/Axlsx/Line3DChart.html deleted file mode 100644 index a0995552..00000000 --- a/doc/Axlsx/Line3DChart.html +++ /dev/null @@ -1,985 +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::Line3DChart - - — 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> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Line3DChart</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::Line3DChart - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li class="next">Axlsx::Line3DChart</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_3D_chart.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Line3DChart is a three dimentional line chart (who would have guessed?) -that you can add to your worksheet.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>Creating a chart</p> -</div></h4> - <pre class="example code"><span class='comment val'># This example creates a line in a single sheet.</span> -<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> -<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> - -<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> -<span class='ws identifier id'>ws</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='add_worksheet identifier id'>add_worksheet</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"This is a chart with no data in the sheet"</span><span class='rbrack token'>]</span> - -<span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Line3DChart constant id'>Line3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='comma token'>,</span><span class='integer val'>6</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title=</span><span class='gt op'>></span><span class='string val'>"Most Popular Pets"</span><span class='rparen token'>)</span> -<span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='add_series identifier id'>add_series</span> <span class='symbol val'>:data</span> <span class='assign token'>=</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'>9</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:labels</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Slimy Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Fuzzy Bunnies"</span><span class='comma token'>,</span> <span class='string val'>"Rottweiler"</span><span class='rbrack token'>]</span> -</pre> - - </div> - - - <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="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</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> - - <li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> - - <li><span class='object_link'><a href="Package.html#serialize-instance_method" title="Axlsx::Package#serialize (method)">Package#serialize</a></span></li> - - </ul> - -</div> - <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="GAP_AMOUNT_PERCENT-constant" class="">GAP_AMOUNT_PERCENT = - <div class="docstring"> - <div class="discussion"> - -<p>validation regex for gap amount percent</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='regexp val'>/0*(([0-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</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="#catAxis-instance_method" title="#catAxis (instance method)">- (CatAxis) <strong>catAxis</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#gapDepth-instance_method" title="#gapDepth (instance method)">- (String) <strong>gapDepth</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#grouping-instance_method" title="#grouping (instance method)">- (Symbol) <strong>grouping</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>grouping for a column, line, or area chart.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#serAxis-instance_method" title="#serAxis (instance method)">- (Axis) <strong>serAxis</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#valAxis-instance_method" title="#valAxis (instance method)">- (ValAxis) <strong>valAxis</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the category axis.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">style</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</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)">- (Line3DChart) <strong>initialize</strong>(frame, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new line chart 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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the bar chart.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - - - <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span>, <span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">#end_at</a></span>, <span class='object_link'><a href="Chart.html#from-instance_method" title="Axlsx::Chart#from (method)">#from</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">#index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">#pn</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">#start_at</a></span>, <span class='object_link'><a href="Chart.html#to-instance_method" title="Axlsx::Chart#to (method)">#to</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::Line3DChart (class)">Line3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new line chart object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>frame</span> - - - <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>The workbook that owns this chart.</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">title</span> - <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">show_legend</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">grouping</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">gapDepth</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotX</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">hPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotY</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">depthPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rAngAx</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">perspective</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li><span class='object_link'><a href="View3D.html" title="Axlsx::View3D (class)">View3D</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 61</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</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='@gapDepth ivar id'>@gapDepth</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> - <span class='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:standard</span> - <span class='@catAxId ivar id'>@catAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> - <span class='@valAxId ivar id'>@valAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> - <span class='@serAxId ivar id'>@serAxId</span> <span class='assign token'>=</span> <span class='rand identifier id'>rand</span><span class='lparen token'>(</span><span class='integer val'>8</span> <span class='pow op'>**</span> <span class='integer val'>8</span><span class='rparen token'>)</span> - <span class='@catAxis ivar id'>@catAxis</span> <span class='assign token'>=</span> <span class='CatAxis constant id'>CatAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@catAxId ivar id'>@catAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> - <span class='@valAxis ivar id'>@valAxis</span> <span class='assign token'>=</span> <span class='ValAxis constant id'>ValAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@valAxId ivar id'>@valAxId</span><span class='comma token'>,</span> <span class='@catAxId ivar id'>@catAxId</span><span class='rparen token'>)</span> - <span class='@serAxis ivar id'>@serAxis</span> <span class='assign token'>=</span> <span class='SerAxis constant id'>SerAxis</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='@serAxId ivar id'>@serAxId</span><span class='comma token'>,</span> <span class='@valAxId ivar id'>@valAxId</span><span class='rparen token'>)</span> - <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='LineSeries constant id'>LineSeries</span> - <span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:perspective=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='rbrace token'>}</span><span class='dot token'>.</span><span class='merge identifier id'>merge</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</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=""></span> - <span id="catAxis-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="catAxis-instance_method"> - - - (<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>) <strong>catAxis</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the category axis</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="CatAxis.html" title="Axlsx::CatAxis (class)">CatAxis</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='catAxis identifier id'>catAxis</span> - <span class='@catAxis ivar id'>@catAxis</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="gapDepth=-instance_method"></span> - <span id="gapDepth-instance_method"></span> - <div class="method_details "> - <p class="signature " id="gapDepth-instance_method"> - - - (<tt>String</tt>) <strong>gapDepth</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>space between bar or column clusters, as a percentage of the bar or column -width.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='gapDepth identifier id'>gapDepth</span> - <span class='@gapDepth ivar id'>@gapDepth</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="grouping=-instance_method"></span> - <span id="grouping-instance_method"></span> - <div class="method_details "> - <p class="signature " id="grouping-instance_method"> - - - (<tt>Symbol</tt>) <strong>grouping</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>grouping for a column, line, or area chart. must be one of -[:percentStacked, :clustered, :standard, :stacked]</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"> - - -42 -43 -44</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 42</span> - -<span class='def def kw'>def</span> <span class='grouping identifier id'>grouping</span> - <span class='@grouping ivar id'>@grouping</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="serAxis-instance_method"></span> - <div class="method_details "> - <p class="signature " id="serAxis-instance_method"> - - - (<tt><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></tt>) <strong>serAxis</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the category axis</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Axis.html" title="Axlsx::Axis (class)">Axis</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='serAxis identifier id'>serAxis</span> - <span class='@serAxis ivar id'>@serAxis</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="valAxis-instance_method"></span> - <div class="method_details "> - <p class="signature " id="valAxis-instance_method"> - - - (<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>) <strong>valAxis</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the category axis</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="ValAxis.html" title="Axlsx::ValAxis (class)">ValAxis</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='valAxis identifier id'>valAxis</span> - <span class='@valAxis ivar id'>@valAxis</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> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the bar chart</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -89 -90 -91 -92 -93 -94 -95 -96 -97 -98 -99 -100 -101 -102 -103 -104</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 89</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> - <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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:line3DChart'</span><span class='rparen token'>)</span> <span class='lbrace 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:grouping'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='grouping identifier id'>grouping</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:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> - <span class='@series ivar id'>@series</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='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</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='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:gapDepth'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@gapDepth ivar id'>@gapDepth</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@gapDepth ivar id'>@gapDepth</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@catAxId ivar id'>@catAxId</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@valAxId ivar id'>@valAxId</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:axId'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@serAxId ivar id'>@serAxId</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='@catAxis ivar id'>@catAxis</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='@valAxis ivar id'>@valAxis</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='@serAxis ivar id'>@serAxis</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='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:35 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 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 - - — 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> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <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> - - - — - <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> - - - - — - <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 diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html deleted file mode 100644 index 9ae65689..00000000 --- a/doc/Axlsx/Marker.html +++ /dev/null @@ -1,837 +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::Marker - - — 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 (M)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Marker</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::Marker - - - -</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::Marker</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/marker.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 markers is Worksheet#add_chart Markers are -created for a two cell anchor based on the :start and :end options.</p> -</div> - </div> - - -<p>The Marker class defines a point in the worksheet that drawing anchors -attach to.</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> - - </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="#col-instance_method" title="#col (instance method)">- (Integer) <strong>col</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The column this marker anchors to.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#colOff-instance_method" title="#colOff (instance method)">- (Integer) <strong>colOff</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The offset distance from this marker’s column.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#row-instance_method" title="#row (instance method)">- (Integer) <strong>row</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The row this marker anchors to.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rowOff-instance_method" title="#rowOff (instance method)">- (Integer) <strong>rowOff</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The offset distance from this marker’s row.</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="#coord-instance_method" title="#coord (instance method)">- (Object) <strong>coord</strong>(col, row) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>shortcut to set the column, row position for this marker.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Marker) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Marker 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 marker.</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::Marker (class)">Marker</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Marker 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">col</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">colOff</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">row</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rowOff</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -28 -29 -30 -31 -32 -33</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 28</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='@col ivar id'>@col</span><span class='comma token'>,</span> <span class='@colOff ivar id'>@colOff</span><span class='comma token'>,</span> <span class='@row ivar id'>@row</span><span class='comma token'>,</span> <span class='@rowOff ivar id'>@rowOff</span> <span class='assign token'>=</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</span><span class='comma token'>,</span> <span class='integer val'>0</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</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="col=-instance_method"></span> - <span id="col-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="col-instance_method"> - - - (<tt>Integer</tt>) <strong>col</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The column this marker anchors to</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"> - - -9 -10 -11</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='col identifier id'>col</span> - <span class='@col ivar id'>@col</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="colOff=-instance_method"></span> - <span id="colOff-instance_method"></span> - <div class="method_details "> - <p class="signature " id="colOff-instance_method"> - - - (<tt>Integer</tt>) <strong>colOff</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The offset distance from this marker’s column</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"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='colOff identifier id'>colOff</span> - <span class='@colOff ivar id'>@colOff</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="row=-instance_method"></span> - <span id="row-instance_method"></span> - <div class="method_details "> - <p class="signature " id="row-instance_method"> - - - (<tt>Integer</tt>) <strong>row</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The row this marker anchors to</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"> - - -17 -18 -19</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 17</span> - -<span class='def def kw'>def</span> <span class='row identifier id'>row</span> - <span class='@row ivar id'>@row</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="rowOff=-instance_method"></span> - <span id="rowOff-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rowOff-instance_method"> - - - (<tt>Integer</tt>) <strong>rowOff</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The offset distance from this marker’s row</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"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='rowOff identifier id'>rowOff</span> - <span class='@rowOff ivar id'>@rowOff</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="coord-instance_method"> - - - (<tt>Object</tt>) <strong>coord</strong>(col, row) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>shortcut to set the column, row position for this marker</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>col</span> - - - <span class='type'></span> - - - - — - <div class='inline'> -<p>the column for the marker</p> -</div> - - </li> - - <li> - - <span class='name'>row</span> - - - <span class='type'></span> - - - - — - <div class='inline'> -<p>the row of the marker</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -47 -48 -49 -50</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 47</span> - -<span class='def def kw'>def</span> <span class='coord identifier id'>coord</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='row identifier id'>row</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='row identifier id'>row</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the marker</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"> - - -54 -55 -56 -57 -58</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/marker.rb', line 54</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='lbrack token'>[</span><span class='symbol val'>:col</span><span class='comma token'>,</span> <span class='symbol val'>:colOff</span><span class='comma token'>,</span> <span class='symbol val'>:row</span><span class='comma token'>,</span> <span class='symbol val'>:rowOff</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='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"xdr:#{k.to_s}"</span><span class='comma token'>,</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='k identifier id'>k</span><span class='rparen token'>)</span><span class='rparen token'>)</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:21 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 diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html deleted file mode 100644 index 968f5c9b..00000000 --- a/doc/Axlsx/NumFmt.html +++ /dev/null @@ -1,548 +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::NumFmt - - — 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 (N)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">NumFmt</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::NumFmt - - - -</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::NumFmt</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/num_fmt.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 styles is Styles#add_style</p> -</div> - </div> - - -<p>A NumFmt object defines an identifier and formatting code for data in -cells.</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="#formatCode-instance_method" title="#formatCode (instance method)">- (String) <strong>formatCode</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The formatting to use for this number format.</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>An unsinged integer referencing a standard or custom number format.</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)">- (NumFmt) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A new instance of NumFmt.</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>Creates a numFmt element applying the instance values of this object as -attributes.</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::NumFmt (class)">NumFmt</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A new instance of NumFmt</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -45 -46 -47 -48 -49 -50 -51</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 45</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='@numFmtId ivar id'>@numFmtId</span> <span class='assign token'>=</span> <span class='integer val'>0</span> - <span class='@formatCode ivar id'>@formatCode</span> <span class='assign token'>=</span> <span class='string val'>""</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</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="formatCode=-instance_method"></span> - <span id="formatCode-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="formatCode-instance_method"> - - - (<tt>String</tt>) <strong>formatCode</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The formatting to use for this number format.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The formatting to use for this number format.</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><a href="http://support.microsoft.com/kb/264372" target="_parent" title="http://support.microsoft.com/kb/264372">http://support.microsoft.com/kb/264372</a></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -44 -45 -46</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 44</span> - -<span class='def def kw'>def</span> <span class='formatCode identifier id'>formatCode</span> - <span class='@formatCode ivar id'>@formatCode</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"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>These are the known formats I can dig up. The constant NUM_FMT_PERCENT is -9, and uses the default % formatting. Axlsx also defines a few formats for -date and time that are commonly used in asia as NUM_FMT_YYYYMMDD and -NUM_FRM_YYYYMMDDHHMMSS.</p> - -<pre class="code"><span class='integer val'>1</span> <span class='integer val'>0</span> -<span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> -<span class='integer val'>3</span> <span class='comment val'>#,##0</span> -<span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> -<span class='integer val'>5</span> $<span class='comment val'>#,##0_);($#,##0)</span> -<span class='integer val'>6</span> $<span class='comment val'>#,##0_);[Red]($#,##0)</span> -<span class='integer val'>7</span> $<span class='comment val'>#,##0.00_);($#,##0.00)</span> -<span class='integer val'>8</span> $<span class='comment val'>#,##0.00_);[Red]($#,##0.00)</span> -<span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> -<span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> -<span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> -<span class='integer val'>12</span> <span class='comment val'># ?/?</span> -<span class='integer val'>13</span> <span class='comment val'># ??/??</span> -<span class='integer val'>14</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> -<span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> -<span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> -<span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> -<span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> -<span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> -<span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> -<span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> -<span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yyyy identifier id'>yyyy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> -<span class='integer val'>37</span> <span class='comment val'>#,##0_);(#,##0)</span> -<span class='integer val'>38</span> <span class='comment val'>#,##0_);[Red](#,##0)</span> -<span class='integer val'>39</span> <span class='comment val'>#,##0.00_);(#,##0.00)</span> -<span class='integer val'>40</span> <span class='comment val'>#,##0.00_);[Red](#,##0.00)</span> -<span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> -<span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> -<span class='integer val'>47</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span><span class='integer val'>.0</span> -<span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> -<span class='integer val'>49</span> @ -</pre> -</div> - </div> - - -<p>An unsinged integer referencing a standard or custom number format.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>An unsinged integer referencing a standard or custom number format.</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -40 -41 -42</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 40</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> - - </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>Creates a numFmt element applying the instance values of this object as -attributes.</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"> - - -60</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/num_fmt.rb', line 60</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='numFmt identifier id'>numFmt</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='rparen 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:22 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 diff --git a/doc/Axlsx/OneCellAnchor.html b/doc/Axlsx/OneCellAnchor.html deleted file mode 100644 index 40e76ca2..00000000 --- a/doc/Axlsx/OneCellAnchor.html +++ /dev/null @@ -1,958 +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::OneCellAnchor - - — 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 (O)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">OneCellAnchor</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::OneCellAnchor - - - -</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::OneCellAnchor</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/one_cell_anchor.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 drawings, images and charts is -Worksheet#add_chart or Worksheet#add_image.</p> -</div> - </div> - - -<p>This class details a single cell anchor for drawings.</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="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</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="#drawing-instance_method" title="#drawing (instance method)">- (Drawing) <strong>drawing</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The drawing that holds this anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#from-instance_method" title="#from (instance method)">- (Marker) <strong>from</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A marker that defines the from cell anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#height-instance_method" title="#height (instance method)">- (Integer) <strong>height</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the height of the graphic object in pixels this is converted to EMU at a 92 -ppi resolution.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#object-instance_method" title="#object (instance method)">- (Pic) <strong>object</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The object this anchor hosts.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#width-instance_method" title="#width (instance method)">- (Integer) <strong>width</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the width of the graphic object in pixels.</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="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this anchor in the drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (OneCellAnchor) <strong>initialize</strong>(drawing, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new OneCellAnchor object and an Pic associated with it.</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 anchor.</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::OneCellAnchor (class)">OneCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new OneCellAnchor object and an Pic associated with it.</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>drawing</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</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> - - - — - <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">start_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the col, row to start at</p> -</div> - </li> - - <li> - <span class="name">width</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">height</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">image_src</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the file location of the image you will render</p> -</div> - </li> - - <li> - <span class="name">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the name attribute for the rendered image</p> -</div> - </li> - - <li> - <span class="name">descr</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the description of the image rendered</p> -</div> - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 39</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='drawing identifier id'>drawing</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='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span> - <span class='@width ivar id'>@width</span> <span class='assign token'>=</span> <span class='integer val'>0</span> - <span class='@height ivar id'>@height</span> <span class='assign token'>=</span> <span class='integer val'>0</span> - <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@from ivar id'>@from</span> <span class='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</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='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='Pic constant id'>Pic</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</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=""></span> - <span id="drawing-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="drawing-instance_method"> - - - (<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>drawing</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The drawing that holds this anchor</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> - <span class='@drawing ivar id'>@drawing</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="from-instance_method"></span> - <div class="method_details "> - <p class="signature " id="from-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>from</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A marker that defines the from cell anchor. The default from column and row -are 0 and 0 respectively</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</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/one_cell_anchor.rb', line 10</span> - -<span class='def def kw'>def</span> <span class='from identifier id'>from</span> - <span class='@from ivar id'>@from</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="height=-instance_method"></span> - <span id="height-instance_method"></span> - <div class="method_details "> - <p class="signature " id="height-instance_method"> - - - (<tt>Integer</tt>) <strong>height</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the height of the graphic object in pixels this is converted to EMU at a 92 -ppi resolution</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"> - - -28 -29 -30</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 28</span> - -<span class='def def kw'>def</span> <span class='height identifier id'>height</span> - <span class='@height ivar id'>@height</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="object-instance_method"></span> - <div class="method_details "> - <p class="signature " id="object-instance_method"> - - - (<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>) <strong>object</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The object this anchor hosts</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</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/one_cell_anchor.rb', line 14</span> - -<span class='def def kw'>def</span> <span class='object identifier id'>object</span> - <span class='@object ivar id'>@object</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="width=-instance_method"></span> - <span id="width-instance_method"></span> - <div class="method_details "> - <p class="signature " id="width-instance_method"> - - - (<tt>Integer</tt>) <strong>width</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the width of the graphic object in pixels. this is converted to EMU at a 92 -ppi resolution</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/drawing/one_cell_anchor.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='width identifier id'>width</span> - <span class='@width ivar id'>@width</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="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this anchor in the drawing</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"> - - -59 -60 -61</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 59</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@drawing ivar id'>@drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the anchor</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"> - - -66 -67 -68 -69 -70 -71 -72 -73 -74 -75</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/one_cell_anchor.rb', line 66</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'>'xdr:oneCellAnchor'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'xdr:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='from identifier id'>from</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='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'>'xdr:ext'</span><span class='comma token'>,</span> <span class='ext identifier id'>ext</span><span class='rparen token'>)</span> - <span class='@object ivar id'>@object</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='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'>'xdr:clientData'</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 Wed Nov 30 08:46:22 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 diff --git a/doc/Axlsx/Override.html b/doc/Axlsx/Override.html deleted file mode 100644 index 68ce281e..00000000 --- a/doc/Axlsx/Override.html +++ /dev/null @@ -1,540 +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::Override - - — 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 (O)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Override</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::Override - - - -</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::Override</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/content_type/override.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>An override content part. These parts are automatically created by for you -based on the content of your package.</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="#ContentType-instance_method" title="#ContentType (instance method)">- (String) <strong>ContentType</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of content.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#PartName-instance_method" title="#PartName (instance method)">- (String) <strong>PartName</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name and location of the part.</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)">- (Override) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Override 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 Override object to xml.</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::Override (class)">Override</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Override 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">PartName</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">ContentType</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - — - <div class='inline'> -<p>An argument error is raised if both PartName and ContentType are not -specified.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19 -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 17</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='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"PartName and ContentType are required"</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'>:PartName</span><span class='rbrack token'>]</span> <span class='andop op'>&&</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:ContentType</span><span class='rbrack 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="ContentType=-instance_method"></span> - <span id="ContentType-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="ContentType-instance_method"> - - - (<tt>String</tt>) <strong>ContentType</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The type of content.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -7 -8 -9</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 7</span> - -<span class='def def kw'>def</span> <span class='ContentType constant id'>ContentType</span> - <span class='@ContentType ivar id'>@ContentType</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="PartName=-instance_method"></span> - <span id="PartName-instance_method"></span> - <div class="method_details "> - <p class="signature " id="PartName-instance_method"> - - - (<tt>String</tt>) <strong>PartName</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name and location of the part.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -11 -12 -13</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 11</span> - -<span class='def def kw'>def</span> <span class='PartName constant id'>PartName</span> - <span class='@PartName ivar id'>@PartName</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 Override object to xml</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"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/content_type/override.rb', line 33</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='Override constant id'>Override</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='rparen 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: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 diff --git a/doc/Axlsx/Package.html b/doc/Axlsx/Package.html deleted file mode 100644 index 29c1b79f..00000000 --- a/doc/Axlsx/Package.html +++ /dev/null @@ -1,885 +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::Package - - — 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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Package</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::Package - - - -</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::Package</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/package.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Package is responsible for managing all the bits and peices that Open -Office XML requires to make a valid xlsx document including valdation and -serialization.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <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)">- (Package) <strong>initialize</strong>(options = {}) {|_self| ... }</a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Initializes your package.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#ruport_table-instance_method" title="#ruport_table (instance method)">- (Object) <strong>ruport_table</strong>(table) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Accepts a ruport table for serialization to xlsx.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#serialize-instance_method" title="#serialize (instance method)">- (Boolean) <strong>serialize</strong>(output, confirm_valid = false) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serialize your workbook to disk as an xlsx document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#validate-instance_method" title="#validate (instance method)">- (Array) <strong>validate</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Validate all parts of the package against xsd schema.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> {|@workbook| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The workbook this package will serialize or validate.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#workbook%3D-instance_method" title="#workbook= (instance method)">- (Object) <strong>workbook=</strong>(workbook) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></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::Package (class)">Package</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Initializes your package</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>Package.new :author => ‘you!’, :workbook => Workbook.new</p> -</div></h4> - <pre class="example code"> -</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 hash that you can use to specify the author and workbook for this -package.</p> -</div> - - </li> - -</ul> - - - - - <h3>Options Hash (<tt>options</tt>):</h3> - <ul class="option"> - - <li> - <span class="name">:author</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The author of the document</p> -</div> - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>_self</tt>)</span> - - - - </li> - -</ul> -<h3>Yield Parameters:</h3> -<ul class="yieldparam"> - - <li> - - <span class='name'>_self</span> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Package (class)">Axlsx::Package</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>the object that the method was called on</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -12 -13 -14 -15 -16 -17</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 12</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='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> - <span class='@core ivar id'>@core</span><span class='comma token'>,</span> <span class='@app ivar id'>@app</span> <span class='assign token'>=</span> <span class='Core constant id'>Core</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='App constant id'>App</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:author</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='@core ivar id'>@core</span><span class='dot token'>.</span><span class='creator identifier id'>creator</span> - <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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="ruport_table-instance_method"> - - - (<tt>Object</tt>) <strong>ruport_table</strong>(table) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Accepts a ruport table for serialization to xlsx</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>table</span> - - - <span class='type'>(<tt>Table</tt>)</span> - - - - — - <div class='inline'> -<p>a ruport Table object</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='ruport_table identifier id'>ruport_table</span><span class='lparen token'>(</span><span class='table identifier id'>table</span><span class='rparen token'>)</span> - <span class='puts identifier id'>puts</span> <span class='table identifier id'>table</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="serialize-instance_method"> - - - (<tt>Boolean</tt>) <strong>serialize</strong>(output, confirm_valid = false) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>A tremendous amount of effort has gone into ensuring that you cannot create -invalid xlsx documents. confirm_valid should be used in the rare case that -you cannot open the serialized file.</p> -</div> - </div> - - -<p>Serialize your workbook to disk as an xlsx document.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'></div></h4> - <pre class="example code"><span class='comment val'># This is how easy it is to create a valid xlsx file. Of course you might want to add a sheet or two, and maybe some data, styles and charts.</span> -<span class='comment val'># Take a look at the README for an example of how to do it!</span> -<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'test.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> -<span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> - -<span class='comment val'># You will find a file called test.xlsx</span> -</pre> - - </div> -<h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>output</span> - - - <span class='type'>(<tt>File</tt>)</span> - - - - — - <div class='inline'> -<p>The file you want to serialize your package to</p> -</div> - - </li> - - <li> - - <span class='name'>confirm_valid</span> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - <em class="default">(defaults to: <tt>false</tt>)</em> - - - — - <div class='inline'> -<p>Validate the package prior to serialization.</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p>False if confirm_valid and validation errors exist. True if the package was -serialized</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#validate-instance_method" title="Axlsx::Package#validate (method)">#validate</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 61</span> - -<span class='def def kw'>def</span> <span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='comma token'>,</span> <span class='confirm_valid identifier id'>confirm_valid</span><span class='assign token'>=</span><span class='false false kw'>false</span><span class='rparen token'>)</span> - <span class='return return kw'>return</span> <span class='false false kw'>false</span> <span class='unless unless_mod kw'>unless</span> <span class='notop op'>!</span><span class='confirm_valid identifier id'>confirm_valid</span> <span class='orop op'>||</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</span> - <span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='parts identifier id'>parts</span> - <span class='Zip constant id'>Zip</span><span class='colon2 op'>::</span><span class='ZipOutputStream constant id'>ZipOutputStream</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='output identifier id'>output</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='zip identifier id'>zip</span><span class='bitor op'>|</span> - <span class='p identifier id'>p</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='part identifier id'>part</span><span class='bitor op'>|</span> - <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='puts identifier id'>puts</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='unless unless kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='put_next_entry identifier id'>put_next_entry</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:entry</span><span class='rbrack token'>]</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> - <span class='comment val'># binread for 1.9.3</span> - <span class='zip identifier id'>zip</span><span class='dot token'>.</span><span class='write identifier id'>write</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:binread</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='binread identifier id'>binread</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='colon op'>:</span> <span class='IO constant id'>IO</span><span class='dot token'>.</span><span class='read identifier id'>read</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:path</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> - <span class='true true kw'>true</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="validate-instance_method"> - - - (<tt>Array</tt>) <strong>validate</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>This gem includes all schema from OfficeOpenXML-XMLSchema-Transitional.zip -and OpenPackagingConventions-XMLSchema.zip as per ECMA-376, Third edition. -opc schema require an internet connection to import remote schema from -dublin core for dc, dcterms and xml namespaces. Those remote schema are -included in this gem, and the original files have been altered to refer to -the local versions.</p> - -<p>If by chance you are able to creat a package that does not validate it -indicates that the internal validation is not robust enough and needs to be -improved. Please report your errors to the gem author.</p> -</div> - </div> - - -<p>Validate all parts of the package against xsd schema.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'></div></h4> - <pre class="example code"><span class='comment val'># The following will output any error messages found in serialization.</span> -<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> -<span class='comment val'># ... code to create sheets, charts, styles etc.</span> -<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='validate identifier id'>validate</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='error identifier id'>error</span><span class='bitor op'>|</span> <span class='puts identifier id'>puts</span> <span class='error identifier id'>error</span><span class='dot token'>.</span><span class='message identifier id'>message</span> <span class='rbrace token'>}</span> -</pre> - - </div> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - — - <div class='inline'> -<p>An array of all validation errors found.</p> -</div> - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><a href="http://www.ecma-international.org/publications/standards/Ecma-376.htm" target="_parent" title="http://www.ecma-international.org/publications/standards/Ecma-376.htm">http://www.ecma-international.org/publications/standards/Ecma-376.htm</a></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -95 -96 -97 -98 -99</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 95</span> - -<span class='def def kw'>def</span> <span class='validate identifier id'>validate</span> - <span class='errors identifier id'>errors</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> - <span class='parts identifier id'>parts</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='part identifier id'>part</span><span class='bitor op'>|</span> <span class='errors identifier id'>errors</span><span class='dot token'>.</span><span class='concat identifier id'>concat</span> <span class='validate_single_doc identifier id'>validate_single_doc</span><span class='lparen token'>(</span><span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:doc</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='part identifier id'>part</span><span class='lbrack token'>[</span><span class='symbol val'>:schema</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span> - <span class='errors identifier id'>errors</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="workbook-instance_method"> - - - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> {|@workbook| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>As there are multiple ways to instantiate a workbook for the package, here -are a few examples:</p> - -<pre class="ruby"><span class="ruby-comment"># assign directly during package instanciation</span> -<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>(:<span class="ruby-identifier">workbook</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span>).<span class="ruby-identifier">workbook</span> - -<span class="ruby-comment"># get a fresh workbook automatically from the package</span> -<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Pacakge</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span> -<span class="ruby-comment"># # set the workbook after creating the package</span> -<span class="ruby-identifier">wb</span> = <span class="ruby-constant">Package</span>.<span class="ruby-identifier">new</span>().<span class="ruby-identifier">workbook</span> = <span class="ruby-constant">Workbook</span>.<span class="ruby-identifier">new</span> -</pre> -</div> - </div> - - -<p>The workbook this package will serialize or validate.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>@workbook</tt>)</span> - - - - </li> - -</ul> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>If no workbook instance has been assigned with this package a new Workbook -instance is returned.</p> -</div> - - </li> - -</ul> -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'></span> - - - - - <div class='inline'> -<p>ArgumentError if workbook parameter is not a Workbook instance.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -37 -38 -39 -40 -41</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> - <span class='@workbook ivar id'>@workbook</span> <span class='orop op'>||</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='yield yield kw'>yield</span> <span class='@workbook ivar id'>@workbook</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='@workbook ivar id'>@workbook</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="workbook=-instance_method"> - - - (<tt>Object</tt>) <strong>workbook=</strong>(workbook) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>workbook</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -44</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/package.rb', line 44</span> - -<span class='def def kw'>def</span> <span class='workbook= identifier id'>workbook=</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='rparen token'>)</span> <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Package.workbook"</span><span class='comma token'>,</span> <span class='Workbook constant id'>Workbook</span><span class='comma token'>,</span> <span class='workbook identifier id'>workbook</span><span class='semicolon token'>;</span> <span class='@workbook ivar id'>@workbook</span> <span class='assign token'>=</span> <span class='workbook identifier id'>workbook</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:36 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 diff --git a/doc/Axlsx/PatternFill.html b/doc/Axlsx/PatternFill.html deleted file mode 100644 index a4a6e647..00000000 --- a/doc/Axlsx/PatternFill.html +++ /dev/null @@ -1,666 +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::PatternFill - - — 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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">PatternFill</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::PatternFill - - - -</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::PatternFill</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/pattern_fill.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 styles is with Styles#add_style</p> -</div> - </div> - - -<p>A PatternFill is the pattern and solid fill styling for a cell.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Style#add_style</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="#bgColor-instance_method" title="#bgColor (instance method)">- (Color) <strong>bgColor</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The color to use for the background of the fill when the type is not solid.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#fgColor-instance_method" title="#fgColor (instance method)">- (Color) <strong>fgColor</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The color to use for the the background in solid fills.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#patternType-instance_method" title="#patternType (instance method)">- (Object) <strong>patternType</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The pattern type to use.</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)">- (PatternFill) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new PatternFill 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 pattern fill.</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::PatternFill (class)">PatternFill</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new PatternFill 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">patternType</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">fgColor</span> - <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">bgColor</span> - <span class="type">(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -44 -45 -46 -47 -48 -49</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 44</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='@patternType ivar id'>@patternType</span> <span class='assign token'>=</span> <span class='symbol val'>:none</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="bgColor=-instance_method"></span> - <span id="bgColor-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="bgColor-instance_method"> - - - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>bgColor</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The color to use for the background of the fill when the type is not solid.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='bgColor identifier id'>bgColor</span> - <span class='@bgColor ivar id'>@bgColor</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="fgColor=-instance_method"></span> - <span id="fgColor-instance_method"></span> - <div class="method_details "> - <p class="signature " id="fgColor-instance_method"> - - - (<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>) <strong>fgColor</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The color to use for the the background in solid fills.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Color.html" title="Axlsx::Color (class)">Color</a></span></tt>)</span> - - - - </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/pattern_fill.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='fgColor identifier id'>fgColor</span> - <span class='@fgColor ivar id'>@fgColor</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="patternType=-instance_method"></span> - <span id="patternType-instance_method"></span> - <div class="method_details "> - <p class="signature " id="patternType-instance_method"> - - - (<tt>Object</tt>) <strong>patternType</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>patternType must be one of</p> - -<pre class="code"><span class='symbol val'>:none</span> -<span class='symbol val'>:solid</span> -<span class='symbol val'>:mediumGray</span> -<span class='symbol val'>:darkGray</span> -<span class='symbol val'>:lightGray</span> -<span class='symbol val'>:darkHorizontal</span> -<span class='symbol val'>:darkVertical</span> -<span class='symbol val'>:darkDown</span> -<span class='symbol val'>:darkUp</span> -<span class='symbol val'>:darkGrid</span> -<span class='symbol val'>:darkTrellis</span> -<span class='symbol val'>:lightHorizontal</span> -<span class='symbol val'>:lightVertical</span> -<span class='symbol val'>:lightDown</span> -<span class='symbol val'>:lightUp</span> -<span class='symbol val'>:lightGrid</span> -<span class='symbol val'>:lightTrellis</span> -<span class='symbol val'>:gray125</span> -<span class='symbol val'>:gray0625</span> -</pre> -</div> - </div> - - -<p>The pattern type to use</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Open XML Part 1 18.18.55</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='patternType identifier id'>patternType</span> - <span class='@patternType ivar id'>@patternType</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 pattern fill</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"> - - -60 -61 -62 -63 -64</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/pattern_fill.rb', line 60</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='patternFill identifier id'>patternFill</span><span class='lparen token'>(</span><span class='symbol val'>:patternType</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='patternType identifier id'>patternType</span><span class='rparen token'>)</span> <span class='lbrace 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='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='eq op'>==</span> <span class='symbol val'>:patternType</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='k identifier id'>k</span><span class='comma token'>,</span><span class='v identifier id'>v</span><span class='bitor op'>|</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='k identifier id'>k</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='rparen token'>)</span> <span class='rbrace 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 Wed Nov 30 08:46:29 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 diff --git a/doc/Axlsx/Pic.html b/doc/Axlsx/Pic.html deleted file mode 100644 index cb791160..00000000 --- a/doc/Axlsx/Pic.html +++ /dev/null @@ -1,1594 +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::Pic - - — 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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Pic</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::Pic - - - -</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::Pic</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/pic.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>a Pic object represents an image in your worksheet Worksheet#add_image is -the recommended way to manage images in your sheets</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> - - </ul> - -</div> - <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="ALLOWED_EXTENSIONS-constant" class="">ALLOWED_EXTENSIONS = - <div class="docstring"> - <div class="discussion"> - -<p>allowed file extenstions</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='lbrack token'>[</span><span class='string val'>'gif'</span><span class='comma token'>,</span> <span class='string val'>'jpeg'</span><span class='comma token'>,</span> <span class='string val'>'png'</span><span class='comma token'>,</span> <span class='string val'>'jpg'</span><span class='rbrack token'>]</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="#anchor-instance_method" title="#anchor (instance method)">- (OneCellAnchor) <strong>anchor</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The anchor for this image.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#descr-instance_method" title="#descr (instance method)">- (String) <strong>descr</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A description of the picture.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#image_src-instance_method" title="#image_src (instance method)">- (String) <strong>image_src</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The path to the image you want to include Only local images are supported -at this time and only jpg support.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name to use for this picture.</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="#extname-instance_method" title="#extname (instance method)">- (String) <strong>extname</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>returns the extension of image_src without the preceeding ‘.’.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#file_name-instance_method" title="#file_name (instance method)">- (String) <strong>file_name</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The file name of image_src without any path information.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#height-instance_method" title="#height (instance method)">- (Object) <strong>height</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>providing access to update the anchor’s height attribute.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#height%3D-instance_method" title="#height= (instance method)">- (Object) <strong>height=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Index) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this image in the workbooks images collections.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Pic) <strong>initialize</strong>(anchor, options = {}) {|_self| ... }</a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Pic(ture) object.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The part name for this image used in serialization and relationship -building.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong>(x, y) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need -finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff.</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 picture.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#width-instance_method" title="#width (instance method)">- (Object) <strong>width</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>providing access to the anchor’s width attribute.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#width%3D-instance_method" title="#width= (instance method)">- (Object) <strong>width=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></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::Pic (class)">Pic</a></span></tt>) <strong>initialize</strong>(anchor, options = {}) {|_self| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Pic(ture) object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>anchor</span> - - - <span class='type'>(<tt>Anchor</tt>)</span> - - - - — - <div class='inline'> -<p>the anchor that holds this image</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">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">descr</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">image_src</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">start_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">width</span> - <span class="type">(<tt>Intger</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">height</span> - <span class="type">(<tt>Intger</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>_self</tt>)</span> - - - - </li> - -</ul> -<h3>Yield Parameters:</h3> -<ul class="yieldparam"> - - <li> - - <span class='name'>_self</span> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Pic (class)">Axlsx::Pic</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>the object that the method was called on</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40 -41 -42 -43 -44 -45 -46</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='anchor identifier id'>anchor</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='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span> <span class='lshft op'><<</span> <span class='self self kw'>self</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='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> - <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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=""></span> - <span id="anchor-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="anchor-instance_method"> - - - (<tt><span class='object_link'><a href="OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></tt>) <strong>anchor</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The anchor for this image</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="OneCellAnchor.html" title="Axlsx::OneCellAnchor (class)">OneCellAnchor</a></span></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/drawing/pic.rb', line 27</span> - -<span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> - <span class='@anchor ivar id'>@anchor</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="descr=-instance_method"></span> - <span id="descr-instance_method"></span> - <div class="method_details "> - <p class="signature " id="descr-instance_method"> - - - (<tt>String</tt>) <strong>descr</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A description of the picture</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='descr identifier id'>descr</span> - <span class='@descr ivar id'>@descr</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="image_src=-instance_method"></span> - <span id="image_src-instance_method"></span> - <div class="method_details "> - <p class="signature " id="image_src-instance_method"> - - - (<tt>String</tt>) <strong>image_src</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The path to the image you want to include Only local images are supported -at this time and only jpg support</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -23 -24 -25</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='image_src identifier id'>image_src</span> - <span class='@image_src ivar id'>@image_src</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details "> - <p class="signature " id="name-instance_method"> - - - (<tt>String</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name to use for this picture</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</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="extname-instance_method"> - - - (<tt>String</tt>) <strong>extname</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>returns the extension of image_src without the preceeding ‘.’</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -70 -71 -72</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 70</span> - -<span class='def def kw'>def</span> <span class='extname identifier id'>extname</span> - <span class='File constant id'>File</span><span class='dot token'>.</span><span class='extname identifier id'>extname</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='string val'>'.'</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</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 class="method_details "> - <p class="signature " id="file_name-instance_method"> - - - (<tt>String</tt>) <strong>file_name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The file name of image_src without any path information</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -64 -65 -66</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 64</span> - -<span class='def def kw'>def</span> <span class='file_name identifier id'>file_name</span> - <span class='File constant id'>File</span><span class='dot token'>.</span><span class='basename identifier id'>basename</span><span class='lparen token'>(</span><span class='image_src identifier id'>image_src</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='image_src identifier id'>image_src</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 class="method_details "> - <p class="signature " id="height-instance_method"> - - - (<tt>Object</tt>) <strong>height</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>providing access to update the anchor’s height attribute</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>v</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>OneCellAnchor.width</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -101 -102 -103</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 101</span> - -<span class='def def kw'>def</span> <span class='height identifier id'>height</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="height=-instance_method"> - - - (<tt>Object</tt>) <strong>height=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>height</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -106 -107 -108</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 106</span> - -<span class='def def kw'>def</span> <span class='height= identifier id'>height=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='height identifier id'>height</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Index</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this image in the workbooks images collections</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Index</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -76 -77 -78</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 76</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="pn-instance_method"> - - - (<tt>String</tt>) <strong>pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The part name for this image used in serialization and relationship -building</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -82 -83 -84</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 82</span> - -<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> - <span class='dstring node'>"#{IMAGE_PN % [(index+1), extname]}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="start_at-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>start_at</strong>(x, y) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need -finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>x</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The column</p> -</div> - - </li> - - <li> - - <span class='name'>y</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>The row</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -116 -117 -118 -119</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 116</span> - -<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='from identifier id'>from</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the picture</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"> - - -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138 -139 -140 -141 -142 -143 -144 -145 -146 -147 -148</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 124</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'>'xdr:pic'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'xdr:nvPicPr'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='string val'>"2"</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:descr=</span><span class='gt op'>></span><span class='descr identifier id'>descr</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'>'xdr:cNvPicPr'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:picLocks'</span><span class='comma token'>,</span> <span class='symbol val'>:noChangeAspect=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace 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'>'xdr:blipFill'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:blip'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:embed'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</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'>'a:stretch'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:fillRect'</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace 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'>'xdr:spPr'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:xfrm'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</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'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>2336800</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>2161540</span><span class='rparen token'>)</span> - <span class='rbrace 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'>'a:prstGeom'</span><span class='comma token'>,</span> <span class='symbol val'>:prst=</span><span class='gt op'>></span><span class='symbol val'>:rect</span><span class='rparen token'>)</span> <span class='lbrace 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'>'a:avLst'</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="width-instance_method"> - - - (<tt>Object</tt>) <strong>width</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>providing access to the anchor’s width attribute</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>v</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>OneCellAnchor.width</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -89 -90 -91</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 89</span> - -<span class='def def kw'>def</span> <span class='width identifier id'>width</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="width=-instance_method"> - - - (<tt>Object</tt>) <strong>width=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>width</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -94 -95 -96</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pic.rb', line 94</span> - -<span class='def def kw'>def</span> <span class='width= identifier id'>width=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='@anchor ivar id'>@anchor</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='assign token'>=</span> <span class='v identifier id'>v</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:33 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 diff --git a/doc/Axlsx/Pie3DChart.html b/doc/Axlsx/Pie3DChart.html deleted file mode 100644 index 21cd7df4..00000000 --- a/doc/Axlsx/Pie3DChart.html +++ /dev/null @@ -1,482 +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::Pie3DChart - - — 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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Pie3DChart</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::Pie3DChart - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li class="next">Axlsx::Pie3DChart</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/pie_3D_chart.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Pie3DChart is a three dimentional piechart (who would have guessed?) -that you can add to your worksheet.</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> - - <li>for an example</li> - - </ul> - -</div> - - - - - - - - - - - <h2>Instance Attribute Summary</h2> - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Chart.html#graphic_frame-instance_method" title="Axlsx::Chart#graphic_frame (method)">graphic_frame</a></span>, <span class='object_link'><a href="Chart.html#series-instance_method" title="Axlsx::Chart#series (method)">series</a></span>, <span class='object_link'><a href="Chart.html#series_type-instance_method" title="Axlsx::Chart#series_type (method)">series_type</a></span>, <span class='object_link'><a href="Chart.html#show_legend-instance_method" title="Axlsx::Chart#show_legend (method)">show_legend</a></span>, <span class='object_link'><a href="Chart.html#style-instance_method" title="Axlsx::Chart#style (method)">style</a></span>, <span class='object_link'><a href="Chart.html#title-instance_method" title="Axlsx::Chart#title (method)">title</a></span>, <span class='object_link'><a href="Chart.html#view3D-instance_method" title="Axlsx::Chart#view3D (method)">view3D</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)">- (Pie3DChart) <strong>initialize</strong>(frame, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new pie chart 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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the pie chart.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - - - <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Chart.html#add_series-instance_method" title="Axlsx::Chart#add_series (method)">#add_series</a></span>, <span class='object_link'><a href="Chart.html#end_at-instance_method" title="Axlsx::Chart#end_at (method)">#end_at</a></span>, <span class='object_link'><a href="Chart.html#from-instance_method" title="Axlsx::Chart#from (method)">#from</a></span>, <span class='object_link'><a href="Chart.html#index-instance_method" title="Axlsx::Chart#index (method)">#index</a></span>, <span class='object_link'><a href="Chart.html#pn-instance_method" title="Axlsx::Chart#pn (method)">#pn</a></span>, <span class='object_link'><a href="Chart.html#start_at-instance_method" title="Axlsx::Chart#start_at (method)">#start_at</a></span>, <span class='object_link'><a href="Chart.html#to-instance_method" title="Axlsx::Chart#to (method)">#to</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::Pie3DChart (class)">Pie3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new pie chart object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>frame</span> - - - <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>The workbook that owns this chart.</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">title</span> - <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">show_legend</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">grouping</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">gapDepth</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotX</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">hPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotY</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">depthPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rAngAx</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">perspective</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li><span class='object_link'><a href="View3D.html" title="Axlsx::View3D (class)">View3D</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -24 -25 -26 -27 -28</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 24</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</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='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='PieSeries constant id'>PieSeries</span> - <span class='@view3D ivar id'>@view3D</span> <span class='assign token'>=</span> <span class='View3D constant id'>View3D</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='lbrace token'>{</span><span class='symbol val'>:rotX=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='comma token'>,</span> <span class='symbol val'>:perspective=</span><span class='gt op'>></span><span class='integer val'>30</span><span class='rbrace token'>}</span><span class='dot token'>.</span><span class='merge identifier id'>merge</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span><span class='rparen token'>)</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> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the pie chart</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -32 -33 -34 -35 -36 -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 32</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> - <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</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:pie3DChart'</span><span class='rparen token'>)</span> <span class='lbrace 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:varyColors'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='rparen token'>)</span> - <span class='@series ivar id'>@series</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='ser identifier id'>ser</span><span class='bitor op'>|</span> <span class='ser identifier id'>ser</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='rbrace token'>}</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:28 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 diff --git a/doc/Axlsx/PieSeries.html b/doc/Axlsx/PieSeries.html deleted file mode 100644 index 49c37a7c..00000000 --- a/doc/Axlsx/PieSeries.html +++ /dev/null @@ -1,696 +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::PieSeries - - — 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 (P)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">PieSeries</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::PieSeries - - - -</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::PieSeries</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/pie_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 PieSeries defines the data and labels and explosion for pie charts -series.</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)">- (SimpleTypedList) <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="#explosion-instance_method" title="#explosion (instance method)">- (Integert) <strong>explosion</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The explosion for this series.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#labels-instance_method" title="#labels (instance method)">- (SimpleTypedList) <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)">- (PieSeries) <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::PieSeries (class)">PieSeries</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> - - - — - <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> - - <li> - <span class="name">title</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">explosion</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -26 -27 -28 -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 26</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='@explosion ivar id'>@explosion</span> <span class='assign 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='self self kw'>self</span><span class='dot token'>.</span><span class='labels identifier 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='self self kw'>self</span><span class='dot token'>.</span><span class='data identifier 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="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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/pie_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="explosion=-instance_method"></span> - <span id="explosion-instance_method"></span> - <div class="method_details "> - <p class="signature " id="explosion-instance_method"> - - - (<tt>Integert</tt>) <strong>explosion</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The explosion for this series</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integert</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 18</span> - -<span class='def def kw'>def</span> <span class='explosion identifier id'>explosion</span> - <span class='@explosion ivar id'>@explosion</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="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</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/pie_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> - - - - — - <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"> - - -39 -40 -41 -42 -43 -44 -45</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 39</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='xml_inner identifier id'>xml_inner</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:explosion'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@explosion ivar id'>@explosion</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@explosion ivar id'>@explosion</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:33 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 diff --git a/doc/Axlsx/RegexValidator.html b/doc/Axlsx/RegexValidator.html deleted file mode 100644 index 0e7baede..00000000 --- a/doc/Axlsx/RegexValidator.html +++ /dev/null @@ -1,264 +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::RegexValidator - - — 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 (R)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">RegexValidator</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::RegexValidator - - - -</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::RegexValidator</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/util/validators.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Validates the value against the regular expression provided.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <h2> - Class Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#validate-class_method" title="validate (class method)">+ (Object) <strong>validate</strong>(name, regex, v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></div></span> - -</li> - - - </ul> - - - - - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - - <div class="method_details first"> - <p class="signature first" id="validate-class_method"> - - + (<tt>Object</tt>) <strong>validate</strong>(name, regex, v) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>name</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of what is being validated. This is included in the output when -the value is invalid</p> -</div> - - </li> - - <li> - - <span class='name'>regex</span> - - - <span class='type'>(<tt>Regexp</tt>)</span> - - - - — - <div class='inline'> -<p>The regular expression to evaluate</p> -</div> - - </li> - - <li> - - <span class='name'>v</span> - - - <span class='type'>(<tt>Any</tt>)</span> - - - - — - <div class='inline'> -<p>The value to validate.</p> -</div> - - </li> - -</ul> - -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='regex identifier id'>regex</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_REGEX constant id'>ERR_REGEX</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='comma token'>,</span> <span class='regex identifier id'>regex</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span><span class='lparen token'>(</span><span class='symbol val'>:=~</span><span class='rparen token'>)</span> <span class='andop op'>&&</span> <span class='v identifier id'>v</span> <span class='match op'>=~</span> <span class='regex identifier id'>regex</span><span class='rparen 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:28 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 diff --git a/doc/Axlsx/Relationship.html b/doc/Axlsx/Relationship.html deleted file mode 100644 index e0f7b487..00000000 --- a/doc/Axlsx/Relationship.html +++ /dev/null @@ -1,541 +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::Relationship - - — 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 (R)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Relationship</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::Relationship - - - -</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::Relationship</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/rels/relationship.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>Packages automatcially manage relationships.</p> -</div> - </div> - - -<p>A relationship defines a reference between package parts.</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="#Target-instance_method" title="#Target (instance method)">- (String) <strong>Target</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The location of the relationship target.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#Type-instance_method" title="#Type (instance method)">- (String) <strong>Type</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of relationship.</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)">- (Relationship) <strong>initialize</strong>(type, target) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A new instance of Relationship.</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, rId) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the relationship.</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::Relationship (class)">Relationship</a></span></tt>) <strong>initialize</strong>(type, target) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A new instance of Relationship</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -24 -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 24</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='type identifier id'>type</span><span class='comma token'>,</span> <span class='target identifier id'>target</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Target constant id'>Target</span><span class='assign token'>=</span><span class='target identifier id'>target</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='Type constant id'>Type</span><span class='assign token'>=</span><span class='type identifier id'>type</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="Target=-instance_method"></span> - <span id="Target-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="Target-instance_method"> - - - (<tt>String</tt>) <strong>Target</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The location of the relationship target</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='Target constant id'>Target</span> - <span class='@Target ivar id'>@Target</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="Type=-instance_method"></span> - <span id="Type-instance_method"></span> - <div class="method_details "> - <p class="signature " id="Type-instance_method"> - - - (<tt>String</tt>) <strong>Type</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>Supported types are defined as constants in Axlsx:</p> -</div> - </div> - - -<p>The type of relationship</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>String</tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="../Axlsx.html#XML_NS_R-constant" title="Axlsx::XML_NS_R (constant)">XML_NS_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#TABLE_R-constant" title="Axlsx::TABLE_R (constant)">TABLE_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#WORKBOOK_R-constant" title="Axlsx::WORKBOOK_R (constant)">WORKBOOK_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#WORKSHEET_R-constant" title="Axlsx::WORKSHEET_R (constant)">WORKSHEET_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#APP_R-constant" title="Axlsx::APP_R (constant)">APP_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#RELS_R-constant" title="Axlsx::RELS_R (constant)">Axlsx::RELS_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#CORE_R-constant" title="Axlsx::CORE_R (constant)">CORE_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#STYLES_R-constant" title="Axlsx::STYLES_R (constant)">STYLES_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#CHART_R-constant" title="Axlsx::CHART_R (constant)">CHART_R</a></span></li> - - <li><span class='object_link'><a href="../Axlsx.html#DRAWING_R-constant" title="Axlsx::DRAWING_R (constant)">DRAWING_R</a></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/rels/relationship.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='Type constant id'>Type</span> - <span class='@Type ivar id'>@Type</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, rId) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the relationship</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> - - <li> - - <span class='name'>rId</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>the reference id of the object.</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"> - - -38 -39 -40 -41 -42</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationship.rb', line 38</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='comma token'>,</span> <span class='rId identifier id'>rId</span><span class='rparen token'>)</span> - <span class='h identifier id'>h</span> <span class='assign 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='h identifier id'>h</span><span class='lbrack token'>[</span><span class='symbol val'>:Id</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='rId identifier id'>rId</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationship constant id'>Relationship</span><span class='lparen token'>(</span><span class='h identifier id'>h</span><span class='rparen 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:21 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 diff --git a/doc/Axlsx/Relationships.html b/doc/Axlsx/Relationships.html deleted file mode 100644 index fd687a8b..00000000 --- a/doc/Axlsx/Relationships.html +++ /dev/null @@ -1,332 +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::Relationships - - — 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 (R)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Relationships</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::Relationships - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> - - <li class="next">Axlsx::Relationships</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/rels/relationships.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 package automatically manages releationships.</p> -</div> - </div> - - -<p>Relationships are a collection of Relations that define how package parts -are related.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - - - - - - <h2>Instance Attribute Summary</h2> - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> - <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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)">- (Relationships) <strong>initialize</strong> </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Relationships collection based on SimpleTypedList.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the relationships document.</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::Relationships (class)">Relationships</a></span></tt>) <strong>initialize</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Relationships collection based on SimpleTypedList</p> - - - </div> -</div> -<div class="tags"> - - -</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/rels/relationships.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span> - <span class='super super kw'>super</span> <span class='Relationship constant id'>Relationship</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> -<div id="method_missing_details" class="method_details_list"> - <h2>Dynamic Method Handling</h2> - <p class="notice super"> - This class handles dynamic methods through the <tt>method_missing</tt> method - - in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> - - </p> - -</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> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the relationships document.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -15 -16 -17 -18 -19 -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/rels/relationships.rb', line 15</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='Relationships constant id'>Relationships</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='RELS_R constant id'>RELS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='each_with_index identifier id'>each_with_index</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='rel identifier id'>rel</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> <span class='rel identifier id'>rel</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='comma token'>,</span> <span class='dstring node'>"rId#{index+1}"</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:33 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 diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html deleted file mode 100644 index a5a2bb53..00000000 --- a/doc/Axlsx/RestrictionValidator.html +++ /dev/null @@ -1,292 +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::RestrictionValidator - - — 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 (R)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">RestrictionValidator</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::RestrictionValidator - - - -</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::RestrictionValidator</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/util/validators.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>Validate a value against a specific list of allowed values.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - <h2> - Class Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#validate-class_method" title="validate (class method)">+ (Boolean) <strong>validate</strong>(name, choices, v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Perform validation.</p> -</div></span> - -</li> - - - </ul> - - - - - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - - <div class="method_details first"> - <p class="signature first" id="validate-class_method"> - - + (<tt>Boolean</tt>) <strong>validate</strong>(name, choices, v) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Perform validation</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>name</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - — - <div class='inline'> -<p>The name of what is being validatied. This is included in the error message</p> -</div> - - </li> - - <li> - - <span class='name'>choices</span> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - — - <div class='inline'> -<p>The list of choices to validate against</p> -</div> - - </li> - - <li> - - <span class='name'>v</span> - - - <span class='type'>(<tt>Any</tt>)</span> - - - - — - <div class='inline'> -<p>The value to be validated</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Boolean</tt>)</span> - - - - — - <div class='inline'> -<p>true if validation succeeds.</p> -</div> - - </li> - -</ul> -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - — - <div class='inline'> -<p>Raised if the value provided is not in the list of choices.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -10 -11 -12 -13</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/util/validators.rb', line 10</span> - -<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span><span class='lparen token'>(</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='comma token'>,</span> <span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='lparen token'>(</span><span class='ERR_RESTRICTION constant id'>ERR_RESTRICTION</span> <span class='mod op'>%</span> <span class='lbrack token'>[</span><span class='v identifier id'>v</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='comma token'>,</span> <span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='inspect identifier id'>inspect</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='choices identifier id'>choices</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> - <span class='true true kw'>true</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:30 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 diff --git a/doc/Axlsx/Row.html b/doc/Axlsx/Row.html deleted file mode 100644 index 8a8639bf..00000000 --- a/doc/Axlsx/Row.html +++ /dev/null @@ -1,896 +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::Row - - — 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 (R)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Row</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::Row - - - -</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::Row</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/workbook/worksheet/row.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 rows and cells is to use Worksheet#add_row</p> -</div> - </div> - - -<p>A Row is a single row in a worksheet.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">Worksheet#add_row</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="#cells-instance_method" title="#cells (instance method)">- (SimpleTypedList) <strong>cells</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The cells this row holds.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The worksheet this row belongs to.</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="#add_cell-instance_method" title="#add_cell (instance method)">- (Cell) <strong>add_cell</strong>(value = "", options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a singel sell to the row based on the data provided and updates the -worksheet’s autofit data.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this row in the worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Row) <strong>initialize</strong>(worksheet, values = [], options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new row.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#style%3D-instance_method" title="#style= (instance method)">- (Object) <strong>style=</strong>(style) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>sets the style for every cell in this row.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#to_ary-instance_method" title="#to_ary (instance method)">- (Array) <strong>to_ary</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>returns the cells in this row as an array This lets us transpose the rows -into columns.</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 row.</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::Row (class)">Row</a></span></tt>) <strong>initialize</strong>(worksheet, values = [], options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new row. New Cell objects are created based on the values, types -and style options. A new cell is created for each item in the values array. -style and types options are applied as follows:</p> - -<pre class="code"><span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='a identifier id'>a</span> <span class='symbol identifier id'>symbol</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='the identifier id'>the</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span> -<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='cell identifier id'>cell</span> <span class='types identifier id'>types</span> <span class='are identifier id'>are</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span> -<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='types identifier id'>types</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='set identifier id'>set</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='cell identifier id'>cell</span> <span class='will identifier id'>will</span> <span class='automatically identifier id'>automatically</span> <span class='determine identifier id'>determine</span> <span class='its identifier id'>its</span> <span class='type identifier id'>type</span><span class='dot token'>.</span> -<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='defined identifier id'>defined</span> <span class='and and kw'>and</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='Integer constant id'>Integer</span><span class='comma token'>,</span> <span class='it identifier id'>it</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='all identifier id'>all</span> <span class='cells identifier id'>cells</span> <span class='created identifier id'>created</span><span class='dot token'>.</span> -<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='an identifier id'>an</span> <span class='array identifier id'>array</span><span class='comma token'>,</span> <span class='style identifier id'>style</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='by identifier id'>by</span> <span class='index identifier id'>index</span> <span class='for for kw'>for</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span> -<span class='If constant id'>If</span> <span class='the identifier id'>the</span> <span class='style identifier id'>style</span> <span class='option identifier id'>option</span> <span class='is identifier id'>is</span> <span class='not not kw'>not</span> <span class='defined identifier id'>defined</span><span class='comma token'>,</span> <span class='the identifier id'>the</span> <span class='default identifier id'>default</span> <span class='style identifier id'>style</span> <span class='lparen token'>(</span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='is identifier id'>is</span> <span class='applied identifier id'>applied</span> <span class='to identifier id'>to</span> <span class='each identifier id'>each</span> <span class='cell identifier id'>cell</span><span class='dot token'>.</span> -</pre> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>worksheet</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</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> - - - — - <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">values</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">types</span> - <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#array_to_cells-instance_method" title="Axlsx::Row#array_to_cells (method)">#array_to_cells</a></span></li> - - <li><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -29 -30 -31 -32 -33 -34</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</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='self self kw'>self</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@cells ivar id'>@cells</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='Cell constant id'>Cell</span> - <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='array_to_cells identifier id'>array_to_cells</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</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=""></span> - <span id="cells-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="cells-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cells</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The cells this row holds</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> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='cells identifier id'>cells</span> - <span class='@cells ivar id'>@cells</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="worksheet=-instance_method"></span> - <span id="worksheet-instance_method"></span> - <div class="method_details "> - <p class="signature " id="worksheet-instance_method"> - - - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The worksheet this row belongs to</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> - - - - </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/workbook/worksheet/row.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</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="add_cell-instance_method"> - - - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>add_cell</strong>(value = "", options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Adds a singel sell to the row based on the data provided and updates the -worksheet’s autofit data.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -51 -52 -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 51</span> - -<span class='def def kw'>def</span> <span class='add_cell identifier id'>add_cell</span><span class='lparen token'>(</span><span class='value identifier id'>value</span><span class='assign token'>=</span><span class='string val'>""</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='c identifier id'>c</span> <span class='assign token'>=</span> <span class='Cell constant id'>Cell</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='value identifier id'>value</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> - <span class='c identifier id'>c</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this row in the worksheet</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"> - - -38 -39 -40</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='rows identifier id'>rows</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="style=-instance_method"> - - - (<tt>Object</tt>) <strong>style=</strong>(style) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>sets the style for every cell in this row</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -58 -59 -60 -61 -62 -63</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 58</span> - -<span class='def def kw'>def</span> <span class='style= identifier id'>style=</span><span class='lparen token'>(</span><span class='style identifier id'>style</span><span class='rparen token'>)</span> - <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span> <span class='cell identifier id'>cell</span><span class='comma token'>,</span> <span class='index identifier id'>index</span> <span class='bitor op'>|</span> - <span class='s identifier id'>s</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='style identifier id'>style</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='colon op'>:</span> <span class='style identifier id'>style</span> - <span class='cell identifier id'>cell</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='s identifier id'>s</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_ary-instance_method"> - - - (<tt>Array</tt>) <strong>to_ary</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>returns the cells in this row as an array This lets us transpose the rows -into columns</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -68 -69 -70</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 68</span> - -<span class='def def kw'>def</span> <span class='to_ary identifier id'>to_ary</span> - <span class='@cells ivar id'>@cells</span><span class='dot token'>.</span><span class='to_ary identifier id'>to_ary</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the row</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"> - - -45 -46 -47</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/row.rb', line 45</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='row identifier id'>row</span><span class='lparen token'>(</span><span class='symbol val'>:r</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='@cells ivar id'>@cells</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='cell identifier id'>cell</span><span class='bitor op'>|</span> <span class='cell identifier id'>cell</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='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:36 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 diff --git a/doc/Axlsx/Scaling.html b/doc/Axlsx/Scaling.html deleted file mode 100644 index 333a8ba2..00000000 --- a/doc/Axlsx/Scaling.html +++ /dev/null @@ -1,727 +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::Scaling - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Scaling</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::Scaling - - - -</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::Scaling</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/scaling.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Scaling class defines axis scaling</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="#logBase-instance_method" title="#logBase (instance method)">- (Integer) <strong>logBase</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>logarithmic base for a logarithmic axis.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#max-instance_method" title="#max (instance method)">- (Float) <strong>max</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the maximum scaling.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#min-instance_method" title="#min (instance method)">- (Float) <strong>min</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the minimu scaling.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#orientation-instance_method" title="#orientation (instance method)">- (Symbol) <strong>orientation</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>the orientation of the axis must be one of [:minMax, :maxMin].</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)">- (Scaling) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>creates a new Scaling 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 axId.</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::Scaling (class)">Scaling</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>creates a new Scaling 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">logBase</span> - <span class="type">(<tt>Integer</tt>, <tt>Fixnum</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">orientation</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">max</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">min</span> - <span class="type">(<tt>Float</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -28 -29 -30 -31 -32 -33 -34</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 28</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='@orientation ivar id'>@orientation</span> <span class='assign token'>=</span> <span class='symbol val'>:minMax</span> - <span class='@logBase ivar id'>@logBase</span><span class='comma token'>,</span> <span class='@min ivar id'>@min</span><span class='comma token'>,</span> <span class='@max ivar id'>@max</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='comma token'>,</span> <span class='nil nil kw'>nil</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="logBase=-instance_method"></span> - <span id="logBase-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="logBase-instance_method"> - - - (<tt>Integer</tt>) <strong>logBase</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>logarithmic base for a logarithmic axis. must be between 2 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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='logBase identifier id'>logBase</span> - <span class='@logBase ivar id'>@logBase</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="max=-instance_method"></span> - <span id="max-instance_method"></span> - <div class="method_details "> - <p class="signature " id="max-instance_method"> - - - (<tt>Float</tt>) <strong>max</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the maximum scaling</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 17</span> - -<span class='def def kw'>def</span> <span class='max identifier id'>max</span> - <span class='@max ivar id'>@max</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="min=-instance_method"></span> - <span id="min-instance_method"></span> - <div class="method_details "> - <p class="signature " id="min-instance_method"> - - - (<tt>Float</tt>) <strong>min</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the minimu scaling</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='min identifier id'>min</span> - <span class='@min ivar id'>@min</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="orientation=-instance_method"></span> - <span id="orientation-instance_method"></span> - <div class="method_details "> - <p class="signature " id="orientation-instance_method"> - - - (<tt>Symbol</tt>) <strong>orientation</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>the orientation of the axis must be one of [:minMax, :maxMin]</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"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='orientation identifier id'>orientation</span> - <span class='@orientation ivar id'>@orientation</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 axId</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"> - - -49 -50 -51 -52 -53 -54 -55 -56</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/scaling.rb', line 49</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:scaling'</span><span class='rparen token'>)</span> <span class='lbrace 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:logBase'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span> <span class='@logBase ivar id'>@logBase</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@logBase ivar id'>@logBase</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:orientation'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span> <span class='@orientation ivar id'>@orientation</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@orientation ivar id'>@orientation</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:min'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@min ivar id'>@min</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@min ivar id'>@min</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:max'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='@max ivar id'>@max</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@max ivar id'>@max</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:28 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 diff --git a/doc/Axlsx/SerAxis.html b/doc/Axlsx/SerAxis.html deleted file mode 100644 index 34b87079..00000000 --- a/doc/Axlsx/SerAxis.html +++ /dev/null @@ -1,625 +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::SerAxis - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">SerAxis</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::SerAxis - - - -</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::SerAxis</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/ser_axis.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>A SerAxis object defines a series axis</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="#tickLblSkip-instance_method" title="#tickLblSkip (instance method)">- (Integer) <strong>tickLblSkip</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of tick lables to skip between labels.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#tickMarkSkip-instance_method" title="#tickMarkSkip (instance method)">- (Boolean) <strong>tickMarkSkip</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The number of tickmarks to be skipped before the next one is rendered.</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)">- (SerAxis) <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 SerAxis 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 series 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::SerAxis (class)">SerAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new SerAxis 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. Inherited</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. Inherited</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> - — <div class='inline'> -<p>Inherited</p> -</div> - </li> - - <li> - <span class="name">tickLblPos.</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Inherited</p> -</div> - </li> - - <li> - <span class="name">crosses.</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Inherited</p> -</div> - </li> - - <li> - <span class="name">tickLblSkip</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">tickMarkSkip</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23 -24</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 21</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='@tickLblSkip ivar id'>@tickLblSkip</span><span class='comma token'>,</span> <span class='@tickMarkSkip ivar id'>@tickMarkSkip</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='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='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="tickLblSkip=-instance_method"></span> - <span id="tickLblSkip-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="tickLblSkip-instance_method"> - - - (<tt>Integer</tt>) <strong>tickLblSkip</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of tick lables to skip between labels</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"> - - -7 -8 -9</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 7</span> - -<span class='def def kw'>def</span> <span class='tickLblSkip identifier id'>tickLblSkip</span> - <span class='@tickLblSkip ivar id'>@tickLblSkip</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="tickMarkSkip=-instance_method"></span> - <span id="tickMarkSkip-instance_method"></span> - <div class="method_details "> - <p class="signature " id="tickMarkSkip-instance_method"> - - - (<tt>Boolean</tt>) <strong>tickMarkSkip</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The number of tickmarks to be skipped before the next one is rendered.</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"> - - -11 -12 -13</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 11</span> - -<span class='def def kw'>def</span> <span class='tickMarkSkip identifier id'>tickMarkSkip</span> - <span class='@tickMarkSkip ivar id'>@tickMarkSkip</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 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"> - - -35 -36 -37 -38 -39 -40 -41</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 35</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:serAx'</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:tickLblSkip'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickLblSkip ivar id'>@tickLblSkip</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@tickLblSkip ivar id'>@tickLblSkip</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:tickMarkSkip'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@tickMarkSkip ivar id'>@tickMarkSkip</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@tickMarkSkip ivar id'>@tickMarkSkip</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:21 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 diff --git a/doc/Axlsx/Series.html b/doc/Axlsx/Series.html deleted file mode 100644 index a86ebc17..00000000 --- a/doc/Axlsx/Series.html +++ /dev/null @@ -1,797 +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::Series - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Series</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::Series - - - -</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::Series</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/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 Series defines the common series attributes and is the super class for -all concrete series types.</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><div id="subclasses"> - <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="BarSeries.html" title="Axlsx::BarSeries (class)">BarSeries</a></span>, <span class='object_link'><a href="LineSeries.html" title="Axlsx::LineSeries (class)">LineSeries</a></span>, <span class='object_link'><a href="PieSeries.html" title="Axlsx::PieSeries (class)">PieSeries</a></span></p> -</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="#chart-instance_method" title="#chart (instance method)">- (Chart) <strong>chart</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The chart that owns this series.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#title-instance_method" title="#title (instance method)">- (SeriesTitle) <strong>title</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The title of the series.</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="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this series in the chart’s series.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Series) <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="#order-instance_method" title="#order (instance method)">- (Integer) <strong>order</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The order of this series in the chart’s series.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#order%3D-instance_method" title="#order= (instance method)">- (Object) <strong>order=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'></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> - - -<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::Series (class)">Series</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> - - - — - <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">order</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">title</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -20 -21 -22 -23 -24 -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/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='@order ivar id'>@order</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='chart identifier id'>chart</span> - <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span> <span class='lshft op'><<</span> <span class='self self kw'>self</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="chart=-instance_method"></span> - <span id="chart-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="chart-instance_method"> - - - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>chart</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The chart that owns 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="Chart.html" title="Axlsx::Chart (class)">Chart</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/series.rb', line 10</span> - -<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> - <span class='@chart ivar id'>@chart</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="title=-instance_method"></span> - <span id="title-instance_method"></span> - <div class="method_details "> - <p class="signature " id="title-instance_method"> - - - (<tt><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></tt>) <strong>title</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The title of the series</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</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/series.rb', line 14</span> - -<span class='def def kw'>def</span> <span class='title identifier id'>title</span> - <span class='@title ivar id'>@title</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="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this series in the chart’s series.</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/drawing/series.rb', line 31</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@chart ivar id'>@chart</span><span class='dot token'>.</span><span class='series identifier id'>series</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="order-instance_method"> - - - (<tt>Integer</tt>) <strong>order</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The order of this series in the chart’s series. By default the order is -the index of the series.</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"> - - -38 -39 -40</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='order identifier id'>order</span> - <span class='@order ivar id'>@order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="order=-instance_method"> - - - (<tt>Object</tt>) <strong>order=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>order</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 43</span> - -<span class='def def kw'>def</span> <span class='order= identifier id'>order=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_unsigned_int identifier id'>validate_unsigned_int</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span><span class='semicolon token'>;</span> <span class='@order ivar id'>@order</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " 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> - - - - — - <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"> - - -60 -61 -62 -63 -64 -65 -66 -67</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 60</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:ser'</span><span class='rparen token'>)</span> <span class='lbrace 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:idx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='index identifier id'>index</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:order'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='order identifier id'>order</span> <span class='orop op'>||</span> <span class='index identifier id'>index</span><span class='rparen token'>)</span> - <span class='title identifier id'>title</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='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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:26 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 diff --git a/doc/Axlsx/SeriesTitle.html b/doc/Axlsx/SeriesTitle.html deleted file mode 100644 index 08954e4c..00000000 --- a/doc/Axlsx/SeriesTitle.html +++ /dev/null @@ -1,286 +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::SeriesTitle - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">SeriesTitle</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::SeriesTitle - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></li> - - <li class="next">Axlsx::SeriesTitle</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/series_title.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>A series title is a Title with a slightly different serialization than -chart titles.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - - - - - - <h2>Instance Attribute Summary</h2> - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Title.html#cell-instance_method" title="Axlsx::Title#cell (method)">cell</a></span>, <span class='object_link'><a href="Title.html#text-instance_method" title="Axlsx::Title#text (method)">text</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="#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 title.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - - - <h3 class="inherited">Methods inherited from <span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></h3> - <p class="inherited"><span class='object_link'><a href="Title.html#initialize-instance_method" title="Axlsx::Title#initialize (method)">#initialize</a></span></p> -<div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <p class="notice">This class inherits a constructor from <span class='object_link'><a href="Title.html#initialize-instance_method" title="Axlsx::Title#initialize (method)">Axlsx::Title</a></span></p> - -</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 title</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"> - - -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series_title.rb', line 8</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:tx'</span><span class='rparen token'>)</span> <span class='lbrace 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:strRef'</span><span class='rparen token'>)</span> <span class='lbrace 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:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='@cell ivar id'>@cell</span><span class='rbrack token'>]</span><span class='rparen token'>)</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:strCache'</span><span class='rparen token'>)</span> <span class='lbrace 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:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</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:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='lbrace 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:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='rbrace 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 Wed Nov 30 08:46:29 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 diff --git a/doc/Axlsx/Styles.html b/doc/Axlsx/Styles.html deleted file mode 100644 index 4c5f376d..00000000 --- a/doc/Axlsx/Styles.html +++ /dev/null @@ -1,1700 +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::Styles - - — 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 (S)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Styles</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::Styles - - - -</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::Styles</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/styles.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 styles is with add_style</p> -</div> - </div> - - -<p>The Styles class manages worksheet styles In addition to creating the -require style objects for a valid xlsx package, this class provides the key -mechanism for adding styles to your workbook, and safely applying them to -the cells of your worksheet. All portions of the stylesheet are implemented -here exception colors, which specify legacy and modified pallete colors, -and exLst, whic is used as a future feature data storage area.</p> - - - </div> -</div> -<div class="tags"> - - - <h3>See Also:</h3> - <ul class="see"> - - <li>Open XML Part 1 18.8.11 for gory details on how this stuff gets put together</li> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#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="#borders-instance_method" title="#borders (instance method)">- (SimpleTypedList) <strong>borders</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of borders used in this workbook Axlsx predefines -THIN_BORDER which can be used to put a border around all of your cells.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#cellStyles-instance_method" title="#cellStyles (instance method)">- (SimpleTypedList) <strong>cellStyles</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of named styles, referencing cellStyleXfs items in the -workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#cellStyleXfs-instance_method" title="#cellStyleXfs (instance method)">- (SimpleTypedList) <strong>cellStyleXfs</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of master formatting records for named cell styles, which -means records defined in cellStyles, in the workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#cellXfs-instance_method" title="#cellXfs (instance method)">- (SimpleTypedList) <strong>cellXfs</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of master formatting records.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#dxfs-instance_method" title="#dxfs (instance method)">- (SimpleTypedList) <strong>dxfs</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of non-cell formatting records used in the worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#fills-instance_method" title="#fills (instance method)">- (SimpleTypedList) <strong>fills</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of fills used in this workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#fonts-instance_method" title="#fonts (instance method)">- (SimpleTypedList) <strong>fonts</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of fonts used in this workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#numFmts-instance_method" title="#numFmts (instance method)">- (SimpleTypedList) <strong>numFmts</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>numFmts for your styles.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#tableStyles-instance_method" title="#tableStyles (instance method)">- (SimpleTypedList) <strong>tableStyles</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The collection of table styles that will be available to the user in the -excel UI.</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="#add_style-instance_method" title="#add_style (instance method)">- (Integer) <strong>add_style</strong>(options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Drastically simplifies style creation and management.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Styles) <strong>initialize</strong> </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Styles object and prepopulates it with the requires objects -to generate a valid package style part.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the styles document.</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::Styles (class)">Styles</a></span></tt>) <strong>initialize</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Styles object and prepopulates it with the requires objects -to generate a valid package style part.</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -118 -119 -120</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 118</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='load_default_styles identifier id'>load_default_styles</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=""></span> - <span id="borders-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="borders-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>borders</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of borders used in this workbook Axlsx predefines -THIN_BORDER which can be used to put a border around all of your cells.</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -85 -86 -87</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 85</span> - -<span class='def def kw'>def</span> <span class='borders identifier id'>borders</span> - <span class='@borders ivar id'>@borders</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="cellStyles-instance_method"></span> - <div class="method_details "> - <p class="signature " id="cellStyles-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cellStyles</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of named styles, referencing cellStyleXfs items in the -workbook.</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -97 -98 -99</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 97</span> - -<span class='def def kw'>def</span> <span class='cellStyles identifier id'>cellStyles</span> - <span class='@cellStyles ivar id'>@cellStyles</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="cellStyleXfs-instance_method"></span> - <div class="method_details "> - <p class="signature " id="cellStyleXfs-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cellStyleXfs</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of master formatting records for named cell styles, which -means records defined in cellStyles, in the workbook</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -91 -92 -93</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 91</span> - -<span class='def def kw'>def</span> <span class='cellStyleXfs identifier id'>cellStyleXfs</span> - <span class='@cellStyleXfs ivar id'>@cellStyleXfs</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="cellXfs-instance_method"></span> - <div class="method_details "> - <p class="signature " id="cellXfs-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>cellXfs</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of master formatting records. This is the list that you will -actually use in styling a workbook.</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -103 -104 -105</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 103</span> - -<span class='def def kw'>def</span> <span class='cellXfs identifier id'>cellXfs</span> - <span class='@cellXfs ivar id'>@cellXfs</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="dxfs-instance_method"></span> - <div class="method_details "> - <p class="signature " id="dxfs-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>dxfs</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of non-cell formatting records used in the worksheet.</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -109 -110 -111</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 109</span> - -<span class='def def kw'>def</span> <span class='dxfs identifier id'>dxfs</span> - <span class='@dxfs ivar id'>@dxfs</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="fills-instance_method"></span> - <div class="method_details "> - <p class="signature " id="fills-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>fills</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of fills used in this workbook</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -78 -79 -80</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 78</span> - -<span class='def def kw'>def</span> <span class='fills identifier id'>fills</span> - <span class='@fills ivar id'>@fills</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="fonts-instance_method"></span> - <div class="method_details "> - <p class="signature " id="fonts-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>fonts</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of fonts used in this workbook</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -72 -73 -74</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 72</span> - -<span class='def def kw'>def</span> <span class='fonts identifier id'>fonts</span> - <span class='@fonts ivar id'>@fonts</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="numFmts-instance_method"></span> - <div class="method_details "> - <p class="signature " id="numFmts-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>numFmts</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>numFmts for your styles.</p> - -<pre class="code"><span class='The constant id'>The</span> <span class='default identifier id'>default</span> <span class='styles identifier id'>styles</span><span class='comma token'>,</span> <span class='which identifier id'>which</span> <span class='change identifier id'>change</span> <span class='based identifier id'>based</span> <span class='on identifier id'>on</span> <span class='the identifier id'>the</span> <span class='system identifier id'>system</span> <span class='local identifier id'>local</span><span class='comma token'>,</span> <span class='are identifier id'>are</span> <span class='as identifier id'>as</span> <span class='follows identifier id'>follows</span><span class='dot token'>.</span> -<span class='id identifier id'>id</span> <span class='formatCode identifier id'>formatCode</span> - <span class='integer val'>0</span> <span class='General constant id'>General</span> - <span class='integer val'>1</span> <span class='integer val'>0</span> - <span class='integer val'>2</span> <span class='integer val'>0</span><span class='integer val'>.00</span> - <span class='integer val'>3</span> <span class='comment val'>#,##0</span> - <span class='integer val'>4</span> <span class='comment val'>#,##0.00</span> - <span class='integer val'>9</span> <span class='integer val'>0</span><span class='mod op'>%</span> - <span class='integer val'>10</span> <span class='integer val'>0</span><span class='integer val'>.00</span><span class='mod op'>%</span> - <span class='integer val'>11</span> <span class='integer val'>0</span><span class='float val'>.00E+00</span> - <span class='integer val'>12</span> <span class='comment val'># ?/?</span> - <span class='integer val'>13</span> <span class='comment val'># ??/??</span> - <span class='integer val'>14</span> <span class='mm identifier id'>mm</span><span class='minus op'>-</span><span class='dd identifier id'>dd</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> - <span class='integer val'>15</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> - <span class='integer val'>16</span> <span class='d identifier id'>d</span><span class='minus op'>-</span><span class='mmm identifier id'>mmm</span> - <span class='integer val'>17</span> <span class='mmm identifier id'>mmm</span><span class='minus op'>-</span><span class='yy identifier id'>yy</span> - <span class='integer val'>18</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> - <span class='integer val'>19</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> <span class='AM constant id'>AM</span><span class='div op'>/</span><span class='PM constant id'>PM</span> - <span class='integer val'>20</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> - <span class='integer val'>21</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> - <span class='integer val'>22</span> <span class='m identifier id'>m</span><span class='div op'>/</span><span class='d identifier id'>d</span><span class='div op'>/</span><span class='yy identifier id'>yy</span> <span class='h identifier id'>h</span><span class='symbol val'>:mm</span> - <span class='integer val'>37</span> <span class='comment val'>#,##0 ;(#,##0)</span> - <span class='integer val'>38</span> <span class='comment val'>#,##0 ;[Red](#,##0)</span> - <span class='integer val'>39</span> <span class='comment val'>#,##0.00;(#,##0.00)</span> - <span class='integer val'>40</span> <span class='comment val'>#,##0.00;[Red](#,##0.00)</span> - <span class='integer val'>45</span> <span class='mm identifier id'>mm</span><span class='symbol val'>:ss</span> - <span class='integer val'>46</span> <span class='lbrack token'>[</span><span class='h identifier id'>h</span><span class='rbrack token'>]</span><span class='symbol val'>:mm</span><span class='symbol val'>:ss</span> - <span class='integer val'>47</span> <span class='mmss identifier id'>mmss</span><span class='integer val'>.0</span> - <span class='integer val'>48</span> <span class='comment val'>##0.0E+0</span> - <span class='integer val'>49</span> @ -<span class='Axlsx constant id'>Axlsx</span> <span class='also identifier id'>also</span> <span class='defines identifier id'>defines</span> <span class='the identifier id'>the</span> <span class='following identifier id'>following</span> <span class='constants identifier id'>constants</span> <span class='which identifier id'>which</span> <span class='you identifier id'>you</span> <span class='can identifier id'>can</span> <span class='use identifier id'>use</span> <span class='in in kw'>in</span> <span class='add_style identifier id'>add_style</span><span class='dot token'>.</span> - <span class='NUM_FMT_PERCENT constant id'>NUM_FMT_PERCENT</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"0%"</span> - <span class='NUM_FMT_YYYYMMDD constant id'>NUM_FMT_YYYYMMDD</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"yyyy/mm/dd"</span> - <span class='NUM_FMT_YYYYMMDDHHMMSS constant id'>NUM_FMT_YYYYMMDDHHMMSS</span> <span class='formats identifier id'>formats</span> <span class='to identifier id'>to</span> <span class='string val'>"yyyy/mm/dd hh:mm:ss"</span> -</pre> - - - </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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li>Open XML Part 1 - 18.8.31 for more information on creating number formats</li> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -66 -67 -68</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 66</span> - -<span class='def def kw'>def</span> <span class='numFmts identifier id'>numFmts</span> - <span class='@numFmts ivar id'>@numFmts</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="tableStyles-instance_method"></span> - <div class="method_details "> - <p class="signature " id="tableStyles-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>tableStyles</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is with add_style</p> -</div> - </div> - - -<p>The collection of table styles that will be available to the user in the -excel UI</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_style-instance_method" title="Axlsx::Styles#add_style (method)">#add_style</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -115 -116 -117</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 115</span> - -<span class='def def kw'>def</span> <span class='tableStyles identifier id'>tableStyles</span> - <span class='@tableStyles ivar id'>@tableStyles</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="add_style-instance_method"> - - - (<tt>Integer</tt>) <strong>add_style</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Drastically simplifies style creation and management.</p> - - - </div> -</div> -<div class="tags"> - - <div class="examples"> - <h3>Examples:</h3> - - <h4><div class='inline'> -<p>You Got Style</p> -</div></h4> - <pre class="example code"><span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> -<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> - -<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> -<span class='ws identifier id'>ws</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='add_worksheet identifier id'>add_worksheet</span> - -<span class='comment val'># black text on a white background at 14pt with thin borders!</span> -<span class='title identifier id'>title</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFF0000"</span><span class='comma token'>,</span> <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"#FF000000"</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='integer val'>14</span><span class='comma token'>,</span> <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> - -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Least Popular Pets"</span><span class='rbrack token'>]</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>""</span><span class='comma token'>,</span> <span class='string val'>"Dry Skinned Reptiles"</span><span class='comma token'>,</span> <span class='string val'>"Bald Cats"</span><span class='comma token'>,</span> <span class='string val'>"Violent Parrots"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Votes"</span><span class='comma token'>,</span> <span class='integer val'>6</span><span class='comma token'>,</span> <span class='integer val'>4</span><span class='comma token'>,</span> <span class='integer val'>1</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span> -<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_you_got_style.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> -<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</span> -</pre> - - <h4><div class='inline'> -<p>Styling specifically</p> -</div></h4> - <pre class="example code"><span class='comment val'># an example of applying specific styles to specific cells</span> -<span class='require identifier id'>require</span> <span class='string val'>"rubygems"</span> <span class='comment val'># if that is your preferred way to manage gems!</span> -<span class='require identifier id'>require</span> <span class='string val'>"axlsx"</span> - -<span class='p identifier id'>p</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Package constant id'>Package</span><span class='dot token'>.</span><span class='new identifier id'>new</span> -<span class='ws identifier id'>ws</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='add_worksheet identifier id'>add_worksheet</span> - -<span class='comment val'># define your styles</span> -<span class='title identifier id'>title</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:bg_color</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"FFFF0000"</span><span class='comma token'>,</span> - <span class='symbol val'>:fg_color=</span><span class='gt op'>></span><span class='string val'>"#FF000000"</span><span class='comma token'>,</span> - <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='comma token'>,</span> - <span class='symbol val'>:alignment=</span><span class='gt op'>></span><span class='lbrace token'>{</span><span class='symbol val'>:horizontal</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='symbol val'>:center</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> - -<span class='date_time identifier id'>date_time</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='NUM_FMT_YYYYMMDDHHMMSS constant id'>NUM_FMT_YYYYMMDDHHMMSS</span><span class='comma token'>,</span> - <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> - -<span class='percent identifier id'>percent</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:num_fmt</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='NUM_FMT_PERCENT constant id'>NUM_FMT_PERCENT</span><span class='comma token'>,</span> - <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> - -<span class='currency identifier id'>currency</span> <span class='assign token'>=</span> <span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='dot token'>.</span><span class='add_style identifier id'>add_style</span><span class='lparen token'>(</span><span class='symbol val'>:format_code=</span><span class='gt op'>></span><span class='string val'>"¥#,##0;[Red]¥-#,##0"</span><span class='comma token'>,</span> - <span class='symbol val'>:border=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='STYLE_THIN_BORDER constant id'>STYLE_THIN_BORDER</span><span class='rparen token'>)</span> - -<span class='comment val'># build your rows</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Genreated At:"</span><span class='comma token'>,</span> <span class='Time constant id'>Time</span><span class='dot token'>.</span><span class='now identifier id'>now</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:styles=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='date_time identifier id'>date_time</span><span class='rbrack token'>]</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Previous Year Quarterly Profits (JPY)"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Quarter"</span><span class='comma token'>,</span> <span class='string val'>"Profit"</span><span class='comma token'>,</span> <span class='string val'>"% of Total"</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='title identifier id'>title</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q1"</span><span class='comma token'>,</span> <span class='integer val'>4000</span><span class='comma token'>,</span> <span class='integer val'>40</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q2"</span><span class='comma token'>,</span> <span class='integer val'>3000</span><span class='comma token'>,</span> <span class='integer val'>30</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q3"</span><span class='comma token'>,</span> <span class='integer val'>1000</span><span class='comma token'>,</span> <span class='integer val'>10</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> -<span class='ws identifier id'>ws</span><span class='dot token'>.</span><span class='add_row identifier id'>add_row</span> <span class='symbol val'>:values</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='lbrack token'>[</span><span class='string val'>"Q4"</span><span class='comma token'>,</span> <span class='integer val'>2000</span><span class='comma token'>,</span> <span class='integer val'>20</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:style=</span><span class='gt op'>></span><span class='lbrack token'>[</span><span class='title identifier id'>title</span><span class='comma token'>,</span> <span class='currency identifier id'>currency</span><span class='comma token'>,</span> <span class='percent identifier id'>percent</span><span class='rbrack token'>]</span> -<span class='f identifier id'>f</span> <span class='assign token'>=</span> <span class='File constant id'>File</span><span class='dot token'>.</span><span class='open identifier id'>open</span><span class='lparen token'>(</span><span class='string val'>'example_you_got_style.xlsx'</span><span class='comma token'>,</span> <span class='string val'>'w'</span><span class='rparen token'>)</span> -<span class='p identifier id'>p</span><span class='dot token'>.</span><span class='serialize identifier id'>serialize</span><span class='lparen token'>(</span><span class='f identifier id'>f</span><span class='rparen token'>)</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">fg_color</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The text color</p> -</div> - </li> - - <li> - <span class="name">sz</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The text size</p> -</div> - </li> - - <li> - <span class="name">b</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Indicates if the text should be bold</p> -</div> - </li> - - <li> - <span class="name">i</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Indicates if the text should be italicised</p> -</div> - </li> - - <li> - <span class="name">strike</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Indicates if the text should be rendered with a strikethrough</p> -</div> - </li> - - <li> - <span class="name">strike</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Indicates if the text should be rendered with a shadow</p> -</div> - </li> - - <li> - <span class="name">charset</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The character set to use.</p> -</div> - </li> - - <li> - <span class="name">family</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The font family to use.</p> -</div> - </li> - - <li> - <span class="name">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The name of the font to use</p> -</div> - </li> - - <li> - <span class="name">num_fmt</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The number format to apply</p> -</div> - </li> - - <li> - <span class="name">format_code</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The formatting to apply. If this is specified, num_fmt is ignored.</p> -</div> - </li> - - <li> - <span class="name">border</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The border style to use.</p> -</div> - </li> - - <li> - <span class="name">bg_color</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The background color to apply to the cell</p> -</div> - </li> - - <li> - <span class="name">hidden</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Indicates if the cell should be hidden</p> -</div> - </li> - - <li> - <span class="name">locked</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>Indicates if the cell should be locked</p> -</div> - </li> - - <li> - <span class="name">alignment</span> - <span class="type">(<tt>Hash</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>A hash defining any of the attributes used in CellAlignment</p> -</div> - </li> - - </ul> - - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</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"> - - -191 -192 -193 -194 -195 -196 -197 -198 -199 -200 -201 -202 -203 -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222 -223 -224 -225 -226 -227 -228 -229 -230 -231 -232 -233 -234 -235</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 191</span> - -<span class='def def kw'>def</span> <span class='add_style identifier id'>add_style</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='numFmtId identifier id'>numFmtId</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:format_code</span><span class='rbrack token'>]</span> - <span class='n identifier id'>n</span> <span class='assign token'>=</span> <span class='@numFmts ivar id'>@numFmts</span><span class='dot token'>.</span><span class='map identifier id'>map</span><span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='f identifier id'>f</span><span class='bitor op'>|</span> <span class='f identifier id'>f</span><span class='dot token'>.</span><span class='numFmtId identifier id'>numFmtId</span> <span class='rbrace token'>}</span><span class='dot token'>.</span><span class='max identifier id'>max</span> <span class='plus op'>+</span> <span class='integer val'>1</span> - <span class='numFmts identifier id'>numFmts</span> <span class='lshft op'><<</span> <span class='NumFmt constant id'>NumFmt</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:numFmtId</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='n identifier id'>n</span><span class='comma token'>,</span> <span class='symbol val'>:formatCode=</span><span class='gt op'>></span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:format_code</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='n identifier id'>n</span> - <span class='else else kw'>else</span> - <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:num_fmt</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> - <span class='end end kw'>end</span> - - <span class='borderId identifier id'>borderId</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:border</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='integer val'>0</span> - <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='string val'>"Invalid borderId"</span> <span class='unless unless_mod kw'>unless</span> <span class='borderId identifier id'>borderId</span> <span class='lt op'><</span> <span class='borders identifier id'>borders</span><span class='dot token'>.</span><span class='size identifier id'>size</span> - - <span class='fill identifier id'>fill</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:bg_color</span><span class='rbrack token'>]</span> - <span class='color identifier id'>color</span> <span class='assign token'>=</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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:bg_color</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='pattern identifier id'>pattern</span> <span class='assign token'>=</span> <span class='PatternFill constant id'>PatternFill</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:patternType</span> <span class='assign token'>=</span><span class='gt op'>></span><span class='symbol val'>:solid</span><span class='comma token'>,</span> <span class='symbol val'>:fgColor=</span><span class='gt op'>></span><span class='color identifier id'>color</span><span class='rparen token'>)</span> - <span class='fills identifier id'>fills</span> <span class='lshft op'><<</span> <span class='Fill constant id'>Fill</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='pattern identifier id'>pattern</span><span class='rparen token'>)</span> - <span class='else else kw'>else</span> - <span class='integer val'>0</span> - <span class='end end kw'>end</span> - - <span class='fontId identifier id'>fontId</span> <span class='assign token'>=</span> <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='dot token'>.</span><span class='values_at identifier id'>values_at</span><span class='lparen token'>(</span><span class='symbol val'>:fg_color</span><span class='comma token'>,</span> <span class='symbol val'>:sz</span><span class='comma token'>,</span> <span class='symbol val'>:b</span><span class='comma token'>,</span> <span class='symbol val'>:i</span><span class='comma token'>,</span> <span class='symbol val'>:strike</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='comma token'>,</span> <span class='symbol val'>:shadow</span><span class='comma token'>,</span> <span class='symbol val'>:charset</span><span class='comma token'>,</span> <span class='symbol val'>:family</span><span class='comma token'>,</span> <span class='symbol val'>:font_name</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='length identifier id'>length</span><span class='rparen token'>)</span> - <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='Font constant id'>Font</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='lbrack token'>[</span><span class='symbol val'>:b</span><span class='comma token'>,</span> <span class='symbol val'>:i</span><span class='comma token'>,</span> <span class='symbol val'>:strike</span><span class='comma token'>,</span> <span class='symbol val'>:outline</span><span class='comma token'>,</span> <span class='symbol val'>:shadow</span><span class='comma token'>,</span> <span class='symbol val'>:charset</span><span class='comma token'>,</span> <span class='symbol val'>:family</span><span class='comma token'>,</span> <span class='symbol val'>:sz</span><span class='rbrack 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='k identifier id'>k</span><span class='bitor op'>|</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{k}="</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='k identifier id'>k</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='k identifier id'>k</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> <span class='rbrace token'>}</span> - <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='color identifier id'>color</span> <span class='assign token'>=</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='assign token'>=</span><span class='gt op'>></span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:fg_color</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'>:fg_color</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:font_name</span><span class='rbrack 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'>:font_name</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='fonts identifier id'>fonts</span> <span class='lshft op'><<</span> <span class='font identifier id'>font</span> - <span class='else else kw'>else</span> - <span class='integer val'>0</span> - <span class='end end kw'>end</span> - - <span class='applyProtection identifier id'>applyProtection</span> <span class='assign token'>=</span> <span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:hidden</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:locked</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='integer val'>1</span> <span class='colon op'>:</span> <span class='integer val'>0</span> - - <span class='xf identifier id'>xf</span> <span class='assign token'>=</span> <span class='Xf constant id'>Xf</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:fillId</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='fill identifier id'>fill</span><span class='comma token'>,</span> <span class='symbol val'>:fontId=</span><span class='gt op'>></span><span class='fontId identifier id'>fontId</span><span class='comma token'>,</span> <span class='symbol val'>:applyFill=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:applyFont=</span><span class='gt op'>></span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:numFmtId=</span><span class='gt op'>></span><span class='numFmtId identifier id'>numFmtId</span><span class='comma token'>,</span> <span class='symbol val'>:borderId=</span><span class='gt op'>></span><span class='borderId identifier id'>borderId</span><span class='comma token'>,</span> <span class='symbol val'>:applyProtection=</span><span class='gt op'>></span><span class='applyProtection identifier id'>applyProtection</span><span class='rparen token'>)</span> - - <span class='if if kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:alignment</span><span class='rbrack token'>]</span> - <span class='xf identifier id'>xf</span><span class='dot token'>.</span><span class='alignment identifier id'>alignment</span> <span class='assign token'>=</span> <span class='CellAlignment constant id'>CellAlignment</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'>:alignment</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - - <span class='if if kw'>if</span> <span class='applyProtection identifier id'>applyProtection</span> - <span class='xf identifier id'>xf</span><span class='dot token'>.</span><span class='protection identifier id'>protection</span> <span class='assign token'>=</span> <span class='CellProtection constant id'>CellProtection</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='rparen token'>)</span> - <span class='end end kw'>end</span> - - <span class='cellXfs identifier id'>cellXfs</span> <span class='lshft op'><<</span> <span class='xf identifier id'>xf</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the styles document</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -239 -240 -241 -242 -243 -244 -245 -246 -247 -248</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/styles.rb', line 239</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='styleSheet identifier id'>styleSheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='lbrack token'>[</span><span class='symbol val'>:numFmts</span><span class='comma token'>,</span> <span class='symbol val'>:fonts</span><span class='comma token'>,</span> <span class='symbol val'>:fills</span><span class='comma token'>,</span> <span class='symbol val'>:borders</span><span class='comma token'>,</span> <span class='symbol val'>:cellStyleXfs</span><span class='comma token'>,</span> <span class='symbol val'>:cellXfs</span><span class='comma token'>,</span> <span class='symbol val'>:cellStyles</span><span class='comma token'>,</span> <span class='symbol val'>:dxfs</span><span class='comma token'>,</span> <span class='symbol val'>:tableStyles</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='key identifier id'>key</span><span class='bitor op'>|</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</span><span class='lbrack token'>[</span><span class='key identifier id'>key</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='rbrack token'>]</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='end end kw'>end</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</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:31 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 diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html deleted file mode 100644 index 41cd0318..00000000 --- a/doc/Axlsx/TableStyle.html +++ /dev/null @@ -1,690 +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::TableStyle - - — 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 (T)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">TableStyle</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::TableStyle - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> - - <li class="next">Axlsx::TableStyle</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/table_style.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>Table are not supported in this version and only the defaults required for -a valid workbook are created.</p> -</div> - </div> - - -<p>A single table style definition and is a collection for tableStyleElements</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="#name-instance_method" title="#name (instance method)">- (string) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of this table style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pivot-instance_method" title="#pivot (instance method)">- (Boolean) <strong>pivot</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if this style should be applied to pivot tables.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#table-instance_method" title="#table (instance method)">- (Boolean) <strong>table</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>indicates if this style should be applied to tables.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> - <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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)">- (TableStyle) <strong>initialize</strong>(name, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>creates a new TableStyle 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 table style.</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::TableStyle (class)">TableStyle</a></span></tt>) <strong>initialize</strong>(name, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>creates a new TableStyle object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>name</span> - - - <span class='type'>(<tt>String</tt>)</span> - - - - </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">pivot</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">table</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Raises:</h3> -<ul class="raise"> - - <li> - - - <span class='type'>(<tt>ArgumentError</tt>)</span> - - - - — - <div class='inline'> -<p>if name option is not provided.</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -23 -24 -25 -26 -27 -28 -29</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 23</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='name identifier id'>name</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='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='name identifier id'>name</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span> - <span class='end end kw'>end</span> - <span class='super super kw'>super</span> <span class='TableStyleElement constant id'>TableStyleElement</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> -<div id="method_missing_details" class="method_details_list"> - <h2>Dynamic Method Handling</h2> - <p class="notice super"> - This class handles dynamic methods through the <tt>method_missing</tt> method - - in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> - - </p> - -</div> - - <div id="instance_attr_details" class="attr_details"> - <h2>Instance Attribute Details</h2> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="name-instance_method"> - - - (<tt>string</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of this table style</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="pivot=-instance_method"></span> - <span id="pivot-instance_method"></span> - <div class="method_details "> - <p class="signature " id="pivot-instance_method"> - - - (<tt>Boolean</tt>) <strong>pivot</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if this style should be applied to pivot tables</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"> - - -12 -13 -14</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='pivot identifier id'>pivot</span> - <span class='@pivot ivar id'>@pivot</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="table=-instance_method"></span> - <span id="table-instance_method"></span> - <div class="method_details "> - <p class="signature " id="table-instance_method"> - - - (<tt>Boolean</tt>) <strong>table</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>indicates if this style should be applied to tables</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"> - - -16 -17 -18</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 16</span> - -<span class='def def kw'>def</span> <span class='table identifier id'>table</span> - <span class='@table ivar id'>@table</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 table style</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"> - - -41 -42 -43 -44 -45</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style.rb', line 41</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='attr identifier id'>attr</span> <span class='assign 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'>:name</span><span class='comma token'>,</span> <span class='symbol val'>:pivot</span><span class='comma token'>,</span> <span class='symbol val'>:table</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='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyle identifier id'>tableStyle</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> <span class='self self kw'>self</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='table_style_el identifier id'>table_style_el</span><span class='bitor op'>|</span> <span class='table_style_el identifier id'>table_style_el</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='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:21 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 diff --git a/doc/Axlsx/TableStyleElement.html b/doc/Axlsx/TableStyleElement.html deleted file mode 100644 index 3b629497..00000000 --- a/doc/Axlsx/TableStyleElement.html +++ /dev/null @@ -1,663 +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::TableStyleElement - - — 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 (T)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">TableStyleElement</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::TableStyleElement - - - -</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::TableStyleElement</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/table_style_element.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>tables and table styles are not supported in this version. This class -exists in preparation for that support.</p> -</div> - </div> - - -<p>an element of style that belongs to a table style.</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="#dxfId-instance_method" title="#dxfId (instance method)">- (Integer) <strong>dxfId</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The dxfId this style element points to.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#size-instance_method" title="#size (instance method)">- (Integer) <strong>size</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Number of rows or columns used in striping when the type is firstRowStripe, -secondRowStripe, firstColumnStripe, or secondColumnStripe.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#type-instance_method" title="#type (instance method)">- (Symbol) <strong>type</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The type of style element.</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)">- (TableStyleElement) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>creates a new TableStyleElement 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 table style 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::TableStyleElement (class)">TableStyleElement</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>creates a new TableStyleElement 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">type</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">size</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">dxfId</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -49 -50 -51 -52 -53</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 49</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='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</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="dxfId=-instance_method"></span> - <span id="dxfId-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="dxfId-instance_method"> - - - (<tt>Integer</tt>) <strong>dxfId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The dxfId this style element points to</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"> - - -43 -44 -45</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 43</span> - -<span class='def def kw'>def</span> <span class='dxfId identifier id'>dxfId</span> - <span class='@dxfId ivar id'>@dxfId</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="size=-instance_method"></span> - <span id="size-instance_method"></span> - <div class="method_details "> - <p class="signature " id="size-instance_method"> - - - (<tt>Integer</tt>) <strong>size</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Number of rows or columns used in striping when the type is firstRowStripe, -secondRowStripe, firstColumnStripe, or secondColumnStripe.</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"> - - -39 -40 -41</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 39</span> - -<span class='def def kw'>def</span> <span class='size identifier id'>size</span> - <span class='@size ivar id'>@size</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="type=-instance_method"></span> - <span id="type-instance_method"></span> - <div class="method_details "> - <p class="signature " id="type-instance_method"> - - - (<tt>Symbol</tt>) <strong>type</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The type of style element. The following type are allowed</p> - -<pre class="code"><span class='symbol val'>:wholeTable</span> -<span class='symbol val'>:headerRow</span> -<span class='symbol val'>:totalRow</span> -<span class='symbol val'>:firstColumn</span> -<span class='symbol val'>:lastColumn</span> -<span class='symbol val'>:firstRowStripe</span> -<span class='symbol val'>:secondRowStripe</span> -<span class='symbol val'>:firstColumnStripe</span> -<span class='symbol val'>:secondColumnStripe</span> -<span class='symbol val'>:firstHeaderCell</span> -<span class='symbol val'>:lastHeaderCell</span> -<span class='symbol val'>:firstTotalCell</span> -<span class='symbol val'>:lastTotalCell</span> -<span class='symbol val'>:firstSubtotalColumn</span> -<span class='symbol val'>:secondSubtotalColumn</span> -<span class='symbol val'>:thirdSubtotalColumn</span> -<span class='symbol val'>:firstSubtotalRow</span> -<span class='symbol val'>:secondSubtotalRow</span> -<span class='symbol val'>:thirdSubtotalRow</span> -<span class='symbol val'>:blankRow</span> -<span class='symbol val'>:firstColumnSubheading</span> -<span class='symbol val'>:secondColumnSubheading</span> -<span class='symbol val'>:thirdColumnSubheading</span> -<span class='symbol val'>:firstRowSubheading</span> -<span class='symbol val'>:secondRowSubheading</span> -<span class='symbol val'>:thirdRowSubheading</span> -<span class='symbol val'>:pageFieldLabels</span> -<span class='symbol val'>:pageFieldValues</span> -</pre> - - - </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"> - - -35 -36 -37</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 35</span> - -<span class='def def kw'>def</span> <span class='type identifier id'>type</span> - <span class='@type ivar id'>@type</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 table style 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> - -<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"> - - -67 -68 -69</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_style_element.rb', line 67</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='tableStyleElement identifier id'>tableStyleElement</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='instance_values identifier id'>instance_values</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:27 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 diff --git a/doc/Axlsx/TableStyles.html b/doc/Axlsx/TableStyles.html deleted file mode 100644 index 4f265099..00000000 --- a/doc/Axlsx/TableStyles.html +++ /dev/null @@ -1,580 +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::TableStyles - - — 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 (T)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">TableStyles</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::TableStyles - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> - - <li class="next">Axlsx::TableStyles</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/stylesheet/table_styles.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>Support for custom table styles does not exist in this version. Many of the -classes required are defined in preparation for future release. Please do -not attempt to add custom table styles.</p> -</div> - </div> - - -<p>TableStyles represents a collection of style definitions for table styles -and pivot table 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="#defaultPivotStyle-instance_method" title="#defaultPivotStyle (instance method)">- (String) <strong>defaultPivotStyle</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The default pivot table style.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#defaultTableStyle-instance_method" title="#defaultTableStyle (instance method)">- (String) <strong>defaultTableStyle</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The default table style.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> - <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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)">- (TableStyles) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new TableStyles object that is a container for TableStyle -objects.</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 table styles 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::TableStyles (class)">TableStyles</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new TableStyles object that is a container for TableStyle objects</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">defaultTableStyle</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">defaultPivotStyle</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 17</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='@defaultTableStyle ivar id'>@defaultTableStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"TableStyleMedium9"</span> - <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"PivotStyleLight16"</span> - <span class='super super kw'>super</span> <span class='TableStyle constant id'>TableStyle</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - -</div> -<div id="method_missing_details" class="method_details_list"> - <h2>Dynamic Method Handling</h2> - <p class="notice super"> - This class handles dynamic methods through the <tt>method_missing</tt> method - - in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> - - </p> - -</div> - - <div id="instance_attr_details" class="attr_details"> - <h2>Instance Attribute Details</h2> - - - <span id="defaultPivotStyle=-instance_method"></span> - <span id="defaultPivotStyle-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="defaultPivotStyle-instance_method"> - - - (<tt>String</tt>) <strong>defaultPivotStyle</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The default pivot table style. The default value is ‘PivotStyleLight6’</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -12 -13 -14</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='defaultPivotStyle identifier id'>defaultPivotStyle</span> - <span class='@defaultPivotStyle ivar id'>@defaultPivotStyle</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="defaultTableStyle=-instance_method"></span> - <span id="defaultTableStyle-instance_method"></span> - <div class="method_details "> - <p class="signature " id="defaultTableStyle-instance_method"> - - - (<tt>String</tt>) <strong>defaultTableStyle</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The default table style. The default value is ‘TableStyleMedium9’</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='defaultTableStyle identifier id'>defaultTableStyle</span> - <span class='@defaultTableStyle ivar id'>@defaultTableStyle</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 table styles 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> - -<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 -36</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/stylesheet/table_styles.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='attr identifier id'>attr</span> <span class='assign 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='notop op'>!</span><span class='lbrack token'>[</span><span class='symbol val'>:defaultTableStyle</span><span class='comma token'>,</span> <span class='symbol val'>:defaultPivotStyle</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span><span class='lparen token'>(</span><span class='k identifier id'>k</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='attr identifier id'>attr</span><span class='lbrack token'>[</span><span class='symbol val'>:count</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='size identifier id'>size</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='tableStyles identifier id'>tableStyles</span><span class='lparen token'>(</span><span class='attr identifier id'>attr</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='self self kw'>self</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='table_style identifier id'>table_style</span><span class='bitor op'>|</span> <span class='table_style identifier id'>table_style</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='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:33 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 diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html deleted file mode 100644 index d4b7daf6..00000000 --- a/doc/Axlsx/Title.html +++ /dev/null @@ -1,532 +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::Title - - — 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 (T)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Title</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::Title - - - -</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::Title</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/title.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>A Title stores information about the title of a chart</p> - - - </div> -</div> -<div class="tags"> - - -</div><div id="subclasses"> - <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="SeriesTitle.html" title="Axlsx::SeriesTitle (class)">SeriesTitle</a></span></p> -</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="#cell-instance_method" title="#cell (instance method)">- (Cell) <strong>cell</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The cell that holds the text for the title.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#text-instance_method" title="#text (instance method)">- (String) <strong>text</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The text to be shown.</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)">- (Title) <strong>initialize</strong>(title = "") </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Title 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 chart title.</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::Title (class)">Title</a></span></tt>) <strong>initialize</strong>(title = "") - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Title object</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>title</span> - - - <span class='type'>(<tt>String</tt>, <tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>)</span> - - - <em class="default">(defaults to: <tt>""</tt>)</em> - - - — - <div class='inline'> -<p>The cell or string to be used for the chart’s title</p> -</div> - - </li> - -</ul> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -15 -16 -17 -18</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 15</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='title identifier id'>title</span><span class='assign token'>=</span><span class='string val'>""</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='cell identifier id'>cell</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span> <span class='if if_mod kw'>if</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='text identifier id'>text</span> <span class='assign token'>=</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> <span class='unless unless_mod kw'>unless</span> <span class='title identifier id'>title</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</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="cell=-instance_method"></span> - <span id="cell-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="cell-instance_method"> - - - (<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>) <strong>cell</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The cell that holds the text for the title. Setting this property will -automatically update the text attribute.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></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/title.rb', line 11</span> - -<span class='def def kw'>def</span> <span class='cell identifier id'>cell</span> - <span class='@cell ivar id'>@cell</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="text=-instance_method"></span> - <span id="text-instance_method"></span> - <div class="method_details "> - <p class="signature " id="text-instance_method"> - - - (<tt>String</tt>) <strong>text</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The text to be shown. Setting this property directly with a string will -remove the cell reference.</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -7 -8 -9</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.rb', line 7</span> - -<span class='def def kw'>def</span> <span class='text identifier id'>text</span> - <span class='@text ivar id'>@text</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 chart title</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"> - - -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/title.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='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:title'</span><span class='rparen token'>)</span> <span class='lbrace 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:tx'</span><span class='rparen token'>)</span> <span class='lbrace 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:strRef'</span><span class='rparen token'>)</span> <span class='lbrace 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:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='lbrack token'>[</span><span class='@cell ivar id'>@cell</span><span class='rbrack token'>]</span><span class='rparen token'>)</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:strCache'</span><span class='rparen token'>)</span> <span class='lbrace 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:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='integer val'>1</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:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> <span class='lbrace 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:v'</span><span class='comma token'>,</span> <span class='@text ivar id'>@text</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='rbrace 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 Wed Nov 30 08:46:33 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 diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html deleted file mode 100644 index 388b1e26..00000000 --- a/doc/Axlsx/TwoCellAnchor.html +++ /dev/null @@ -1,948 +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::TwoCellAnchor - - — 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 (T)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">TwoCellAnchor</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::TwoCellAnchor - - - -</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::TwoCellAnchor</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/two_cell_anchor.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 drawings and charts is Worksheet#add_chart. -Anchors are specified by the :start_at and :end_at options to that method.</p> -</div> - </div> - - -<p>This class details the anchor points for drawings.</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> - - </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="#drawing-instance_method" title="#drawing (instance method)">- (Drawing) <strong>drawing</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The drawing that holds this anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#from-instance_method" title="#from (instance method)">- (Marker) <strong>from</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A marker that defines the from cell anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#object-instance_method" title="#object (instance method)">- (Pic, GraphicFrame) <strong>object</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The object this anchor hosts.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#to-instance_method" title="#to (instance method)">- (Marker) <strong>to</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A marker that returns the to cell anchor.</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Chart) <strong>add_chart</strong>(chart_type, options) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a graphic frame and chart object associated with this anchor.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this anchor in the drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (TwoCellAnchor) <strong>initialize</strong>(drawing, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame’s chart.</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 two cell anchor.</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::TwoCellAnchor (class)">TwoCellAnchor</a></span></tt>) <strong>initialize</strong>(drawing, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>the chart_type parameter will be replaced with object in v. 2.0.0</p> -</div> - </div> - - -<p>Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame’s chart. That means that you can do -stuff like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>drawing</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> - - - - </li> - - <li> - - <span class='name'>chart_type</span> - - - <span class='type'>(<tt>Class</tt>)</span> - - - - — - <div class='inline'> -<p>This is passed to the graphic frame for instantiation. must be Chart or a -subclass of Chart</p> -</div> - - </li> - - <li> - - <span class='name'>object</span> - - - <span class='type'></span> - - - - — - <div class='inline'> -<p>The object this anchor holds.</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">start_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the col, row to start at</p> -</div> - </li> - - <li> - <span class="name">end_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>the col, row to end at</p> -</div> - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40 -41 -42</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='drawing identifier id'>drawing</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='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span> - <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@from ivar id'>@from</span><span class='comma token'>,</span> <span class='@to ivar id'>@to</span> <span class='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:col</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='symbol val'>:row=</span><span class='gt op'>></span><span class='integer val'>10</span><span class='rparen token'>)</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=""></span> - <span id="drawing-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="drawing-instance_method"> - - - (<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>drawing</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The drawing that holds this anchor</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> - <span class='@drawing ivar id'>@drawing</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="from-instance_method"></span> - <div class="method_details "> - <p class="signature " id="from-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>from</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A marker that defines the from cell anchor. The default from column and row -are 0 and 0 respectively</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </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/drawing/two_cell_anchor.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='from identifier id'>from</span> - <span class='@from ivar id'>@from</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="object-instance_method"></span> - <div class="method_details "> - <p class="signature " id="object-instance_method"> - - - (<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>, <tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>) <strong>object</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The object this anchor hosts</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></tt>, <tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -21 -22 -23</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 21</span> - -<span class='def def kw'>def</span> <span class='object identifier id'>object</span> - <span class='@object ivar id'>@object</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="to-instance_method"></span> - <div class="method_details "> - <p class="signature " id="to-instance_method"> - - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>to</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>A marker that returns the to cell anchor. The default to column and row are -5 and 10 respectively</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> - - - - </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/drawing/two_cell_anchor.rb', line 12</span> - -<span class='def def kw'>def</span> <span class='to identifier id'>to</span> - <span class='@to ivar id'>@to</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="add_chart-instance_method"> - - - (<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>) <strong>add_chart</strong>(chart_type, options) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a graphic frame and chart object associated with this anchor</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -46 -47 -48 -49</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 46</span> - -<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='GraphicFrame constant id'>GraphicFrame</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@object ivar id'>@object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this anchor in the drawing</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"> - - -53 -54 -55</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 53</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@drawing ivar id'>@drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong>(xml) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the two cell anchor</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"> - - -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 59</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='comment val'>#build it for now, break it down later!</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'>'xdr:twoCellAnchor'</span><span class='rparen token'>)</span> <span class='lbrace 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'>'xdr:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='from identifier id'>from</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='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'>'xdr:to'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='to identifier id'>to</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='@object ivar id'>@object</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='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'>'xdr:clientData'</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 Wed Nov 30 08:46:24 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 diff --git a/doc/Axlsx/ValAxis.html b/doc/Axlsx/ValAxis.html deleted file mode 100644 index 4096a451..00000000 --- a/doc/Axlsx/ValAxis.html +++ /dev/null @@ -1,527 +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::ValAxis - - — 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 (V)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">ValAxis</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::ValAxis - - - -</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::ValAxis</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/val_axis.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>the ValAxis class defines a chart value axis.</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="#crossBetween-instance_method" title="#crossBetween (instance method)">- (Symbol) <strong>crossBetween</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>This element specifies how the value axis crosses the category axis.</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)">- (ValAxis) <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 ValAxis 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 value 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::ValAxis (class)">ValAxis</a></span></tt>) <strong>initialize</strong>(axId, crossAx, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new ValAxis 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">crossesBetween</span> - <span class="type">(<tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -17 -18 -19 -20</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 17</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='self self kw'>self</span><span class='dot token'>.</span><span class='crossBetween identifier id'>crossBetween</span> <span class='assign token'>=</span> <span class='symbol val'>:between</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='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="crossBetween=-instance_method"></span> - <span id="crossBetween-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="crossBetween-instance_method"> - - - (<tt>Symbol</tt>) <strong>crossBetween</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>This element specifies how the value axis crosses the category axis. must -be one of [:between, :midCat]</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"> - - -8 -9 -10</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 8</span> - -<span class='def def kw'>def</span> <span class='crossBetween identifier id'>crossBetween</span> - <span class='@crossBetween ivar id'>@crossBetween</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 value 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"> - - -27 -28 -29 -30 -31 -32</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis.rb', line 27</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:valAx'</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:crossBetween'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@crossBetween ivar id'>@crossBetween</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 Wed Nov 30 08:46:22 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 diff --git a/doc/Axlsx/ValAxisData.html b/doc/Axlsx/ValAxisData.html deleted file mode 100644 index cbc2210f..00000000 --- a/doc/Axlsx/ValAxisData.html +++ /dev/null @@ -1,317 +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::ValAxisData - - — 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 (V)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">ValAxisData</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::ValAxisData - - - -</h1> - -<dl class="box"> - - <dt class="r1">Inherits:</dt> - <dd class="r1"> - <span class="inheritName"><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></span> - - <ul class="fullTree"> - <li>Object</li> - - <li class="next"><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></li> - - <li class="next"><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></li> - - <li class="next">Axlsx::ValAxisData</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/val_axis_data.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The ValAxisData class manages the values for a chart value series.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - - - - - - - - - - - - - - - - - - <h2>Instance Attribute Summary</h2> - - <h3 class="inherited">Attributes inherited from <span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></h3> - <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#allowed_types-instance_method" title="Axlsx::SimpleTypedList#allowed_types (method)">allowed_types</a></span>, <span class='object_link'><a href="SimpleTypedList.html#locked_at-instance_method" title="Axlsx::SimpleTypedList#locked_at (method)">locked_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#serialize_as-instance_method" title="Axlsx::SimpleTypedList#serialize_as (method)">serialize_as</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="#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 value axis data.</p> -</div></span> - -</li> - - - </ul> - - - - - - - - - - - <h3 class="inherited">Methods inherited from <span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></h3> - <p class="inherited"><span class='object_link'><a href="CatAxisData.html#initialize-instance_method" title="Axlsx::CatAxisData#initialize (method)">#initialize</a></span></p> - - - - - - <div id="constructor_details" class="method_details_list"> - <h2>Constructor Details</h2> - - <p class="notice">This class inherits a constructor from <span class='object_link'><a href="CatAxisData.html#initialize-instance_method" title="Axlsx::CatAxisData#initialize (method)">Axlsx::CatAxisData</a></span></p> - -</div> -<div id="method_missing_details" class="method_details_list"> - <h2>Dynamic Method Handling</h2> - <p class="notice super"> - This class handles dynamic methods through the <tt>method_missing</tt> method - - in the class <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">Axlsx::SimpleTypedList</a></span> - - </p> - -</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 value axis data</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"> - - -8 -9 -10 -11 -12 -13 -14 -15 -16 -17 -18 -19 -20 -21 -22 -23 -24</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/val_axis_data.rb', line 8</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:val'</span><span class='rparen token'>)</span> <span class='lbrace 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:numRef'</span><span class='rparen token'>)</span> <span class='lbrace 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:f'</span><span class='comma token'>,</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='cell_range identifier id'>cell_range</span><span class='lparen token'>(</span><span class='@list ivar id'>@list</span><span class='rparen token'>)</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:numCache'</span><span class='rparen token'>)</span> <span class='lbrace 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:formatCode'</span><span class='comma token'>,</span> <span class='string val'>'General'</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:ptCount'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> - <span class='v identifier id'>v</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Cell constant id'>Cell</span><span class='rparen token'>)</span> <span class='question op'>?</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='item identifier id'>item</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:pt'</span><span class='comma token'>,</span> <span class='symbol val'>:idx=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='rparen token'>)</span> <span class='lbrace 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:v'</span><span class='comma token'>,</span> <span class='v identifier id'>v</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='rbrace 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 Wed Nov 30 08:46:36 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 diff --git a/doc/Axlsx/View3D.html b/doc/Axlsx/View3D.html deleted file mode 100644 index 324478c2..00000000 --- a/doc/Axlsx/View3D.html +++ /dev/null @@ -1,952 +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::View3D - - — 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 (V)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">View3D</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::View3D - - - -</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::View3D</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/drawing/view_3D.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>3D attributes for a chart.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="H_PERCENT_REGEX-constant" class="">H_PERCENT_REGEX = - <div class="docstring"> - <div class="discussion"> - -<p>Validation for hPercent</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='regexp val'>/0*(([5-9])|([1-9][0-9])|([1-4][0-9][0-9])|500)%/</span> -</pre></dd> - - <dt id="DEPTH_PERCENT_REGEX-constant" class="">DEPTH_PERCENT_REGEX = - <div class="docstring"> - <div class="discussion"> - -<p>validation for depthPercent</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='regexp val'>/0*(([2-9][0-9])|([1-9][0-9][0-9])|(1[0-9][0-9][0-9])|2000)%/</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="#depthPercent-instance_method" title="#depthPercent (instance method)">- (String) <strong>depthPercent</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>depth or chart as % of chart width must be between 20% and 2000%.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#hPercent-instance_method" title="#hPercent (instance method)">- (String) <strong>hPercent</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>height of chart as % of chart must be between 5% and 500%.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#perspective-instance_method" title="#perspective (instance method)">- (Integer) <strong>perspective</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>field of view angle.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rAngAx-instance_method" title="#rAngAx (instance method)">- (Boolean) <strong>rAngAx</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Chart axis are at right angles.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rotX-instance_method" title="#rotX (instance method)">- (Integer) <strong>rotX</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>x rotation for the chart must be between -90 and 90.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rotY-instance_method" title="#rotY (instance method)">- (Integer) <strong>rotY</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>y rotation for the chart must be between 0 and 360.</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)">- (View3D) <strong>initialize</strong>(options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new View3D for charts.</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 view3D properties.</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::View3D (class)">View3D</a></span></tt>) <strong>initialize</strong>(options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new View3D for charts</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">rotX</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">hPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rotY</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">depthPercent</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">rAngAx</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">perspective</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -46 -47 -48 -49 -50 -51</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 46</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='@rotX ivar id'>@rotX</span><span class='comma token'>,</span> <span class='@hPercent ivar id'>@hPercent</span><span class='comma token'>,</span> <span class='@rotY ivar id'>@rotY</span><span class='comma token'>,</span> <span class='@depthPercent ivar id'>@depthPercent</span><span class='comma token'>,</span> <span class='@rAngAx ivar id'>@rAngAx</span><span class='comma token'>,</span> <span class='@perspective ivar id'>@perspective</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='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</span><span class='comma token'>,</span> <span class='nil nil kw'>nil</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="depthPercent=-instance_method"></span> - <span id="depthPercent-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="depthPercent-instance_method"> - - - (<tt>String</tt>) <strong>depthPercent</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>depth or chart as % of chart width must be between 20% and 2000%</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -29 -30 -31</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 29</span> - -<span class='def def kw'>def</span> <span class='depthPercent identifier id'>depthPercent</span> - <span class='@depthPercent ivar id'>@depthPercent</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="hPercent=-instance_method"></span> - <span id="hPercent-instance_method"></span> - <div class="method_details "> - <p class="signature " id="hPercent-instance_method"> - - - (<tt>String</tt>) <strong>hPercent</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>height of chart as % of chart must be between 5% and 500%</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -19 -20 -21</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 19</span> - -<span class='def def kw'>def</span> <span class='hPercent identifier id'>hPercent</span> - <span class='@hPercent ivar id'>@hPercent</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="perspective=-instance_method"></span> - <span id="perspective-instance_method"></span> - <div class="method_details "> - <p class="signature " id="perspective-instance_method"> - - - (<tt>Integer</tt>) <strong>perspective</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>field of view angle</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"> - - -37 -38 -39</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 37</span> - -<span class='def def kw'>def</span> <span class='perspective identifier id'>perspective</span> - <span class='@perspective ivar id'>@perspective</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="rAngAx=-instance_method"></span> - <span id="rAngAx-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rAngAx-instance_method"> - - - (<tt>Boolean</tt>) <strong>rAngAx</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Chart axis are at right angles</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"> - - -33 -34 -35</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 33</span> - -<span class='def def kw'>def</span> <span class='rAngAx identifier id'>rAngAx</span> - <span class='@rAngAx ivar id'>@rAngAx</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="rotX=-instance_method"></span> - <span id="rotX-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rotX-instance_method"> - - - (<tt>Integer</tt>) <strong>rotX</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>x rotation for the chart must be between -90 and 90</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"> - - -14 -15 -16</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 14</span> - -<span class='def def kw'>def</span> <span class='rotX identifier id'>rotX</span> - <span class='@rotX ivar id'>@rotX</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="rotY=-instance_method"></span> - <span id="rotY-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rotY-instance_method"> - - - (<tt>Integer</tt>) <strong>rotY</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>y rotation for the chart must be between 0 and 360</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"> - - -24 -25 -26</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 24</span> - -<span class='def def kw'>def</span> <span class='rotY identifier id'>rotY</span> - <span class='@rotY ivar id'>@rotY</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 view3D properties</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"> - - -74 -75 -76 -77 -78 -79 -80 -81 -82 -83</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 74</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:view3D'</span><span class='rparen token'>)</span> <span class='lbrace 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:rotX'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rotX ivar id'>@rotX</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rotX ivar id'>@rotX</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:hPercent'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@hPercent ivar id'>@hPercent</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@hPercent ivar id'>@hPercent</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:rotY'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rotY ivar id'>@rotY</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rotY ivar id'>@rotY</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:depthPercent'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@depthPercent ivar id'>@depthPercent</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@depthPercent ivar id'>@depthPercent</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:rAngAx'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@rAngAx ivar id'>@rAngAx</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@rAngAx ivar id'>@rAngAx</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:perspective'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='@perspective ivar id'>@perspective</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@perspective ivar id'>@perspective</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</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:29 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 diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html deleted file mode 100644 index 915b139b..00000000 --- a/doc/Axlsx/Workbook.html +++ /dev/null @@ -1,1472 +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::Workbook - - — 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 (W)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Workbook</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::Workbook - - - -</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::Workbook</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/workbook/workbook.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Workbook class is an xlsx workbook that manages worksheets, charts, -drawings and styles. The following parts of the Office Open XML spreadsheet -specification are not implimented in this version.</p> - -<pre class="code"><span class='bookViews identifier id'>bookViews</span> -<span class='calcPr identifier id'>calcPr</span> -<span class='customWorkbookViews identifier id'>customWorkbookViews</span> -<span class='definedNames identifier id'>definedNames</span> -<span class='externalReferences identifier id'>externalReferences</span> -<span class='extLst identifier id'>extLst</span> -<span class='fileRecoveryPr identifier id'>fileRecoveryPr</span> -<span class='fileSharing identifier id'>fileSharing</span> -<span class='fileVersion identifier id'>fileVersion</span> -<span class='functionGroups identifier id'>functionGroups</span> -<span class='oleSize identifier id'>oleSize</span> -<span class='pivotCaches identifier id'>pivotCaches</span> -<span class='smartTagPr identifier id'>smartTagPr</span> -<span class='smartTagTypes identifier id'>smartTagTypes</span> -<span class='webPublishing identifier id'>webPublishing</span> -<span class='webPublishObjects identifier id'>webPublishObjects</span> -<span class='workbookProtection identifier id'>workbookProtection</span> -<span class='workbookPr identifier id'>workbookPr</span><span class='mult op'>*</span> - -<span class='mult op'>*</span><span class='workbookPr identifier id'>workbookPr</span> <span class='is identifier id'>is</span> <span class='only identifier id'>only</span> <span class='supported identifier id'>supported</span> <span class='to identifier id'>to</span> <span class='the identifier id'>the</span> <span class='extend identifier id'>extend</span> <span class='of identifier id'>of</span> <span class='date1904 identifier id'>date1904</span> -</pre> - - - </div> -</div> -<div class="tags"> - - -</div> - <h2>Constant Summary</h2> - - <dl class="constants"> - - <dt id="date1904-classvariable" class="">@@date1904 = - <div class="docstring"> - <div class="discussion"> - -<p>Indicates if the epoc date for serialization should be 1904. If false, 1900 -is used.</p> - - - </div> -</div> -<div class="tags"> - - -</div> - </dt> - <dd><pre class="code"><span class='false false kw'>false</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="#charts-instance_method" title="#charts (instance method)">- (SimpleTypedList) <strong>charts</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A colllection of charts associated with this workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#drawings-instance_method" title="#drawings (instance method)">- (SimpleTypedList) <strong>drawings</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A colllection of drawings associated with this workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#images-instance_method" title="#images (instance method)">- (SimpleTypedList) <strong>images</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A colllection of images associated with this workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#worksheets-instance_method" title="#worksheets (instance method)">- (SimpleTypedList) <strong>worksheets</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>A collection of worksheets associated with this workbook.</p> -</div></span> - -</li> - - - </ul> - - - - - - <h2> - Class Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> - - <ul class="summary"> - - <li class="public "> - <span class="summary_signature"> - - <a href="#date1904-class_method" title="date1904 (class method)">+ (Boolean) <strong>date1904</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>retrieves the date1904 attribute.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#date1904%3D-class_method" title="date1904= (class method)">+ (Boolean) <strong>date1904=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Sets the date1904 attribute to the provided boolean.</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="#add_worksheet-instance_method" title="#add_worksheet (instance method)">- (Worksheet) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a worksheet to this workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#date1904-instance_method" title="#date1904 (instance method)">- (Boolean) <strong>date1904</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Instance level access to the class variable 1904.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#date1904%3D-instance_method" title="#date1904= (instance method)">- (Object) <strong>date1904=</strong>(v) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>see @date1904.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Workbook) <strong>initialize</strong>(options = {}) {|_self| ... }</a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new Workbook.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The workbook relationships.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#styles-instance_method" title="#styles (instance method)">- (Styles) <strong>styles</strong> {|@styles| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The styles associated with this workbook.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the workbook document.</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::Workbook (class)">Workbook</a></span></tt>) <strong>initialize</strong>(options = {}) {|_self| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Creates a new Workbook</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">date1904</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>_self</tt>)</span> - - - - </li> - -</ul> -<h3>Yield Parameters:</h3> -<ul class="yieldparam"> - - <li> - - <span class='name'>_self</span> - - - <span class='type'>(<tt><span class='object_link'><a href="" title="Axlsx::Workbook (class)">Axlsx::Workbook</a></span></tt>)</span> - - - - — - <div class='inline'> -<p>the object that the method was called on</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -77 -78 -79 -80 -81 -82 -83 -84 -85</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 77</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='@styles ivar id'>@styles</span> <span class='assign token'>=</span> <span class='Styles constant id'>Styles</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='@worksheets ivar id'>@worksheets</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='Worksheet constant id'>Worksheet</span> - <span class='@drawings ivar id'>@drawings</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='Drawing constant id'>Drawing</span> - <span class='@charts ivar id'>@charts</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='Chart constant id'>Chart</span> - <span class='@images ivar id'>@images</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='Pic constant id'>Pic</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:date1904</span><span class='rbrack 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'>:date1904</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> - <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</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=""></span> - <span id="charts-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="charts-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>charts</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage charts is Worksheet#add_chart</p> -</div> - </div> - - -<p>A colllection of charts associated with this workbook</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> - - - - </li> - -</ul> - - <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)">Axlsx::Worksheet#add_chart</a></span></li> - - <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -45 -46 -47</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 45</span> - -<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> - <span class='@charts ivar id'>@charts</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="drawings-instance_method"></span> - <div class="method_details "> - <p class="signature " id="drawings-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>drawings</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings is Worksheet#add_chart</p> -</div> - </div> - - -<p>A colllection of drawings associated with this workbook</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> - - - - </li> - -</ul> - - <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)">Axlsx::Worksheet#add_chart</a></span></li> - - <li><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></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/workbook/workbook.rb', line 59</span> - -<span class='def def kw'>def</span> <span class='drawings identifier id'>drawings</span> - <span class='@drawings ivar id'>@drawings</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="images-instance_method"></span> - <div class="method_details "> - <p class="signature " id="images-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>images</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage images is Worksheet#add_image</p> -</div> - </div> - - -<p>A colllection of images associated with this workbook</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Axlsx::Worksheet#add_image</a></span></li> - - <li><span class='object_link'><a href="Pic.html" title="Axlsx::Pic (class)">Pic</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -52 -53 -54</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 52</span> - -<span class='def def kw'>def</span> <span class='images identifier id'>images</span> - <span class='@images ivar id'>@images</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="worksheets-instance_method"></span> - <div class="method_details "> - <p class="signature " id="worksheets-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>worksheets</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage worksheets is add_worksheet</p> -</div> - </div> - - -<p>A collection of worksheets associated with this workbook.</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">#add_worksheet</a></span></li> - - <li><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Axlsx::Worksheet</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -38 -39 -40</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 38</span> - -<span class='def def kw'>def</span> <span class='worksheets identifier id'>worksheets</span> - <span class='@worksheets ivar id'>@worksheets</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - </div> - - - <div id="class_method_details" class="method_details_list"> - <h2>Class Method Details</h2> - - - <div class="method_details first"> - <p class="signature first" id="date1904-class_method"> - - + (<tt>Boolean</tt>) <strong>date1904</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>retrieves the date1904 attribute</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"> - - -100</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 100</span> - -<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="date1904=-class_method"> - - + (<tt>Boolean</tt>) <strong>date1904=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Sets the date1904 attribute to the provided boolean</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"> - - -96</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 96</span> - -<span class='def def kw'>def</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='assign token'>=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</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="add_worksheet-instance_method"> - - - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>add_worksheet</strong>(options = {}) {|worksheet| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Adds a worksheet to this workbook</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">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The name of the worksheet.</p> -</div> - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>worksheet</tt>)</span> - - - - </li> - -</ul> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#initialize-instance_method" title="Axlsx::Worksheet#initialize (method)">Axlsx::Worksheet#initialize</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -106 -107 -108 -109 -110</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 106</span> - -<span class='def def kw'>def</span> <span class='add_worksheet identifier id'>add_worksheet</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='worksheet identifier id'>worksheet</span> <span class='assign token'>=</span> <span class='Worksheet constant id'>Worksheet</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='yield yield kw'>yield</span> <span class='worksheet identifier id'>worksheet</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='worksheet identifier id'>worksheet</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="date1904-instance_method"> - - - (<tt>Boolean</tt>) <strong>date1904</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Instance level access to the class variable 1904</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"> - - -89</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 89</span> - -<span class='def def kw'>def</span> <span class='date1904 identifier id'>date1904</span><span class='lparen token'>(</span><span class='rparen token'>)</span> <span class='@@date1904 ivar id'>@@date1904</span><span class='semicolon token'>;</span> <span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="date1904=-instance_method"> - - - (<tt>Object</tt>) <strong>date1904=</strong>(v) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>see @date1904</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -92</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 92</span> - -<span class='def def kw'>def</span> <span class='date1904= identifier id'>date1904=</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='validate_boolean identifier id'>validate_boolean</span> <span class='v identifier id'>v</span><span class='semicolon token'>;</span> <span class='@@date1904 ivar id'>@@date1904</span> <span class='assign token'>=</span> <span class='v identifier id'>v</span> <span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="relationships-instance_method"> - - - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The workbook relationships. This is managed automatically by the workbook</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -114 -115 -116 -117 -118 -119 -120 -121</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 114</span> - -<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> - <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='@worksheets ivar id'>@worksheets</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='sheet identifier id'>sheet</span><span class='bitor op'>|</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='WORKSHEET_R constant id'>WORKSHEET_R</span><span class='comma token'>,</span> <span class='WORKSHEET_PN constant id'>WORKSHEET_PN</span> <span class='mod op'>%</span> <span class='lparen token'>(</span><span class='r identifier id'>r</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='STYLES_R constant id'>STYLES_R</span><span class='comma token'>,</span> <span class='STYLES_PN constant id'>STYLES_PN</span><span class='rparen token'>)</span> - <span class='r identifier id'>r</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="styles-instance_method"> - - - (<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>) <strong>styles</strong> {|@styles| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is Styles#add_style</p> -</div> - </div> - - -<p>The styles associated with this workbook</p> - - - </div> -</div> -<div class="tags"> - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>@styles</tt>)</span> - - - - </li> - -</ul> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Styles.html" title="Axlsx::Styles (class)">Styles</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li>Style#add_style</li> - - <li>Style</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -66 -67 -68 -69</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 66</span> - -<span class='def def kw'>def</span> <span class='styles identifier id'>styles</span> - <span class='yield yield kw'>yield</span> <span class='@styles ivar id'>@styles</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='@styles ivar id'>@styles</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the workbook document</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136 -137 -138</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 125</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='rparen token'>)</span> - <span class='add_worksheet identifier id'>add_worksheet</span> <span class='unless unless_mod kw'>unless</span> <span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='workbookPr identifier id'>workbookPr</span><span class='lparen token'>(</span><span class='symbol val'>:date1904=</span><span class='gt op'>></span><span class='@@date1904 ivar id'>@@date1904</span><span class='rparen token'>)</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheets identifier id'>sheets</span> <span class='lbrace token'>{</span> - <span class='@worksheets ivar id'>@worksheets</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='sheet identifier id'>sheet</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheet identifier id'>sheet</span><span class='lparen token'>(</span><span class='symbol val'>:name=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='comma token'>,</span> <span class='symbol val'>:sheetId=</span><span class='gt op'>></span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='comma token'>,</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='sheet identifier id'>sheet</span><span class='dot token'>.</span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='symbol val'>:indent=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen 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 diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html deleted file mode 100644 index 39bd418b..00000000 --- a/doc/Axlsx/Worksheet.html +++ /dev/null @@ -1,2386 +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::Worksheet - - — 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 (W)</a> » - <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> - » - <span class="title">Worksheet</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::Worksheet - - - -</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::Worksheet</li> - - </ul> - <a href="#" class="inheritanceTree">show all</a> - - </dd> - - - - - - - - - - <dt class="r2 last">Defined in:</dt> - <dd class="r2 last">lib/axlsx/workbook/worksheet/worksheet.rb</dd> - -</dl> -<div class="clear"></div> - -<h2>Overview</h2><div class="docstring"> - <div class="discussion"> - -<p>The Worksheet class represents a worksheet in the workbook.</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="#auto_fit_data-instance_method" title="#auto_fit_data (instance method)">- (Array) <strong>auto_fit_data</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>An array of content based calculated column widths.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#name-instance_method" title="#name (instance method)">- (String) <strong>name</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The name of the worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rows-instance_method" title="#rows (instance method)">- (SimpleTypedList) <strong>rows</strong> </a> - - - - </span> - - - <span class="note title readonly">readonly</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The rows in this worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#workbook-instance_method" title="#workbook (instance method)">- (Workbook) <strong>workbook</strong> </a> - - - - </span> - - - - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The workbook that owns this worksheet.</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) {|chart| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a chart to this worksheets drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) {|image| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a media item to the worksheets drawing.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#add_row-instance_method" title="#add_row (instance method)">- (Row) <strong>add_row</strong>(values = [], options = {}) {|@rows.last| ... }</a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Adds a row to the worksheet and updates auto fit data.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#auto_width-instance_method" title="#auto_width (instance method)">- (Float) <strong>auto_width</strong>(col) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Determines the proper width for a column based on content.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#col_style-instance_method" title="#col_style (instance method)">- (Object) <strong>col_style</strong>(index, style, options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Set the style for cells in a specific column.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#cols-instance_method" title="#cols (instance method)">- (Object) <strong>cols</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>returns the sheet data as columnw.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#drawing-instance_method" title="#drawing (instance method)">- (Drawing) <strong>drawing</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The drawing associated with this worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The index of this worksheet in the owning Workbook’s worksheets list.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Worksheet) <strong>initialize</strong>(wb, options = {}) </a> - - - - </span> - - <span class="note title constructor">constructor</span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Creates a new worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The part name of this worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The worksheet relationships.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The relationship part name of this worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>The relationship Id of thiw worksheet.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#row_style-instance_method" title="#row_style (instance method)">- (Object) <strong>row_style</strong>(index, style, options = {}) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Set the style for cells in a specific row.</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> </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Serializes the worksheet document.</p> -</div></span> - -</li> - - - <li class="public "> - <span class="summary_signature"> - - <a href="#update_auto_fit_data-instance_method" title="#update_auto_fit_data (instance method)">- (Array) <strong>update_auto_fit_data</strong>(cells) </a> - - - - </span> - - - - - - - - - <span class="summary_desc"><div class='inline'> -<p>Updates auto fit data.</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::Worksheet (class)">Worksheet</a></span></tt>) <strong>initialize</strong>(wb, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>the recommended way to manage worksheets is Workbook#add_worksheet</p> -</div> - </div> - - -<p>Creates a new worksheet.</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">name</span> - <span class="type">(<tt>String</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>The name of this sheet.</p> -</div> - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Workbook.html#add_worksheet-instance_method" title="Axlsx::Workbook#add_worksheet (method)">Axlsx::Workbook#add_worksheet</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -34 -35 -36 -37 -38 -39 -40 -41 -42 -43</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 34</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='wb identifier id'>wb</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='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='nil nil kw'>nil</span> - <span class='@rows ivar id'>@rows</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='Row constant id'>Row</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span> <span class='assign token'>=</span> <span class='wb identifier id'>wb</span> - <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@auto_fit_data ivar id'>@auto_fit_data</span> <span class='assign token'>=</span> <span class='lbrack token'>[</span><span class='rbrack token'>]</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='name identifier id'>name</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:name</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='string val'>"Sheet"</span> <span class='plus op'>+</span> <span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> - <span class='@magick_draw ivar id'>@magick_draw</span> <span class='assign token'>=</span> <span class='Magick constant id'>Magick</span><span class='colon2 op'>::</span><span class='Draw constant id'>Draw</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='@cols ivar id'>@cols</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='Cell constant id'>Cell</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=""></span> - <span id="auto_fit_data-instance_method"></span> - <div class="method_details first"> - <p class="signature first" id="auto_fit_data-instance_method"> - - - (<tt>Array</tt>) <strong>auto_fit_data</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>a single auto fit data item is a hash with :longest => [String] and -:sz=> [Integer] members.</p> -</div> - </div> - - -<p>An array of content based calculated column widths.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - — - <div class='inline'> -<p>of Hash</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -25 -26 -27</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 25</span> - -<span class='def def kw'>def</span> <span class='auto_fit_data identifier id'>auto_fit_data</span> - <span class='@auto_fit_data ivar id'>@auto_fit_data</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="name=-instance_method"></span> - <span id="name-instance_method"></span> - <div class="method_details "> - <p class="signature " id="name-instance_method"> - - - (<tt>String</tt>) <strong>name</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The name of the worksheet</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -9 -10 -11</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 9</span> - -<span class='def def kw'>def</span> <span class='name identifier id'>name</span> - <span class='@name ivar id'>@name</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id=""></span> - <span id="rows-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rows-instance_method"> - - - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>rows</strong> <span class="extras">(readonly)</span> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage rows is Worksheet#add_row</p> -</div> - </div> - - -<p>The rows in this worksheet</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> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -20 -21 -22</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 20</span> - -<span class='def def kw'>def</span> <span class='rows identifier id'>rows</span> - <span class='@rows ivar id'>@rows</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - - <span id="workbook=-instance_method"></span> - <span id="workbook-instance_method"></span> - <div class="method_details "> - <p class="signature " id="workbook-instance_method"> - - - (<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>) <strong>workbook</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The workbook that owns this worksheet</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -13 -14 -15</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 13</span> - -<span class='def def kw'>def</span> <span class='workbook identifier id'>workbook</span> - <span class='@workbook ivar id'>@workbook</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="add_chart-instance_method"> - - - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) {|chart| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>each chart type also specifies additional options</p> -</div> - </div> - - -<p>Adds a chart to this worksheets drawing. This is the recommended way to -create charts for your worksheet. This method wraps the complexity of -dealing with ooxml drawing, anchors, markers graphic frames chart objects -and all the other dirty details.</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>chart_type</span> - - - <span class='type'>(<tt>Class</tt>)</span> - - - - </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">start_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">end_at</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">title</span> - <span class="type">(<tt><span class='object_link'><a href="Cell.html" title="Axlsx::Cell (class)">Cell</a></span></tt>, <tt>String</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">show_legend</span> - <span class="type">(<tt>Boolean</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>chart</tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> - - <li><span class='object_link'><a href="Pie3DChart.html" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span></li> - - <li><span class='object_link'><a href="Bar3DChart.html" title="Axlsx::Bar3DChart (class)">Bar3DChart</a></span></li> - - <li><span class='object_link'><a href="Line3DChart.html" title="Axlsx::Line3DChart (class)">Line3DChart</a></span></li> - - <li>for examples</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -148 -149 -150 -151 -152</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 148</span> - -<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</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='chart identifier id'>chart</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='yield yield kw'>yield</span> <span class='chart identifier id'>chart</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='chart identifier id'>chart</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="add_image-instance_method"> - - - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) {|image| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Adds a media item to the worksheets drawing</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>media_type</span> - - - <span class='type'>(<tt>Class</tt>)</span> - - - - </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">[]</span> - <span class="type">(<tt>Object</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>unknown</p> -</div> - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>image</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -157 -158 -159 -160 -161</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 157</span> - -<span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</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='image identifier id'>image</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='add_image identifier id'>add_image</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='yield yield kw'>yield</span> <span class='image identifier id'>image</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='image identifier id'>image</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="add_row-instance_method"> - - - (<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>) <strong>add_row</strong>(values = [], options = {}) {|@rows.last| ... } - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Adds a row to the worksheet and updates auto fit data</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">values</span> - <span class="type">(<tt>Array</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">types</span> - <span class="type">(<tt>Array</tt>, <tt>Symbol</tt>)</span> - <span class="default"> - - </span> - - </li> - - <li> - <span class="name">style</span> - <span class="type">(<tt>Array</tt>, <tt>Integer</tt>)</span> - <span class="default"> - - </span> - - </li> - - </ul> - - -<h3>Yields:</h3> -<ul class="yield"> - - <li> - - - <span class='type'>(<tt>@rows.last</tt>)</span> - - - - </li> - -</ul> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Row.html" title="Axlsx::Row (class)">Row</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -86 -87 -88 -89 -90 -91</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 86</span> - -<span class='def def kw'>def</span> <span class='add_row identifier id'>add_row</span><span class='lparen token'>(</span><span class='values identifier id'>values</span><span class='assign token'>=</span><span class='lbrack token'>[</span><span class='rbrack token'>]</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='Row constant id'>Row</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='values identifier id'>values</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span> - <span class='yield yield kw'>yield</span> <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> - <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='last identifier id'>last</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="auto_width-instance_method"> - - - (<tt>Float</tt>) <strong>auto_width</strong>(col) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>From ECMA docs</p> - -<pre class="code"><span class='Column constant id'>Column</span> <span class='width identifier id'>width</span> <span class='measured identifier id'>measured</span> <span class='as identifier id'>as</span> <span class='the identifier id'>the</span> <span class='number identifier id'>number</span> <span class='of identifier id'>of</span> <span class='characters identifier id'>characters</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='maximum identifier id'>maximum</span> <span class='digit identifier id'>digit</span> <span class='width identifier id'>width</span> <span class='of identifier id'>of</span> <span class='the identifier id'>the</span> <span class='numbers identifier id'>numbers</span> <span class='integer val'>0</span> <span class='dot2 op'>..</span> <span class='integer val'>9</span> <span class='as identifier id'>as</span> -<span class='rendered identifier id'>rendered</span> <span class='in in kw'>in</span> <span class='the identifier id'>the</span> <span class='normal identifier id'>normal</span> <span class='style identifier id'>style</span><span class='string val'>'s font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines. -width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256 -</span></pre> -</div> - </div> - - -<p>Determines the proper width for a column based on content.</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>A</span> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - - — - <div class='inline'> -<p>hash of auto_fit_data</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Float</tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -232 -233 -234 -235 -236 -237 -238 -239 -240 -241 -242</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 232</span> - -<span class='def def kw'>def</span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span> - <span class='mdw identifier id'>mdw</span> <span class='assign token'>=</span> <span class='float val'>6.0</span> <span class='comment val'># maximum digit with is always 6.0 with RMagick's default font</span> - <span class='mdw_count identifier id'>mdw_count</span> <span class='assign token'>=</span> <span class='integer val'>0</span> - <span class='best_guess identifier id'>best_guess</span> <span class='assign token'>=</span> <span class='float val'>1.5</span> <span class='comment val'>#direct testing shows the results of the documented formula to be a bit too small. This is a best guess scaling</span> - <span class='font_scale identifier id'>font_scale</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='div op'>/</span> <span class='lparen token'>(</span><span class='self self kw'>self</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='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span><span class='dot token'>.</span><span class='to_f identifier id'>to_f</span> <span class='orop op'>||</span> <span class='float val'>11.0</span><span class='rparen token'>)</span> - - <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen 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='i identifier id'>i</span><span class='bitor op'>|</span> - <span class='mdw_count identifier id'>mdw_count</span> <span class='opasgn op'>+=</span><span class='integer val'>1</span> <span class='if if_mod kw'>if</span> <span class='@magick_draw ivar id'>@magick_draw</span><span class='dot token'>.</span><span class='get_type_metrics identifier id'>get_type_metrics</span><span class='lparen token'>(</span><span class='i identifier id'>i</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='width identifier id'>width</span> <span class='geq op'>>=</span> <span class='mdw identifier id'>mdw</span> - <span class='end end kw'>end</span> - <span class='lparen token'>(</span><span class='lparen token'>(</span><span class='mdw_count identifier id'>mdw_count</span> <span class='mult op'>*</span> <span class='mdw identifier id'>mdw</span> <span class='plus op'>+</span> <span class='integer val'>5</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='mdw identifier id'>mdw</span> <span class='mult op'>*</span> <span class='integer val'>256</span><span class='rparen token'>)</span> <span class='div op'>/</span> <span class='float val'>256.0</span> <span class='mult op'>*</span> <span class='best_guess identifier id'>best_guess</span> <span class='mult op'>*</span> <span class='font_scale identifier id'>font_scale</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="col_style-instance_method"> - - - (<tt>Object</tt>) <strong>col_style</strong>(index, style, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>You can also specify the style for specific columns in the call to add_row -by using an array for the :styles option</p> -</div> - </div> - - -<p>Set the style for cells in a specific column</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>index</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>the index of the column</p> -</div> - - </li> - - <li> - - <span class='name'>the</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>cellXfs index</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">row_offset</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>only cells after this column will be updated.</p> -</div> - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> - - <li>for an example</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 123</span> - -<span class='def def kw'>def</span> <span class='col_style identifier id'>col_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</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='offset identifier id'>offset</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:row_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span> - <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</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='r identifier id'>r</span><span class='bitor op'>|</span> - <span class='cells identifier id'>cells</span> <span class='assign token'>=</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> - <span class='if if kw'>if</span> <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> - <span class='cells identifier id'>cells</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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> - <span class='else else kw'>else</span> - <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> - <span class='end end kw'>end</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="cols-instance_method"> - - - (<tt>Object</tt>) <strong>cols</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>returns the sheet data as columnw</p> - - - </div> -</div> -<div class="tags"> - - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -111 -112 -113</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 111</span> - -<span class='def def kw'>def</span> <span class='cols identifier id'>cols</span> - <span class='@rows ivar id'>@rows</span><span class='dot token'>.</span><span class='transpose identifier id'>transpose</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="drawing-instance_method"> - - - (<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>) <strong>drawing</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>the recommended way to work with drawings and charts is Worksheet#add_chart</p> -</div> - </div> - - -<p>The drawing associated with this worksheet.</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Drawing.html" title="Axlsx::Drawing (class)">Drawing</a></span></tt>)</span> - - - - </li> - -</ul> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">#add_chart</a></span></li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -77 -78 -79</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 77</span> - -<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> - <span class='@drawing ivar id'>@drawing</span> <span class='orop op'>||</span> <span class='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Drawing constant id'>Drawing</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="index-instance_method"> - - - (<tt>Integer</tt>) <strong>index</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The index of this worksheet in the owning Workbook’s worksheets list.</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"> - - -69 -70 -71</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 69</span> - -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@workbook ivar id'>@workbook</span><span class='dot token'>.</span><span class='worksheets identifier id'>worksheets</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="pn-instance_method"> - - - (<tt>String</tt>) <strong>pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The part name of this worksheet</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -51 -52 -53</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 51</span> - -<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> - <span class='dstring node'>"#{WORKSHEET_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="relationships-instance_method"> - - - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The worksheet relationships. This is managed automatically by the worksheet</p> - - - </div> -</div> -<div class="tags"> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> - - - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -189 -190 -191 -192 -193</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 189</span> - -<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> - <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='DRAWING_R constant id'>DRAWING_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{@drawing.pn}"</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> - <span class='r identifier id'>r</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="rels_pn-instance_method"> - - - (<tt>String</tt>) <strong>rels_pn</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The relationship part name of this worksheet</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 57</span> - -<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> - <span class='dstring node'>"#{WORKSHEET_RELS_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="rId-instance_method"> - - - (<tt>String</tt>) <strong>rId</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>The relationship Id of thiw worksheet</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -63 -64 -65</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 63</span> - -<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> - <span class='dstring node'>"rId#{index+1}"</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="row_style-instance_method"> - - - (<tt>Object</tt>) <strong>row_style</strong>(index, style, options = {}) - - - -</p><div class="docstring"> - <div class="discussion"> - - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'> -<p>You can also specify the style in the add_row call</p> -</div> - </div> - - -<p>Set the style for cells in a specific row</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>index</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>or range of indexes in the table</p> -</div> - - </li> - - <li> - - <span class='name'>the</span> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - — - <div class='inline'> -<p>cellXfs index</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">col_offset</span> - <span class="type">(<tt>Integer</tt>)</span> - <span class="default"> - - </span> - — <div class='inline'> -<p>only cells after this column will be updated.</p> -</div> - </li> - - </ul> - - - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="#add_row-instance_method" title="Axlsx::Worksheet#add_row (method)">#add_row</a></span></li> - - <li>for an example</li> - - </ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -100 -101 -102 -103 -104 -105 -106 -107 -108</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 100</span> - -<span class='def def kw'>def</span> <span class='row_style identifier id'>row_style</span><span class='lparen token'>(</span><span class='index identifier id'>index</span><span class='comma token'>,</span> <span class='style identifier id'>style</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='offset identifier id'>offset</span> <span class='assign token'>=</span> <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='delete identifier id'>delete</span><span class='lparen token'>(</span><span class='symbol val'>:col_offset</span><span class='rparen token'>)</span> <span class='orop op'>||</span> <span class='integer val'>0</span> - <span class='rs identifier id'>rs</span> <span class='assign token'>=</span> <span class='@rows ivar id'>@rows</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> - <span class='if if kw'>if</span> <span class='rs identifier id'>rs</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Array constant id'>Array</span><span class='rparen token'>)</span> - <span class='rs identifier id'>rs</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='r identifier id'>r</span><span class='bitor op'>|</span> <span class='r identifier id'>r</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack 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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> <span class='rbrace token'>}</span> - <span class='else else kw'>else</span> - <span class='rs identifier id'>rs</span><span class='dot token'>.</span><span class='cells identifier id'>cells</span><span class='lbrack token'>[</span><span class='lparen token'>(</span><span class='offset identifier id'>offset</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</span><span class='rbrack 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='c identifier id'>c</span><span class='bitor op'>|</span> <span class='c identifier id'>c</span><span class='dot token'>.</span><span class='style identifier id'>style</span> <span class='assign token'>=</span> <span class='style identifier id'>style</span> <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="to_xml-instance_method"> - - - (<tt>String</tt>) <strong>to_xml</strong> - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Serializes the worksheet document</p> - - - </div> -</div> -<div class="tags"> - -<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"> - - -165 -166 -167 -168 -169 -170 -171 -172 -173 -174 -175 -176 -177 -178 -179 -180 -181 -182 -183 -184 -185</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 165</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> - <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='lparen token'>(</span><span class='symbol val'>:xmlns</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS constant id'>XML_NS</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:r'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_R constant id'>XML_NS_R</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='if if kw'>if</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='gt op'>></span> <span class='integer val'>0</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='cols identifier id'>cols</span> <span class='lbrace token'>{</span> - <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='col identifier id'>col</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> - <span class='min_max identifier id'>min_max</span> <span class='assign token'>=</span> <span class='index identifier id'>index</span><span class='plus op'>+</span><span class='integer val'>1</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='col identifier id'>col</span><span class='lparen token'>(</span><span class='symbol val'>:min=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:max=</span><span class='gt op'>></span><span class='min_max identifier id'>min_max</span><span class='comma token'>,</span> <span class='symbol val'>:width</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='auto_width identifier id'>auto_width</span><span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='rparen token'>)</span><span class='comma token'>,</span> <span class='symbol val'>:customWidth=</span><span class='gt op'>></span><span class='string val'>"true"</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='sheetData identifier id'>sheetData</span> <span class='lbrace token'>{</span> - <span class='@rows ivar id'>@rows</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='row identifier id'>row</span><span class='bitor op'>|</span> - <span class='row identifier id'>row</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='end end kw'>end</span> - <span class='rbrace token'>}</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span> <span class='symbol val'>:"r:id"</span><span class='assign token'>=</span><span class='gt op'>></span><span class='string val'>"rId1"</span> <span class='if if_mod kw'>if</span> <span class='@drawing ivar id'>@drawing</span> - <span class='rbrace token'>}</span> - <span class='end end kw'>end</span> - <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <div class="method_details "> - <p class="signature " id="update_auto_fit_data-instance_method"> - - - (<tt>Array</tt>) <strong>update_auto_fit_data</strong>(cells) - - - -</p><div class="docstring"> - <div class="discussion"> - -<p>Updates auto fit data. Autofit data attempts to determine the cell in a -column that has the greatest width by comparing the length of the text -multiplied by the size of the font.</p> - - - </div> -</div> -<div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - - <li> - - <span class='name'>cells</span> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - — - <div class='inline'> -<p>an array of cells</p> -</div> - - </li> - -</ul> - -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - — - <div class='inline'> -<p>of Cell objects</p> -</div> - - </li> - -</ul> - -</div><table class="source_code"> - <tr> - <td> - <pre class="lines"> - - -204 -205 -206 -207 -208 -209 -210 -211 -212 -213 -214 -215 -216 -217 -218 -219 -220 -221 -222</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 204</span> - -<span class='def def kw'>def</span> <span class='update_auto_fit_data identifier id'>update_auto_fit_data</span><span class='lparen token'>(</span><span class='cells identifier id'>cells</span><span class='rparen token'>)</span> - <span class='styles identifier id'>styles</span> <span class='assign token'>=</span> <span class='self self kw'>self</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='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='fonts identifier id'>fonts</span> <span class='assign token'>=</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='cellXfs identifier id'>cellXfs</span><span class='comma token'>,</span> <span class='styles identifier id'>styles</span><span class='dot token'>.</span><span class='fonts identifier id'>fonts</span> - <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> - - <span class='cells identifier id'>cells</span><span class='dot token'>.</span><span class='each_with_index identifier id'>each_with_index</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='item identifier id'>item</span><span class='comma token'>,</span> <span class='index identifier id'>index</span><span class='bitor op'>|</span> - <span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='orop op'>||</span> <span class='lbrace token'>{</span><span class='symbol val'>:longest=</span><span class='gt op'>></span><span class='string val'>""</span><span class='comma token'>,</span> <span class='symbol val'>:sz=</span><span class='gt op'>></span><span class='sz identifier id'>sz</span><span class='rbrace token'>}</span> - <span class='cell_xf identifier id'>cell_xf</span> <span class='assign token'>=</span> <span class='cellXfs identifier id'>cellXfs</span><span class='lbrack token'>[</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='style identifier id'>style</span><span class='rbrack token'>]</span> - <span class='font identifier id'>font</span> <span class='assign token'>=</span> <span class='fonts identifier id'>fonts</span><span class='lbrack token'>[</span><span class='cell_xf identifier id'>cell_xf</span><span class='dot token'>.</span><span class='fontId identifier id'>fontId</span> <span class='orop op'>||</span> <span class='integer val'>0</span><span class='rbrack token'>]</span> - <span class='sz identifier id'>sz</span> <span class='assign token'>=</span> <span class='font identifier id'>font</span><span class='dot token'>.</span><span class='sz identifier id'>sz</span> <span class='orop op'>||</span> <span class='sz identifier id'>sz</span> - - <span class='if if kw'>if</span> <span class='lparen token'>(</span><span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='lt op'><</span> <span class='lparen token'>(</span><span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span><span class='dot token'>.</span><span class='scan identifier id'>scan</span><span class='lparen token'>(</span><span class='regexp val'>/./</span><span class='mu identifier id'>mu</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='size identifier id'>size</span> <span class='mult op'>*</span> <span class='sz identifier id'>sz</span><span class='rparen token'>)</span> - <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:sz</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='sz identifier id'>sz</span> - <span class='col identifier id'>col</span><span class='lbrack token'>[</span><span class='symbol val'>:longest</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='item identifier id'>item</span><span class='dot token'>.</span><span class='value identifier id'>value</span><span class='dot token'>.</span><span class='to_s identifier id'>to_s</span> - <span class='end end kw'>end</span> - <span class='@auto_fit_data ivar id'>@auto_fit_data</span><span class='lbrack token'>[</span><span class='index identifier id'>index</span><span class='rbrack token'>]</span> <span class='assign token'>=</span> <span class='col identifier id'>col</span> - <span class='end end kw'>end</span> - <span class='cells identifier id'>cells</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:24 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 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 |