@univerjs/facade v0.1.17 • Docs
Class: FWorksheet
Constructors
new FWorksheet()
new FWorksheet(
_workbook,
_worksheet,
_injector,
_selectionManagerService,
_commandService): FWorksheet
Parameters
Parameter | Type |
---|---|
_workbook | Workbook |
_worksheet | Worksheet |
_injector | Injector |
_selectionManagerService | SelectionManagerService |
_commandService | ICommandService |
Returns
Defined in
sheets/f-worksheet.ts:26 (opens in a new tab)
Methods
getMaxColumns()
getMaxColumns(): number
Returns the current number of columns in the sheet, regardless of content.
Returns
number
The maximum columns count of the sheet
Defined in
sheets/f-worksheet.ts:108 (opens in a new tab)
getMaxRows()
getMaxRows(): number
Returns the current number of rows in the sheet, regardless of content.
Returns
number
The maximum rows count of the sheet
Defined in
sheets/f-worksheet.ts:116 (opens in a new tab)
getRange()
getRange(
row,
col,
height?,
width?): null | FRange
Parameters
Parameter | Type |
---|---|
row | number |
col | number |
height ? | number |
width ? | number |
Returns
null
| FRange
Defined in
sheets/f-worksheet.ts:61 (opens in a new tab)
getSelection()
getSelection(): null | FSelection
Returns
null
| FSelection
Defined in
sheets/f-worksheet.ts:52 (opens in a new tab)
getSheetId()
getSheetId(): string
Returns the worksheet id
Returns
string
The id of the worksheet
Defined in
sheets/f-worksheet.ts:40 (opens in a new tab)
getSheetName()
getSheetName(): string
Returns the worksheet name
Returns
string
The name of the worksheet
Defined in
sheets/f-worksheet.ts:48 (opens in a new tab)
setColumnWidths()
setColumnWidths(
startColumn,
numColumns,
width): void
Parameters
Parameter | Type |
---|---|
startColumn | number |
numColumns | number |
width | number |
Returns
void
Defined in
sheets/f-worksheet.ts:88 (opens in a new tab)
setRowHeights()
setRowHeights(
startRow,
numRows,
height): void
Parameters
Parameter | Type |
---|---|
startRow | number |
numRows | number |
height | number |
Returns
void