diff options
Diffstat (limited to 'doc/Axlsx/Workbook.html')
| -rw-r--r-- | doc/Axlsx/Workbook.html | 362 |
1 files changed, 207 insertions, 155 deletions
diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html index 69e4e8e0..ffb0522c 100644 --- a/doc/Axlsx/Workbook.html +++ b/doc/Axlsx/Workbook.html @@ -94,31 +94,33 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> - -<p>The Workbook class is an xlsx workbook that manages worksheets, charts, + <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">bookViews -calcPr -customWorkbookViews -definedNames -externalReferences -extLst -fileRecoveryPr -fileSharing -fileVersion -functionGroups -oleSize -pivotCaches -smartTagPr -smartTagTypes -webPublishing -webPublishObjects -workbookProtection -workbookPr* - -*workbookPr is only supported to the extend of date1904</pre> +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> @@ -134,9 +136,10 @@ workbookPr* <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> + <p> +Indicates if the epoc date for serialization should be 1904. If false, 1900 +is used. +</p> </div> @@ -146,7 +149,8 @@ is used.</p> </div> </dt> - <dd><pre class="code"><span class='kw'>false</span></pre></dd> + <dd><pre class="code"><span class='false false kw'>false</span> +</pre></dd> </dl> @@ -174,8 +178,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A colllection of charts associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A colllection of charts associated with this workbook. +</p> </div></span> </li> @@ -200,8 +205,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A colllection of drawings associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A colllection of drawings associated with this workbook. +</p> </div></span> </li> @@ -226,8 +232,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A colllection of images associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A colllection of images associated with this workbook. +</p> </div></span> </li> @@ -252,8 +259,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>The styles associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +The styles associated with this workbook. +</p> </div></span> </li> @@ -278,8 +286,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>A collection of worksheets associated with this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +A collection of worksheets associated with this workbook. +</p> </div></span> </li> @@ -314,8 +323,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>retrieves the date1904 attribute.</p> + <span class="summary_desc"><div class='inline'><p> +retrieves the date1904 attribute. +</p> </div></span> </li> @@ -337,8 +347,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Sets the date1904 attribute to the provided boolean.</p> + <span class="summary_desc"><div class='inline'><p> +Sets the date1904 attribute to the provided boolean. +</p> </div></span> </li> @@ -369,8 +380,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Adds a worksheet to this workbook.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a worksheet to this workbook. +</p> </div></span> </li> @@ -392,8 +404,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Instance level access to the class variable 1904.</p> + <span class="summary_desc"><div class='inline'><p> +Instance level access to the class variable 1904. +</p> </div></span> </li> @@ -415,8 +428,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>see @date1904.</p> + <span class="summary_desc"><div class='inline'><p> +see @date1904. +</p> </div></span> </li> @@ -440,8 +454,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new Workbook.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new Workbook. +</p> </div></span> </li> @@ -463,8 +478,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>The workbook relationships.</p> + <span class="summary_desc"><div class='inline'><p> +The workbook relationships. +</p> </div></span> </li> @@ -486,8 +502,9 @@ is used.</p> - <span class="summary_desc"><div class='inline'> -<p>Serializes the workbook document.</p> + <span class="summary_desc"><div class='inline'><p> +Serializes the workbook document. +</p> </div></span> </li> @@ -508,8 +525,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new Workbook</p> + <p> +Creates a new Workbook +</p> </div> @@ -530,8 +548,9 @@ is used.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -582,8 +601,9 @@ is used.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -609,15 +629,16 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 75</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</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='ivar'>@styles</span> <span class='op'>=</span> <span class='const'>Styles</span><span class='period'>.</span><span class='id new'>new</span> - <span class='ivar'>@worksheets</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Worksheet</span> - <span class='ivar'>@drawings</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Drawing</span> - <span class='ivar'>@charts</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Chart</span> - <span class='ivar'>@images</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Pic</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id date1904'>date1904</span><span class='op'>=</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:date1904</span><span class='rbracket'>]</span> <span class='kw'>unless</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:date1904</span><span class='rbracket'>]</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> -<span class='kw'>end</span></pre> +<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> @@ -643,13 +664,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage charts is Worksheet#add_chart</p> + <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> +<p> +A colllection of charts associated with this workbook +</p> </div> @@ -692,9 +715,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 45</span> -<span class='kw'>def</span> <span class='id charts'>charts</span> - <span class='ivar'>@charts</span> -<span class='kw'>end</span></pre> +<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> @@ -715,13 +739,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage drawings is Worksheet#add_chart</p> + <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> +<p> +A colllection of drawings associated with this workbook +</p> </div> @@ -764,9 +790,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 59</span> -<span class='kw'>def</span> <span class='id drawings'>drawings</span> - <span class='ivar'>@drawings</span> -<span class='kw'>end</span></pre> +<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> @@ -787,13 +814,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage images is Worksheet#add_image</p> + <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> +<p> +A colllection of images associated with this workbook +</p> </div> @@ -836,9 +865,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 52</span> -<span class='kw'>def</span> <span class='id images'>images</span> - <span class='ivar'>@images</span> -<span class='kw'>end</span></pre> +<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> @@ -859,13 +889,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage styles is Styles#add_style</p> + <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> +<p> +The styles associated with this workbook +</p> </div> @@ -908,9 +940,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 66</span> -<span class='kw'>def</span> <span class='id styles'>styles</span> - <span class='ivar'>@styles</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='styles identifier id'>styles</span> + <span class='@styles ivar id'>@styles</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -931,13 +964,15 @@ is used.</p> <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>The recommended way to manage worksheets is add_worksheet</p> + <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> +<p> +A collection of worksheets associated with this workbook. +</p> </div> @@ -980,9 +1015,10 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 38</span> -<span class='kw'>def</span> <span class='id worksheets'>worksheets</span> - <span class='ivar'>@worksheets</span> -<span class='kw'>end</span></pre> +<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> @@ -1004,8 +1040,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>retrieves the date1904 attribute</p> + <p> +retrieves the date1904 attribute +</p> </div> @@ -1037,7 +1074,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 98</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id date1904'>date1904</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='cvar'>@@date1904</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<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> @@ -1052,8 +1090,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Sets the date1904 attribute to the provided boolean</p> + <p> +Sets the date1904 attribute to the provided boolean +</p> </div> @@ -1085,7 +1124,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 94</span> -<span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id date1904='>date1904=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_boolean'>validate_boolean</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='cvar'>@@date1904</span> <span class='op'>=</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<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> @@ -1106,8 +1146,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Adds a worksheet to this workbook</p> + <p> +Adds a worksheet to this workbook +</p> </div> @@ -1128,8 +1169,9 @@ is used.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -1148,8 +1190,9 @@ is used.</p> <span class="default"> </span> - — <div class='inline'> -<p>The name of the worksheet.</p> + — <div class='inline'><p> +The name of the worksheet. +</p> </div> </li> @@ -1205,11 +1248,12 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 104</span> -<span class='kw'>def</span> <span class='id add_worksheet'>add_worksheet</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 worksheet'>worksheet</span> <span class='op'>=</span> <span class='const'>Worksheet</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id worksheet'>worksheet</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='id worksheet'>worksheet</span> -<span class='kw'>end</span></pre> +<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> @@ -1224,8 +1268,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Instance level access to the class variable 1904</p> + <p> +Instance level access to the class variable 1904 +</p> </div> @@ -1257,7 +1302,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 87</span> -<span class='kw'>def</span> <span class='id date1904'>date1904</span><span class='lparen'>(</span><span class='rparen'>)</span> <span class='cvar'>@@date1904</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<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> @@ -1272,8 +1318,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>see @date1904</p> + <p> +see @date1904 +</p> </div> @@ -1292,7 +1339,8 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 90</span> -<span class='kw'>def</span> <span class='id date1904='>date1904=</span><span class='lparen'>(</span><span class='id v'>v</span><span class='rparen'>)</span> <span class='const'>Axlsx</span><span class='op'>::</span><span class='id validate_boolean'>validate_boolean</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='cvar'>@@date1904</span> <span class='op'>=</span> <span class='id v'>v</span><span class='semicolon'>;</span> <span class='kw'>end</span></pre> +<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> @@ -1307,8 +1355,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The workbook relationships. This is managed automatically by the workbook</p> + <p> +The workbook relationships. This is managed automatically by the workbook +</p> </div> @@ -1347,14 +1396,15 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 112</span> -<span class='kw'>def</span> <span class='id relationships'>relationships</span> - <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Relationships</span><span class='period'>.</span><span class='id new'>new</span> - <span class='ivar'>@worksheets</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='op'>|</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>WORKSHEET_R</span><span class='comma'>,</span> <span class='const'>WORKSHEET_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id r'>r</span><span class='period'>.</span><span class='id size'>size</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>STYLES_R</span><span class='comma'>,</span> <span class='const'>STYLES_PN</span><span class='rparen'>)</span> - <span class='id r'>r</span> -<span class='kw'>end</span></pre> +<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> @@ -1369,8 +1419,9 @@ is used.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Serializes the workbook document</p> + <p> +Serializes the workbook document +</p> </div> @@ -1415,20 +1466,21 @@ is used.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/workbook.rb', line 123</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='rparen'>)</span> - <span class='id add_worksheet'>add_worksheet</span> <span class='kw'>unless</span> <span class='id worksheets'>worksheets</span><span class='period'>.</span><span class='id size'>size</span> <span class='op'>></span> <span class='int'>0</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='lparen'>(</span><span class='symbol'>:xmlns</span> <span class='op'>=></span> <span class='const'>XML_NS</span><span class='comma'>,</span> <span class='symbol'>:xmlns:r</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_R</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id workbookPr'>workbookPr</span><span class='lparen'>(</span><span class='symbol'>:date1904</span><span class='op'>=></span><span class='cvar'>@@date1904</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id sheets'>sheets</span> <span class='lbrace'>{</span> - <span class='ivar'>@worksheets</span><span class='period'>.</span><span class='id each_with_index'>each_with_index</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id sheet'>sheet</span><span class='comma'>,</span> <span class='id index'>index</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id sheet'>sheet</span><span class='lparen'>(</span><span class='symbol'>:name</span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id name'>name</span><span class='comma'>,</span> <span class='symbol'>:sheetId</span><span class='op'>=></span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='comma'>,</span> <span class='symbol'>:r:id</span><span class='tstring_end'>"</span></span><span class='op'>=></span><span class='id sheet'>sheet</span><span class='period'>.</span><span class='id rId'>rId</span><span class='rparen'>)</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='symbol'>:indent</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<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> @@ -1439,9 +1491,9 @@ is used.</p> </div> <div id="footer"> - Generated on Sat Nov 26 13:16:38 2011 by + Generated on Sun Nov 27 18:05:08 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> |