diff options
| author | Randy Morgan <[email protected]> | 2011-11-26 13:20:57 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-26 13:20:57 +0900 |
| commit | 11303a4d6664d9a7ff7bc408035d2ab70378a375 (patch) | |
| tree | 51c675ae3ab8cd6c1afd7087145261b1eb2ec54c /doc/Axlsx/GraphicFrame.html | |
| parent | 044afe5a35db42cefce4f18a0fecc3da90cab1b5 (diff) | |
| download | caxlsx-11303a4d6664d9a7ff7bc408035d2ab70378a375.tar.gz caxlsx-11303a4d6664d9a7ff7bc408035d2ab70378a375.zip | |
adding in support for ruby 1.9.3
release version 1.0.9
Diffstat (limited to 'doc/Axlsx/GraphicFrame.html')
| -rw-r--r-- | doc/Axlsx/GraphicFrame.html | 236 |
1 files changed, 106 insertions, 130 deletions
diff --git a/doc/Axlsx/GraphicFrame.html b/doc/Axlsx/GraphicFrame.html index a04b2477..39c8949b 100644 --- a/doc/Axlsx/GraphicFrame.html +++ b/doc/Axlsx/GraphicFrame.html @@ -6,7 +6,7 @@ <title> Class: Axlsx::GraphicFrame - — Documentation by YARD 0.7.3 + — AXLSX </title> @@ -97,15 +97,13 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage charts is Worksheet#add_chart -</p> + <div class='inline'> +<p>The recommended way to manage charts is Worksheet#add_chart</p> </div> </div> -<p> -A graphic frame defines a container for a chart object -</p> + +<p>A graphic frame defines a container for a chart object</p> </div> @@ -144,9 +142,8 @@ A graphic frame defines a container for a chart object - <span class="summary_desc"><div class='inline'><p> -A anchor that holds this frame. -</p> + <span class="summary_desc"><div class='inline'> +<p>A anchor that holds this frame.</p> </div></span> </li> @@ -171,26 +168,37 @@ A anchor that holds this frame. - <span class="summary_desc"><div class='inline'><p> -A reference to the chart object associated with this frame. -</p> + <span class="summary_desc"><div class='inline'> +<p>A reference to the chart object associated with this frame.</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="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> + <a href="#initialize-instance_method" title="#initialize (instance method)">- (GraphicFrame) <strong>initialize</strong>(anchor, chart_type, options) </a> </span> + <span class="note title constructor">constructor</span> - <span class="note title readonly">readonly</span> - @@ -198,38 +206,22 @@ A reference to the chart object associated with this frame. - <span class="summary_desc"><div class='inline'><p> -The relationship id for this graphic. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates a new GraphicFrame object.</p> </div></span> </li> - - </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="#initialize-instance_method" title="#initialize (instance method)">- (GraphicFrame) <strong>initialize</strong>(anchor, chart_type, options) </a> + <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> </span> - <span class="note title constructor">constructor</span> - @@ -237,9 +229,8 @@ The relationship id for this graphic. - <span class="summary_desc"><div class='inline'><p> -Creates a new GraphicFrame object. -</p> + <span class="summary_desc"><div class='inline'> +<p>The relationship id for this graphic.</p> </div></span> </li> @@ -261,9 +252,8 @@ Creates a new GraphicFrame object. - <span class="summary_desc"><div class='inline'><p> -Serializes the graphic frame. -</p> + <span class="summary_desc"><div class='inline'> +<p>Serializes the graphic frame.</p> </div></span> </li> @@ -284,9 +274,8 @@ Serializes the graphic frame. </p><div class="docstring"> <div class="discussion"> - <p> -Creates a new GraphicFrame object -</p> + +<p>Creates a new GraphicFrame object</p> </div> @@ -326,21 +315,20 @@ Creates a new GraphicFrame object <pre class="lines"> -22 -23 -24 -25 -26</pre> +18 +19 +20 +21 +22</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 22</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='anchor identifier id'>anchor</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.chart_type"</span><span class='comma token'>,</span> <span class='Chart constant id'>Chart</span><span class='comma token'>,</span> <span class='chart_type identifier id'>chart_type</span> - <span class='@anchor ivar id'>@anchor</span> <span class='assign token'>=</span> <span class='anchor identifier id'>anchor</span> - <span class='@chart ivar id'>@chart</span> <span class='assign token'>=</span> <span class='chart_type identifier id'>chart_type</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 18</span> + +<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id anchor'>anchor</span><span class='comma'>,</span> <span class='id chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> + <span class='const'>DataTypeValidator</span><span class='period'>.</span><span class='id validate'>validate</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Drawing.chart_type</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Chart</span><span class='comma'>,</span> <span class='id chart_type'>chart_type</span> + <span class='ivar'>@anchor</span> <span class='op'>=</span> <span class='id anchor'>anchor</span> + <span class='ivar'>@chart</span> <span class='op'>=</span> <span class='id chart_type'>chart_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='kw'>end</span></pre> </td> </tr> </table> @@ -363,9 +351,8 @@ Creates a new GraphicFrame object </p><div class="docstring"> <div class="discussion"> - <p> -A anchor that holds this frame -</p> + +<p>A anchor that holds this frame</p> </div> @@ -399,10 +386,9 @@ A anchor that holds this frame <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 13</span> -<span class='def def kw'>def</span> <span class='anchor identifier id'>anchor</span> - <span class='@anchor ivar id'>@anchor</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id anchor'>anchor</span> + <span class='ivar'>@anchor</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -420,9 +406,8 @@ A anchor that holds this frame </p><div class="docstring"> <div class="discussion"> - <p> -A reference to the chart object associated with this frame -</p> + +<p>A reference to the chart object associated with this frame</p> </div> @@ -456,30 +441,32 @@ A reference to the chart object associated with this frame <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 9</span> -<span class='def def kw'>def</span> <span class='chart identifier id'>chart</span> - <span class='@chart ivar id'>@chart</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id chart'>chart</span> + <span class='ivar'>@chart</span> +<span class='kw'>end</span></pre> </td> </tr> </table> </div> - - <span id=""></span> - <span id="rId-instance_method"></span> - <div class="method_details "> - <p class="signature " id="rId-instance_method"> + </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="rId-instance_method"> - - (<tt>String</tt>) <strong>rId</strong> <span class="extras">(readonly)</span> + - (<tt>String</tt>) <strong>rId</strong> </p><div class="docstring"> <div class="discussion"> - <p> -The relationship id for this graphic -</p> + +<p>The relationship id for this graphic</p> </div> @@ -506,31 +493,23 @@ The relationship id for this graphic <pre class="lines"> -17 -18 -19</pre> +26 +27 +28</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 17</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 26</span> -<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> - <span class='dstring node'>"rId#{@anchor.index+1}"</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id rId'>rId</span> + <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>rId</span><span class='embexpr_beg'>#{</span><span class='ivar'>@anchor</span><span class='period'>.</span><span class='id index'>index</span><span class='op'>+</span><span class='int'>1</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span> +<span class='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="to_xml-instance_method"> + <div class="method_details "> + <p class="signature " id="to_xml-instance_method"> - (<tt>String</tt>) <strong>to_xml</strong>(xml) @@ -538,9 +517,8 @@ The relationship id for this graphic </p><div class="docstring"> <div class="discussion"> - <p> -Serializes the graphic frame -</p> + +<p>Serializes the graphic frame</p> </div> @@ -559,9 +537,8 @@ Serializes the graphic frame — - <div class='inline'><p> -The document builder instance this objects xml will be added to. -</p> + <div class='inline'> +<p>The document builder instance this objects xml will be added to.</p> </div> </li> @@ -588,6 +565,8 @@ The document builder instance this objects xml will be added to. <pre class="lines"> +33 +34 35 36 37 @@ -603,32 +582,29 @@ The document builder instance this objects xml will be added to. 47 48 49 -50 -51 -52</pre> +50</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 35</span> - -<span class='def def kw'>def</span> <span class='to_xml identifier id'>to_xml</span><span class='lparen token'>(</span><span class='xml identifier id'>xml</span><span class='rparen token'>)</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:graphicFrame'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:nvGraphicFramePr'</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'>'xdr:cNvPr'</span><span class='comma token'>,</span> <span class='symbol val'>:id=</span><span class='gt op'>></span><span class='integer val'>2</span><span class='comma token'>,</span> <span class='symbol val'>:name=</span><span class='gt op'>></span><span class='chart identifier id'>chart</span><span class='dot token'>.</span><span class='title identifier id'>title</span><span class='rparen token'>)</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:cNvGraphicFramePr'</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='xml identifier id'>xml</span><span class='dot token'>.</span><span class='send identifier id'>send</span><span class='lparen token'>(</span><span class='string val'>'xdr:xfrm'</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'>'a:off'</span><span class='comma token'>,</span> <span class='symbol val'>:x=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:y=</span><span class='gt op'>></span><span class='integer val'>0</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'>'a:ext'</span><span class='comma token'>,</span> <span class='symbol val'>:cx=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='comma token'>,</span> <span class='symbol val'>:cy=</span><span class='gt op'>></span><span class='integer val'>0</span><span class='rparen token'>)</span> - <span class='rbrace 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'>'a:graphic'</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'>'a:graphicData'</span><span class='comma token'>,</span> <span class='symbol val'>:uri=</span><span class='gt op'>></span><span class='XML_NS_C constant id'>XML_NS_C</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:chart'</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:r'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_R constant id'>XML_NS_R</span><span class='comma token'>,</span> <span class='symbol val'>:'r:id'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='rId identifier id'>rId</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - <span class='rbrace token'>}</span> - -<span class='end end kw'>end</span> -</pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/graphic_frame.rb', line 33</span> + +<span class='kw'>def</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='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'>xdr:graphicFrame</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'>xdr:nvGraphicFramePr</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'>xdr:cNvPr</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:id</span><span class='op'>=></span><span class='int'>2</span><span class='comma'>,</span> <span class='symbol'>:name</span><span class='op'>=></span><span class='id chart'>chart</span><span class='period'>.</span><span class='id title'>title</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'>xdr:cNvGraphicFramePr</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + <span class='rbrace'>}</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'>xdr:xfrm</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'>a:off</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:x</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:y</span><span class='op'>=></span><span class='int'>0</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'>a:ext</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:cx</span><span class='op'>=></span><span class='int'>0</span><span class='comma'>,</span> <span class='symbol'>:cy</span><span class='op'>=></span><span class='int'>0</span><span class='rparen'>)</span> + <span class='rbrace'>}</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'>a:graphic</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'>a:graphicData</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:uri</span><span class='op'>=></span><span class='const'>XML_NS_C</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:chart</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:r</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>XML_NS_R</span><span class='comma'>,</span> <span class='symbol'>:r:id</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='id rId'>rId</span><span class='rparen'>)</span> + <span class='rbrace'>}</span> + <span class='rbrace'>}</span> + <span class='rbrace'>}</span> + +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -639,9 +615,9 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Wed Nov 23 22:20:51 2011 by + Generated on Sat Nov 26 13:16:38 2011 by <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> - 0.7.3 (ruby-1.8.7). + 0.7.3 (ruby-1.9.3). </div> </body> |
