Class Sheet

Base implementation of ISheet.

Implements

ISheet

Constructors

constructor

new Sheet(options?: ISheet.ConstructorOptions): Sheet
Parameters
- Optionaloptions: ISheet.ConstructorOptions
Returns Sheet

Accessors

[toStringTag]

get "[toStringTag]"(): string
Returns string

isISheet

get isISheet(): true
For runtime type checking.

Returns true
Implementation of ISheet.isISheet

Methods

_doPerfTest

_doPerfTest(length?: number, doProfile?: boolean): void
Parameters
- length: number = 10000000
- doProfile: boolean = false
Returns void

addListeners

addListeners(listeners: IListeners, options?: IListener.Options): Remove
Add Listeners.
Parameters
- listeners: IListeners
- Optionaloptions: IListener.Options
Returns Remove
Implementation of ISheet.addListeners

beginCommit

beginCommit(options?: string | OperationOptions): ITransaction
Batches all 'transactional' changes until they have all be committed or rolled back.
Parameters
- Optionaloptions: string | OperationOptions
  Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns ITransaction
Remarks
Any changes that are made to this object will be reflected in the local record but not committed to the transactional store until the batch is popped.

Useful for operations that are longer running but generally not recommended as it keeps a transaction open. doBatch is the preferred option.

Implementation of ISheet.beginCommit

close

close(): void
Free all resources associated with the sheet.

Returns void
Remarks
- Called by workbooks when the workbook is is closed.
- This is different than delete which removes the sheet from the workbook.
Implementation of ISheet.close

createTemporaryCell

createTemporaryCell(update: ICell.Update, coords?: IRange.CellCoords): ICell
Creates a cell that is not including at a coordinate but adopts all rendering.

Useful for previewing values such as tooltip. If the coords are passed it will return a disconnect cell update for that value.
Parameters
- update: ICell.Update
  Cell Update
- coords: IRange.CellCoords = null
  Optional CellCoord
Returns ICell
A detached ICell

Remarks
Does not add to the sheet but provides a standalone ICell.

Implementation of ISheet.createTemporaryCell

delete

delete(): void
Removes from a container. This is usually the Workbook. If this is being used standalone this operation will throw an exception.

Returns void
Implementation of ISheet.delete

doBatch

doBatch<R>(
callback: (commit: ICommit) => R | Promise<R>,
options?: string | OperationOptions,
): R | Promise<R>
Provides a mechanism to perform a set of operations in a batch.
Type Parameters
- R
Parameters
- callback: (commit: ICommit) => R | Promise<R>
  A callback that performs multiple operations all within the same transaction.
- Optionaloptions: string | OperationOptions
  Description of the operation or additional options. Used for tracking undo/redo and history. Default Value User Operation.
Returns R | Promise<R>
Implementation of ISheet.doBatch

duplicate

duplicate(): Promise<ISheet>
Returns a promise that will resolve to a copy of the current sheet.

Returns Promise<ISheet>
Implementation of ISheet.duplicate

find

find(text: string, options?: FindOptions): Iterator<ICell>
Returns an iterator of ICells that match the results.
Parameters
- text: string
  The text to search for.
- Optionaloptions: FindOptions
Returns Iterator<ICell>
Remarks
This is the equivalent of getEntireRange().find.

Implementation of ISheet.find

getCalculation

getCalculation(): ICalculation
Returns the ICalculation for the workbook.

Returns ICalculation
Implementation of ISheet.getCalculation

getColumnHeaders

getColumnHeaders(): ISheetHeader
Returns the column headers managed by the sheet.

Returns ISheetHeader
Implementation of ISheet.getColumnHeaders

getColumnWidthAsFontUnit

getColumnWidthAsFontUnit(pixelWidth: number): number
Returns the column width as a font unit.

This is used as an informative tooltip.
Parameters
- pixelWidth: number
Returns number
Implementation of ISheet.getColumnWidthAsFontUnit

getConditionals

getConditionals(): IConditionalFormatCollection
Returns IConditionalFormatCollection

getEntireRange

getEntireRange(options?: GetRangeOptions): ICellRange
Returns the range for the entire sheet.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellRange
Implementation of ISheet.getEntireRange

getFilter

getFilter(): IAutoFilter
Returns the IAutoFilter created using insertFilter.

Returns IAutoFilter
The current filter or null if there is no filter.

