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/Drawing.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/Drawing.html')
| -rw-r--r-- | doc/Axlsx/Drawing.html | 734 |
1 files changed, 322 insertions, 412 deletions
diff --git a/doc/Axlsx/Drawing.html b/doc/Axlsx/Drawing.html index 89318def..80d5ca01 100644 --- a/doc/Axlsx/Drawing.html +++ b/doc/Axlsx/Drawing.html @@ -6,7 +6,7 @@ <title> Class: Axlsx::Drawing - — Documentation by YARD 0.7.3 + — AXLSX </title> @@ -97,19 +97,17 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage drawings is to use the Worksheet.add_chart -method. -</p> + <div class='inline'> +<p>The recommended way to manage drawings is to use the Worksheet.add_chart +method.</p> </div> </div> -<p> -A Drawing is a canvas for charts. Each worksheet has a single drawing that + +<p>A Drawing is a canvas for charts. Each worksheet has a single drawing that manages anchors. The anchors reference the charts via graphical frames. This is not a trivial relationship so please do follow the advice in the -note. see README for an example of how to create a chart. -</p> +note. see README for an example of how to create a chart.</p> </div> @@ -150,10 +148,9 @@ note. see README for an example of how to create a chart. - <span class="summary_desc"><div class='inline'><p> -A collection of anchors for this drawing only TwoCellAnchors are supported -in this version. -</p> + <span class="summary_desc"><div class='inline'> +<p>A collection of anchors for this drawing only TwoCellAnchors are supported +in this version.</p> </div></span> </li> @@ -162,7 +159,7 @@ in this version. <li class="public "> <span class="summary_signature"> - <a href="#charts-instance_method" title="#charts (instance method)">- (Array) <strong>charts</strong> </a> + <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a> @@ -178,163 +175,152 @@ in this version. - <span class="summary_desc"><div class='inline'><p> -An array of charts that are associated with this drawing’s anchors. -</p> + <span class="summary_desc"><div class='inline'> +<p>The worksheet that owns the drawing.</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="#images-instance_method" title="#images (instance method)">- (Array) <strong>images</strong> </a> + <a href="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) </a> </span> - <span class="note title readonly">readonly</span> - - - <span class="summary_desc"><div class='inline'><p> -An array of image objects that are associated with this drawing’s -anchors. -</p> + <span class="summary_desc"><div class='inline'> +<p>Adds a chart to the drawing.</p> </div></span> </li> - - <li class="public "> + + <li class="public "> <span class="summary_signature"> - <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> + <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) </a> </span> - <span class="note title readonly">readonly</span> - - - <span class="summary_desc"><div class='inline'><p> -The index of this drawing in the owning workbooks’s drawings -collection. -</p> + <span class="summary_desc"><div class='inline'> +<p>Adds an image to the chart.</p> </div></span> </li> - - <li class="public "> + + <li class="public "> <span class="summary_signature"> - <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> + <a href="#charts-instance_method" title="#charts (instance method)">- (Array) <strong>charts</strong> </a> </span> - <span class="note title readonly">readonly</span> - - - <span class="summary_desc"><div class='inline'><p> -The part name for this drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>An array of charts that are associated with this drawing's anchors.</p> </div></span> </li> - - <li class="public "> + + <li class="public "> <span class="summary_signature"> - <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a> + <a href="#images-instance_method" title="#images (instance method)">- (Array) <strong>images</strong> </a> </span> - <span class="note title readonly">readonly</span> - - - <span class="summary_desc"><div class='inline'><p> -The drawing’s relationships. -</p> + <span class="summary_desc"><div class='inline'> +<p>An array of image objects that are associated with this drawing's anchors.</p> </div></span> </li> - - <li class="public "> + + <li class="public "> <span class="summary_signature"> - <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a> + <a href="#index-instance_method" title="#index (instance method)">- (Integer) <strong>index</strong> </a> </span> - <span class="note title readonly">readonly</span> - - - <span class="summary_desc"><div class='inline'><p> -The relational part name for this drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>The index of this drawing in the owning workbooks's drawings collection.</p> </div></span> </li> - - <li class="public "> + + <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)">- (Drawing) <strong>initialize</strong>(worksheet) </a> </span> + <span class="note title constructor">constructor</span> - <span class="note title readonly">readonly</span> - @@ -342,58 +328,40 @@ The relational part name for this drawing. - <span class="summary_desc"><div class='inline'><p> -The relation reference id for this drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates a new Drawing object.</p> </div></span> </li> - - <li class="public "> + + <li class="public "> <span class="summary_signature"> - <a href="#worksheet-instance_method" title="#worksheet (instance method)">- (Worksheet) <strong>worksheet</strong> </a> + <a href="#pn-instance_method" title="#pn (instance method)">- (String) <strong>pn</strong> </a> </span> - <span class="note title readonly">readonly</span> - - - <span class="summary_desc"><div class='inline'><p> -The worksheet that owns the drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>The part name for this drawing.</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="#add_chart-instance_method" title="#add_chart (instance method)">- (Object) <strong>add_chart</strong>(chart_type, options = {}) </a> + <a href="#relationships-instance_method" title="#relationships (instance method)">- (Relationships) <strong>relationships</strong> </a> @@ -406,9 +374,8 @@ The worksheet that owns the drawing. - <span class="summary_desc"><div class='inline'><p> -Adds a chart to the drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>The drawing's relationships.</p> </div></span> </li> @@ -417,7 +384,7 @@ Adds a chart to the drawing. <li class="public "> <span class="summary_signature"> - <a href="#add_image-instance_method" title="#add_image (instance method)">- (Object) <strong>add_image</strong>(options = {}) </a> + <a href="#rels_pn-instance_method" title="#rels_pn (instance method)">- (String) <strong>rels_pn</strong> </a> @@ -430,9 +397,8 @@ Adds a chart to the drawing. - <span class="summary_desc"><div class='inline'><p> -Adds an image to the chart. -</p> + <span class="summary_desc"><div class='inline'> +<p>The relational part name for this drawing.</p> </div></span> </li> @@ -441,14 +407,12 @@ Adds an image to the chart. <li class="public "> <span class="summary_signature"> - <a href="#initialize-instance_method" title="#initialize (instance method)">- (Drawing) <strong>initialize</strong>(worksheet) </a> + <a href="#rId-instance_method" title="#rId (instance method)">- (String) <strong>rId</strong> </a> </span> - <span class="note title constructor">constructor</span> - @@ -456,9 +420,8 @@ Adds an image to the chart. - <span class="summary_desc"><div class='inline'><p> -Creates a new Drawing object. -</p> + <span class="summary_desc"><div class='inline'> +<p>The relation reference id for this drawing.</p> </div></span> </li> @@ -480,9 +443,8 @@ Creates a new Drawing object. - <span class="summary_desc"><div class='inline'><p> -Serializes the drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>Serializes the drawing.</p> </div></span> </li> @@ -503,9 +465,8 @@ Serializes the drawing. </p><div class="docstring"> <div class="discussion"> - <p> -Creates a new Drawing object -</p> + +<p>Creates a new Drawing object</p> </div> @@ -524,9 +485,8 @@ Creates a new Drawing object — - <div class='inline'><p> -The worksheet that owns this drawing -</p> + <div class='inline'> +<p>The worksheet that owns this drawing</p> </div> </li> @@ -540,23 +500,22 @@ The worksheet that owns this drawing <pre class="lines"> -80 -81 -82 -83 -84 -85</pre> +52 +53 +54 +55 +56 +57</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 80</span> - -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='worksheet identifier id'>worksheet</span><span class='rparen token'>)</span> - <span class='DataTypeValidator constant id'>DataTypeValidator</span><span class='dot token'>.</span><span class='validate identifier id'>validate</span> <span class='string val'>"Drawing.worksheet"</span><span class='comma token'>,</span> <span class='Worksheet constant id'>Worksheet</span><span class='comma token'>,</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</span> <span class='assign token'>=</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@anchors ivar id'>@anchors</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='lbrack token'>[</span><span class='TwoCellAnchor constant id'>TwoCellAnchor</span><span class='comma token'>,</span> <span class='OneCellAnchor constant id'>OneCellAnchor</span><span class='rbrack token'>]</span> -<span class='end end kw'>end</span> -</pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 52</span> + +<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id worksheet'>worksheet</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.worksheet</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='const'>Worksheet</span><span class='comma'>,</span> <span class='id worksheet'>worksheet</span> + <span class='ivar'>@worksheet</span> <span class='op'>=</span> <span class='id worksheet'>worksheet</span> + <span class='ivar'>@worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id drawings'>drawings</span> <span class='op'><<</span> <span class='kw'>self</span> + <span class='ivar'>@anchors</span> <span class='op'>=</span> <span class='const'>SimpleTypedList</span><span class='period'>.</span><span class='id new'>new</span> <span class='lbracket'>[</span><span class='const'>TwoCellAnchor</span><span class='comma'>,</span> <span class='const'>OneCellAnchor</span><span class='rbracket'>]</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -579,10 +538,9 @@ The worksheet that owns this drawing </p><div class="docstring"> <div class="discussion"> - <p> -A collection of anchors for this drawing only TwoCellAnchors are supported -in this version -</p> + +<p>A collection of anchors for this drawing only TwoCellAnchors are supported +in this version</p> </div> @@ -616,10 +574,9 @@ in this version <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 48</span> -<span class='def def kw'>def</span> <span class='anchors identifier id'>anchors</span> - <span class='@anchors ivar id'>@anchors</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id anchors'>anchors</span> + <span class='ivar'>@anchors</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -627,19 +584,18 @@ in this version <span id=""></span> - <span id="charts-instance_method"></span> + <span id="worksheet-instance_method"></span> <div class="method_details "> - <p class="signature " id="charts-instance_method"> + <p class="signature " id="worksheet-instance_method"> - - (<tt>Array</tt>) <strong>charts</strong> <span class="extras">(readonly)</span> + - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> <span class="extras">(readonly)</span> </p><div class="docstring"> <div class="discussion"> - <p> -An array of charts that are associated with this drawing’s anchors -</p> + +<p>The worksheet that owns the drawing</p> </div> @@ -652,7 +608,7 @@ An array of charts that are associated with this drawing’s anchors <li> - <span class='type'>(<tt>Array</tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> @@ -666,59 +622,61 @@ An array of charts that are associated with this drawing’s anchors <pre class="lines"> -52 -53 -54 -55</pre> +43 +44 +45</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 52</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span> -<span class='def def kw'>def</span> <span class='charts identifier id'>charts</span> - <span class='charts identifier id'>charts</span> <span class='assign token'>=</span> <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='GraphicFrame constant id'>GraphicFrame</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='charts identifier id'>charts</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</span> <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id worksheet'>worksheet</span> + <span class='ivar'>@worksheet</span> +<span class='kw'>end</span></pre> </td> </tr> </table> </div> - - <span id=""></span> - <span id="images-instance_method"></span> - <div class="method_details "> - <p class="signature " id="images-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="add_chart-instance_method"> - - (<tt>Array</tt>) <strong>images</strong> <span class="extras">(readonly)</span> + - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) </p><div class="docstring"> <div class="discussion"> - <p> -An array of image objects that are associated with this drawing’s -anchors -</p> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'> +<p>The recommended way to manage charts is to use Worksheet.add_chart. Please +refer to that method for documentation.</p> +</div> + </div> + + +<p>Adds a chart to the drawing.</p> </div> </div> <div class="tags"> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Array</tt>)</span> - - - - </li> - -</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li> + + </ul> </div><table class="source_code"> <tr> @@ -726,59 +684,56 @@ anchors <pre class="lines"> -56 -57 -58 -59</pre> +70 +71 +72 +73</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 56</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 70</span> -<span class='def def kw'>def</span> <span class='images identifier id'>images</span> - <span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='select identifier id'>select</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span><span class='dot token'>.</span><span class='is_a? fid id'>is_a?</span><span class='lparen token'>(</span><span class='Pic constant id'>Pic</span><span class='rparen token'>)</span> <span class='rbrace token'>}</span> - <span class='images identifier id'>images</span><span class='dot token'>.</span><span class='map identifier id'>map</span> <span class='lbrace token'>{</span> <span class='bitor op'>|</span><span class='a identifier id'>a</span><span class='bitor op'>|</span> <span class='a identifier id'>a</span><span class='dot token'>.</span><span class='object identifier id'>object</span> <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id add_chart'>add_chart</span><span class='lparen'>(</span><span class='id chart_type'>chart_type</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='const'>TwoCellAnchor</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'>@anchors</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id add_chart'>add_chart</span><span class='lparen'>(</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='kw'>end</span></pre> </td> </tr> </table> </div> - - <span id=""></span> - <span id="index-instance_method"></span> <div class="method_details "> - <p class="signature " id="index-instance_method"> + <p class="signature " id="add_image-instance_method"> - - (<tt>Integer</tt>) <strong>index</strong> <span class="extras">(readonly)</span> + - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) </p><div class="docstring"> <div class="discussion"> - <p> -The index of this drawing in the owning workbooks’s drawings -collection. -</p> + + <div class="note notetag"> + <strong>Note:</strong> + <div class='inline'> +<p>The recommended way to manage images is to use Worksheet.add_image. Please +refer to that method for documentation.</p> +</div> + </div> + + +<p>Adds an image to the chart</p> </div> </div> <div class="tags"> -<h3>Returns:</h3> -<ul class="return"> - - <li> - - - <span class='type'>(<tt>Integer</tt>)</span> - - - - </li> - -</ul> + + <h3>See Also:</h3> + <ul class="see"> + + <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> + + </ul> </div><table class="source_code"> <tr> @@ -786,37 +741,34 @@ collection. <pre class="lines"> -60 -61 -62</pre> +62 +63 +64 +65</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 60</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 62</span> -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@worksheet ivar id'>@worksheet</span><span class='dot token'>.</span><span class='workbook identifier id'>workbook</span><span class='dot token'>.</span><span class='drawings identifier id'>drawings</span><span class='dot token'>.</span><span class='index identifier id'>index</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id add_image'>add_image</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='const'>OneCellAnchor</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'>@anchors</span><span class='period'>.</span><span class='id last'>last</span><span class='period'>.</span><span class='id object'>object</span> +<span class='kw'>end</span></pre> </td> </tr> </table> </div> - - <span id=""></span> - <span id="pn-instance_method"></span> <div class="method_details "> - <p class="signature " id="pn-instance_method"> + <p class="signature " id="charts-instance_method"> - - (<tt>String</tt>) <strong>pn</strong> <span class="extras">(readonly)</span> + - (<tt>Array</tt>) <strong>charts</strong> </p><div class="docstring"> <div class="discussion"> - <p> -The part name for this drawing -</p> + +<p>An array of charts that are associated with this drawing's anchors</p> </div> @@ -829,7 +781,7 @@ The part name for this drawing <li> - <span class='type'>(<tt>String</tt>)</span> + <span class='type'>(<tt>Array</tt>)</span> @@ -843,37 +795,34 @@ The part name for this drawing <pre class="lines"> -68 -69 -70</pre> +77 +78 +79 +80</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 68</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 77</span> -<span class='def def kw'>def</span> <span class='pn identifier id'>pn</span> - <span class='dstring node'>"#{DRAWING_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id charts'>charts</span> + <span class='id charts'>charts</span> <span class='op'>=</span> <span class='ivar'>@anchors</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>GraphicFrame</span><span class='rparen'>)</span> <span class='rbrace'>}</span> + <span class='id charts'>charts</span><span class='period'>.</span><span class='id map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span><span class='period'>.</span><span class='id chart'>chart</span> <span class='rbrace'>}</span> +<span class='kw'>end</span></pre> </td> </tr> </table> </div> - - <span id=""></span> - <span id="relationships-instance_method"></span> <div class="method_details "> - <p class="signature " id="relationships-instance_method"> + <p class="signature " id="images-instance_method"> - - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> <span class="extras">(readonly)</span> + - (<tt>Array</tt>) <strong>images</strong> </p><div class="docstring"> <div class="discussion"> - <p> -The drawing’s relationships. -</p> + +<p>An array of image objects that are associated with this drawing's anchors</p> </div> @@ -886,7 +835,7 @@ The drawing’s relationships. <li> - <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> + <span class='type'>(<tt>Array</tt>)</span> @@ -900,51 +849,34 @@ The drawing’s relationships. <pre class="lines"> -76 -77 -78 -79 -80 -81 -82 -83 84 -85</pre> +85 +86 +87</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 76</span> - -<span class='def def kw'>def</span> <span class='relationships identifier id'>relationships</span> - <span class='r identifier id'>r</span> <span class='assign token'>=</span> <span class='Relationships constant id'>Relationships</span><span class='dot token'>.</span><span class='new identifier id'>new</span> - <span class='charts identifier id'>charts</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='chart identifier id'>chart</span><span class='bitor op'>|</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='CHART_R constant id'>CHART_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{chart.pn}"</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='images identifier id'>images</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='image identifier id'>image</span><span class='bitor op'>|</span> - <span class='r identifier id'>r</span> <span class='lshft op'><<</span> <span class='Relationship constant id'>Relationship</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='IMAGE_R constant id'>IMAGE_R</span><span class='comma token'>,</span> <span class='dstring node'>"../#{image.pn}"</span><span class='rparen token'>)</span> - <span class='end end kw'>end</span> - <span class='r identifier id'>r</span> -<span class='end end kw'>end</span> -</pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 84</span> + +<span class='kw'>def</span> <span class='id images'>images</span> + <span class='id images'>images</span> <span class='op'>=</span> <span class='ivar'>@anchors</span><span class='period'>.</span><span class='id select'>select</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span><span class='period'>.</span><span class='id is_a?'>is_a?</span><span class='lparen'>(</span><span class='const'>Pic</span><span class='rparen'>)</span> <span class='rbrace'>}</span> + <span class='id images'>images</span><span class='period'>.</span><span class='id map'>map</span> <span class='lbrace'>{</span> <span class='op'>|</span><span class='id a'>a</span><span class='op'>|</span> <span class='id a'>a</span><span class='period'>.</span><span class='id object'>object</span> <span class='rbrace'>}</span> +<span class='kw'>end</span></pre> </td> </tr> </table> </div> - - <span id=""></span> - <span id="rels_pn-instance_method"></span> <div class="method_details "> - <p class="signature " id="rels_pn-instance_method"> + <p class="signature " id="index-instance_method"> - - (<tt>String</tt>) <strong>rels_pn</strong> <span class="extras">(readonly)</span> + - (<tt>Integer</tt>) <strong>index</strong> </p><div class="docstring"> <div class="discussion"> - <p> -The relational part name for this drawing -</p> + +<p>The index of this drawing in the owning workbooks's drawings collection.</p> </div> @@ -957,7 +889,7 @@ The relational part name for this drawing <li> - <span class='type'>(<tt>String</tt>)</span> + <span class='type'>(<tt>Integer</tt>)</span> @@ -971,37 +903,32 @@ The relational part name for this drawing <pre class="lines"> -72 -73 -74</pre> +91 +92 +93</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 72</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 91</span> -<span class='def def kw'>def</span> <span class='rels_pn identifier id'>rels_pn</span> - <span class='dstring node'>"#{DRAWING_RELS_PN % (index+1)}"</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id index'>index</span> + <span class='ivar'>@worksheet</span><span class='period'>.</span><span class='id workbook'>workbook</span><span class='period'>.</span><span class='id drawings'>drawings</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> </td> </tr> </table> </div> - - <span id=""></span> - <span id="rId-instance_method"></span> <div class="method_details "> - <p class="signature " id="rId-instance_method"> + <p class="signature " id="pn-instance_method"> - - (<tt>String</tt>) <strong>rId</strong> <span class="extras">(readonly)</span> + - (<tt>String</tt>) <strong>pn</strong> </p><div class="docstring"> <div class="discussion"> - <p> -The relation reference id for this drawing -</p> + +<p>The part name for this drawing</p> </div> @@ -1028,37 +955,32 @@ The relation reference id for this drawing <pre class="lines"> -64 -65 -66</pre> +103 +104 +105</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 64</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 103</span> -<span class='def def kw'>def</span> <span class='rId identifier id'>rId</span> - <span class='dstring node'>"rId#{index+1}"</span> -<span class='end end kw'>end</span> -</pre> +<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'>DRAWING_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> </td> </tr> </table> </div> - - <span id=""></span> - <span id="worksheet-instance_method"></span> <div class="method_details "> - <p class="signature " id="worksheet-instance_method"> + <p class="signature " id="relationships-instance_method"> - - (<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>) <strong>worksheet</strong> <span class="extras">(readonly)</span> + - (<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>) <strong>relationships</strong> </p><div class="docstring"> <div class="discussion"> - <p> -The worksheet that owns the drawing -</p> + +<p>The drawing's relationships.</p> </div> @@ -1071,7 +993,7 @@ The worksheet that owns the drawing <li> - <span class='type'>(<tt><span class='object_link'><a href="Worksheet.html" title="Axlsx::Worksheet (class)">Worksheet</a></span></tt>)</span> + <span class='type'>(<tt><span class='object_link'><a href="Relationships.html" title="Axlsx::Relationships (class)">Relationships</a></span></tt>)</span> @@ -1085,64 +1007,65 @@ The worksheet that owns the drawing <pre class="lines"> -43 -44 -45</pre> +115 +116 +117 +118 +119 +120 +121 +122 +123 +124</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 43</span> - -<span class='def def kw'>def</span> <span class='worksheet identifier id'>worksheet</span> - <span class='@worksheet ivar id'>@worksheet</span> -<span class='end end kw'>end</span> -</pre> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 115</span> + +<span class='kw'>def</span> <span class='id relationships'>relationships</span> + <span class='id r'>r</span> <span class='op'>=</span> <span class='const'>Relationships</span><span class='period'>.</span><span class='id new'>new</span> + <span class='id charts'>charts</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id chart'>chart</span><span class='op'>|</span> + <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>CHART_R</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../</span><span class='embexpr_beg'>#{</span><span class='id chart'>chart</span><span class='period'>.</span><span class='id pn'>pn</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> + <span class='kw'>end</span> + <span class='id images'>images</span><span class='period'>.</span><span class='id each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id image'>image</span><span class='op'>|</span> + <span class='id r'>r</span> <span class='op'><<</span> <span class='const'>Relationship</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='const'>IMAGE_R</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>../</span><span class='embexpr_beg'>#{</span><span class='id image'>image</span><span class='period'>.</span><span class='id pn'>pn</span><span class='rbrace'>}</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span> + <span class='kw'>end</span> + <span class='id r'>r</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="add_chart-instance_method"> + <div class="method_details "> + <p class="signature " id="rels_pn-instance_method"> - - (<tt>Object</tt>) <strong>add_chart</strong>(chart_type, options = {}) + - (<tt>String</tt>) <strong>rels_pn</strong> </p><div class="docstring"> <div class="discussion"> - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage charts is to use Worksheet.add_chart. Please -refer to that method for documentation. -</p> -</div> - </div> - -<p> -Adds a chart to the drawing. -</p> +<p>The relational part name for this drawing</p> </div> </div> <div class="tags"> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_chart-instance_method" title="Axlsx::Worksheet#add_chart (method)">Worksheet#add_chart</a></span></li> - - </ul> +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> @@ -1150,59 +1073,51 @@ Adds a chart to the drawing. <pre class="lines"> -98 -99 -100 -101</pre> +109 +110 +111</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 98</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 109</span> -<span class='def def kw'>def</span> <span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='assign token'>=</span><span class='lbrace token'>{</span><span class='rbrace token'>}</span><span class='rparen token'>)</span> - <span class='TwoCellAnchor constant id'>TwoCellAnchor</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='self self kw'>self</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> - <span class='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='add_chart identifier id'>add_chart</span><span class='lparen token'>(</span><span class='chart_type identifier id'>chart_type</span><span class='comma token'>,</span> <span class='options identifier id'>options</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id rels_pn'>rels_pn</span> + <span class='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'>DRAWING_RELS_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> </td> </tr> </table> </div> <div class="method_details "> - <p class="signature " id="add_image-instance_method"> + <p class="signature " id="rId-instance_method"> - - (<tt>Object</tt>) <strong>add_image</strong>(options = {}) + - (<tt>String</tt>) <strong>rId</strong> </p><div class="docstring"> <div class="discussion"> - <div class="note notetag"> - <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage images is to use Worksheet.add_image. Please -refer to that method for documentation. -</p> -</div> - </div> - -<p> -Adds an image to the chart -</p> +<p>The relation reference id for this drawing</p> </div> </div> <div class="tags"> - - <h3>See Also:</h3> - <ul class="see"> - - <li><span class='object_link'><a href="Worksheet.html#add_image-instance_method" title="Axlsx::Worksheet#add_image (method)">Worksheet#add_image</a></span></li> - - </ul> +<h3>Returns:</h3> +<ul class="return"> + + <li> + + + <span class='type'>(<tt>String</tt>)</span> + + + + </li> + +</ul> </div><table class="source_code"> <tr> @@ -1210,19 +1125,16 @@ Adds an image to the chart <pre class="lines"> -90 -91 -92 -93</pre> +97 +98 +99</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 90</span> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 97</span> -<span class='def def kw'>def</span> <span class='add_image identifier id'>add_image</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='OneCellAnchor constant id'>OneCellAnchor</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='@anchors ivar id'>@anchors</span><span class='dot token'>.</span><span class='last identifier id'>last</span><span class='dot token'>.</span><span class='object identifier id'>object</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='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> @@ -1237,9 +1149,8 @@ Adds an image to the chart </p><div class="docstring"> <div class="discussion"> - <p> -Serializes the drawing -</p> + +<p>Serializes the drawing</p> </div> @@ -1266,27 +1177,26 @@ Serializes the drawing <pre class="lines"> -142 -143 -144 -145 -146 -147 -148 -149</pre> +128 +129 +130 +131 +132 +133 +134 +135</pre> </td> <td> - <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 142</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> - <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:wsDr'</span><span class='comma token'>,</span> <span class='symbol val'>:'xmlns:xdr'</span><span class='assign token'>=</span><span class='gt op'>></span><span class='XML_NS_XDR constant id'>XML_NS_XDR</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='anchors identifier id'>anchors</span><span class='dot token'>.</span><span class='each identifier id'>each</span> <span class='lbrace token'>{</span><span class='bitor op'>|</span><span class='anchor identifier id'>anchor</span><span class='bitor op'>|</span> <span class='anchor identifier id'>anchor</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='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> + <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/drawing.rb', line 128</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'>xdr:wsDr</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='symbol'>:xmlns:xdr</span><span class='tstring_end'>'</span></span><span class='op'>=></span><span class='const'>XML_NS_XDR</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 anchors'>anchors</span><span class='period'>.</span><span class='id each'>each</span> <span class='lbrace'>{</span><span class='op'>|</span><span class='id anchor'>anchor</span><span class='op'>|</span> <span class='id anchor'>anchor</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='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> </td> </tr> </table> @@ -1297,9 +1207,9 @@ Serializes the drawing </div> <div id="footer"> - Generated on Wed Nov 23 22:20:46 2011 by + Generated on Sat Nov 26 13:16:37 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> |
