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/Chart.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/Chart.html')
| -rw-r--r-- | doc/Axlsx/Chart.html | 661 |
1 files changed, 449 insertions, 212 deletions
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> |
