@univerjs/core v0.4.2 • Docs

Class: Worksheet

The model of a Worksheet.

Constructors

new Worksheet()

new Worksheet(
   unitId, 
   snapshot, 
   _styles): Worksheet

Parameters

Returns

Worksheet

Defined in

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

Properties

Methods

__interceptViewModel()

__interceptViewModel(callback): void

Internal

Parameters

Returns

void

Defined in

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

cellHasValue()

cellHasValue(value): boolean

Parameters

Returns

boolean

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:773 (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:317 (opens in a new tab)

getCell()

getCell(row, col): Nullable<ICellDataForSheetInterceptor>

Get cellData, includes cellData, customRender, markers, dataValidate, etc.

WARNING: All sheet CELL_CONTENT interceptors will be called in this method, cause performance issue. example: this._sheetInterceptorService.intercept(INTERCEPTOR_POINT.CELL_CONTENT);

Parameters

Returns

Nullable<ICellDataForSheetInterceptor>

ICellDataForSheetInterceptor

Defined in

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

getCellInfoInMergeData()

getCellInfoInMergeData(row, column): ISelectionCell

Get cell info with merge data

Parameters

Returns

ISelectionCell

• The cell info with merge data

Defined in

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

getCellMatrix()

getCellMatrix(): ObjectMatrix<Nullable<ICellData>>

Returns WorkSheet Cell Data Matrix

Returns

ObjectMatrix<Nullable<ICellData>>

WorkSheet Cell Data Matrix

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:184 (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:192 (opens in a new tab)

getCellRaw()

getCellRaw(row, col): Nullable<ICellData>

Parameters

Returns

Nullable<ICellData>

Defined in

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

getCellStyleOnly()

getCellStyleOnly(row, col): Nullable<ICellDataForSheetInterceptor>

Get cellData only use effect on style interceptor

Parameters

Returns

Nullable<ICellDataForSheetInterceptor>

The cell data only use effect on style interceptor

Defined in

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

getCellValueOnly()

getCellValueOnly(row, col): Nullable<ICellDataForSheetInterceptor>

Get cellData only use effect on value interceptor

Parameters

Returns

Nullable<ICellDataForSheetInterceptor>

The cell data only use effect on value interceptor

Defined in

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

getColVisible()

getColVisible(col): boolean

Parameters

Returns

boolean

Defined in

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

getColumnCount()

getColumnCount(): number

Returns

number

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:619 (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:300 (opens in a new tab)

getColumnStyle()

getColumnStyle(column, keepRaw?): string | Nullable<IStyleData>

Get the style of the column.

Parameters

Returns

string | Nullable<IStyleData>

The style of the column

Defined in

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

getColumnWidth()

getColumnWidth(columnPosition): number

Gets the width in pixels of the given column.

Parameters

Returns

number

Gets the width in pixels of the given column.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:665 (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:577 (opens in a new tab)

getDefaultCellStyle()

getDefaultCellStyle(): string | Nullable<IStyleData>

Get the default style of the worksheet.

Returns

string | Nullable<IStyleData>

Default Style

Defined in

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

getDefaultCellStyleInternal()

getDefaultCellStyleInternal(): Nullable<IStyleData>

Returns

Nullable<IStyleData>

Defined in

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

getFreeze()

getFreeze(): IFreeze

Returns frozen.

Returns

IFreeze

frozen

Defined in

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

getHiddenCols()

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

Parameters

Returns

IRange[]

Defined in

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

getHiddenRows()

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

Parameters

Returns

IRange[]

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:708 (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:769 (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:761 (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

Returns

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

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:491 (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:593 (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:604 (opens in a new tab)

getMergeData()

getMergeData(): IRange[]

Get the merged cell list of the sheet.

Returns

IRange[]

merged cell list

Defined in

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

getMergedCell()

getMergedCell(row, col): Nullable<IRange>

Get the merged cell Range of the sheet cell.

Parameters

Returns

Nullable<IRange>

The merged cell range of the cell, if the cell is not in a merged cell, return null

Defined in

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

getMergedCellRange()

getMergedCellRange(
   startRow, 
   startColumn, 
   endRow, 
   endColumn): IRange[]

Get the merged cell info list which has intersection with the given range.

Parameters

Returns

IRange[]

The merged cell info list which has intersection with the given range or empty array if no merged cell in the range

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:350 (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:308 (opens in a new tab)

getRange()

getRange(range)

getRange(range): Range

Parameters

Returns

Range

Defined in

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

getRange(startRow, startColumn)

getRange(startRow, startColumn): Range

Parameters

Returns

Range

Defined in

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

getRange(startRow, startColumn, endRow, endColumn)

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

Parameters

Returns

Range

Defined in

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

getRowCount()

getRowCount(): number

Returns

number

Defined in

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

getRowFiltered()

getRowFiltered(row): boolean

Parameters

Returns

boolean

Defined in

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

getRowHeight()

getRowHeight(row): number

Gets the height in pixels of the given row.

Parameters

Returns

number

Gets the height in pixels of the given row.

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:674 (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:277 (opens in a new tab)

getRowRawVisible()

getRowRawVisible(row): boolean

Get if the row does not have hidden property. This value won't affected by features like filter and view.

Parameters

Returns

boolean

if the row does not have hidden property

Defined in

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

getRowStyle()

getRowStyle(row, keepRaw?): string | Nullable<IStyleData>

Get the style of the row.

Parameters

Returns

string | Nullable<IStyleData>

The style of the row

Defined in

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

getRowVisible()

getRowVisible(row): boolean

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

Parameters

Returns

boolean

if the row in visible to the user

Defined in

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

getScrollLeftTopFromSnapshot()

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

Returns

{
  scrollLeft: number;
  scrollTop: number;
}

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:558 (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:292 (opens in a new tab)

getSnapshot()

getSnapshot(): IWorksheetData

Returns

IWorksheetData

Defined in

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

getSpanModel()

getSpanModel(): SpanModel

Returns

SpanModel

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:86 (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:653 (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:284 (opens in a new tab)

getVisibleCols()

getVisibleCols(): IRange[]

Get all visible columns in the sheet.(not include filter & view)

Returns

IRange[]

Visible columns range list

Defined in

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

getVisibleRows()

getVisibleRows(): IRange[]

Get all visible rows in the sheet.(not include filter & view, like getRawVisibleRows)

Returns

IRange[]

Visible rows range list

Defined in

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

getZoomRatio()

getZoomRatio(): number

Return WorkSheetZoomRatio

Returns

number

zoomRatio

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:569 (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:639 (opens in a new tab)

isColumnContainsMergedCell()

isColumnContainsMergedCell(column): boolean

Get if the column contains merged cell

Parameters

Returns

boolean

Is merge cell across column

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:368 (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:750 (opens in a new tab)

isRowContainsMergedCell()

isRowContainsMergedCell(row): boolean

Get if the row contains merged cell

Parameters

Returns

boolean

Is merge cell across row

Defined in

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

isRowFiltered()

isRowFiltered(row): boolean

Row is filtered out, that means this row is invisible.

Parameters

Returns

boolean

is row hidden by filter

Defined in

submodules/univer/packages/core/src/sheets/worksheet.ts:686 (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:631 (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

Returns

Iterable<Readonly<ICell>>

Defined in

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

iterateByRow()

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

Iterate a range row by row.

Performance intensive.

Parameters

Returns

Iterable<Readonly<ICell>>

Defined in

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

mixinDefaultStyleToCellRaw()

mixinDefaultStyleToCellRaw(
   row, 
   col, 
   cellRaw, 
   isRowStylePrecedeColumnStyle): void

this function is used to mixin default style to cell raw{number}

Parameters

Returns

void

Defined in

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

setColumnCount()

setColumnCount(count): void

Parameters

Returns

void

Defined in

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

setColumnStyle()

setColumnStyle(column, style): void

Set the style of the column.

Parameters

Returns

void

Defined in

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

setDefaultCellStyle()

setDefaultCellStyle(style): void

Set Default Style, if the style has been set, all cells style will be base on this style.

Parameters

Returns

void

Defined in

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

setMergeData()

setMergeData(mergeData): void

Set the merge data of the sheet, all the merged cells will be rebuilt.

Parameters

Returns

void

Defined in

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

setRowCount()

setRowCount(count): void

Parameters

Returns

void

Defined in

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

setRowStyle()

setRowStyle(row, style): void

Set the style of the row.

Parameters

Returns

void

Defined in

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