Class: Worksheet

The model of a Worksheet.

Constructors

new Worksheet()

new Worksheet(
   unitId, 
   snapshot, 
   _styles): Worksheet

Parameters

Parameter	Type
`unitId`	`string`
`snapshot`	`Partial`<`IWorksheetData`>
`_styles`	`Styles`

Returns

Worksheet

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:42 (opens in a new tab)

Properties

Property	Modifier	Type	Defined in
`_cellData`	`protected`	`ObjectMatrix`<`ICellData`>	submodules/univer/packages/core/src/sheets/worksheet.ts:35 (opens in a new tab)
`_columnManager`	`protected`	`ColumnManager`	submodules/univer/packages/core/src/sheets/worksheet.ts:38 (opens in a new tab)
`_rowManager`	`protected`	`RowManager`	submodules/univer/packages/core/src/sheets/worksheet.ts:37 (opens in a new tab)
`_sheetId`	`protected`	`string`	submodules/univer/packages/core/src/sheets/worksheet.ts:33 (opens in a new tab)
`_snapshot`	`protected`	`IWorksheetData`	submodules/univer/packages/core/src/sheets/worksheet.ts:34 (opens in a new tab)
`_viewModel`	`readonly`	`SheetViewModel`	submodules/univer/packages/core/src/sheets/worksheet.ts:40 (opens in a new tab)
`unitId`	`readonly`	`string`	submodules/univer/packages/core/src/sheets/worksheet.ts:43 (opens in a new tab)

Methods

__interceptViewModel()

__interceptViewModel(callback): void

Internal

Parameters

Parameter	Type
`callback`	(`viewModel`) => `void`

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:63 (opens in a new tab)

cellHasValue()

cellHasValue(value): boolean

Parameters

Parameter	Type
`value`	`ICellData`

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:541 (opens in a new tab)

clone()

clone(): Worksheet

Returns WorkSheet Clone Object

Returns

Worksheet

WorkSheet Clone Object

Deprecated

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:208 (opens in a new tab)

getCell()

getCell(row, col): Nullable<ICellDataForSheetInterceptor>

Parameters

Parameter	Type
`row`	`number`
`col`	`number`

Returns

Nullable<ICellDataForSheetInterceptor>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:241 (opens in a new tab)

getCellMatrix()

getCellMatrix(): ObjectMatrix<Nullable<ICellData>>

Returns WorkSheet Cell Data Matrix

Returns

ObjectMatrix<Nullable<ICellData>>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:75 (opens in a new tab)

getCellMatrixPrintRange()

getCellMatrixPrintRange(): null | {
  endColumn: number;
  endRow: number;
  startColumn: number;
  startRow: number;
}

Get worksheet printable cell range.

Returns

null | { endColumn: number; endRow: number; startColumn: number; startRow: number; }

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:83 (opens in a new tab)

getCellRaw()

getCellRaw(row, col): Nullable<ICellData>

Parameters

Parameter	Type
`row`	`number`
`col`	`number`

Returns

Nullable<ICellData>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:249 (opens in a new tab)

getColVisible()

getColVisible(col): boolean

Parameters

Parameter	Type
`col`	`number`

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:484 (opens in a new tab)

getColumnCount()

getColumnCount(): number

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:393 (opens in a new tab)

getColumnManager()

getColumnManager(): ColumnManager

Returns Column Manager

Returns

ColumnManager

Column Manager

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:191 (opens in a new tab)

getColumnWidth()

getColumnWidth(columnPosition): number

Gets the width in pixels of the given column.

Parameters

Parameter	Type	Description
`columnPosition`	`number`	column index

Returns

number

Gets the width in pixels of the given column.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:439 (opens in a new tab)

getConfig()

getConfig(): IWorksheetData

Returns WorkSheet Configures

Returns

IWorksheetData

WorkSheet Configures

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:351 (opens in a new tab)

getFreeze()

getFreeze(): IFreeze

Returns frozen.

Returns

IFreeze

frozen

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:359 (opens in a new tab)

getHiddenCols()

