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/TableStyle.html | 690 ---------------------------------------------- 1 file changed, 690 deletions(-) delete mode 100644 doc/Axlsx/TableStyle.html (limited to 'doc/Axlsx/TableStyle.html') diff --git a/doc/Axlsx/TableStyle.html b/doc/Axlsx/TableStyle.html deleted file mode 100644 index 41cd0318..00000000 --- a/doc/Axlsx/TableStyle.html +++ /dev/null @@ -1,690 +0,0 @@ - - - - - - Class: Axlsx::TableStyle - - — AXLSX - - - - - - - - - - - - - - - - - - - - - - -

Class: Axlsx::TableStyle - - - -

- -
- -
Inherits:
-
- SimpleTypedList - - - show all - -
- - - - - - - - - -
Defined in:
-
lib/axlsx/stylesheet/table_style.rb
- -
-
- -

Overview

-
- -
- Note: -
-

Table are not supported in this version and only the defaults required for -a valid workbook are created.

-
-
- - -

A single table style definition and is a collection for tableStyleElements

- - -
-
-
- - -
- - - - - -

Instance Attribute Summary (collapse)

- - - - - - - - - -

Attributes inherited from SimpleTypedList

-

allowed_types, locked_at, serialize_as

- - - -

- Instance Method Summary - (collapse) -

- - - - - - - - - -
-

Constructor Details

- -
-

- - - (TableStyle) initialize(name, options = {}) - - - -

-
- -

creates a new TableStyle object

- - -
-
-
-

Parameters:

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

    a customizable set of options

    -
    - -
    • - -
- - - - - - -

Options Hash (options):

-
    - -
  • - pivot - (Boolean) - - - - -
    • - -
  • - table - (Boolean) - - - - -
    • - -
- - -

Raises:

-
    - -
  • - - - (ArgumentError) - - - - — -
    -

    if name option is not provided.

    -
    - -
    • - -
- -
- - - - -
- 
-
-
-23
-24
-25
-26
-27
-28
-29
- 		- 
# File 'lib/axlsx/stylesheet/table_style.rb', line 23
-
-def initialize(name, options={})
-  self.name = name
-  options.each do |o|
-    self.send("#{o[0]}=", o[1]) if self.respond_to? o[0]
-  end
-  super TableStyleElement
-end
-
-
-
- -
-
-

Dynamic Method Handling

-

- This class handles dynamic methods through the method_missing method - - in the class Axlsx::SimpleTypedList - -

- -
- -
-

Instance Attribute Details

- - - - -
-

- - - (string) name - - - -

-
- -

The name of this table style

- - -
-
-
- -

Returns:

-
    - -
  • - - - (string) - - - -
    • - -
- -
- - - - -
- 
-
-
-8
-9
-10
- 		- 
# File 'lib/axlsx/stylesheet/table_style.rb', line 8
-
-def name
-  @name
-end
-
-
-
- - - - -
-

- - - (Boolean) pivot - - - -

-
- -

indicates if this style should be applied to pivot tables

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Boolean) - - - -
    • - -
- -
- - - - -
- 
-
-
-12
-13
-14
- 		- 
# File 'lib/axlsx/stylesheet/table_style.rb', line 12
-
-def pivot
-  @pivot
-end
-
-
-
- - - - -
-

- - - (Boolean) table - - - -

-
- -

indicates if this style should be applied to tables

- - -
-
-
- -

Returns:

-
    - -
  • - - - (Boolean) - - - -
    • - -
- -
- - - - -
- 
-
-
-16
-17
-18
- 		- 
# File 'lib/axlsx/stylesheet/table_style.rb', line 16
-
-def table
-  @table
-end
-
-
-
- -
- - -
-

Instance Method Details

- - -
-

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

-
- -

Serializes the table style

- - -
-
-
-

Parameters:

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

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

    -
    - -
    • - -
- -

Returns:

-
    - -
  • - - - (String) - - - -
    • - -
- -
- - - - -
- 
-
-
-41
-42
-43
-44
-45
- 		- 
# File 'lib/axlsx/stylesheet/table_style.rb', line 41
-
-def to_xml(xml)
-  attr = self.instance_values.select { |k, v| [:name, :pivot, :table].include? k }
-  attr[:count] = self.size
-  xml.tableStyle(attr) { self.each { |table_style_el| table_style_el.to_xml(xml) } }
-end
-
-
-
- -
- -
- - - - - \ No newline at end of file -- cgit v1.2.3