High level representation of a Excel workbook. This is the first object most users will construct whether they are reading or writing a workbook. It is also the top level object for creating new sheets/etc. More info.
1 excel.Workbook
<excel.Workbook
type='xls|xlsx'
stream='true|false'
stream-window-size='stream-window-size'
encoding='encoding'
>
<file /> *
</excel.Workbook>
| Attributes | |||||
|---|---|---|---|---|---|
| Name | Type | Required | Default | Description | |
| Atype | string | The type of workbook.
|
|||
| Astream | boolean | false | Only available on new creation for xlsx workbook document to specify the window for row access. | ||
| Astream-window-size | integer | 100 |
Only available on new creation for xlsx workbook document when stream is active. When a new node is created via SXSSFSheet.createRow(int) and the total number of unflushed records would exceed the specified value, then the row with the lowest index value is flushed and cannot be accessed via SXSSFSheet.getRow(int) anymore. A value of -1 indicates unlimited access. In this case all records that have not been flushed by a call to flush() are available for random access. A value of 0 is not allowed because it would flush any newly created row without having a chance to specify any cells. |
||
| Aencoding | string | Indicates the encoding of the string to be processed, such as ISO-8859-1 or UTF-8. If the usage that has been defined in the configuration files for the server has not been specified. | |||
| Arguments | |||||
|---|---|---|---|---|---|
| Name | Type | Required | Unique | Nullable | Description |
| Efile | file | Excel workbook file. If this argument is not defined a new Excel workbook will be created. | |||
| Returns | |
|---|---|
| Type | Description |
| Workbook | The workbook object. |