From 076be316935180341d7ee7a9335281a4b18d1fa9 Mon Sep 17 00:00:00 2001 From: Randy Morgan Date: Wed, 30 Nov 2011 08:53:14 +0900 Subject: pre 1.0.10 release commit --- doc/Axlsx/Worksheet.html | 353 +++++++++++++++++++---------------------------- 1 file changed, 143 insertions(+), 210 deletions(-) (limited to 'doc/Axlsx/Worksheet.html') diff --git a/doc/Axlsx/Worksheet.html b/doc/Axlsx/Worksheet.html index 1672e4c7..39bd418b 100644 --- a/doc/Axlsx/Worksheet.html +++ b/doc/Axlsx/Worksheet.html @@ -94,9 +94,8 @@

Overview

-

-The Worksheet class represents a worksheet in the workbook. -

+ +

The Worksheet class represents a worksheet in the workbook.

@@ -128,9 +127,8 @@ The Worksheet class represents a worksheet in the workbook. -

-An array of content based calculated column widths. -

+
+

An array of content based calculated column widths.

 @@ -155,9 +153,8 @@ An array of content based calculated column widths. -

-The name of the worksheet. -

+
+

The name of the worksheet.

 @@ -182,9 +179,8 @@ The name of the worksheet. -

-The rows in this worksheet. -

+
+

The rows in this worksheet.

 @@ -209,9 +205,8 @@ The rows in this worksheet. -

-The workbook that owns this worksheet. -

+
+

The workbook that owns this worksheet.

 @@ -246,9 +241,8 @@ The workbook that owns this worksheet. -

-Adds a chart to this worksheets drawing. -

+
+

Adds a chart to this worksheets drawing.

 @@ -270,9 +264,8 @@ Adds a chart to this worksheets drawing. -

-Adds a media item to the worksheets drawing. -

+
+

Adds a media item to the worksheets drawing.

 @@ -294,9 +287,8 @@ Adds a media item to the worksheets drawing. -

-Adds a row to the worksheet and updates auto fit data. -

+
+

Adds a row to the worksheet and updates auto fit data.

 @@ -318,9 +310,8 @@ Adds a row to the worksheet and updates auto fit data. -

-Determines the proper width for a column based on content. -

+
+

Determines the proper width for a column based on content.

 @@ -342,9 +333,8 @@ Determines the proper width for a column based on content. -

-Set the style for cells in a specific column. -

+
+

Set the style for cells in a specific column.

 @@ -366,9 +356,8 @@ Set the style for cells in a specific column. -

-returns the sheet data as columnw. -

+
+

returns the sheet data as columnw.

 @@ -390,9 +379,8 @@ returns the sheet data as columnw. -

-The drawing associated with this worksheet. -

+
+

The drawing associated with this worksheet.

 @@ -414,9 +402,8 @@ The drawing associated with this worksheet. -

-The index of this worksheet in the owning Workbook’s worksheets list. -

+
+

The index of this worksheet in the owning Workbook’s worksheets list.

 @@ -440,9 +427,8 @@ The index of this worksheet in the owning Workbook’s worksheets list. -

-Creates a new worksheet. -

+
+

Creates a new worksheet.

 @@ -464,9 +450,8 @@ Creates a new worksheet. -

-The part name of this worksheet. -

+
+

The part name of this worksheet.

 @@ -488,9 +473,8 @@ The part name of this worksheet. -

-The worksheet relationships. -

+
+

The worksheet relationships.

 @@ -512,9 +496,8 @@ The worksheet relationships. -

-The relationship part name of this worksheet. -

+
+

The relationship part name of this worksheet.

 @@ -536,9 +519,8 @@ The relationship part name of this worksheet. -

-The relationship Id of thiw worksheet. -

+
+

The relationship Id of thiw worksheet.

 @@ -560,9 +542,8 @@ The relationship Id of thiw worksheet. -

-Set the style for cells in a specific row. -

+
+

Set the style for cells in a specific row.

 @@ -584,9 +565,8 @@ Set the style for cells in a specific row. -

