From 8cf0296bbc16e8eb535e9af932eed2557d5e66d2 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Thu, 1 Dec 2011 14:11:42 +0900 Subject: removing generated yard docs from repository --- doc/Axlsx/Marker.html | 837 -------------------------------------------------- 1 file changed, 837 deletions(-) delete mode 100644 doc/Axlsx/Marker.html (limited to 'doc/Axlsx/Marker.html') diff --git a/doc/Axlsx/Marker.html b/doc/Axlsx/Marker.html deleted file mode 100644 index 9ae65689..00000000 --- a/doc/Axlsx/Marker.html +++ /dev/null @@ -1,837 +0,0 @@ - - - - - - Class: Axlsx::Marker - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::Marker - - - -

- -
- -
Inherits:
-
- Object - -
    -
  • Object
    • - - - -
- show all - -
- - - - - - - - - -
Defined in:
-
lib/axlsx/drawing/marker.rb
- -
-
- -

Overview

-
- -
- Note: -
-

The recommended way to manage markers is Worksheet#add_chart Markers are -created for a two cell anchor based on the :start and :end options.

-
-
- - -

The Marker class defines a point in the worksheet that drawing anchors -attach to.

- - -
-
-
- - -

See Also:

- - -
- -

Instance Attribute Summary (collapse)

- - - - - - -

- Instance Method Summary - (collapse) -

- - - - -
-

Constructor Details

- -
-

- - - (Marker) initialize(options = {}) - - - -

-
- -

Creates a new Marker object

- - -
-
-
-

Parameters:

-
    - -
  • - - options - - - (Hash) - - - (defaults to: {}) - - - — -
    -

    a customizable set of options

    -
    - -
    • - -
- - - - -

Options Hash (options):

-
    - -
  • - col - (Integer) - - - - -
    • - -
  • - colOff - (Integer) - - - - -
    • - -
  • - row - (Integer) - - - - -
    • - -
  • - rowOff - (Integer) - - - - -
    • - -
- - - -
- - - - -
- 
-
-
-28
-29
-30
-31
-32
-33
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 28
-
-def initialize(options={})
-  @col, @colOff, @row, @rowOff = 0, 0, 0, 0
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-  end      
-end
-
-
-
- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (Integer) col - - - -

-
- -

The column this marker anchors to

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-9
-10
-11
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 9
-
-def col
-  @col
-end
-
-
-
- - - - -
-

- - - (Integer) colOff - - - -

-
- -

The offset distance from this marker’s column

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-13
-14
-15
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 13
-
-def colOff
-  @colOff
-end
-
-
-
- - - - -
-

- - - (Integer) row - - - -

-
- -

The row this marker anchors to

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-17
-18
-19
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 17
-
-def row
-  @row
-end
-
-
-
- - - - -
-

- - - (Integer) rowOff - - - -

-
- -

The offset distance from this marker’s row

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Integer) - - - -
    • - -
- -
- - - - -
- 
-
-
-21
-22
-23
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 21
-
-def rowOff
-  @rowOff
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

- - - (Object) coord(col, row) - - - -

-
- -

shortcut to set the column, row position for this marker

- - -
-
-
-

Parameters:

-
    - -
  • - - col - - - - - - - — -
    -

    the column for the marker

    -
    - -
    • - -
  • - - row - - - - - - - — -
    -

    the row of the marker

    -
    - -
    • - -
- - -
- - - - -
- 
-
-
-47
-48
-49
-50
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 47
-
-def coord(col, row)
-  self.col = col
-  self.row = row
-end
-
-
-
- -
-

- - - (String) to_xml(xml) - - - -

-
- -

Serializes the marker

- - -
-
-
-

Parameters:

-
    - -
  • - - xml - - - (Nokogiri::XML::Builder) - - - - — -
    -

    The document builder instance this objects xml will be added to.

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-54
-55
-56
-57
-58
- 		- 
# File 'lib/axlsx/drawing/marker.rb', line 54
-
-def to_xml(xml)
-  [:col, :colOff, :row, :rowOff].each do |k|
-    xml.send("xdr:#{k.to_s}", self.send(k))
-  end      
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3