Implementation of ISheet.getFilter

getMovables

getMovables(): IMovableCollection
Returns a collection of movables that are embedded in this sheet.

Returns IMovableCollection
Implementation of ISheet.getMovables

getName

getName(): string
Returns the display name for the sheet.

Returns string
Implementation of ISheet.getName

getNames

getNames(): INamedCollection
Returns a collection of INameds.

Returns INamedCollection
Implementation of ISheet.getNames

getProtection

getProtection(): ISheetProtection
Returns the sheet protection.

Returns ISheetProtection
Implementation of ISheet.getProtection

getRange

getRange(address: ICellRange.Address, options?: GetRangeOptions): ICellRange
Returns an ICellRange used to interact with a a rectangular 2D collection of cells at a specific range.
Parameters
- address: ICellRange.Address
  Address of the ranges.
- Optionaloptions: GetRangeOptions
  Options for the ranges.
Returns ICellRange
Implementation of ISheet.getRange

getRangeAtBounds

getRangeAtBounds(bounds: Bounds, options?: GetRangeOptions): ICellRange
Returns the range for a given pixel bounds.
Parameters
- bounds: Bounds
- Optionaloptions: GetRangeOptions
Returns ICellRange
Implementation of ISheet.getRangeAtBounds

getRanges

getRanges(address: ICellRanges.Address, options?: GetRangeOptions): ICellRanges
Returns an ICellRange used to interact with a a rectangular 2D collection of cells at a specific range.
Parameters
- address: ICellRanges.Address
  Address of the ranges.
- Optionaloptions: GetRangeOptions
  Options for the ranges.
Returns ICellRanges
Implementation of ISheet.getRanges

getResources

getResources(): IResourceCollection
Returns the current shared resources.

Returns IResourceCollection
Implementation of ISheet.getResources

getRowHeaders

getRowHeaders(): ISheetHeader
Returns the row headers managed by the sheet.

Returns ISheetHeader
Implementation of ISheet.getRowHeaders

getSelectedCell

getSelectedCell(): ICell
Returns the selected cell.

Returns ICell
Implementation of ISheet.getSelectedCell

getSelectedRange

getSelectedRange(options?: GetRangeOptions): ICellRange
Returns a range of cells for the current selection.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellRange
Implementation of ISheet.getSelectedRange

getSelectedRanges

getSelectedRanges(options?: GetRangeOptions): ICellRanges
Returns ranges of cells for the current selection.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellRanges
Implementation of ISheet.getSelectedRanges

getSelection

getSelection(): IRangeSelection
Returns the current selection.

Returns IRangeSelection
Remarks
This allows for listening to selection changes and advanced navigation.

Implementation of ISheet.getSelection

getSort

getSort(): IAutoSort
Returns the IAutoSort created using insertSort.

Returns IAutoSort
The current sort or null if there is no sort.

Implementation of ISheet.getSort

getStrings

getStrings(): IStringCollection
Returns the current shared resources.

Returns IStringCollection
Implementation of ISheet.getStrings

getStyles

getStyles(): IStyleCollection
Returns IStyleCollection associated with this sheet.

Returns IStyleCollection
Implementation of ISheet.getStyles

getTabColor

getTabColor(): IColor
Return a custom color or null if no custom color has been set.

Returns IColor
Implementation of ISheet.getTabColor

getTables

getTables(): ITableCollection
Returns a collection of tables that are embedded in this sheet.

Returns ITableCollection
Implementation of ISheet.getTables

getTransactions

getTransactions(): IStore
Returns the current shared resources.

Returns IStore
Implementation of ISheet.getTransactions

getUsedRange

getUsedRange(options?: GetRangeOptions): ICellRange
Returns the smallest range within the sheet that contains any used cells.
Parameters
- Optionaloptions: GetRangeOptions
Returns ICellRange
Implementation of ISheet.getUsedRange

getView

getView(): ISheetView
Returns the current view settings View settings determine how the sheet is displayed and interacted with (e.g., frozen panes, zoom level, selection) but do not affect the underlying data itself.

Returns ISheetView
The ISheetView object representing the current view settings.

Implementation of ISheet.getView

getVisibility

getVisibility(): Visibility
Returns the visibility of the sheet.

Returns Visibility
Implementation of ISheet.getVisibility

insertFilter