-Serializes the worksheet document. -

+
+

Serializes the worksheet document.

 @@ -608,9 +588,8 @@ Serializes the worksheet document. -

-Updates auto fit data. -

+
+

Updates auto fit data.

 @@ -634,15 +613,13 @@ Updates auto fit data.
Note: -

-the recommended way to manage worksheets is Workbook#add_worksheet -

+
+

the recommended way to manage worksheets is Workbook#add_worksheet

-

-Creates a new worksheet. -

+ +

Creates a new worksheet.

@@ -663,9 +640,8 @@ Creates a new worksheet. — -

-a customizable set of options -

+
+

a customizable set of options

@@ -686,9 +662,8 @@ a customizable set of options - —

-The name of this sheet. -

+ —
+

The name of this sheet.

@@ -759,16 +734,14 @@ The name of this sheet.
Note: -

-a single auto fit data item is a hash with :longest => [String] and -:sz=> [Integer] members. -

+
+

a single auto fit data item is a hash with :longest => [String] and +:sz=> [Integer] members.

-

-An array of content based calculated column widths. -

+ +

An array of content based calculated column widths.

@@ -786,9 +759,8 @@ An array of content based calculated column widths. — -

-of Hash -

+
+

of Hash

@@ -829,9 +801,8 @@ of Hash

-

-The name of the worksheet -

+ +

The name of the worksheet

@@ -889,15 +860,13 @@ The name of the worksheet
Note: -

-The recommended way to manage rows is Worksheet#add_row -

+
+

The recommended way to manage rows is Worksheet#add_row

-

-The rows in this worksheet -

+ +

The rows in this worksheet

@@ -959,9 +928,8 @@ The rows in this worksheet

-

-The workbook that owns this worksheet -

+ +

The workbook that owns this worksheet

@@ -1023,18 +991,16 @@ The workbook that owns this worksheet
Note: -

-each chart type also specifies additional options -

+
+

each chart type also specifies additional options

-

-Adds a chart to this worksheets drawing. This is the recommended way to + +

Adds a chart to this worksheets drawing. This is the recommended way to create charts for your worksheet. This method wraps the complexity of dealing with ooxml drawing, anchors, markers graphic frames chart objects -and all the other dirty details. -

+and all the other dirty details.

@@ -1066,9 +1032,8 @@ and all the other dirty details. — -

-a customizable set of options -

+
+

a customizable set of options

@@ -1195,9 +1160,8 @@ a customizable set of options

-

-Adds a media item to the worksheets drawing -

+ +

Adds a media item to the worksheets drawing

@@ -1229,9 +1193,8 @@ Adds a media item to the worksheets drawing — -

-a customizable set of options -

+
+

a customizable set of options

@@ -1250,9 +1213,8 @@ a customizable set of options - —

-unknown -

+ —
+

unknown

@@ -1308,9 +1270,8 @@ unknown

-

-Adds a row to the worksheet and updates auto fit data -

+ +

Adds a row to the worksheet and updates auto fit data

@@ -1331,9 +1292,8 @@ Adds a row to the worksheet and updates auto fit data — -

-a customizable set of options -

+
+

a customizable set of options

@@ -1445,20 +1405,18 @@ a customizable set of options
Note: -

-From ECMA docs -

-
- Column width measured as the number of characters of the maximum digit width of the numbers 0 .. 9 as
- rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
- width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256
+    

+
From ECMA docs

+
+
Column width measured as the number of characters of the maximum digit width of the numbers 0 .. 9 as 
+rendered in the normal style's font. There are 4 pixels of margin padding (two on each side), plus 1 pixel padding for the gridlines.
+width = Truncate([!{Number of Characters} * !{Maximum Digit Width} + !{5 pixel padding}]/{Maximum Digit Width}*256)/256
-

-Determines the proper width for a column based on content. -

+ +

Determines the proper width for a column based on content.

@@ -1477,9 +1435,8 @@ Determines the proper width for a column based on content. — -