getHiddenCols(start?, end?): IRange[]

Parameters

Parameter	Type
`start`?	`number`
`end`?	`number`

Returns

IRange[]

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:488 (opens in a new tab)

getHiddenRows()

getHiddenRows(start?, end?): IRange[]

Parameters

Parameter	Type
`start`?	`number`
`end`?	`number`

Returns

IRange[]

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:476 (opens in a new tab)

getLastColumnWithContent()

getLastColumnWithContent(): number

Returns the position of the last column that has content.

Returns

number

the position of the last column that has content.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:537 (opens in a new tab)

getLastRowWithContent()

getLastRowWithContent(): number

Returns the position of the last row that has content.

Returns

number

the position of the last row that has content.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:529 (opens in a new tab)

getMatrixWithMergedCells()

getMatrixWithMergedCells(
   row, 
   col, 
   endRow, 
   endCol, 
   isRaw): ObjectMatrix<ICellData & {
  colSpan: number;
  rowSpan: number;
}>

Get cell matrix from a given range and pick out non-first cells of merged cells.

Notice that ICellData here is not after copying. In another word, the object matrix here should be considered as a slice of the original worksheet data matrix.

Parameters

Parameter	Type	Default value
`row`	`number`	`undefined`
`col`	`number`	`undefined`
`endRow`	`number`	`undefined`
`endCol`	`number`	`undefined`
`isRaw`	`boolean`	`false`

Returns

ObjectMatrix<ICellData & { colSpan: number; rowSpan: number; }>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:263 (opens in a new tab)

getMaxColumns()

getMaxColumns(): number

Returns the current number of columns in the sheet, regardless of content.

Returns

number

the current number of columns in the sheet, regardless of content

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:367 (opens in a new tab)

getMaxRows()

getMaxRows(): number

Returns the current number of rows in the sheet, regardless of content.

Returns

number

the current number of rows in the sheet, regardless of content

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:378 (opens in a new tab)

getMergeData()

getMergeData(): IRange[]

Returns

IRange[]

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:215 (opens in a new tab)

getMergedCell()

getMergedCell(row, col): Nullable<IRange>

Parameters

Parameter	Type
`row`	`number`
`col`	`number`

Returns

Nullable<IRange>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:219 (opens in a new tab)

getName()

getName(): string

Returns the name of the sheet.

Returns

string

name of the sheet

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:199 (opens in a new tab)

getRange()

getRange(range)

getRange(range): Range

Parameters

Parameter	Type
`range`	`IRange`

Returns

Range

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:308 (opens in a new tab)

getRange(startRow, startColumn)

getRange(startRow, startColumn): Range

Parameters

Parameter	Type
`startRow`	`number`
`startColumn`	`number`

Returns

Range

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:309 (opens in a new tab)

getRange(startRow, startColumn, endRow, endColumn)

getRange(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): Range

Parameters

Parameter	Type
`startRow`	`number`
`startColumn`	`number`
`endRow`	`number`
`endColumn`	`number`

Returns

Range

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:310 (opens in a new tab)

getRowCount()

getRowCount(): number

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:385 (opens in a new tab)

getRowFiltered()

getRowFiltered(row): boolean

Parameters

Parameter	Type
`row`	`number`

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:253 (opens in a new tab)

getRowHeight()

getRowHeight(row): number

Gets the height in pixels of the given row.

Parameters

Parameter	Type	Description
`row`	`number`	row index

Returns

number

Gets the height in pixels of the given row.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:448 (opens in a new tab)

getRowManager()

getRowManager(): RowManager

Returns Row Manager

Returns

RowManager

Row Manager

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:168 (opens in a new tab)

getRowRawVisible()

getRowRawVisible(row): boolean

Get if the row does not have hidden property.

Parameters

Parameter	Type	Description
`row`	`number`	the row index

Returns

boolean

if the row does not have hidden property

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:472 (opens in a new tab)

getRowVisible()

getRowVisible(row): boolean

Get if the row in visible. It may be affected by features like filter and view.

Parameters