insertFilter(address?: ICellRange.Address): IAutoFilter
Enable and return an IAutoFilter.
Parameters
- Optionaladdress: ICellRange.Address
Returns IAutoFilter
Remarks
Only one IAutoFilter is allowed so this will return the same instance if it has already been created.

Implementation of ISheet.insertFilter

insertSort

insertSort(address?: ICellRange.Address): IAutoSort
Enable and return an IAutoSort.
Parameters
- Optionaladdress: ICellRange.Address
Returns IAutoSort
Remarks
Only one IAutoFilter is supported so this will return the same instance if it has already been created.

Implementation of ISheet.insertSort

isClosed

isClosed(): boolean
Returns true if the sheet has been closed.

Returns boolean
Implementation of ISheet.isClosed

isDate1904

isDate1904(): boolean
Indicates if the sheet is using 1904 dates.

Returns boolean
Remarks
This can not be set on the ISheet. This is managed by the sheet's container.

Implementation of ISheet.isDate1904

scrollTo

scrollTo(
coords: Partial<IRange.Coords>,
options?: ScrollToOptions,
): Promise<boolean>
Attempt to scroll the range into view.
Parameters
- coords: Partial<IRange.Coords>
  The partial coords to scroll to.
- Optionaloptions: ScrollToOptions
  ISheet.ScrollToOptions.
Returns Promise<boolean>
Implementation of ISheet.scrollTo

select

select(options: ITypes.SelectOptions): Promise<ISheet>
Select the ISheet.
Parameters
- options: ITypes.SelectOptions
Returns Promise<ISheet>
Implementation of ISheet.select

setName

setName(name: string): ISheet
Set the display name for the sheet.
Parameters
- name: string
Returns ISheet
Implementation of ISheet.setName

setPosition

setPosition(index: number): ISheet
Reorders the ISheet with in the container. This is generally the tab order within an IWorkbook but may be the zIndex if the ISheets are movable. This only affects visual listings of the sheets (but selection doesn't change).
Parameters
- index: number
Returns ISheet
Remarks
This is zero-based.

Implementation of ISheet.setPosition

setTabColor

setTabColor(color: string | IColor): this
See the tab color for the sheet.
Parameters
- color: string | IColor
  The color
Returns this
Remarks
- If set to null the color will revert to the default.
- The tab color is not used by the sheet but rather by the workbook.
Implementation of ISheet.setTabColor

setView

setView(view: ISheetView): this
Set a specific view.
Parameters
- view: ISheetView
  The view properties.
Returns this
Implementation of ISheet.setView

setVisibility

setVisibility(visibility?: boolean | Visibility): Sheet
Change the visibility of the sheet.
Parameters
- visibility: boolean | Visibility = true
Returns Sheet
Implementation of ISheet.setVisibility

toJSON

toJSON(excludeData?: boolean): Promise<ISheet.JSON>
Returns a JSON representation of the sheet.
Parameters
- excludeData: boolean = false
  If true only meta data about the sheet will be saved.
Returns Promise<ISheet.JSON>
Implementation of ISheet.toJSON

toString

toString(): string
Returns the address as a string.

Returns string

Class Sheet

Implements

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns Sheet

Accessors

[toStringTag]

Returns string

isISheet

Returns true

Methods

_doPerfTest

Parameters

Returns void

addListeners

Parameters

Returns Remove

beginCommit

Parameters

Returns ITransaction

Remarks

close

Returns void

Remarks

createTemporaryCell

Parameters

Returns ICell

Remarks

delete

Returns void

doBatch

Type Parameters

Parameters

Returns R | Promise<R>

duplicate

Returns Promise<ISheet>

find

Parameters

Returns Iterator<ICell>

Remarks

getCalculation

Returns ICalculation

getColumnHeaders

Returns ISheetHeader

getColumnWidthAsFontUnit

Parameters

Returns number

getConditionals

Returns IConditionalFormatCollection

getEntireRange

Parameters

Returns ICellRange

getFilter

Returns IAutoFilter

getMovables

Returns IMovableCollection

getName

Returns string

getNames

Returns INamedCollection

getProtection

Returns ISheetProtection

getRange

Parameters

Returns ICellRange

getRangeAtBounds

Parameters

Returns ICellRange

getRanges

Parameters

Returns ICellRanges

getResources

Returns IResourceCollection

getRowHeaders

Returns ISheetHeader