diff options
| author | Randy Morgan <[email protected]> | 2011-11-27 21:45:19 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-27 21:45:19 +0900 |
| commit | cdfc7251bde8347678d355e5fe65fc20e120bc23 (patch) | |
| tree | d555a2b6a70b8e5b735aa7ef2248017cf7b1447e /doc/Axlsx/Chart.html | |
| parent | e6d269d03875bc0a4687b9d5f4b7016fc7d27b32 (diff) | |
| download | caxlsx-cdfc7251bde8347678d355e5fe65fc20e120bc23.tar.gz caxlsx-cdfc7251bde8347678d355e5fe65fc20e120bc23.zip | |
updating docs for 1.0.10a release
Diffstat (limited to 'doc/Axlsx/Chart.html')
| -rw-r--r-- | doc/Axlsx/Chart.html | 417 |
1 files changed, 238 insertions, 179 deletions
diff --git a/doc/Axlsx/Chart.html b/doc/Axlsx/Chart.html index 52ac2c91..7a9b16d3 100644 --- a/doc/Axlsx/Chart.html +++ b/doc/Axlsx/Chart.html @@ -97,14 +97,16 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'> -<p>Worksheet#add_chart is the recommended way to create charts for your -worksheets.</p> + <div class='inline'><p> +Worksheet#add_chart is the recommended way to create charts for your +worksheets. +</p> </div> </div> - -<p>A Chart is the superclass for specific charts</p> +<p> +A Chart is the superclass for specific charts +</p> </div> @@ -147,8 +149,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>A reference to the graphic frame that owns this chart.</p> + <span class="summary_desc"><div class='inline'><p> +A reference to the graphic frame that owns this chart. +</p> </div></span> </li> @@ -173,8 +176,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>A collection of series objects that are applied to the chart.</p> + <span class="summary_desc"><div class='inline'><p> +A collection of series objects that are applied to the chart. +</p> </div></span> </li> @@ -199,8 +203,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The type of series to use for this chart.</p> + <span class="summary_desc"><div class='inline'><p> +The type of series to use for this chart. +</p> </div></span> </li> @@ -225,8 +230,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>Show the legend in the chart.</p> + <span class="summary_desc"><div class='inline'><p> +Show the legend in the chart. +</p> </div></span> </li> @@ -251,8 +257,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The style for the chart.</p> + <span class="summary_desc"><div class='inline'><p> +The style for the chart. +</p> </div></span> </li> @@ -277,8 +284,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The title object for the chart.</p> + <span class="summary_desc"><div class='inline'><p> +The title object for the chart. +</p> </div></span> </li> @@ -303,8 +311,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>The 3D view properties for the chart.</p> + <span class="summary_desc"><div class='inline'><p> +The 3D view properties for the chart. +</p> </div></span> </li> @@ -339,8 +348,9 @@ worksheets.</p> - <span class="summary_desc"><div class='inline'> -<p>Adds a new series to the chart's series collection.</p> + <span class="summary_desc"><div class='inline'><p> +Adds a new series to the chart’s series collection. +</p> </div></span> </li> @@ -362,9 +372,10 @@ worksheets.</p> - <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> + <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> @@ -386,9 +397,10 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers.</p> + <span class="summary_desc"><div class='inline'><p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers. +</p> </div></span> </li> @@ -410,8 +422,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>The index of this chart in the workbooks charts collection.</p> + <span class="summary_desc"><div class='inline'><p> +The index of this chart in the workbooks charts collection. +</p> </div></span> </li> @@ -435,8 +448,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>Creates a new chart object.</p> + <span class="summary_desc"><div class='inline'><p> +Creates a new chart object. +</p> </div></span> </li> @@ -458,8 +472,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>The part name for this chart.</p> + <span class="summary_desc"><div class='inline'><p> +The part name for this chart. +</p> </div></span> </li> @@ -481,10 +496,11 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>This is a short cut method to set the start anchor position If you need + <span class="summary_desc"><div class='inline'><p> +This is a short cut method to set the start anchor position If you need finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff.</p> +rowOff. +</p> </div></span> </li> @@ -506,9 +522,10 @@ rowOff.</p> - <span class="summary_desc"><div class='inline'> -<p>backwards compatibility to allow chart.to and chart.from access to anchor -markers.</p> + <span class="summary_desc"><div class='inline'><p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers. +</p> </div></span> </li> @@ -530,8 +547,9 @@ markers.</p> - <span class="summary_desc"><div class='inline'> -<p>Chart Serialization serializes the chart.</p> + <span class="summary_desc"><div class='inline'><p> +Chart Serialization serializes the chart. +</p> </div></span> </li> @@ -552,8 +570,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Creates a new chart object</p> + <p> +Creates a new chart object +</p> </div> @@ -572,8 +591,9 @@ markers.</p> — - <div class='inline'> -<p>The frame that holds this chart.</p> + <div class='inline'><p> +The frame that holds this chart. +</p> </div> </li> @@ -590,8 +610,9 @@ markers.</p> — - <div class='inline'> -<p>a customizable set of options</p> + <div class='inline'><p> +a customizable set of options +</p> </div> </li> @@ -653,8 +674,9 @@ markers.</p> — - <div class='inline'> -<p>the object that the method was called on</p> + <div class='inline'><p> +the object that the method was called on +</p> </div> </li> @@ -685,20 +707,21 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 44</span> -<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id frame'>frame</span><span class='comma'>,</span> <span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@style</span> <span class='op'>=</span> <span class='int'>2</span> - <span class='ivar'>@graphic_frame</span><span class='op'>=</span><span class='id frame'>frame</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id charts'>charts</span> <span class='op'><<</span> <span class='kw'>self</span> - <span class='ivar'>@series</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='const'>Series</span> - <span class='ivar'>@show_legend</span> <span class='op'>=</span> <span class='kw'>true</span> - <span class='ivar'>@series_type</span> <span class='op'>=</span> <span class='const'>Series</span> - <span class='id options'>options</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id o'>o</span><span class='op'>|</span> - <span class='kw'>self</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>1</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='kw'>self</span><span class='period'>.</span><span class='id respond_to?'>respond_to?</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='id o'>o</span><span class='lbracket'>[</span><span class='int'>0</span><span class='rbracket'>]</span><span class='rbrace'>}</span><span class='tstring_content'>=</span><span class='tstring_end'>"</span></span> - <span class='kw'>end</span> - <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='op'>*</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span> - <span class='id end_at'>end_at</span><span class='lparen'>(</span><span class='op'>*</span><span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:end_at</span><span class='rbracket'>]</span><span class='rparen'>)</span> <span class='kw'>if</span> <span class='id options'>options</span><span class='lbracket'>[</span><span class='symbol'>:start_at</span><span class='rbracket'>]</span> - <span class='kw'>yield</span> <span class='kw'>self</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='frame identifier id'>frame</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@style ivar id'>@style</span> <span class='assign token'>=</span> <span class='integer val'>2</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='assign token'>=</span><span class='frame identifier id'>frame</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> + <span class='@series ivar id'>@series</span> <span class='assign token'>=</span> <span class='SimpleTypedList constant id'>SimpleTypedList</span><span class='dot token'>.</span><span class='new identifier id'>new</span> <span class='Series constant id'>Series</span> + <span class='@show_legend ivar id'>@show_legend</span> <span class='assign token'>=</span> <span class='true true kw'>true</span> + <span class='@series_type ivar id'>@series_type</span> <span class='assign token'>=</span> <span class='Series constant id'>Series</span> + <span class='options identifier id'>options</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='o identifier id'>o</span><span class='bitor op'>|</span> + <span class='self self kw'>self</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='dstring node'>"#{o[0]}="</span><span class='comma token'>,</span> <span class='o identifier id'>o</span><span class='lbrack token'>[</span><span class='integer val'>1</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='self self kw'>self</span><span class='dot token'>.</span><span class='respond_to? fid id'>respond_to?</span> <span class='dstring node'>"#{o[0]}="</span> + <span class='end end kw'>end</span> + <span class='start_at identifier id'>start_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> + <span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='mult op'>*</span><span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:end_at</span><span class='rbrack token'>]</span><span class='rparen token'>)</span> <span class='if if_mod kw'>if</span> <span class='options identifier id'>options</span><span class='lbrack token'>[</span><span class='symbol val'>:start_at</span><span class='rbrack token'>]</span> + <span class='yield yield kw'>yield</span> <span class='self self kw'>self</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -721,8 +744,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A reference to the graphic frame that owns this chart</p> + <p> +A reference to the graphic frame that owns this chart +</p> </div> @@ -756,9 +780,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 14</span> -<span class='kw'>def</span> <span class='id graphic_frame'>graphic_frame</span> - <span class='ivar'>@graphic_frame</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='graphic_frame identifier id'>graphic_frame</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -776,8 +801,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>A collection of series objects that are applied to the chart</p> + <p> +A collection of series objects that are applied to the chart +</p> </div> @@ -811,9 +837,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 18</span> -<span class='kw'>def</span> <span class='id series'>series</span> - <span class='ivar'>@series</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='series identifier id'>series</span> + <span class='@series ivar id'>@series</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -831,8 +858,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The type of series to use for this chart.</p> + <p> +The type of series to use for this chart. +</p> </div> @@ -866,9 +894,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 22</span> -<span class='kw'>def</span> <span class='id series_type'>series_type</span> - <span class='ivar'>@series_type</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='series_type identifier id'>series_type</span> + <span class='@series_type ivar id'>@series_type</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -886,8 +915,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Show the legend in the chart</p> + <p> +Show the legend in the chart +</p> </div> @@ -921,9 +951,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 38</span> -<span class='kw'>def</span> <span class='id show_legend'>show_legend</span> - <span class='ivar'>@show_legend</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='show_legend identifier id'>show_legend</span> + <span class='@show_legend ivar id'>@show_legend</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -941,8 +972,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The style for the chart. see ECMA Part 1 §21.2.2.196</p> + <p> +The style for the chart. see ECMA Part 1 §21.2.2.196 +</p> </div> @@ -976,9 +1008,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 34</span> -<span class='kw'>def</span> <span class='id style'>style</span> - <span class='ivar'>@style</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='style identifier id'>style</span> + <span class='@style ivar id'>@style</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -996,8 +1029,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The title object for the chart.</p> + <p> +The title object for the chart. +</p> </div> @@ -1031,9 +1065,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 29</span> -<span class='kw'>def</span> <span class='id title'>title</span> - <span class='ivar'>@title</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='title identifier id'>title</span> + <span class='@title ivar id'>@title</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1051,8 +1086,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>The 3D view properties for the chart</p> + <p> +The 3D view properties for the chart +</p> </div> @@ -1073,9 +1109,10 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 10</span> -<span class='kw'>def</span> <span class='id view3D'>view3D</span> - <span class='ivar'>@view3D</span> -<span class='kw'>end</span></pre> +<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> @@ -1097,8 +1134,9 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>Adds a new series to the chart's series collection.</p> + <p> +Adds a new series to the chart’s series collection. +</p> </div> @@ -1140,10 +1178,11 @@ markers.</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 106</span> -<span class='kw'>def</span> <span class='id add_series'>add_series</span><span class='lparen'>(</span><span class='id options'>options</span><span class='op'>=</span><span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span> - <span class='ivar'>@series_type</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='kw'>self</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> - <span class='ivar'>@series</span><span class='period'>.</span><span class='id last'>last</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='add_series identifier id'>add_series</span><span class='lparen token'>(</span><span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> + <span class='@series_type ivar id'>@series_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> + <span class='@series ivar id'>@series</span><span class='dot token'>.</span><span class='last identifier id'>last</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1158,9 +1197,10 @@ markers.</p> </p><div class="docstring"> <div class="discussion"> - -<p>This is a short cut method to set the end anchor position If you need finer -granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> + <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> @@ -1179,8 +1219,9 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> — - <div class='inline'> -<p>The column</p> + <div class='inline'><p> +The column +</p> </div> </li> @@ -1195,8 +1236,9 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> — - <div class='inline'> -<p>The row</p> + <div class='inline'><p> +The row +</p> </div> </li> @@ -1231,10 +1273,11 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 154</span> -<span class='kw'>def</span> <span class='id end_at'>end_at</span><span class='lparen'>(</span><span class='id x'>x</span><span class='comma'>,</span> <span class='id y'>y</span><span class='rparen'>)</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to'>to</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id x'>x</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to'>to</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id y'>y</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='end_at identifier id'>end_at</span><span class='lparen token'>(</span><span class='x identifier id'>x</span><span class='comma token'>,</span> <span class='y identifier id'>y</span><span class='rparen token'>)</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span><span class='dot token'>.</span><span class='col identifier id'>col</span> <span class='assign token'>=</span> <span class='x identifier id'>x</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span><span class='dot token'>.</span><span class='row identifier id'>row</span> <span class='assign token'>=</span> <span class='y identifier id'>y</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1252,14 +1295,16 @@ granularity in positioning use graphic_frame.anchor.to.colOff / rowOff</p> <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 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> +<p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers +</p> </div> @@ -1280,9 +1325,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 99</span> -<span class='kw'>def</span> <span class='id from'>from</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id from'>from</span> -<span class='kw'>end</span></pre> +<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> @@ -1297,8 +1343,9 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>The index of this chart in the workbooks charts collection</p> + <p> +The index of this chart in the workbooks charts collection +</p> </div> @@ -1332,9 +1379,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 61</span> -<span class='kw'>def</span> <span class='id index'>index</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id drawing'>drawing</span><span class='period'>.</span><span class='id worksheet'>worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id charts'>charts</span><span class='period'>.</span><span class='id index'>index</span><span class='lparen'>(</span><span class='kw'>self</span><span class='rparen'>)</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='index identifier id'>index</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='worksheet identifier id'>worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1349,8 +1397,9 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>The part name for this chart</p> + <p> +The part name for this chart +</p> </div> @@ -1384,9 +1433,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 67</span> -<span class='kw'>def</span> <span class='id pn'>pn</span> - <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>CHART_PN</span> <span class='op'>%</span> <span class='lparen'>(</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rparen'>)</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> + <span class='dstring node'>"#{CHART_PN % (index+1)}"</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1401,10 +1451,11 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>This is a short cut method to set the start anchor position If you need + <p> +This is a short cut method to set the start anchor position If you need finer granularity in positioning use graphic_frame.anchor.from.colOff / -rowOff</p> +rowOff +</p> </div> @@ -1423,8 +1474,9 @@ rowOff</p> — - <div class='inline'> -<p>The column</p> + <div class='inline'><p> +The column +</p> </div> </li> @@ -1439,8 +1491,9 @@ rowOff</p> — - <div class='inline'> -<p>The row</p> + <div class='inline'><p> +The row +</p> </div> </li> @@ -1475,10 +1528,11 @@ rowOff</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 143</span> -<span class='kw'>def</span> <span class='id start_at'>start_at</span><span class='lparen'>(</span><span class='id x'>x</span><span class='comma'>,</span> <span class='id y'>y</span><span class='rparen'>)</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id col'>col</span> <span class='op'>=</span> <span class='id x'>x</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id from'>from</span><span class='period'>.</span><span class='id row'>row</span> <span class='op'>=</span> <span class='id y'>y</span> -<span class='kw'>end</span></pre> +<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> @@ -1496,14 +1550,16 @@ rowOff</p> <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 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> +<p> +backwards compatibility to allow chart.to and chart.from access to anchor +markers +</p> </div> @@ -1524,9 +1580,10 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 93</span> -<span class='kw'>def</span> <span class='id to'>to</span> - <span class='ivar'>@graphic_frame</span><span class='period'>.</span><span class='id anchor'>anchor</span><span class='period'>.</span><span class='id to'>to</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to identifier id'>to</span> + <span class='@graphic_frame ivar id'>@graphic_frame</span><span class='dot token'>.</span><span class='anchor identifier id'>anchor</span><span class='dot token'>.</span><span class='to identifier id'>to</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1541,8 +1598,9 @@ markers</p> </p><div class="docstring"> <div class="discussion"> - -<p>Chart Serialization serializes the chart</p> + <p> +Chart Serialization serializes the chart +</p> </div> @@ -1583,29 +1641,30 @@ markers</p> <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/chart.rb', line 113</span> -<span class='kw'>def</span> <span class='id to_xml'>to_xml</span> - <span class='id builder'>builder</span> <span class='op'>=</span> <span class='const'>Nokogiri</span><span class='op'>::</span><span class='const'>XML</span><span class='op'>::</span><span class='const'>Builder</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:encoding</span> <span class='op'>=></span> <span class='const'>ENCODING</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id xml'>xml</span><span class='op'>|</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:chartSpace</span><span class='tstring_end'>'</span></span><span class='comma'>,</span><span class='symbol'>:xmlns:c</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_C</span><span class='comma'>,</span> <span class='symbol'>:xmlns:a</span><span class='tstring_end'>'</span></span> <span class='op'>=></span> <span class='const'>XML_NS_A</span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:date1904</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='const'>Axlsx</span><span class='op'>::</span><span class='const'>Workbook</span><span class='period'>.</span><span class='id date1904'>date1904</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:style</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span><span class='op'>=></span><span class='id style'>style</span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:chart</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='ivar'>@title</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@title</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='ivar'>@view3D</span><span class='period'>.</span><span class='id to_xml'>to_xml</span><span class='lparen'>(</span><span class='id xml'>xml</span><span class='rparen'>)</span> <span class='kw'>unless</span> <span class='ivar'>@view3D</span><span class='period'>.</span><span class='id nil?'>nil?</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:plotArea</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:layout</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='kw'>yield</span> <span class='id xml'>xml</span> <span class='kw'>if</span> <span class='id block_given?'>block_given?</span> - <span class='rbrace'>}</span> - <span class='kw'>if</span> <span class='ivar'>@show_legend</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:legend</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:legendPos</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:val</span> <span class='op'>=></span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>r</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> - <span class='id xml'>xml</span><span class='period'>.</span><span class='id send'>send</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>c:layout</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='rbrace'>}</span> - <span class='rbrace'>}</span> - <span class='kw'>end</span> - <span class='id builder'>builder</span><span class='period'>.</span><span class='id to_xml'>to_xml</span> -<span class='kw'>end</span></pre> +<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span> + <span class='builder identifier id'>builder</span> <span class='assign token'>=</span> <span class='Nokogiri constant id'>Nokogiri</span><span class='colon2 op'>::</span><span class='XML constant id'>XML</span><span class='colon2 op'>::</span><span class='Builder constant id'>Builder</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:encoding</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='ENCODING constant id'>ENCODING</span><span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='xml identifier id'>xml</span><span class='bitor op'>|</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chartSpace'</span><span class='comma token'>,</span><span class='symbol val'>:'xmlns:c'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_C constant id'>XML_NS_C</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:a'</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='XML_NS_A constant id'>XML_NS_A</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:date1904'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='Axlsx constant id'>Axlsx</span><span class='colon2 op'>::</span><span class='Workbook constant id'>Workbook</span><span class='dot token'>.</span><span class='date1904 identifier id'>date1904</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:style'</span><span class='comma token'>,</span> <span class='symbol val'>:val=</span><span class='gt op'>></span><span class='style identifier id'>style</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:chart'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@title ivar id'>@title</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> <span class='unless unless_mod kw'>unless</span> <span class='@view3D ivar id'>@view3D</span><span class='dot token'>.</span><span class='nil? fid id'>nil?</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:plotArea'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:layout'</span><span class='rparen token'>)</span> + <span class='yield yield kw'>yield</span> <span class='xml identifier id'>xml</span> <span class='if if_mod kw'>if</span> <span class='block_given? fid id'>block_given?</span> + <span class='rbrace token'>}</span> + <span class='if if kw'>if</span> <span class='@show_legend ivar id'>@show_legend</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:legend'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:legendPos'</span><span class='comma token'>,</span> <span class='symbol val'>:val</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='string val'>"r"</span><span class='rparen token'>)</span> + <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'c:layout'</span><span class='rparen token'>)</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='rbrace token'>}</span> + <span class='rbrace token'>}</span> + <span class='end end kw'>end</span> + <span class='builder identifier id'>builder</span><span class='dot token'>.</span><span class='to_xml identifier id'>to_xml</span> +<span class='end end kw'>end</span> +</pre> </td> </tr> </table> @@ -1616,9 +1675,9 @@ markers</p> </div> <div id="footer"> - Generated on Sun Nov 27 20:28:12 2011 by + Generated on Sun Nov 27 21:44:40 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.9.3). + 0.7.3 (ruby-1.8.7). </div> </body> |