Parameter	Type	Description
`row`	`number`	the row index

Returns

boolean

if the row in visible to the user

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:460 (opens in a new tab)

getScrollLeftTopFromSnapshot()

getScrollLeftTopFromSnapshot(): {
  scrollLeft: number;
  scrollTop: number;
}

Returns

{
  scrollLeft: number;
  scrollTop: number;
}

Name	Type	Defined in
`scrollLeft`	`number`	submodules/univer/packages/core/src/sheets/worksheet.ts:334 (opens in a new tab)
`scrollTop`	`number`	submodules/univer/packages/core/src/sheets/worksheet.ts:335 (opens in a new tab)

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:332 (opens in a new tab)

getSheetId()

getSheetId(): string

Returns the ID of the sheet represented by this object.

Returns

string

ID of the sheet

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:183 (opens in a new tab)

getSnapshot()

getSnapshot(): IWorksheetData

Returns

IWorksheetData

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:67 (opens in a new tab)

getTabColor()

getTabColor(): Nullable<string>

Gets the sheet tab color, or null if the sheet tab has no color.

Returns

Nullable<string>

the sheet tab color or null

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:427 (opens in a new tab)

getUnitId()

getUnitId(): string

Returns the ID of its parent unit.

Returns

string

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:175 (opens in a new tab)

getVisibleCols()

getVisibleCols(): IRange[]

Get all visible columns in the sheet.

Returns

IRange[]

Visible columns range list

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:509 (opens in a new tab)

getVisibleRows()

getVisibleRows(): IRange[]

Get all visible rows in the sheet.

Returns

IRange[]

Visible rows range list

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:500 (opens in a new tab)

getZoomRatio()

getZoomRatio(): number

Return WorkSheetZoomRatio

Returns

number

zoomRatio

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:343 (opens in a new tab)

hasHiddenGridlines()

hasHiddenGridlines(): boolean

Returns true if the sheet's gridlines are hidden; otherwise returns false. Gridlines are visible by default.

Returns

boolean

Gridlines Hidden Status

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:413 (opens in a new tab)

isRightToLeft()

isRightToLeft(): BooleanNumber

Returns true if this sheet layout is right-to-left. Returns false if the sheet uses the default left-to-right layout.

Returns

BooleanNumber

true if this sheet layout is right-to-left. Returns false if the sheet uses the default left-to-right layout.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:518 (opens in a new tab)

isSheetHidden()

isSheetHidden(): BooleanNumber

isSheetHidden

Returns

BooleanNumber

hidden status of sheet

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:405 (opens in a new tab)

iterateByColumn()

iterateByColumn(
   range, 
   skipEmpty, 
skipNonTopLeft): Iterable<Readonly<ICell>>

Iterate a range column by column. This is pretty similar to iterateByRow but with different order.

Performance intensive.

Parameters

Parameter	Type	Default value	Description
`range`	`IRange`	`undefined`	The iterate range.
`skipEmpty`	`boolean`	`true`	Whether to skip empty cells, default to be `true`.
`skipNonTopLeft`	`boolean`	`true`	Whether to skip non-top-left cells of merged cells, default to be `true`. If the parameter is set to `false`, the iterator will return cells in the top row.

Returns

Iterable<Readonly<ICell>>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:628 (opens in a new tab)

iterateByRow()

iterateByRow(range, skipEmpty): Iterable<Readonly<ICell>>

Iterate a range row by row.

Performance intensive.

Parameters

Parameter	Type	Default value	Description
`range`	`IRange`	`undefined`	the iterate range
`skipEmpty`	`boolean`	`true`	whether to skip empty cells, default to be `true`

Returns

Iterable<Readonly<ICell>>

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:557 (opens in a new tab)

setColumnCount()

setColumnCount(count): void

Parameters

Parameter	Type
`count`	`number`

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:397 (opens in a new tab)

setRowCount()

setRowCount(count): void

Parameters

Parameter	Type
`count`	`number`

Returns

void

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:389 (opens in a new tab)

Workbook Absolutereftype