The following table lists the child elements of the sheets element. The sheets element has no attributes.
| Child Element |
API Reference |
Count |
Type |
| sheet |
any |
|
sheet |
The following table lists the attributes of the sheet element.
| Attribute |
API Reference |
Type |
Comment |
| allowCellOverflow |
sheet.allowCellOverflow(value) |
boolean |
|
| borderColor |
sheet.borderColor |
string |
|
| borderWidth |
sheet.borderWidth |
number |
|
| clipBoardOptions |
sheet.clipBoardoptions(value) |
GcSpread.Sheets.ClipboardPasteOptions |
|
| columnHeaderAutoText |
sheet.setColumnHeaderAutoText(value) |
GcSpread.Sheets.HeaderAutoText |
|
| columnHeaderAutoTextIndex |
sheet.setColumnHeaderAutoTextIndex(value) |
number |
|
| columnHeaderVisible |
sheet.setColumnHeaderVisible(value) |
boolean |
|
| currentTheme |
sheet.currentTheme(value) |
string |
|
| dataSource |
sheet.setDataSource(value) |
any |
|
| dataSourceDeepWatch |
|
boolean |
This attribute is used for SpreadJS to automatically refresh when the array type data source is changed. When set to true, AngularJS notifies the source of the change and updates SpreadJS; otherwise, does not refresh. The default value is true. |
| frozenColumnCount |
sheet.setFrozenColumnCount(value) |
number |
|
| frozenlineColor |
sheet.frozenlineColor(value) |
string |
|
| frozenRowCount |
sheet.setFrozenRowCount(value) |
number |
|
| frozenTrailingColumnCount |
sheet.setFrozenTrailingColumnCount(value) |
number |
|
| frozenTrailingRowCount |
sheet.setFrozenTrailingRowCount(value) |
number |
|
| isProtected |
sheet.setIsProtected(value) |
boolean |
|
| name |
sheet.name |
string |
|
| referenceStyle |
sheet.referenceStyle(value) |
GcSpread.Sheets.ReferenceStyle |
|
| rowCount |
sheet.setRowCount(value) |
number |
|
| rowHeaderAutoText |
sheet.setRowHeaderAutoText(value) |
GcSpread.Sheets.HeaderAutoText |
|
| rowHeaderAutoTextIndex |
sheet.setRowHeaderAutoTextIndex(value) |
number |
|
| rowHeaderVisible |
sheet.setRowHeaderVisible(value) |
boolean |
|
| selectionPolicy |
sheet.selectionPolicy(value) |
GcSpread.Sheets.SelectionPolicy |
|
| selectionUnit |
sheet.selectionUnit(value) |
GcSpread.Sheets.SelectionUnit |
|
| sheetTabColor |
sheet.sheetTabColor(value) |
string |
|
| showColumnRangeGroup |
sheet.showColumnRangeGroup(value) |
boolean |
|
| showRowRangeGroup |
sheet.showRowRangeGroup(value) |
boolean |
|
| zoom |
sheet.zoom(value) |
number |
|
The following table lists the child elements of the sheet.
| Child Element |
API Reference |
Count |
Type |
Comment |
| columns |
sheet.columns |
1 |
columns |
The columns element can only be added on the sheet element. |
| colRangeGroup |
sheet.colRangeGroup |
1 |
rangeGroup |
|
| columnHeaderDefaultStyle |
sheet.setDefaultStyle(value, SheetArea.colHeader) |
1 |
style |
|
| cornerHeaderDefaultStyle |
sheet.setDefaultStyle(value, SheetArea.corner) |
1 |
style |
|
| defaultStyle |
sheet.setDefaultStyle(value, SheetArea.viewport) |
1 |
style |
|
| rowHeaderDefaultStyle |
sheet.setDefaultStyle(value, SheetArea.rowHeader) |
1 |
style |
|
| rowRangeGroup |
sheet.rowRangeGroup |
1 |
rangeGroup |
|