-hash of auto_fit_data -

+
+

hash of auto_fit_data

@@ -1550,16 +1507,14 @@ hash of auto_fit_data
Note: -

-You can also specify the style for specific columns in the call to add_row -by using an array for the :styles option -

+
+

You can also specify the style for specific columns in the call to add_row +by using an array for the :styles option

-

-Set the style for cells in a specific column -

+ +

Set the style for cells in a specific column

@@ -1578,9 +1533,8 @@ Set the style for cells in a specific column — -

-the index of the column -

+
+

the index of the column

@@ -1595,9 +1549,8 @@ the index of the column — -

-cellXfs index -

+
+

cellXfs index

@@ -1614,9 +1567,8 @@ cellXfs index — -

-a customizable set of options -

+
+

a customizable set of options

@@ -1639,9 +1591,8 @@ a customizable set of options - —

-only cells after this column will be updated. -

+ —
+

only cells after this column will be updated.

@@ -1705,9 +1656,8 @@ only cells after this column will be updated.

-

-returns the sheet data as columnw -

+ +

returns the sheet data as columnw

@@ -1749,15 +1699,13 @@ returns the sheet data as columnw
Note: -

-the recommended way to work with drawings and charts is Worksheet#add_chart -

+
+

the recommended way to work with drawings and charts is Worksheet#add_chart

-

-The drawing associated with this worksheet. -

+ +

The drawing associated with this worksheet.

@@ -1816,9 +1764,8 @@ The drawing associated with this worksheet.

-

-The index of this worksheet in the owning Workbook’s worksheets list. -

+ +

The index of this worksheet in the owning Workbook’s worksheets list.

@@ -1870,9 +1817,8 @@ The index of this worksheet in the owning Workbook’s worksheets list.

-

-The part name of this worksheet -

+ +

The part name of this worksheet

@@ -1924,9 +1870,8 @@ The part name of this worksheet

-

-The worksheet relationships. This is managed automatically by the worksheet -

+ +

The worksheet relationships. This is managed automatically by the worksheet

@@ -1982,9 +1927,8 @@ The worksheet relationships. This is managed automatically by the worksheet

-

-The relationship part name of this worksheet -

+ +

The relationship part name of this worksheet

@@ -2036,9 +1980,8 @@ The relationship part name of this worksheet

-

-The relationship Id of thiw worksheet -

+ +

The relationship Id of thiw worksheet

@@ -2093,15 +2036,13 @@ The relationship Id of thiw worksheet
Note: -

-You can also specify the style in the add_row call -

+
+

You can also specify the style in the add_row call

-

-Set the style for cells in a specific row -

+ +

Set the style for cells in a specific row

@@ -2120,9 +2061,8 @@ Set the style for cells in a specific row — -

-or range of indexes in the table -

+
+

or range of indexes in the table

@@ -2137,9 +2077,8 @@ or range of indexes in the table — -

-cellXfs index -

+
+

cellXfs index

@@ -2156,9 +2095,8 @@ cellXfs index — -

-a customizable set of options -

+
+

a customizable set of options

@@ -2181,9 +2119,8 @@ a customizable set of options - —

-only cells after this column will be updated. -

+ —
+

only cells after this column will be updated.

@@ -2243,9 +2180,8 @@ only cells after this column will be updated.

-

-Serializes the worksheet document -

+ +

Serializes the worksheet document

@@ -2333,11 +2269,10 @@ Serializes the worksheet document

-

-Updates auto fit data. Autofit data attempts to determine the cell in a + +

Updates auto fit data. Autofit data attempts to determine the cell in a column that has the greatest width by comparing the length of the text -multiplied by the size of the font. -

+multiplied by the size of the font.

@@ -2356,9 +2291,8 @@ multiplied by the size of the font. — -

-an array of cells -

+
+

an array of cells

@@ -2376,9 +2310,8 @@ an array of cells — -

-of Cell objects -

+
+

of Cell objects

@@ -2444,7 +2377,7 @@ of Cell objects
-- cgit v1.2.3