diff options
| author | Randy Morgan <[email protected]> | 2011-11-23 12:28:10 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-23 12:28:10 +0900 |
| commit | 6739c249e7bf3cf7d2132b2aa49b6faf6bebec29 (patch) | |
| tree | c68e1527212c3665464debeebd2d97c127b0887e /doc/Axlsx | |
| parent | 099a1d5a7824b7a6392bfe2f124ebeaf9d8122db (diff) | |
| download | caxlsx-6739c249e7bf3cf7d2132b2aa49b6faf6bebec29.tar.gz caxlsx-6739c249e7bf3cf7d2132b2aa49b6faf6bebec29.zip | |
-refactoring chart position and axis data/category for chart.
-additional specs and documentation improvements.
Diffstat (limited to 'doc/Axlsx')
55 files changed, 2114 insertions, 1255 deletions
diff --git a/doc/Axlsx/App.html b/doc/Axlsx/App.html index ead90508..fcbd72ee 100644 --- a/doc/Axlsx/App.html +++ b/doc/Axlsx/App.html @@ -2631,7 +2631,7 @@ The document as a string </div> <div id="footer"> - Generated on Tue Nov 22 23:52:43 2011 by + Generated on Wed Nov 23 12:24:05 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> diff --git a/doc/Axlsx/Axis.html b/doc/Axlsx/Axis.html index 7f4d1e0b..4ae315c3 100644 --- a/doc/Axlsx/Axis.html +++ b/doc/Axlsx/Axis.html @@ -95,7 +95,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p> -the access class defines common properties and values for chart axis +the access class defines common properties and values for a chart axis. </p> @@ -242,7 +242,7 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, <span class="summary_desc"><div class='inline'><p> -The number format format code for this axis. +The number format format code for this axis default :General. </p> </div></span> @@ -487,6 +487,25 @@ a customizable set of options </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> @@ -494,7 +513,6 @@ a customizable set of options <pre class="lines"> -44 45 46 47 @@ -507,20 +525,21 @@ a customizable set of options 54 55 56 -57</pre> +57 +58</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 44</span> + <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='@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='@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='@formatCode ivar id'>@formatCode</span> <span class='assign token'>=</span> <span class='string val'>""</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> @@ -550,7 +569,7 @@ a customizable set of options </p><div class="docstring"> <div class="discussion"> <p> -the id of the axis +the id of the axis. </p> @@ -578,12 +597,12 @@ the id of the axis <pre class="lines"> +7 8 -9 -10</pre> +9</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 8</span> + <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> @@ -692,12 +711,12 @@ The perpendicular axis <pre class="lines"> +11 12 -13 -14</pre> +13</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 12</span> + <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> @@ -779,7 +798,7 @@ specifies how the perpendicular axis is crossed must be one of [:autoZero, </p><div class="docstring"> <div class="discussion"> <p> -The number format format code for this axis +The number format format code for this axis default :General </p> @@ -858,6 +877,13 @@ The scaling of the axis </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> @@ -1003,7 +1029,6 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -67 68 69 70 @@ -1012,10 +1037,11 @@ The document builder instance this objects xml will be added to. 73 74 75 -76</pre> +76 +77</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 67</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/axis.rb', line 68</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> @@ -1038,7 +1064,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:53 2011 by + Generated on Wed Nov 23 12:24:03 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.3 (ruby-1.8.7). </div> diff --git a/doc/Axlsx/Bar3DChart.html b/doc/Axlsx/Bar3DChart.html index 8cb43ac0..fcee1a86 100644 --- a/doc/Axlsx/Bar3DChart.html +++ b/doc/Axlsx/Bar3DChart.html @@ -106,54 +106,18 @@ that you can add to your worksheet. </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 two charts in a single sheet.</span> -<span class='comment val'># The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.</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='Bar3DChart constant id'>Bar3DChart</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> - -<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 chart uses the data below"</span><span class='rbrack token'>]</span> -<span class='title_row identifier id'>title_row</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='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='label_row identifier id'>label_row</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='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='data_row identifier id'>data_row</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='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='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='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</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'>11</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</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'>16</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='title_row identifier id'>title_row</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='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='data_row identifier id'>data_row</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='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</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='label_row identifier id'>label_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</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_pie_3d_chart.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>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> + <li>for an example</li> + </ul> </div> @@ -347,8 +311,8 @@ grouping for a column, line, or area chart. <span class="summary_desc"><div class='inline'><p> -The shabe of the bars or columns must be one of [:percentStacked, -:clustered, :standard, :stacked]. +The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, +:cylinder, :pyramid, :pyramidToMax]. </p> </div></span> @@ -375,7 +339,7 @@ The shabe of the bars or columns must be one of [:percentStacked, <span class="summary_desc"><div class='inline'><p> -the category axis. +the valueaxis. </p> </div></span> @@ -392,7 +356,7 @@ the category axis. <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#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <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#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#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#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</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> + <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#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#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> @@ -465,7 +429,7 @@ Serializes the bar chart. <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></p> + <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#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> @@ -598,30 +562,93 @@ a customizable set of options </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"> -79 -80 -81 -82 -83 -84 -85 -86 -87 -88 -89</pre> +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/bar_3D_chart.rb', line 79</span> + <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> @@ -630,9 +657,9 @@ a customizable set of options <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='@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='symbol val'>:rAngAx=</span><span class='gt op'>></span><span class='integer val'>1</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> @@ -686,12 +713,12 @@ The direction of the bars in the chart must be one of [:bar, :col] <pre class="lines"> -47 -48 -49</pre> +21 +22 +23</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 47</span> + <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> @@ -743,12 +770,12 @@ the category axis <pre class="lines"> -38 -39 -40</pre> +12 +13 +14</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 38</span> + <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> @@ -801,12 +828,12 @@ width. <pre class="lines"> -51 -52 -53</pre> +25 +26 +27</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 51</span> + <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> @@ -859,12 +886,12 @@ width. <pre class="lines"> -55 -56 -57</pre> +29 +30 +31</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 55</span> + <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> @@ -917,12 +944,12 @@ grouping for a column, line, or area chart. must be one of <pre class="lines"> -60 -61 -62</pre> +34 +35 +36</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 60</span> + <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> @@ -946,8 +973,8 @@ grouping for a column, line, or area chart. must be one of </p><div class="docstring"> <div class="discussion"> <p> -The shabe of the bars or columns must be one of [:percentStacked, -:clustered, :standard, :stacked] +The shabe of the bars or columns must be one of [:cone, :coneToMax, :box, +:cylinder, :pyramid, :pyramidToMax] </p> @@ -975,12 +1002,12 @@ The shabe of the bars or columns must be one of [:percentStacked, <pre class="lines"> -65 -66 -67</pre> +39 +40 +41</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 65</span> + <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> @@ -1004,7 +1031,7 @@ The shabe of the bars or columns must be one of [:percentStacked, </p><div class="docstring"> <div class="discussion"> <p> -the category axis +the valueaxis </p> @@ -1032,12 +1059,12 @@ the category axis <pre class="lines"> -42 -43 -44</pre> +16 +17 +18</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 42</span> + <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> @@ -1093,27 +1120,27 @@ Serializes the bar chart <pre class="lines"> -119 -120 -121 -122 -123 -124 -125 -126 -127 -128 -129 -130 -131 -132 -133 -134 -135 -136</pre> +101 +102 +103 +104 +105 +106 +107 +108 +109 +110 +111 +112 +113 +114 +115 +116 +117 +118</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 119</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_3D_chart.rb', line 101</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> @@ -1144,7 +1171,7 @@ Serializes the bar chart </div> <div id="footer"> - Generated on Tue Nov 22 23:52:38 2011 by + Generated on Wed Nov 23 12:23:50 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> diff --git a/doc/Axlsx/BarSeries.html b/doc/Axlsx/BarSeries.html index 749762da..303d12f3 100644 --- a/doc/Axlsx/BarSeries.html +++ b/doc/Axlsx/BarSeries.html @@ -416,8 +416,8 @@ a customizable set of options <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='data identifier id'>data</span> <span class='assign 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='orop op'>||</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='labels identifier id'>labels</span> <span class='assign 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='orop op'>||</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='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> @@ -674,73 +674,15 @@ The document builder instance this objects xml will be added to. 46 47 48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74 -75 -76 -77 -78</pre> +49</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/bar_series.rb', line 43</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 identifier id'>xml</span><span class='bitor op'>|</span> - <span class='if if kw'>if</span> <span class='notop op'>!</span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</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='labels identifier id'>labels</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='labels identifier id'>labels</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='labels identifier id'>labels</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='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</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='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</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> - <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='data identifier id'>data</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='data identifier id'>data</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='data identifier id'>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='cell identifier id'>cell</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='cell identifier id'>cell</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='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</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='@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 identifier id'>xml</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 identifier id'>xml</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 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='end end kw'>end</span> <span class='end end kw'>end</span> @@ -755,7 +697,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:50 2011 by + Generated on Wed Nov 23 12:23:42 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> diff --git a/doc/Axlsx/Border.html b/doc/Axlsx/Border.html index acb2adbc..209a4388 100644 --- a/doc/Axlsx/Border.html +++ b/doc/Axlsx/Border.html @@ -766,7 +766,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:39 2011 by + Generated on Wed Nov 23 12:23:55 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> diff --git a/doc/Axlsx/BorderPr.html b/doc/Axlsx/BorderPr.html index cbacb66f..e4bcb6ab 100644 --- a/doc/Axlsx/BorderPr.html +++ b/doc/Axlsx/BorderPr.html @@ -700,7 +700,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:37 2011 by + Generated on Wed Nov 23 12:23:54 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> diff --git a/doc/Axlsx/CatAxis.html b/doc/Axlsx/CatAxis.html index 82f7c980..5babf097 100644 --- a/doc/Axlsx/CatAxis.html +++ b/doc/Axlsx/CatAxis.html @@ -336,7 +336,7 @@ Creates a new CatAxis object — <div class='inline'><p> -the id of this axis +the id of this axis. Inherited </p> </div> @@ -353,7 +353,7 @@ the id of this axis — <div class='inline'><p> -the id of the perpendicular axis +the id of the perpendicular axis. Inherited </p> </div> @@ -391,30 +391,39 @@ a customizable set of options <ul class="option"> <li> - <span class="name">axPos</span> + <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="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="name">crosses.</span> <span class="type">(<tt>Symbol</tt>)</span> <span class="default"> </span> - + — <div class='inline'><p> +Inherited +</p> +</div> </li> <li> @@ -454,27 +463,21 @@ a customizable set of options <pre class="lines"> -30 31 32 33 34 35 -36 -37 -38</pre> +36</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 30</span> + <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='super super kw'>super</span><span class='lparen token'>(</span><span class='axId identifier id'>axId</span><span class='comma token'>,</span> <span class='crossAx identifier id'>crossAx</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='auto identifier id'>auto</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblAlgn identifier id'>lblAlgn</span> <span class='assign token'>=</span> <span class='symbol val'>:ctr</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='lblOffset identifier id'>lblOffset</span> <span class='assign token'>=</span> <span class='string val'>"100%"</span> - <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> - <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> - <span class='end end kw'>end</span> + <span class='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> @@ -529,12 +532,12 @@ based on the data that is used for the axis labels, not a specific choice. <pre class="lines"> -6 7 -8</pre> +8 +9</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 6</span> + <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> @@ -587,12 +590,12 @@ specifies how the perpendicular axis is crossed must be one of [:ctr, :l, <pre class="lines"> -11 12 -13</pre> +13 +14</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 11</span> + <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> @@ -644,12 +647,12 @@ The offset of the labels must be between a string between 0 and 1000 <pre class="lines"> -16 17 -18</pre> +18 +19</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 16</span> + <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> @@ -726,17 +729,17 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +45 +46 47 48 49 50 51 -52 -53 -54</pre> +52</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.rb', line 47</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis.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='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> @@ -757,7 +760,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:42 2011 by + Generated on Wed Nov 23 12:24:00 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> diff --git a/doc/Axlsx/CatAxisData.html b/doc/Axlsx/CatAxisData.html new file mode 100644 index 00000000..fd0ea3aa --- /dev/null +++ b/doc/Axlsx/CatAxisData.html @@ -0,0 +1,400 @@ +<!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 + + — Documentation by YARD 0.7.3 + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (C)</a> » + <span class='title'><span class='object_link'><a href="../Axlsx.html" title="Axlsx (module)">Axlsx</a></span></span> + » + <span class="title">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> + + + + + + + + + + + <h3 class="inherited">Methods 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#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%3D%3D-instance_method" title="Axlsx::SimpleTypedList#== (method)">#==</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</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::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</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='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"> + + +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +26 +27 +28 +29 +30</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/cat_axis_data.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='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 23 12:23:51 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 index 44da43ed..bef1219e 100644 --- a/doc/Axlsx/Cell.html +++ b/doc/Axlsx/Cell.html @@ -1614,7 +1614,7 @@ xml text for the cell </div> <div id="footer"> - Generated on Tue Nov 22 23:52:52 2011 by + Generated on Wed Nov 23 12:23:47 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> diff --git a/doc/Axlsx/CellAlignment.html b/doc/Axlsx/CellAlignment.html index 3da3113f..4ac86068 100644 --- a/doc/Axlsx/CellAlignment.html +++ b/doc/Axlsx/CellAlignment.html @@ -1238,7 +1238,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:55 2011 by + Generated on Wed Nov 23 12:23:54 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> diff --git a/doc/Axlsx/CellProtection.html b/doc/Axlsx/CellProtection.html index 9088a55b..267d5865 100644 --- a/doc/Axlsx/CellProtection.html +++ b/doc/Axlsx/CellProtection.html @@ -556,7 +556,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:37 2011 by + Generated on Wed Nov 23 12:24:01 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> diff --git a/doc/Axlsx/CellStyle.html b/doc/Axlsx/CellStyle.html index a8769cbe..26d4d512 100644 --- a/doc/Axlsx/CellStyle.html +++ b/doc/Axlsx/CellStyle.html @@ -940,7 +940,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:32 2011 by + Generated on Wed Nov 23 12:24:01 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> diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html index 2f1a6465..6665f8a0 100644 --- a/doc/Axlsx/Chart.html +++ b/doc/Axlsx/Chart.html @@ -114,6 +114,13 @@ A Chart is the superclass for specific charts <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> @@ -126,14 +133,14 @@ A Chart is the superclass for specific charts <li class="public "> <span class="summary_signature"> - <a href="#end_at-instance_method" title="#end_at (instance method)">- (Marker) <strong>end_at</strong> </a> + <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> @@ -143,7 +150,7 @@ A Chart is the superclass for specific charts <span class="summary_desc"><div class='inline'><p> -The ending marker for this chart. +A reference to the graphic frame that owns this chart. </p> </div></span> @@ -153,7 +160,7 @@ The ending marker for this chart. <li class="public "> <span class="summary_signature"> - <a href="#graphic_frame-instance_method" title="#graphic_frame (instance method)">- (GraphicFrame) <strong>graphic_frame</strong> </a> + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> @@ -170,7 +177,7 @@ The ending marker for this chart. <span class="summary_desc"><div class='inline'><p> -A reference to the graphic frame that owns this chart. +The index of this chart in the workbooks charts collection. </p> </div></span> @@ -180,7 +187,7 @@ A reference to the graphic frame that owns this chart. <li class="public "> <span class="summary_signature"> - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> + <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> @@ -197,7 +204,7 @@ A reference to the graphic frame that owns this chart. <span class="summary_desc"><div class='inline'><p> -The index of this chart in the workbooks charts collection. +The part name for this chart. </p> </div></span> @@ -207,7 +214,7 @@ The index of this chart in the workbooks charts collection. <li class="public "> <span class="summary_signature"> - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> + <a href="#series-instance_method" title="#series (instance method)">- (SimpleTypedList) <strong>series</strong> </a> @@ -224,7 +231,7 @@ The index of this chart in the workbooks charts collection. <span class="summary_desc"><div class='inline'><p> -The part name for this chart. +A collection of series objects that are applied to the chart. </p> </div></span> @@ -234,7 +241,7 @@ The part name for this chart. <li class="public "> <span class="summary_signature"> - <a href="#series-instance_method" title="#series (instance method)">- (SimpleTypedList) <strong>series</strong> </a> + <a href="#series_type-instance_method" title="#series_type (instance method)">- (Series) <strong>series_type</strong> </a> @@ -251,7 +258,7 @@ The part name for this chart. <span class="summary_desc"><div class='inline'><p> -A collection of series objects that are applied to the chart. +The type of series to use for this chart. </p> </div></span> @@ -261,14 +268,14 @@ A collection of series objects that are applied to the chart. <li class="public "> <span class="summary_signature"> - <a href="#series_type-instance_method" title="#series_type (instance method)">- (Series) <strong>series_type</strong> </a> + <a href="#show_legend-instance_method" title="#show_legend (instance method)">- (Boolean) <strong>show_legend</strong> </a> </span> - <span class="note title readonly">readonly</span> + @@ -278,7 +285,7 @@ A collection of series objects that are applied to the chart. <span class="summary_desc"><div class='inline'><p> -The type of series to use for this chart. +Show the legend in the chart. </p> </div></span> @@ -288,7 +295,7 @@ The type of series to use for this chart. <li class="public "> <span class="summary_signature"> - <a href="#show_legend-instance_method" title="#show_legend (instance method)">- (Boolean) <strong>show_legend</strong> </a> + <a href="#style-instance_method" title="#style (instance method)">- (Integer) <strong>style</strong> </a> @@ -305,7 +312,7 @@ The type of series to use for this chart. <span class="summary_desc"><div class='inline'><p> -Show the legend in the chart. +The style for the chart. </p> </div></span> @@ -315,7 +322,7 @@ Show the legend in the chart. <li class="public "> <span class="summary_signature"> - <a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong> </a> + <a href="#title-instance_method" title="#title (instance method)">- (Title) <strong>title</strong> </a> @@ -332,7 +339,7 @@ Show the legend in the chart. <span class="summary_desc"><div class='inline'><p> -The starting marker for this chart. +The title object for the chart. </p> </div></span> @@ -342,7 +349,7 @@ The starting marker for this chart. <li class="public "> <span class="summary_signature"> - <a href="#style-instance_method" title="#style (instance method)">- (Integer) <strong>style</strong> </a> + <a href="#view3D-instance_method" title="#view3D (instance method)">- (Object) <strong>view3D</strong> </a> @@ -359,26 +366,36 @@ The starting marker for this chart. <span class="summary_desc"><div class='inline'><p> -The style for the chart. +The 3D view properties for the chart. </p> </div></span> </li> - <li class="public "> + </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="#title-instance_method" title="#title (instance method)">- (Title) <strong>title</strong> </a> + <a href="#add_series-instance_method" title="#add_series (instance method)">- (Series) <strong>add_series</strong>(options = {}) </a> </span> - - - @@ -386,25 +403,47 @@ The style for the chart. <span class="summary_desc"><div class='inline'><p> -The title object for the chart. +Adds a new series to the chart’s series collection. </p> </div></span> </li> - - <li class="public "> + + <li class="public "> <span class="summary_signature"> - <a href="#view3D-instance_method" title="#view3D (instance method)">- (Object) <strong>view3D</strong> </a> + <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> + @@ -413,30 +452,44 @@ The title object for the chart. <span class="summary_desc"><div class='inline'><p> -The 3D view properties for the chart. +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="#initialize-instance_method" title="#initialize (instance method)">- (Chart) <strong>initialize</strong>(frame, options = {}) {|_self| ... }</a> - </ul> - - + + </span> + + <span class="note title constructor">constructor</span> + + + + + + - <h2> - Instance Method Summary - <small>(<a href="#" class="summary_toggle">collapse</a>)</small> - </h2> + <span class="summary_desc"><div class='inline'><p> +Creates a new chart object. +</p> +</div></span> + +</li> - <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> + <a href="#start_at-instance_method" title="#start_at (instance method)">- (Marker) <strong>start_at</strong>(x, y) </a> @@ -450,7 +503,9 @@ The 3D view properties for the chart. <span class="summary_desc"><div class='inline'><p> -Adds a new series to the chart’s series collection. +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> @@ -460,14 +515,12 @@ Adds a new series to the chart’s series collection. <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Chart) <strong>initialize</strong>(frame, options = {}) {|_self| ... }</a> + <a href="#to-instance_method" title="#to (instance method)">- (Object) <strong>to</strong> </a> </span> - <span class="note title constructor">constructor</span> - @@ -476,7 +529,8 @@ Adds a new series to the chart’s series collection. <span class="summary_desc"><div class='inline'><p> -Creates a new chart object. +backwards compatibility to allow chart.to and chart.from access to anchor +markers. </p> </div></span> @@ -641,6 +695,12 @@ the object that the method was called on <pre class="lines"> +52 +53 +54 +55 +56 +57 58 59 60 @@ -648,14 +708,10 @@ the object that the method was called on 62 63 64 -65 -66 -67 -68 -69</pre> +65</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 58</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.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='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> @@ -667,6 +723,8 @@ the object that the method was called on <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='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='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='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='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> @@ -681,67 +739,10 @@ the object that the method was called on <h2>Instance Attribute Details</h2> - <span id="end_at=-instance_method"></span> - <span id="end_at-instance_method"></span> - <div class="method_details first"> - <p class="signature first" 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> - - - -</p><div class="docstring"> - <div class="discussion"> - <p> -The ending marker 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="Marker.html" title="Axlsx::Marker (class)">Marker</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/chart.rb', line 48</span> - -<span class='def def kw'>def</span> <span class='end_at identifier id'>end_at</span> - <span class='@end_at ivar id'>@end_at</span> -<span class='end end kw'>end</span> -</pre> - </td> - </tr> -</table> -</div> - - <span id=""></span> <span id="graphic_frame-instance_method"></span> - <div class="method_details "> - <p class="signature " id="graphic_frame-instance_method"> + <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> @@ -778,12 +779,12 @@ A reference to the graphic frame that owns this chart <pre class="lines"> -21 -22 -23</pre> +14 +15 +16</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 21</span> + <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> @@ -835,12 +836,12 @@ The index of this chart in the workbooks charts collection <pre class="lines"> -33 -34 -35</pre> +26 +27 +28</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 33</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 26</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> @@ -892,12 +893,12 @@ The part name for this chart <pre class="lines"> -37 -38 -39</pre> +30 +31 +32</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 37</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 30</span> <span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> <span class='dstring node'>"#{CHART_PN % (index+1)}"</span> @@ -949,12 +950,12 @@ A collection of series objects that are applied to the chart <pre class="lines"> -25 -26 -27</pre> +18 +19 +20</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 25</span> + <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> @@ -978,7 +979,7 @@ A collection of series objects that are applied to the chart </p><div class="docstring"> <div class="discussion"> <p> -The type of series to use for this chart +The type of series to use for this chart. </p> @@ -1006,12 +1007,12 @@ The type of series to use for this chart <pre class="lines"> -29 -30 -31</pre> +22 +23 +24</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 29</span> + <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> @@ -1063,12 +1064,12 @@ Show the legend in the chart <pre class="lines"> -52 -53 -54</pre> +46 +47 +48</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 52</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 46</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> @@ -1080,19 +1081,19 @@ Show the legend in the chart </div> - <span id="start_at=-instance_method"></span> - <span id="start_at-instance_method"></span> + <span id="style=-instance_method"></span> + <span id="style-instance_method"></span> <div class="method_details "> - <p class="signature " id="start_at-instance_method"> + <p class="signature " id="style-instance_method"> - - (<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>) <strong>start_at</strong> + - (<tt>Integer</tt>) <strong>style</strong> </p><div class="docstring"> <div class="discussion"> <p> -The starting marker for this chart +The style for the chart. see ECMA Part 1 §21.2.2.196 </p> @@ -1106,7 +1107,7 @@ The starting marker for this chart <li> - <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> + <span class='type'>(<tt>Integer</tt>)</span> @@ -1120,15 +1121,15 @@ The starting marker for this chart <pre class="lines"> -44 -45 -46</pre> +42 +43 +44</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 44</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 42</span> -<span class='def def kw'>def</span> <span class='start_at identifier id'>start_at</span> - <span class='@start_at ivar id'>@start_at</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> @@ -1137,19 +1138,19 @@ The starting marker for this chart </div> - <span id="style=-instance_method"></span> - <span id="style-instance_method"></span> + <span id="title=-instance_method"></span> + <span id="title-instance_method"></span> <div class="method_details "> - <p class="signature " id="style-instance_method"> + <p class="signature " id="title-instance_method"> - - (<tt>Integer</tt>) <strong>style</strong> + - (<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 style for the chart. see ECMA Part 1 §21.2.2.196 +The title object for the chart. </p> @@ -1163,7 +1164,7 @@ The style for the chart. see ECMA Part 1 §21.2.2.196 <li> - <span class='type'>(<tt>Integer</tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>)</span> @@ -1177,15 +1178,15 @@ The style for the chart. see ECMA Part 1 §21.2.2.196 <pre class="lines"> -14 -15 -16</pre> +37 +38 +39</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 14</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 37</span> -<span class='def def kw'>def</span> <span class='style identifier id'>style</span> - <span class='@style ivar id'>@style</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> @@ -1194,19 +1195,67 @@ The style for the chart. see ECMA Part 1 §21.2.2.196 </div> - <span id="title=-instance_method"></span> - <span id="title-instance_method"></span> + <span id="view3D=-instance_method"></span> + <span id="view3D-instance_method"></span> <div class="method_details "> - <p class="signature " id="title-instance_method"> + <p class="signature " id="view3D-instance_method"> - - (<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>) <strong>title</strong> + - (<tt>Object</tt>) <strong>view3D</strong> </p><div class="docstring"> <div class="discussion"> <p> -The title object for the chart. +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> @@ -1220,7 +1269,7 @@ The title object for the chart. <li> - <span class='type'>(<tt><span class='object_link'><a href="Title.html" title="Axlsx::Title (class)">Title</a></span></tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span> @@ -1228,21 +1277,30 @@ The title object for the chart. </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"> -9 -10 -11</pre> +101 +102 +103 +104</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 9</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 101</span> -<span class='def def kw'>def</span> <span class='title identifier id'>title</span> - <span class='@title ivar id'>@title</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> @@ -1250,27 +1308,76 @@ The title object for the chart. </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"> + <p class="signature " id="end_at-instance_method"> - - (<tt>Object</tt>) <strong>view3D</strong> + - (<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> -The 3D view properties for the chart +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> @@ -1278,15 +1385,17 @@ The 3D view properties for the chart <pre class="lines"> -17 -18 -19</pre> +149 +150 +151 +152</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 17</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 149</span> -<span class='def def kw'>def</span> <span class='view3D identifier id'>view3D</span> - <span class='@view3D ivar id'>@view3D</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> @@ -1294,38 +1403,122 @@ The 3D view properties for the chart </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 id="instance_method_details" class="method_details_list"> - <h2>Instance Method Details</h2> - + + </div> +</div> +<div class="tags"> + + +</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/chart.rb', line 94</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 first"> - <p class="signature first" id="add_series-instance_method"> + <div class="method_details "> + <p class="signature " id="start_at-instance_method"> - - (<tt><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>) <strong>add_series</strong>(options = {}) + - (<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> -Adds a new series to the chart’s series collection. +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="Series.html" title="Axlsx::Series (class)">Series</a></span></tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="Marker.html" title="Axlsx::Marker (class)">Marker</a></span></tt>)</span> @@ -1333,12 +1526,58 @@ Adds a new series to the chart’s series collection. </ul> - <h3>See Also:</h3> - <ul class="see"> +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +138 +139 +140 +141</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 138</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> - <li><span class='object_link'><a href="Series.html" title="Axlsx::Series (class)">Series</a></span></li> + <div class="method_details "> + <p class="signature " id="to-instance_method"> + + - (<tt>Object</tt>) <strong>to</strong> + + + +</p><div class="docstring"> + <div class="discussion"> - </ul> + <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> @@ -1346,17 +1585,15 @@ Adds a new series to the chart’s series collection. <pre class="lines"> -94 -95 -96 -97</pre> +87 +88 +89</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 94</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 87</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='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> @@ -1389,13 +1626,6 @@ Chart Serialization serializes the chart <pre class="lines"> -101 -102 -103 -104 -105 -106 -107 108 109 110 @@ -1411,10 +1641,17 @@ Chart Serialization serializes the chart 120 121 122 -123</pre> +123 +124 +125 +126 +127 +128 +129 +130</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 101</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 108</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> @@ -1450,7 +1687,7 @@ Chart Serialization serializes the chart </div> <div id="footer"> - Generated on Tue Nov 22 23:52:46 2011 by + Generated on Wed Nov 23 12:23:58 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.3 (ruby-1.8.7). </div> diff --git a/doc/Axlsx/Color.html b/doc/Axlsx/Color.html index e856e81f..e1479faf 100644 --- a/doc/Axlsx/Color.html +++ b/doc/Axlsx/Color.html @@ -656,7 +656,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:34 2011 by + Generated on Wed Nov 23 12:23:51 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> diff --git a/doc/Axlsx/ContentType.html b/doc/Axlsx/ContentType.html index 293926d4..21d7c70d 100644 --- a/doc/Axlsx/ContentType.html +++ b/doc/Axlsx/ContentType.html @@ -194,7 +194,7 @@ Generates the xml document for [Content_Types].xml. <h3 class="inherited">Methods 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#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%3D%3D-instance_method" title="Axlsx::SimpleTypedList#== (method)">#==</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> @@ -331,7 +331,7 @@ The document as a string. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:48 2011 by + Generated on Wed Nov 23 12:24:05 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> diff --git a/doc/Axlsx/Core.html b/doc/Axlsx/Core.html index 1271d383..ed241c2b 100644 --- a/doc/Axlsx/Core.html +++ b/doc/Axlsx/Core.html @@ -456,7 +456,7 @@ time when this method is called. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:41 2011 by + Generated on Wed Nov 23 12:23:56 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> diff --git a/doc/Axlsx/DataTypeValidator.html b/doc/Axlsx/DataTypeValidator.html index dedc619a..6f2f98ac 100644 --- a/doc/Axlsx/DataTypeValidator.html +++ b/doc/Axlsx/DataTypeValidator.html @@ -315,7 +315,7 @@ types or the block passed returns false </div> <div id="footer"> - Generated on Tue Nov 22 23:52:41 2011 by + Generated on Wed Nov 23 12:23:43 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> diff --git a/doc/Axlsx/Default.html b/doc/Axlsx/Default.html index 27bf8b21..b53c8ea5 100644 --- a/doc/Axlsx/Default.html +++ b/doc/Axlsx/Default.html @@ -566,7 +566,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:44 2011 by + Generated on Wed Nov 23 12:23:48 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> diff --git a/doc/Axlsx/Drawing.html b/doc/Axlsx/Drawing.html index 82b6dd0a..1d2bce32 100644 --- a/doc/Axlsx/Drawing.html +++ b/doc/Axlsx/Drawing.html @@ -99,14 +99,16 @@ <strong>Note:</strong> <div class='inline'><p> The recommended way to manage drawings is to use the Worksheet.add_chart -method, specifying the chart class, start and end marker locations. +method. </p> </div> </div> <p> A Drawing is a canvas for charts. Each worksheet has a single drawing that -can specify multiple anchors which reference charts. +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> @@ -120,8 +122,6 @@ can specify multiple anchors which reference charts. <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="TwoCellAnchor.html" title="Axlsx::TwoCellAnchor (class)">TwoCellAnchor</a></span></li> - <li><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></li> </ul> @@ -151,7 +151,8 @@ can specify multiple anchors which reference charts. <span class="summary_desc"><div class='inline'><p> -A collection of anchors for this drawing. +A collection of anchors for this drawing only TwoCellAnchors are supported +in this version. </p> </div></span> @@ -487,15 +488,15 @@ The worksheet that owns this drawing <pre class="lines"> -67 -68 -69 -70 71 -72</pre> +72 +73 +74 +75 +76</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 67</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 71</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> @@ -527,7 +528,8 @@ The worksheet that owns this drawing </p><div class="docstring"> <div class="discussion"> <p> -A collection of anchors for this drawing +A collection of anchors for this drawing only TwoCellAnchors are supported +in this version </p> @@ -555,12 +557,12 @@ A collection of anchors for this drawing <pre class="lines"> -39 -40 -41</pre> +43 +44 +45</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 39</span> + <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='anchors identifier id'>anchors</span> <span class='@anchors ivar id'>@anchors</span> @@ -612,12 +614,12 @@ An array of charts that are associated with this drawing’s anchors <pre class="lines"> -43 -44 -45</pre> +47 +48 +49</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 47</span> <span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> <span class='@anchors ivar id'>@anchors</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='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='rbrace token'>}</span> @@ -670,12 +672,12 @@ collection. <pre class="lines"> -47 -48 -49</pre> +51 +52 +53</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 47</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 51</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> @@ -727,12 +729,12 @@ The part name for this drawing <pre class="lines"> -55 -56 -57</pre> +59 +60 +61</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 55</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 59</span> <span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> <span class='dstring node'>"#{DRAWING_PN % (index+1)}"</span> @@ -784,17 +786,17 @@ The drawing’s relationships. <pre class="lines"> -63 -64 -65 -66 67 68 69 -70</pre> +70 +71 +72 +73 +74</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 63</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 67</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> @@ -851,12 +853,12 @@ The relational part name for this drawing <pre class="lines"> -59 -60 -61</pre> +63 +64 +65</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 59</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 63</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> @@ -908,12 +910,12 @@ The relation reference id for this drawing <pre class="lines"> -51 -52 -53</pre> +55 +56 +57</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 51</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 55</span> <span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> <span class='dstring node'>"rId#{index+1}"</span> @@ -965,12 +967,12 @@ The worksheet that owns the drawing <pre class="lines"> -34 -35 -36</pre> +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 34</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 38</span> <span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> <span class='@worksheet ivar id'>@worksheet</span> @@ -1001,7 +1003,8 @@ The worksheet that owns the drawing <div class="note notetag"> <strong>Note:</strong> <div class='inline'><p> -The recommended way to manage charts is to use Worksheet.add_chart. +The recommended way to manage charts is to use Worksheet.add_chart. Please +refer to that method for documentation. </p> </div> </div> @@ -1014,41 +1017,14 @@ Adds a chart to the drawing. </div> </div> <div class="tags"> - <h3>Parameters:</h3> -<ul class="param"> - <li> - - <span class='name'>chart_type</span> - - - <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</span> - - - - — - <div class='inline'><p> -The class of the chart to be added to the drawing -</p> -</div> - - </li> - - <li> - - <span class='name'>options</span> - - - <span class='type'>(<tt>Hash</tt>)</span> - - - <em class="default">(defaults to: <tt>{}</tt>)</em> - - - </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)">Worksheet#add_chart</a></span></li> + + </ul> </div><table class="source_code"> <tr> @@ -1056,17 +1032,15 @@ The class of the chart to be added to the drawing <pre class="lines"> -79 -80 -81 82 -83</pre> +83 +84 +85</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 79</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 82</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='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='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='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='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='graphic_frame identifier id'>graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='end end kw'>end</span> @@ -1114,17 +1088,17 @@ Serializes the drawing <pre class="lines"> -116 -117 118 119 120 121 122 -123</pre> +123 +124 +125</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 116</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 118</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> @@ -1145,7 +1119,7 @@ Serializes the drawing </div> <div id="footer"> - Generated on Tue Nov 22 23:52:33 2011 by + Generated on Wed Nov 23 12:23:49 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> diff --git a/doc/Axlsx/Fill.html b/doc/Axlsx/Fill.html index da35b662..f5c9b6fa 100644 --- a/doc/Axlsx/Fill.html +++ b/doc/Axlsx/Fill.html @@ -451,7 +451,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:50 2011 by + Generated on Wed Nov 23 12:23:56 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> diff --git a/doc/Axlsx/Font.html b/doc/Axlsx/Font.html index ee723a16..0091cf69 100644 --- a/doc/Axlsx/Font.html +++ b/doc/Axlsx/Font.html @@ -1545,7 +1545,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:51 2011 by + Generated on Wed Nov 23 12:23:41 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> diff --git a/doc/Axlsx/GradientFill.html b/doc/Axlsx/GradientFill.html index 7fa542ec..7cb1494f 100644 --- a/doc/Axlsx/GradientFill.html +++ b/doc/Axlsx/GradientFill.html @@ -1017,7 +1017,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:41 2011 by + Generated on Wed Nov 23 12:24:04 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> diff --git a/doc/Axlsx/GradientStop.html b/doc/Axlsx/GradientStop.html index 6f5ca4d4..89bc1e26 100644 --- a/doc/Axlsx/GradientStop.html +++ b/doc/Axlsx/GradientStop.html @@ -517,7 +517,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:44 2011 by + Generated on Wed Nov 23 12:23:46 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> diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html index f7e91018..0c328ab9 100644 --- a/doc/Axlsx/GraphicFrame.html +++ b/doc/Axlsx/GraphicFrame.html @@ -329,12 +329,14 @@ Creates a new GraphicFrame object 24 25 26 -27</pre> +27 +28</pre> </td> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.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='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> @@ -586,7 +588,6 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -36 37 38 39 @@ -603,10 +604,11 @@ The document builder instance this objects xml will be added to. 50 51 52 -53</pre> +53 +54</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 36</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 37</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> @@ -637,7 +639,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:56 2011 by + Generated on Wed Nov 23 12:23:47 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> diff --git a/doc/Axlsx/Line3DChart.html b/doc/Axlsx/Line3DChart.html index 589a6d54..3512d2a7 100644 --- a/doc/Axlsx/Line3DChart.html +++ b/doc/Axlsx/Line3DChart.html @@ -323,7 +323,7 @@ the category axis. <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#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <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#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#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#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</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> + <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#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#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> @@ -396,7 +396,7 @@ Serializes the bar chart. <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></p> + <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#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> @@ -467,6 +467,24 @@ a customizable set of options <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"> @@ -484,31 +502,94 @@ a customizable set of options </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"> -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 61 -62</pre> +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/line_3D_chart.rb', line 51</span> + <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='@grouping ivar id'>@grouping</span> <span class='assign token'>=</span> <span class='symbol val'>:standard</span> @@ -518,9 +599,9 @@ a customizable set of options <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='@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='symbol val'>:perspective=</span><span class='gt op'>></span><span class='integer val'>30</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> @@ -865,25 +946,25 @@ Serializes the bar chart <pre class="lines"> -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 86 87 88 89 90 -91</pre> +91 +92 +93 +94 +95 +96 +97 +98 +99 +100 +101</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 76</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_3D_chart.rb', line 86</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> @@ -912,7 +993,7 @@ Serializes the bar chart </div> <div id="footer"> - Generated on Tue Nov 22 23:52:45 2011 by + Generated on Wed Nov 23 12:24:02 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> diff --git a/doc/Axlsx/LineSeries.html b/doc/Axlsx/LineSeries.html index f6d997da..b1b59a0b 100644 --- a/doc/Axlsx/LineSeries.html +++ b/doc/Axlsx/LineSeries.html @@ -136,7 +136,7 @@ A LineSeries defines the title, data and labels for line charts <li class="public "> <span class="summary_signature"> - <a href="#data-instance_method" title="#data (instance method)">- (Array, SimpleTypedList) <strong>data</strong> </a> + <a href="#data-instance_method" title="#data (instance method)">- (ValAxisData) <strong>data</strong> </a> @@ -163,7 +163,7 @@ The data for this series. <li class="public "> <span class="summary_signature"> - <a href="#labels-instance_method" title="#labels (instance method)">- (Array, SimpleTypedList) <strong>labels</strong> </a> + <a href="#labels-instance_method" title="#labels (instance method)">- (CatAxisData) <strong>labels</strong> </a> @@ -251,7 +251,8 @@ Creates a new series. <span class="summary_desc"><div class='inline'><p> -Serializes the series. +Serializes the series TODO create series_cat and series_val classes as this +serialization is duplicated. </p> </div></span> @@ -368,8 +369,8 @@ a customizable set of options <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='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='data identifier id'>data</span> <span class='assign 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='orop op'>||</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='labels identifier id'>labels</span> <span class='assign 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='orop op'>||</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='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> @@ -388,7 +389,7 @@ a customizable set of options <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> + - (<tt><span class='object_link'><a href="ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span></tt>) <strong>data</strong> @@ -409,7 +410,7 @@ The data for this series. <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> + <span class='type'>(<tt><span class='object_link'><a href="ValAxisData.html" title="Axlsx::ValAxisData (class)">ValAxisData</a></span></tt>)</span> @@ -445,7 +446,7 @@ The data for this series. <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> + - (<tt><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></tt>) <strong>labels</strong> @@ -466,7 +467,7 @@ The labels for this series. <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> + <span class='type'>(<tt><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span></tt>)</span> @@ -513,7 +514,8 @@ The labels for this series. </p><div class="docstring"> <div class="discussion"> <p> -Serializes the series +Serializes the series TODO create series_cat and series_val classes as this +serialization is duplicated </p> @@ -562,78 +564,20 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -29 30 31 32 33 34 -35 -36 -37 -38 -39 -40 -41 -42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63</pre> +35</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/line_series.rb', line 29</span> + <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 identifier id'>xml</span><span class='bitor op'>|</span> - <span class='if if kw'>if</span> <span class='notop op'>!</span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</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='labels identifier id'>labels</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='labels identifier id'>labels</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='labels identifier id'>labels</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='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</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='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</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> - <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='data identifier id'>data</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='data identifier id'>data</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='data identifier id'>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='cell identifier id'>cell</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='cell identifier id'>cell</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='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</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='@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 identifier id'>xml</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 identifier id'>xml</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> @@ -647,7 +591,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:41 2011 by + Generated on Wed Nov 23 12:23:58 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.3 (ruby-1.8.7). </div> diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html index 3a5e0864..a35500f7 100644 --- a/doc/Axlsx/Marker.html +++ b/doc/Axlsx/Marker.html @@ -848,7 +848,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:38 2011 by + Generated on Wed Nov 23 12:24:00 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> diff --git a/doc/Axlsx/NumFmt.html b/doc/Axlsx/NumFmt.html index b530f49a..2fe65d34 100644 --- a/doc/Axlsx/NumFmt.html +++ b/doc/Axlsx/NumFmt.html @@ -553,7 +553,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:53 2011 by + Generated on Wed Nov 23 12:23:50 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> diff --git a/doc/Axlsx/Override.html b/doc/Axlsx/Override.html index 0eeec0b6..2157fc29 100644 --- a/doc/Axlsx/Override.html +++ b/doc/Axlsx/Override.html @@ -559,7 +559,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:45 2011 by + Generated on Wed Nov 23 12:23:54 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> diff --git a/doc/Axlsx/Package.html b/doc/Axlsx/Package.html index a8875b81..dccd861b 100644 --- a/doc/Axlsx/Package.html +++ b/doc/Axlsx/Package.html @@ -1284,7 +1284,7 @@ An array of all validation errors encountered. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:33 2011 by + Generated on Wed Nov 23 12:23:43 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> diff --git a/doc/Axlsx/PatternFill.html b/doc/Axlsx/PatternFill.html index 00371bc9..22009d77 100644 --- a/doc/Axlsx/PatternFill.html +++ b/doc/Axlsx/PatternFill.html @@ -672,7 +672,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:40 2011 by + Generated on Wed Nov 23 12:23:57 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> diff --git a/doc/Axlsx/Pie3DChart.html b/doc/Axlsx/Pie3DChart.html index f34d11e8..668d4797 100644 --- a/doc/Axlsx/Pie3DChart.html +++ b/doc/Axlsx/Pie3DChart.html @@ -106,53 +106,15 @@ that you can add to your worksheet. </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 two charts in a single sheet.</span> -<span class='comment val'># The first uses data directly fed to the sheet, while the second references cells withing the worksheet for data.</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='Pie3DChart constant id'>Pie3DChart</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> - -<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 chart uses the data below"</span><span class='rbrack token'>]</span> -<span class='title_row identifier id'>title_row</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='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='label_row identifier id'>label_row</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='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='data_row identifier id'>data_row</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='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='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='Pie3DChart constant id'>Pie3DChart</span><span class='comma token'>,</span> <span class='symbol val'>:start_at</span> <span class='assign token'>=</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'>11</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:end_at</span> <span class='assign token'>=</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'>16</span><span class='rbrack token'>]</span><span class='comma token'>,</span> <span class='symbol val'>:title</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='title_row identifier id'>title_row</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='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='data_row identifier id'>data_row</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='float val'>1</span><span class='dot2 op'>..</span><span class='integer val'>-1</span><span class='rparen token'>)</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='label_row identifier id'>label_row</span><span class='dot token'>.</span><span class='cells identifier id'>cells</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_pie_3d_chart.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>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)">Axlsx::Package#serialize</a></span></li> + <li>for an example</li> </ul> @@ -170,7 +132,7 @@ Creating a chart <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#end_at-instance_method" title="Axlsx::Chart#end_at (method)">end_at</a></span>, <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#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#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#start_at-instance_method" title="Axlsx::Chart#start_at (method)">start_at</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> + <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#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#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> @@ -184,7 +146,7 @@ Creating a chart <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Pie3DChart) <strong>initialize</strong>(workbook, options = {}) </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">- (Pie3DChart) <strong>initialize</strong>(frame, options = {}) </a> @@ -243,14 +205,14 @@ Serializes the pie chart. <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></p> + <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#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>(workbook, options = {}) + - (<tt><span class='object_link'><a href="" title="Axlsx::Pie3DChart (class)">Pie3DChart</a></span></tt>) <strong>initialize</strong>(frame, options = {}) @@ -269,10 +231,10 @@ Creates a new pie chart object <li> - <span class='name'>workbook</span> + <span class='name'>frame</span> - <span class='type'>(<tt><span class='object_link'><a href="Workbook.html" title="Axlsx::Workbook (class)">Workbook</a></span></tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="GraphicFrame.html" title="Axlsx::GraphicFrame (class)">GraphicFrame</a></span></tt>)</span> @@ -322,31 +284,121 @@ a customizable set of options </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"> -41 -42 -43 -44 -45 -46</pre> +24 +25 +26 +27 +28 +29</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 41</span> + <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='workbook identifier id'>workbook</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='comment val'># this charts series type</span> - <span class='super super kw'>super</span><span class='lparen token'>(</span><span class='workbook identifier id'>workbook</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</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='symbol val'>:rotX</span> <span class='assign token'>=</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='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>30</span><span class='rparen token'>)</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> @@ -399,17 +451,17 @@ Serializes the pie chart <pre class="lines"> -50 -51 -52 -53 -54 -55 -56 -57</pre> +33 +34 +35 +36 +37 +38 +39 +40</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 50</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_3D_chart.rb', line 33</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> @@ -430,7 +482,7 @@ Serializes the pie chart </div> <div id="footer"> - Generated on Tue Nov 22 23:52:46 2011 by + Generated on Wed Nov 23 12:23:50 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> diff --git a/doc/Axlsx/PieSeries.html b/doc/Axlsx/PieSeries.html index 7e5d747b..07ca6f75 100644 --- a/doc/Axlsx/PieSeries.html +++ b/doc/Axlsx/PieSeries.html @@ -106,7 +106,8 @@ The recommended way to manage series is to use Chart#add_series </div> <p> -A PieSeries defines the title, data and labels for pie charts +A PieSeries defines the data and labels and explosion for pie charts +series. </p> @@ -136,7 +137,7 @@ A PieSeries defines the title, data and labels for pie charts <li class="public "> <span class="summary_signature"> - <a href="#data-instance_method" title="#data (instance method)">- (Array, SimpleTypedList) <strong>data</strong> </a> + <a href="#data-instance_method" title="#data (instance method)">- (SimpleTypedList) <strong>data</strong> </a> @@ -163,7 +164,7 @@ The data for this series. <li class="public "> <span class="summary_signature"> - <a href="#explosion-instance_method" title="#explosion (instance method)">- (Array, SimpleTypedList) <strong>explosion</strong> </a> + <a href="#explosion-instance_method" title="#explosion (instance method)">- (Integert) <strong>explosion</strong> </a> @@ -190,7 +191,7 @@ The explosion for this series. <li class="public "> <span class="summary_signature"> - <a href="#labels-instance_method" title="#labels (instance method)">- (Array, SimpleTypedList) <strong>labels</strong> </a> + <a href="#labels-instance_method" title="#labels (instance method)">- (SimpleTypedList) <strong>labels</strong> </a> @@ -402,19 +403,19 @@ a customizable set of options <pre class="lines"> +26 +27 28 29 -30 -31 -32</pre> +30</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 28</span> + <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='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='data identifier id'>data</span> <span class='assign 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='orop op'>||</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='labels identifier id'>labels</span> <span class='assign 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='orop op'>||</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='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> @@ -433,7 +434,7 @@ a customizable set of options <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> + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>data</strong> @@ -454,7 +455,7 @@ The data for this series. <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> + <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> @@ -490,7 +491,7 @@ The data for this series. <div class="method_details "> <p class="signature " id="explosion-instance_method"> - - (<tt>Array</tt>, <tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>explosion</strong> + - (<tt>Integert</tt>) <strong>explosion</strong> @@ -511,7 +512,7 @@ The explosion for this series <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> + <span class='type'>(<tt>Integert</tt>)</span> @@ -525,12 +526,12 @@ The explosion for this series <pre class="lines"> -20 -21 -22</pre> +18 +19 +20</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 20</span> + <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> @@ -547,7 +548,7 @@ The explosion for this series <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> + - (<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>) <strong>labels</strong> @@ -568,7 +569,7 @@ The labels for this series. <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> + <span class='type'>(<tt><span class='object_link'><a href="SimpleTypedList.html" title="Axlsx::SimpleTypedList (class)">SimpleTypedList</a></span></tt>)</span> @@ -582,12 +583,12 @@ The labels for this series. <pre class="lines"> +14 15 -16 -17</pre> +16</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 15</span> + <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> @@ -664,82 +665,22 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +37 38 39 40 41 42 -43 -44 -45 -46 -47 -48 -49 -50 -51 -52 -53 -54 -55 -56 -57 -58 -59 -60 -61 -62 -63 -64 -65 -66 -67 -68 -69 -70 -71 -72 -73 -74</pre> +43</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 38</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/pie_series.rb', line 37</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 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: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='if if kw'>if</span> <span class='notop op'>!</span><span class='labels identifier id'>labels</span><span class='dot token'>.</span><span class='empty? fid id'>empty?</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='labels identifier id'>labels</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='labels identifier id'>labels</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='labels identifier id'>labels</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='v identifier id'>v</span> <span class='assign token'>=</span> <span class='cell identifier id'>cell</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='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</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> - <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='data identifier id'>data</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='data identifier id'>data</span><span class='dot token'>.</span><span class='size identifier id'>size</span><span class='rparen token'>)</span> - <span class='data identifier id'>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='cell identifier id'>cell</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='cell identifier id'>cell</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='cell identifier id'>cell</span><span class='dot token'>.</span><span class='value identifier id'>value</span> <span class='colon op'>:</span> <span class='cell identifier id'>cell</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='@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 identifier id'>xml</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 identifier id'>xml</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> @@ -753,7 +694,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:49 2011 by + Generated on Wed Nov 23 12:23:44 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> diff --git a/doc/Axlsx/RegexValidator.html b/doc/Axlsx/RegexValidator.html index c3ad45b1..f644c404 100644 --- a/doc/Axlsx/RegexValidator.html +++ b/doc/Axlsx/RegexValidator.html @@ -259,7 +259,7 @@ The value to validate. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:44 2011 by + Generated on Wed Nov 23 12:23:47 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> diff --git a/doc/Axlsx/Relationship.html b/doc/Axlsx/Relationship.html index 486b348c..f9786c69 100644 --- a/doc/Axlsx/Relationship.html +++ b/doc/Axlsx/Relationship.html @@ -545,7 +545,7 @@ the reference id of the object. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:37 2011 by + Generated on Wed Nov 23 12:24:05 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> diff --git a/doc/Axlsx/Relationships.html b/doc/Axlsx/Relationships.html index b1687dcb..95e4f3b3 100644 --- a/doc/Axlsx/Relationships.html +++ b/doc/Axlsx/Relationships.html @@ -203,7 +203,7 @@ Serializes the relationships document. <h3 class="inherited">Methods 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#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%3D%3D-instance_method" title="Axlsx::SimpleTypedList#== (method)">#==</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> @@ -334,7 +334,7 @@ Serializes the relationships document. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:41 2011 by + Generated on Wed Nov 23 12:23:47 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> diff --git a/doc/Axlsx/RestrictionValidator.html b/doc/Axlsx/RestrictionValidator.html index 1ea8d71f..dcb9402f 100644 --- a/doc/Axlsx/RestrictionValidator.html +++ b/doc/Axlsx/RestrictionValidator.html @@ -291,7 +291,7 @@ Raised if the value provided is not in the list of choices. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:46 2011 by + Generated on Wed Nov 23 12:23:50 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> diff --git a/doc/Axlsx/Row.html b/doc/Axlsx/Row.html index 2d7802f0..cd95e0ec 100644 --- a/doc/Axlsx/Row.html +++ b/doc/Axlsx/Row.html @@ -762,7 +762,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:55 2011 by + Generated on Wed Nov 23 12:24:03 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.3 (ruby-1.8.7). </div> diff --git a/doc/Axlsx/Scaling.html b/doc/Axlsx/Scaling.html index 540ac273..341bd7d8 100644 --- a/doc/Axlsx/Scaling.html +++ b/doc/Axlsx/Scaling.html @@ -731,7 +731,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:44 2011 by + Generated on Wed Nov 23 12:23:48 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> diff --git a/doc/Axlsx/SerAxis.html b/doc/Axlsx/SerAxis.html index 17fe2a43..e46afa7e 100644 --- a/doc/Axlsx/SerAxis.html +++ b/doc/Axlsx/SerAxis.html @@ -97,7 +97,7 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p> -A SarAxis object defines a series axis +A SerAxis object defines a series axis </p> @@ -118,7 +118,7 @@ A SarAxis object defines a series axis <li class="public "> <span class="summary_signature"> - <a href="#tickLblSkip-instance_method" title="#tickLblSkip (instance method)">- (Boolean) <strong>tickLblSkip</strong> </a> + <a href="#tickLblSkip-instance_method" title="#tickLblSkip (instance method)">- (Integer) <strong>tickLblSkip</strong> </a> @@ -134,7 +134,10 @@ A SarAxis object defines a series axis - <span class="summary_desc"><div class='inline'></div></span> + <span class="summary_desc"><div class='inline'><p> +The number of tick lables to skip between labels. +</p> +</div></span> </li> @@ -158,7 +161,10 @@ A SarAxis object defines a series axis - <span class="summary_desc"><div class='inline'></div></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> @@ -276,7 +282,7 @@ Creates a new SerAxis object — <div class='inline'><p> -the id of this axis +the id of this axis. Inherited </p> </div> @@ -293,7 +299,7 @@ the id of this axis — <div class='inline'><p> -the id of the perpendicular axis +the id of the perpendicular axis. Inherited </p> </div> @@ -331,35 +337,44 @@ a customizable set of options <ul class="option"> <li> - <span class="name">axPos</span> + <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="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="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>Boolean</tt>)</span> + <span class="type">(<tt>Integer</tt>)</span> <span class="default"> </span> @@ -368,7 +383,7 @@ a customizable set of options <li> <span class="name">tickMarkSkip</span> - <span class="type">(<tt>Symbol</tt>)</span> + <span class="type">(<tt>Integer</tt>)</span> <span class="default"> </span> @@ -385,21 +400,15 @@ a customizable set of options <pre class="lines"> -19 -20 21 22 -23 -24</pre> +23</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 19</span> + <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='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='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> @@ -418,13 +427,16 @@ a customizable set of options <div class="method_details first"> <p class="signature first" id="tickLblSkip-instance_method"> - - (<tt>Boolean</tt>) <strong>tickLblSkip</strong> + - (<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> @@ -436,7 +448,7 @@ a customizable set of options <li> - <span class='type'>(<tt>Boolean</tt>)</span> + <span class='type'>(<tt>Integer</tt>)</span> @@ -450,12 +462,12 @@ a customizable set of options <pre class="lines"> -6 7 -8</pre> +8 +9</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 6</span> + <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> @@ -478,7 +490,10 @@ a customizable set of options </p><div class="docstring"> <div class="discussion"> - + <p> +The number of tickmarks to be skipped before the next one is rendered. +</p> + </div> </div> @@ -504,12 +519,12 @@ a customizable set of options <pre class="lines"> -9 -10 -11</pre> +11 +12 +13</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 9</span> + <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> @@ -586,16 +601,16 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +31 32 33 34 35 36 -37 -38</pre> +37</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.rb', line 32</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/ser_axis.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='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> @@ -615,7 +630,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:32 2011 by + Generated on Wed Nov 23 12:23:58 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.7.3 (ruby-1.8.7). </div> diff --git a/doc/Axlsx/Series.html b/doc/Axlsx/Series.html index 668ede03..32106681 100644 --- a/doc/Axlsx/Series.html +++ b/doc/Axlsx/Series.html @@ -104,7 +104,8 @@ The recommended way to manage series is to use Chart#add_series </div> <p> -A Series defines the title, data and labels for chart data. +A Series defines the common series attributes and is the super class for +all concrete series types. </p> @@ -161,7 +162,7 @@ The chart that owns this series. <li class="public "> <span class="summary_signature"> - <a href="#index-instance_method" title="#index (instance method)">- (Object) <strong>index</strong> </a> + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> @@ -178,7 +179,7 @@ The chart that owns this series. <span class="summary_desc"><div class='inline'><p> -retrieves the series index in the chart’s series collection. +The index of this series in the chart’s series. </p> </div></span> @@ -488,14 +489,14 @@ The chart that owns this series <div class="method_details "> <p class="signature " id="index-instance_method"> - - (<tt>Object</tt>) <strong>index</strong> <span class="extras">(readonly)</span> + - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span> </p><div class="docstring"> <div class="discussion"> <p> -retrieves the series index in the chart’s series collection +The index of this series in the chart’s series. </p> @@ -503,6 +504,19 @@ retrieves the series index in the chart’s series collection </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> @@ -539,7 +553,8 @@ retrieves the series index in the chart’s series collection </p><div class="docstring"> <div class="discussion"> <p> -The order of this series in the chart’s series. +The order of this series in the chart’s series. By default the order +is the index of the series. </p> @@ -706,17 +721,17 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +60 61 62 63 64 65 66 -67 -68</pre> +67</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/series.rb', line 61</span> + <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> @@ -737,7 +752,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:42 2011 by + Generated on Wed Nov 23 12:23:59 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> diff --git a/doc/Axlsx/SeriesTitle.html b/doc/Axlsx/SeriesTitle.html index 8c6e2377..46224b97 100644 --- a/doc/Axlsx/SeriesTitle.html +++ b/doc/Axlsx/SeriesTitle.html @@ -97,7 +97,8 @@ <h2>Overview</h2><div class="docstring"> <div class="discussion"> <p> -A series title is a Title with a slightly different serialization +A series title is a Title with a slightly different serialization than +chart titles. </p> @@ -280,7 +281,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:39 2011 by + Generated on Wed Nov 23 12:24:04 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> diff --git a/doc/Axlsx/SimpleTypedList.html b/doc/Axlsx/SimpleTypedList.html index d28079f3..72ff9c07 100644 --- a/doc/Axlsx/SimpleTypedList.html +++ b/doc/Axlsx/SimpleTypedList.html @@ -107,7 +107,7 @@ methods from Array and supports basic xml serialization. </div><div id="subclasses"> <h2>Direct Known Subclasses</h2> - <p class="children"><span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span>, <span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span>, <span class='object_link'><a href="TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span>, <span class='object_link'><a href="TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span></p> + <p class="children"><span class='object_link'><a href="CatAxisData.html" title="Axlsx::CatAxisData (class)">CatAxisData</a></span>, <span class='object_link'><a href="ContentType.html" title="Axlsx::ContentType (class)">ContentType</a></span>, <span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span>, <span class='object_link'><a href="TableStyle.html" title="Axlsx::TableStyle (class)">TableStyle</a></span>, <span class='object_link'><a href="TableStyles.html" title="Axlsx::TableStyles (class)">TableStyles</a></span></p> </div> @@ -237,6 +237,31 @@ Concat operator. <li class="public "> <span class="summary_signature"> + <a href="#%3D%3D-instance_method" title="#== (instance method)">- (Object) <strong>==</strong>(v) </a> + + + + </span> + + + + + + + + + <span class="summary_desc"><div class='inline'><p> +override the equality method so that this object can be compared to a +simple array. +</p> +</div></span> + +</li> + + + <li class="public "> + <span class="summary_signature"> + <a href="#%5B%5D%3D-instance_method" title="#[]= (instance method)">- (Object) <strong>[]=</strong>(index, v) </a> @@ -643,7 +668,6 @@ the following methods are not allowed <span class='symbol val'>:drop_while</span> <span class='symbol val'>:delete_if</span> <span class='symbol val'>:clear</span> - <span class='symbol val'>:concat</span> </pre> </div> </div> @@ -677,23 +701,25 @@ method_mission override to pass allowed methods to the list. <pre class="lines"> -127 -128 -129 -130 131 132 133 -134</pre> +134 +135 +136 +137 +138 +139</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 127</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 131</span> <span class='def def kw'>def</span> <span class='method_missing identifier id'>method_missing</span><span class='lparen token'>(</span><span class='meth identifier id'>meth</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</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='dstring node'>"#{meth} not supported"</span> <span class='if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:replace</span><span class='comma token'>,</span> <span class='symbol val'>:insert</span><span class='comma token'>,</span> <span class='symbol val'>:collect!</span><span class='comma token'>,</span> <span class='symbol val'>:map!</span><span class='comma token'>,</span> <span class='symbol val'>:pop</span><span class='comma token'>,</span> <span class='symbol val'>:delete_if</span><span class='comma token'>,</span> <span class='symbol val'>:reverse!</span><span class='comma token'>,</span> <span class='symbol val'>:shift</span><span class='comma token'>,</span> <span class='symbol val'>:shuffle!</span><span class='comma token'>,</span> <span class='symbol val'>:slice!</span><span class='comma token'>,</span> <span class='symbol val'>:sort!</span><span class='comma token'>,</span> <span class='symbol val'>:uniq!</span><span class='comma token'>,</span> <span class='symbol val'>:unshift</span><span class='comma token'>,</span> <span class='symbol val'>:zip</span><span class='comma token'>,</span> <span class='symbol val'>:flatten!</span><span class='comma token'>,</span> <span class='symbol val'>:fill</span><span class='comma token'>,</span> <span class='symbol val'>:drop</span><span class='comma token'>,</span> <span class='symbol val'>:drop_while</span><span class='comma token'>,</span> <span class='symbol val'>:delete_if</span><span class='comma token'>,</span> <span class='symbol val'>:clear</span><span class='comma token'>,</span> <span class='symbol val'>:concat</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='meth identifier id'>meth</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> + <span class='raise identifier id'>raise</span> <span class='ArgumentError constant id'>ArgumentError</span><span class='comma token'>,</span> <span class='dstring node'>"#{meth} not supported"</span> <span class='if if_mod kw'>if</span> <span class='lbrack token'>[</span><span class='symbol val'>:replace</span><span class='comma token'>,</span> <span class='symbol val'>:insert</span><span class='comma token'>,</span> <span class='symbol val'>:collect!</span><span class='comma token'>,</span> <span class='symbol val'>:map!</span><span class='comma token'>,</span> <span class='symbol val'>:pop</span><span class='comma token'>,</span> <span class='symbol val'>:delete_if</span><span class='comma token'>,</span> <span class='symbol val'>:reverse!</span><span class='comma token'>,</span> <span class='symbol val'>:shift</span><span class='comma token'>,</span> <span class='symbol val'>:shuffle!</span><span class='comma token'>,</span> <span class='symbol val'>:slice!</span><span class='comma token'>,</span> <span class='symbol val'>:sort!</span><span class='comma token'>,</span> <span class='symbol val'>:uniq!</span><span class='comma token'>,</span> <span class='symbol val'>:unshift</span><span class='comma token'>,</span> <span class='symbol val'>:zip</span><span class='comma token'>,</span> <span class='symbol val'>:flatten!</span><span class='comma token'>,</span> <span class='symbol val'>:fill</span><span class='comma token'>,</span> <span class='symbol val'>:drop</span><span class='comma token'>,</span> <span class='symbol val'>:drop_while</span><span class='comma token'>,</span> <span class='symbol val'>:delete_if</span><span class='comma token'>,</span> <span class='symbol val'>:clear</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='include? fid id'>include?</span> <span class='meth identifier id'>meth</span><span class='dot token'>.</span><span class='to_sym identifier id'>to_sym</span> <span class='if if kw'>if</span> <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='meth identifier id'>meth</span> <span class='@list ivar id'>@list</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='meth identifier id'>meth</span><span class='comma token'>,</span> <span class='mult op'>*</span><span class='args identifier id'>args</span><span class='comma token'>,</span> <span class='bitand op'>&</span><span class='block identifier id'>block</span><span class='rparen token'>)</span> <span class='else else kw'>else</span> + <span class='puts identifier id'>puts</span> <span class='dstring node'>"method:#{meth.inspect}"</span> <span class='super super kw'>super</span> <span class='end end kw'>end</span> <span class='end end kw'>end</span> @@ -993,6 +1019,49 @@ if the value being added is not one fo the allowed types </div> <div class="method_details "> + <p class="signature " id="==-instance_method"> + + - (<tt>Object</tt>) <strong>==</strong>(v) + + + +</p><div class="docstring"> + <div class="discussion"> + <p> +override the equality method so that this object can be compared to a +simple array. if this object’s list is equal to the specifiec array, +we return true. +</p> + + + </div> +</div> +<div class="tags"> + + +</div><table class="source_code"> + <tr> + <td> + <pre class="lines"> + + +105 +106 +107</pre> + </td> + <td> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 105</span> + +<span class='def def kw'>def</span> <span class='eq op'>==</span><span class='lparen token'>(</span><span class='v identifier id'>v</span><span class='rparen token'>)</span> + <span class='v identifier id'>v</span> <span class='eq op'>==</span> <span class='@list ivar id'>@list</span> +<span class='end end kw'>end</span> +</pre> + </td> + </tr> +</table> +</div> + + <div class="method_details "> <p class="signature " id="[]=-instance_method"> - (<tt>Object</tt>) <strong>[]=</strong>(index, v) @@ -1523,16 +1592,16 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -141 -142 -143 -144 -145 146 -147</pre> +147 +148 +149 +150 +151 +152</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 141</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/util/simple_typed_list.rb', line 146</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='classname identifier id'>classname</span> <span class='assign token'>=</span> <span class='@allowed_types ivar id'>@allowed_types</span><span class='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='dot token'>.</span><span class='name identifier id'>name</span><span class='dot token'>.</span><span class='split identifier id'>split</span><span class='lparen token'>(</span><span class='string val'>'::'</span><span class='rparen token'>)</span><span class='dot token'>.</span><span class='last identifier id'>last</span> @@ -1608,7 +1677,7 @@ Unlock the list </div> <div id="footer"> - Generated on Tue Nov 22 23:52:48 2011 by + Generated on Wed Nov 23 12:23:53 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> diff --git a/doc/Axlsx/Styles.html b/doc/Axlsx/Styles.html index a11d4454..8044712f 100644 --- a/doc/Axlsx/Styles.html +++ b/doc/Axlsx/Styles.html @@ -1745,7 +1745,7 @@ Serializes the styles document </div> <div id="footer"> - Generated on Tue Nov 22 23:52:40 2011 by + Generated on Wed Nov 23 12:23:56 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> diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html index 0bd012be..5318b1d7 100644 --- a/doc/Axlsx/TableStyle.html +++ b/doc/Axlsx/TableStyle.html @@ -289,7 +289,7 @@ Serializes the table style. <h3 class="inherited">Methods 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#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%3D%3D-instance_method" title="Axlsx::SimpleTypedList#== (method)">#==</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> @@ -701,7 +701,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:50 2011 by + Generated on Wed Nov 23 12:24:01 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> diff --git a/doc/Axlsx/TableStyleElement.html b/doc/Axlsx/TableStyleElement.html index 4f2ed657..7616bef5 100644 --- a/doc/Axlsx/TableStyleElement.html +++ b/doc/Axlsx/TableStyleElement.html @@ -668,7 +668,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:53 2011 by + Generated on Wed Nov 23 12:23:56 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> diff --git a/doc/Axlsx/TableStyles.html b/doc/Axlsx/TableStyles.html index be8a4c84..2458c69b 100644 --- a/doc/Axlsx/TableStyles.html +++ b/doc/Axlsx/TableStyles.html @@ -265,7 +265,7 @@ Serializes the table styles element. <h3 class="inherited">Methods 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#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> + <p class="inherited"><span class='object_link'><a href="SimpleTypedList.html#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%3D%3D-instance_method" title="Axlsx::SimpleTypedList#== (method)">#==</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</a></span></p> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> @@ -590,7 +590,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:39 2011 by + Generated on Wed Nov 23 12:24:00 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> diff --git a/doc/Axlsx/Title.html b/doc/Axlsx/Title.html index 9a97f09c..f66f1339 100644 --- a/doc/Axlsx/Title.html +++ b/doc/Axlsx/Title.html @@ -616,7 +616,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:51 2011 by + Generated on Wed Nov 23 12:23:51 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> diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html index fc8e86a3..20e6e8c8 100644 --- a/doc/Axlsx/TwoCellAnchor.html +++ b/doc/Axlsx/TwoCellAnchor.html @@ -277,30 +277,6 @@ A marker that returns the to cell anchor. <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. -</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, chart_type, options) </a> @@ -317,31 +293,8 @@ This is a short cut method to set the end anchor position. <span class="summary_desc"><div class='inline'><p> -Creates a new TwoCellAnchor object. -</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. +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> @@ -388,7 +341,9 @@ Serializes the two cell anchor. </p><div class="docstring"> <div class="discussion"> <p> -Creates a new TwoCellAnchor object +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> @@ -411,13 +366,20 @@ Creates a new TwoCellAnchor object <li> - <span class='name'>chart</span> + <span class='name'>chart_type</span> - <span class='type'>(<tt><span class='object_link'><a href="Chart.html" title="Axlsx::Chart (class)">Chart</a></span></tt>)</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> @@ -455,7 +417,10 @@ a customizable set of options <span class="default"> </span> - + — <div class='inline'><p> +the col, row to start at +</p> +</div> </li> <li> @@ -464,7 +429,10 @@ a customizable set of options <span class="default"> </span> - + — <div class='inline'><p> +the col, row to end at +</p> +</div> </li> </ul> @@ -477,37 +445,21 @@ a customizable set of options <pre class="lines"> -31 -32 -33 34 35 36 37 38 -39 -40 -41 -42 -43 -44</pre> +39</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 31</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.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='drawing identifier id'>drawing</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='@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='@graphic_frame ivar id'>@graphic_frame</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='self self kw'>self</span><span class='dot token'>.</span><span class='start_at identifier id'>start_at</span><span class='lparen token'>(</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='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='comma token'>,</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='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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</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='self self kw'>self</span><span class='dot token'>.</span><span class='end_at identifier id'>end_at</span><span class='lparen token'>(</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='lbrack token'>[</span><span class='integer val'>0</span><span class='rbrack token'>]</span><span class='comma token'>,</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='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='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</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='comment val'># passing a reference to our start and end markers for convenience</span> - <span class='comment val'># this lets us access the markers directly from the chart.</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:start_at=</span><span class='comma token'>,</span> <span class='@from ivar id'>@from</span><span class='rparen token'>)</span> - <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='symbol val'>:end_at=</span><span class='comma token'>,</span> <span class='@to ivar id'>@to</span><span class='rparen token'>)</span> <span class='end end kw'>end</span> </pre> </td> @@ -815,199 +767,7 @@ A marker that returns the to cell anchor. The default to column and row are <div class="method_details first"> - <p class="signature first" 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 -</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"> - - -65 -66 -67 -68 -69</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 65</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='@to ivar 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='@to ivar 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='@to ivar id'>@to</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 -</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"> - - -55 -56 -57 -58 -59</pre> - </td> - <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 55</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='@from ivar 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='@from ivar 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='@from ivar id'>@from</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"> + <p class="signature first" id="to_xml-instance_method"> - (<tt>String</tt>) <strong>to_xml</strong>(xml) @@ -1065,22 +825,22 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -74 -75 -76 -77 -78 -79 -80 -81 -82 -83 -84 -85 -86</pre> +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/two_cell_anchor.rb', line 74</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.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='comment val'>#build it for now, break it down later!</span> @@ -1106,7 +866,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:48 2011 by + Generated on Wed Nov 23 12:24:02 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> diff --git a/doc/Axlsx/ValAxis.html b/doc/Axlsx/ValAxis.html index f5101e70..6275d10b 100644 --- a/doc/Axlsx/ValAxis.html +++ b/doc/Axlsx/ValAxis.html @@ -135,8 +135,7 @@ the ValAxis class defines a chart value axis. <span class="summary_desc"><div class='inline'><p> -This element specifies whether the value axis crosses the category axis -between categories. +This element specifies how the value axis crosses the category axis. </p> </div></span> @@ -320,7 +319,7 @@ a customizable set of options </li> <li> - <span class="name">crosses</span> + <span class="name">tickLblPos</span> <span class="type">(<tt>Symbol</tt>)</span> <span class="default"> @@ -329,7 +328,7 @@ a customizable set of options </li> <li> - <span class="name">tickLblPos</span> + <span class="name">crosses</span> <span class="type">(<tt>Symbol</tt>)</span> <span class="default"> @@ -365,7 +364,7 @@ a customizable set of options <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='@crossBetween ivar id'>@crossBetween</span> <span class='assign token'>=</span> <span class='symbol val'>:between</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> @@ -392,8 +391,8 @@ a customizable set of options </p><div class="docstring"> <div class="discussion"> <p> -This element specifies whether the value axis crosses the category axis -between categories. must be one of [:between, :midCat] +This element specifies how the value axis crosses the category axis. must +be one of [:between, :midCat] </p> @@ -530,7 +529,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:42 2011 by + Generated on Wed Nov 23 12:24:00 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> diff --git a/doc/Axlsx/ValAxisData.html b/doc/Axlsx/ValAxisData.html new file mode 100644 index 00000000..25145718 --- /dev/null +++ b/doc/Axlsx/ValAxisData.html @@ -0,0 +1,326 @@ +<!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 + + — Documentation by YARD 0.7.3 + +</title> + + <link rel="stylesheet" href="../css/style.css" type="text/css" media="screen" charset="utf-8" /> + + <link rel="stylesheet" href="../css/common.css" type="text/css" media="screen" charset="utf-8" /> + +<script type="text/javascript" charset="utf-8"> + relpath = '..'; + if (relpath != '') relpath += '/'; +</script> + + <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script> + + <script type="text/javascript" charset="utf-8" src="../js/app.js"></script> + + + </head> + <body> + <script type="text/javascript" charset="utf-8"> + if (window.top.frames.main) document.body.className = 'frames'; + </script> + + <div id="header"> + <div id="menu"> + + <a href="../_index.html">Index (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> + + + + + + + + + <h3 class="inherited">Methods 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#%3C%3C-instance_method" title="Axlsx::SimpleTypedList#<< (method)">#<<</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%3D%3D-instance_method" title="Axlsx::SimpleTypedList#== (method)">#==</a></span>, <span class='object_link'><a href="SimpleTypedList.html#%5B%5D%3D-instance_method" title="Axlsx::SimpleTypedList#[]= (method)">#[]=</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete-instance_method" title="Axlsx::SimpleTypedList#delete (method)">#delete</a></span>, <span class='object_link'><a href="SimpleTypedList.html#delete_at-instance_method" title="Axlsx::SimpleTypedList#delete_at (method)">#delete_at</a></span>, <span class='object_link'><a href="SimpleTypedList.html#initialize-instance_method" title="Axlsx::SimpleTypedList#initialize (method)">#initialize</a></span>, <span class='object_link'><a href="SimpleTypedList.html#lock-instance_method" title="Axlsx::SimpleTypedList#lock (method)">#lock</a></span>, <span class='object_link'><a href="SimpleTypedList.html#method_missing-instance_method" title="Axlsx::SimpleTypedList#method_missing (method)">#method_missing</a></span>, <span class='object_link'><a href="SimpleTypedList.html#protected%3F-instance_method" title="Axlsx::SimpleTypedList#protected? (method)">#protected?</a></span>, <span class='object_link'><a href="SimpleTypedList.html#push-instance_method" title="Axlsx::SimpleTypedList#push (method)">#push</a></span>, <span class='object_link'><a href="SimpleTypedList.html#unlock-instance_method" title="Axlsx::SimpleTypedList#unlock (method)">#unlock</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 23 12:23:41 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 index 73bfd8bf..cdc5599f 100644 --- a/doc/Axlsx/View3D.html +++ b/doc/Axlsx/View3D.html @@ -494,14 +494,14 @@ a customizable set of options <pre class="lines"> -39 -40 -41 -42 -43</pre> +46 +47 +48 +49 +50</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 39</span> + <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='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> @@ -560,12 +560,12 @@ depth or chart as % of chart width must be between 20% and 2000% <pre class="lines"> -22 -23 -24</pre> +29 +30 +31</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 22</span> + <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> @@ -617,12 +617,12 @@ height of chart as % of chart must be between 5% and 500% <pre class="lines"> -12 -13 -14</pre> +19 +20 +21</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 12</span> + <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> @@ -674,12 +674,12 @@ field of view angle <pre class="lines"> -30 -31 -32</pre> +37 +38 +39</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 30</span> + <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> @@ -731,12 +731,12 @@ Chart axis are at right angles <pre class="lines"> -26 -27 -28</pre> +33 +34 +35</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 26</span> + <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> @@ -788,12 +788,12 @@ x rotation for the chart must be between -90 and 90 <pre class="lines"> -7 -8 -9</pre> +14 +15 +16</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 7</span> + <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> @@ -845,12 +845,12 @@ y rotation for the chart must be between 0 and 360 <pre class="lines"> -17 -18 -19</pre> +24 +25 +26</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 17</span> + <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> @@ -927,19 +927,19 @@ The document builder instance this objects xml will be added to. <pre class="lines"> -61 -62 -63 -64 -65 -66 67 68 69 -70</pre> +70 +71 +72 +73 +74 +75 +76</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.rb', line 61</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/view_3D.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='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> @@ -962,7 +962,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:36 2011 by + Generated on Wed Nov 23 12:23:52 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> diff --git a/doc/Axlsx/Workbook.html b/doc/Axlsx/Workbook.html index 134092c7..37e81c09 100644 --- a/doc/Axlsx/Workbook.html +++ b/doc/Axlsx/Workbook.html @@ -1338,7 +1338,7 @@ Serializes the workbook document </div> <div id="footer"> - Generated on Tue Nov 22 23:52:49 2011 by + Generated on Wed Nov 23 12:23:53 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> diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html index f3131f16..93e90793 100644 --- a/doc/Axlsx/Worksheet.html +++ b/doc/Axlsx/Worksheet.html @@ -1287,8 +1287,20 @@ The workbook that owns this worksheet </p><div class="docstring"> <div class="discussion"> - <p> -Adds a chart to this worksheets drawing. + + <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> @@ -1365,6 +1377,24 @@ a customizable set of options </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> @@ -1382,20 +1412,35 @@ a customizable set of options </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"> -108 -109 -110 -111 -112</pre> +116 +117 +118 +119 +120</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 108</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 116</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> @@ -1615,19 +1660,19 @@ hash of auto_fit_data <pre class="lines"> -182 -183 -184 -185 -186 -187 -188 -189 190 -191</pre> +191 +192 +193 +194 +195 +196 +197 +198 +199</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 182</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 190</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 in testable fonts so instead of beating RMagick every time, I am hardcoding it here.</span> @@ -1683,14 +1728,6 @@ Serializes the worksheet document <pre class="lines"> -116 -117 -118 -119 -120 -121 -122 -123 124 125 126 @@ -1703,10 +1740,18 @@ Serializes the worksheet document 133 134 135 -136</pre> +136 +137 +138 +139 +140 +141 +142 +143 +144</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 116</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 124</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> @@ -1802,14 +1847,6 @@ of Cell objects <pre class="lines"> -154 -155 -156 -157 -158 -159 -160 -161 162 163 164 @@ -1820,10 +1857,18 @@ of Cell objects 169 170 171 -172</pre> +172 +173 +174 +175 +176 +177 +178 +179 +180</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 154</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/workbook/worksheet/worksheet.rb', line 162</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> @@ -1855,7 +1900,7 @@ of Cell objects </div> <div id="footer"> - Generated on Tue Nov 22 23:52:47 2011 by + Generated on Wed Nov 23 12:23:49 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> diff --git a/doc/Axlsx/Xf.html b/doc/Axlsx/Xf.html index 17c94f7f..f92867c7 100644 --- a/doc/Axlsx/Xf.html +++ b/doc/Axlsx/Xf.html @@ -1672,7 +1672,7 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Tue Nov 22 23:52:54 2011 by + Generated on Wed Nov 23 12:23:42 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> |