diff options
| author | Randy Morgan <[email protected]> | 2011-11-27 22:08:55 +0900 |
|---|---|---|
| committer | Randy Morgan <[email protected]> | 2011-11-27 22:08:55 +0900 |
| commit | 058faf2581970fa18c314ad07f5658adeca32c69 (patch) | |
| tree | fadb7296aa249778690f3c70247c0d79e40b5274 /doc/Axlsx/TwoCellAnchor.html | |
| parent | f050dd81a633c45e3c8a57dffcdb4db715183e3d (diff) | |
| download | caxlsx-058faf2581970fa18c314ad07f5658adeca32c69.tar.gz caxlsx-058faf2581970fa18c314ad07f5658adeca32c69.zip | |
update to README
Diffstat (limited to 'doc/Axlsx/TwoCellAnchor.html')
| -rw-r--r-- | doc/Axlsx/TwoCellAnchor.html | 225 |
1 files changed, 96 insertions, 129 deletions
diff --git a/doc/Axlsx/TwoCellAnchor.html b/doc/Axlsx/TwoCellAnchor.html index 731764f1..68e7ba13 100644 --- a/doc/Axlsx/TwoCellAnchor.html +++ b/doc/Axlsx/TwoCellAnchor.html @@ -97,16 +97,14 @@ <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -The recommended way to manage drawings and charts is Worksheet#add_chart. -Anchors are specified by the :start_at and :end_at options to that method. -</p> + <div class='inline'> +<p>The recommended way to manage drawings and charts is Worksheet#add_chart. +Anchors are specified by the :start_at and :end_at options to that method.</p> </div> </div> -<p> -This class details the anchor points for drawings. -</p> + +<p>This class details the anchor points for drawings.</p> </div> @@ -145,9 +143,8 @@ This class details the anchor points for drawings. - <span class="summary_desc"><div class='inline'><p> -The drawing that holds this anchor. -</p> + <span class="summary_desc"><div class='inline'> +<p>The drawing that holds this anchor.</p> </div></span> </li> @@ -172,9 +169,8 @@ The drawing that holds this anchor. - <span class="summary_desc"><div class='inline'><p> -A marker that defines the from cell anchor. -</p> + <span class="summary_desc"><div class='inline'> +<p>A marker that defines the from cell anchor.</p> </div></span> </li> @@ -199,9 +195,8 @@ A marker that defines the from cell anchor. - <span class="summary_desc"><div class='inline'><p> -The object this anchor hosts. -</p> + <span class="summary_desc"><div class='inline'> +<p>The object this anchor hosts.</p> </div></span> </li> @@ -226,9 +221,8 @@ The object this anchor hosts. - <span class="summary_desc"><div class='inline'><p> -A marker that returns the to cell anchor. -</p> + <span class="summary_desc"><div class='inline'> +<p>A marker that returns the to cell anchor.</p> </div></span> </li> @@ -263,9 +257,8 @@ A marker that returns the to cell anchor. - <span class="summary_desc"><div class='inline'><p> -Creates a graphic frame and chart object associated with this anchor. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates a graphic frame and chart object associated with this anchor.</p> </div></span> </li> @@ -287,9 +280,8 @@ Creates a graphic frame and chart object associated with this anchor. - <span class="summary_desc"><div class='inline'><p> -The index of this anchor in the drawing. -</p> + <span class="summary_desc"><div class='inline'> +<p>The index of this anchor in the drawing.</p> </div></span> </li> @@ -313,10 +305,9 @@ The index of this anchor in the drawing. - <span class="summary_desc"><div class='inline'><p> -Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame’s chart. -</p> + <span class="summary_desc"><div class='inline'> +<p>Creates a new TwoCellAnchor object and sets up a reference to the from and +to markers in the graphic_frame's chart.</p> </div></span> </li> @@ -338,9 +329,8 @@ to markers in the graphic_frame’s chart. - <span class="summary_desc"><div class='inline'><p> -Serializes the two cell anchor. -</p> + <span class="summary_desc"><div class='inline'> +<p>Serializes the two cell anchor.</p> </div></span> </li> @@ -364,17 +354,15 @@ Serializes the two cell anchor. <div class="note notetag"> <strong>Note:</strong> - <div class='inline'><p> -the chart_type parameter will be replaced with object in v. 2.0.0 -</p> + <div class='inline'> +<p>the chart_type parameter will be replaced with object in v. 2.0.0</p> </div> </div> -<p> -Creates a new TwoCellAnchor object and sets up a reference to the from and -to markers in the graphic_frame’s chart. That means that you can do -stuff like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9 -</p> + +<p>Creates a new TwoCellAnchor object and sets up a reference to the from and +to markers in the graphic_frame's chart. That means that you can do stuff +like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9</p> </div> @@ -404,10 +392,9 @@ stuff like c = worksheet.add_chart Axlsx::Chart c.start_at 5, 9 — - <div class='inline'><p> -This is passed to the graphic frame for instantiation. must be Chart or a -subclass of Chart -</p> + <div class='inline'> +<p>This is passed to the graphic frame for instantiation. must be Chart or a +subclass of Chart</p> </div> </li> @@ -422,9 +409,8 @@ subclass of Chart — - <div class='inline'><p> -The object this anchor holds. -</p> + <div class='inline'> +<p>The object this anchor holds.</p> </div> </li> @@ -441,9 +427,8 @@ The object this anchor holds. — - <div class='inline'><p> -a customizable set of options -</p> + <div class='inline'> +<p>a customizable set of options</p> </div> </li> @@ -464,9 +449,8 @@ a customizable set of options <span class="default"> </span> - — <div class='inline'><p> -the col, row to start at -</p> + — <div class='inline'> +<p>the col, row to start at</p> </div> </li> @@ -476,9 +460,8 @@ the col, row to start at <span class="default"> </span> - — <div class='inline'><p> -the col, row to end at -</p> + — <div class='inline'> +<p>the col, row to end at</p> </div> </li> @@ -501,12 +484,11 @@ the col, row to end at <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 38</span> -<span class='def def kw'>def</span> <span class='initialize identifier id'>initialize</span><span class='lparen token'>(</span><span class='drawing identifier id'>drawing</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='@drawing ivar id'>@drawing</span> <span class='assign token'>=</span> <span class='drawing identifier id'>drawing</span> - <span class='drawing identifier id'>drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</span> <span class='lshft op'><<</span> <span class='self self kw'>self</span> - <span class='@from ivar id'>@from</span><span class='comma token'>,</span> <span class='@to ivar id'>@to</span> <span class='assign token'>=</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='comma token'>,</span> <span class='Marker constant id'>Marker</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span><span class='symbol val'>:col</span> <span class='assign token'>=</span><span class='gt op'>></span> <span class='integer val'>5</span><span class='comma token'>,</span> <span class='symbol val'>:row=</span><span class='gt op'>></span><span class='integer val'>10</span><span class='rparen token'>)</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id initialize'>initialize</span><span class='lparen'>(</span><span class='id drawing'>drawing</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'>@drawing</span> <span class='op'>=</span> <span class='id drawing'>drawing</span> + <span class='id drawing'>drawing</span><span class='period'>.</span><span class='id anchors'>anchors</span> <span class='op'><<</span> <span class='kw'>self</span> + <span class='ivar'>@from</span><span class='comma'>,</span> <span class='ivar'>@to</span> <span class='op'>=</span> <span class='const'>Marker</span><span class='period'>.</span><span class='id new'>new</span><span class='comma'>,</span> <span class='const'>Marker</span><span class='period'>.</span><span class='id new'>new</span><span class='lparen'>(</span><span class='symbol'>:col</span> <span class='op'>=></span> <span class='int'>5</span><span class='comma'>,</span> <span class='symbol'>:row</span><span class='op'>=></span><span class='int'>10</span><span class='rparen'>)</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -529,9 +511,8 @@ the col, row to end at </p><div class="docstring"> <div class="discussion"> - <p> -The drawing that holds this anchor -</p> + +<p>The drawing that holds this anchor</p> </div> @@ -565,10 +546,9 @@ The drawing that holds this anchor <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 25</span> -<span class='def def kw'>def</span> <span class='drawing identifier id'>drawing</span> - <span class='@drawing ivar id'>@drawing</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id drawing'>drawing</span> + <span class='ivar'>@drawing</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -586,10 +566,9 @@ The drawing that holds this anchor </p><div class="docstring"> <div class="discussion"> - <p> -A marker that defines the from cell anchor. The default from column and row -are 0 and 0 respectively -</p> + +<p>A marker that defines the from cell anchor. The default from column and row +are 0 and 0 respectively</p> </div> @@ -623,10 +602,9 @@ are 0 and 0 respectively <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 9</span> -<span class='def def kw'>def</span> <span class='from identifier id'>from</span> - <span class='@from ivar id'>@from</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id from'>from</span> + <span class='ivar'>@from</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -644,9 +622,8 @@ are 0 and 0 respectively </p><div class="docstring"> <div class="discussion"> - <p> -The object this anchor hosts -</p> + +<p>The object this anchor hosts</p> </div> @@ -680,10 +657,9 @@ The object this anchor hosts <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 21</span> -<span class='def def kw'>def</span> <span class='object identifier id'>object</span> - <span class='@object ivar id'>@object</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id object'>object</span> + <span class='ivar'>@object</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -701,10 +677,9 @@ The object this anchor hosts </p><div class="docstring"> <div class="discussion"> - <p> -A marker that returns the to cell anchor. The default to column and row are -5 and 10 respectively -</p> + +<p>A marker that returns the to cell anchor. The default to column and row are +5 and 10 respectively</p> </div> @@ -738,10 +713,9 @@ A marker that returns the to cell anchor. The default to column and row are <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 12</span> -<span class='def def kw'>def</span> <span class='to identifier id'>to</span> - <span class='@to ivar id'>@to</span> -<span class='end end kw'>end</span> -</pre> +<span class='kw'>def</span> <span class='id to'>to</span> + <span class='ivar'>@to</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -763,9 +737,8 @@ A marker that returns the to cell anchor. The default to column and row are </p><div class="docstring"> <div class="discussion"> - <p> -Creates a graphic frame and chart object associated with this anchor -</p> + +<p>Creates a graphic frame and chart object associated with this anchor</p> </div> @@ -800,11 +773,10 @@ Creates a graphic frame and chart object associated with this anchor <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 46</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='rparen token'>)</span> - <span class='@object ivar id'>@object</span> <span class='assign token'>=</span> <span class='GraphicFrame constant id'>GraphicFrame</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='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='@object ivar id'>@object</span><span class='dot token'>.</span><span class='chart identifier id'>chart</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='rparen'>)</span> + <span class='ivar'>@object</span> <span class='op'>=</span> <span class='const'>GraphicFrame</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 chart_type'>chart_type</span><span class='comma'>,</span> <span class='id options'>options</span><span class='rparen'>)</span> + <span class='ivar'>@object</span><span class='period'>.</span><span class='id chart'>chart</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -819,9 +791,8 @@ Creates a graphic frame and chart object associated with this anchor </p><div class="docstring"> <div class="discussion"> - <p> -The index of this anchor in the drawing -</p> + +<p>The index of this anchor in the drawing</p> </div> @@ -855,10 +826,9 @@ The index of this anchor in the drawing <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 53</span> -<span class='def def kw'>def</span> <span class='index identifier id'>index</span> - <span class='@drawing ivar id'>@drawing</span><span class='dot token'>.</span><span class='anchors identifier id'>anchors</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 index'>index</span> + <span class='ivar'>@drawing</span><span class='period'>.</span><span class='id anchors'>anchors</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> @@ -873,9 +843,8 @@ The index of this anchor in the drawing </p><div class="docstring"> <div class="discussion"> - <p> -Serializes the two cell anchor -</p> + +<p>Serializes the two cell anchor</p> </div> @@ -894,9 +863,8 @@ Serializes the two cell anchor — - <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> @@ -940,20 +908,19 @@ The document builder instance this objects xml will be added to. <td> <pre class="code"><span class="info file"># File 'lib/axlsx/drawing/two_cell_anchor.rb', line 59</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='comment val'>#build it for now, break it down later!</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:twoCellAnchor'</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:from'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='from identifier id'>from</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='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:to'</span><span class='rparen token'>)</span> <span class='lbrace token'>{</span> - <span class='to identifier id'>to</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='@object ivar id'>@object</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='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:clientData'</span><span class='rparen token'>)</span> - <span class='rbrace token'>}</span> -<span class='end end kw'>end</span> -</pre> +<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='comment'>#build it for now, break it down later! +</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:twoCellAnchor</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:from</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> + <span class='id from'>from</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='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:to</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> <span class='lbrace'>{</span> + <span class='id to'>to</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='ivar'>@object</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='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:clientData</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span> + <span class='rbrace'>}</span> +<span class='kw'>end</span></pre> </td> </tr> </table> @@ -964,9 +931,9 @@ The document builder instance this objects xml will be added to. </div> <div id="footer"> - Generated on Sun Nov 27 21:52:46 2011 by + Generated on Sun Nov 27 22:08:40 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> |
