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/Pie3DChart.html | |
| 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/Pie3DChart.html')
| -rw-r--r-- | doc/Axlsx/Pie3DChart.html | 184 |
1 files changed, 118 insertions, 66 deletions
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> |
