@univerjs/sheets-thread-comment v0.5.1 • Docs

Class: FWorkbookThreadCommentMixin

FBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.

Extends

• FWorkbook

Implements

• IFWorkbookThreadCommentMixin

Constructors

new FWorkbookThreadCommentMixin()

new FWorkbookThreadCommentMixin(
   _workbook, 
   _injector, 
   _resourceLoaderService, 
   _selectionManagerService, 
   _univerInstanceService, 
   _commandService, 
   _permissionService, 
   _logService): FWorkbookThreadCommentMixin

Parameters

Returns

FWorkbookThreadCommentMixin

Inherited from

FWorkbook.constructor

Defined in

sheets/src/facade/f-workbook.ts:27

Properties

Methods

_initialize()

_initialize(): void

Returns

void

Overrides

FWorkbook._initialize

Defined in

sheets-thread-comment/src/facade/f-workbook.ts:70

create()

create(
   name, 
   rows, 
   column): FWorksheet

Create a new worksheet and returns a handle to it.

Parameters

Returns

FWorksheet

The new created sheet

Inherited from

FWorkbook.create

Defined in

sheets/src/facade/f-workbook.ts:94

deleteSheet()

deleteSheet(sheet): void

Deletes the specified worksheet.

Parameters

Returns

void

Inherited from

FWorkbook.deleteSheet

Defined in

sheets/src/facade/f-workbook.ts:189

getActiveRange()

getActiveRange(): null | FRange

Returns the selected range in the active sheet, or null if there is no active range.

Returns

null | FRange

the active range

Inherited from

FWorkbook.getActiveRange

Defined in

sheets/src/facade/f-workbook.ts:303

getActiveSheet()

getActiveSheet(): FWorksheet

Get the active sheet of the workbook.

Returns

FWorksheet

The active sheet of the workbook

Inherited from

FWorkbook.getActiveSheet

Defined in

sheets/src/facade/f-workbook.ts:72

getId()

getId(): string

Returns

string

Inherited from

FWorkbook.getId

Defined in

sheets/src/facade/f-workbook.ts:42

getName()

getName(): string

Returns

string

Inherited from

FWorkbook.getName

Defined in

sheets/src/facade/f-workbook.ts:46

getSheetByName()

getSheetByName(name): null | FWorksheet

Get a worksheet by sheet name.

Parameters

Returns

null | FWorksheet

The worksheet with given sheet name

Inherited from

FWorkbook.getSheetByName

Defined in

sheets/src/facade/f-workbook.ts:139

getSheetBySheetId()

getSheetBySheetId(sheetId): null | FWorksheet

Get a worksheet by sheet id.

Parameters

Returns

null | FWorksheet

The worksheet with given sheet id

Inherited from

FWorkbook.getSheetBySheetId

Defined in

sheets/src/facade/f-workbook.ts:125

getSheets()

getSheets(): FWorksheet[]

Gets all the worksheets in this workbook

Returns

FWorksheet[]

An array of all the worksheets in the workbook

Inherited from

FWorkbook.getSheets

Defined in

sheets/src/facade/f-workbook.ts:81

getSnapshot()

getSnapshot(): IWorkbookData

Returns

IWorkbookData

{IWorkbookData}

Deprecated

use ‘save’ instead.

Memberof

FWorkbook

Inherited from

FWorkbook.getSnapshot

Defined in

sheets/src/facade/f-workbook.ts:63

insertSheet()

insertSheet(): FWorksheet

Inserts a new worksheet into the workbook. Using a default sheet name. The new sheet becomes the active sheet

Returns

FWorksheet

The new sheet

Inherited from

FWorkbook.insertSheet

Defined in

sheets/src/facade/f-workbook.ts:167

onBeforeAddThreadComment()

onBeforeAddThreadComment(callback): IDisposable

The onThreadCommentChange event is fired when the thread comment of this sheet is changed.

Parameters

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Implementation of

IFWorkbookThreadCommentMixin.onBeforeAddThreadComment

Overrides

FWorkbook.onBeforeAddThreadComment

Defined in

sheets-thread-comment/src/facade/f-workbook.ts:84

onBeforeCommandExecute()

onBeforeCommandExecute(callback): IDisposable

Register a callback that will be triggered before invoking a command targeting the Univer sheet.

Parameters

Returns

IDisposable

A function to dispose the listening.

Inherited from

FWorkbook.onBeforeCommandExecute

Defined in

sheets/src/facade/f-workbook.ts:215

onBeforeDeleteThreadComment()

onBeforeDeleteThreadComment(callback): IDisposable

The onBeforeDeleteThreadComment event is fired before the thread comment is deleted.

Parameters

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Implementation of

IFWorkbookThreadCommentMixin.onBeforeDeleteThreadComment

Overrides

FWorkbook.onBeforeDeleteThreadComment

Defined in

sheets-thread-comment/src/facade/f-workbook.ts:112

onBeforeUpdateThreadComment()

onBeforeUpdateThreadComment(callback): IDisposable

The onBeforeUpdateThreadComment event is fired before the thread comment is updated.

Parameters

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Implementation of

IFWorkbookThreadCommentMixin.onBeforeUpdateThreadComment

Overrides

FWorkbook.onBeforeUpdateThreadComment

Defined in

sheets-thread-comment/src/facade/f-workbook.ts:98

onCommandExecuted()

onCommandExecuted(callback): IDisposable

Register a callback that will be triggered when a command is invoked targeting the Univer sheet.

Parameters

Returns

IDisposable

A function to dispose the listening.

Inherited from

FWorkbook.onCommandExecuted

Defined in

sheets/src/facade/f-workbook.ts:230

onSelectionChange()

onSelectionChange(callback): IDisposable

Parameters

Returns

IDisposable

Inherited from

FWorkbook.onSelectionChange

Defined in

sheets/src/facade/f-workbook.ts:240

onThreadCommentChange()

onThreadCommentChange(callback): IDisposable

The onThreadCommentChange event is fired when the thread comment of this sheet is changed.

Parameters

Returns

IDisposable

A disposable object that can be used to unsubscribe from the event

Implementation of

IFWorkbookThreadCommentMixin.onThreadCommentChange

Overrides

FWorkbook.onThreadCommentChange

Defined in

sheets-thread-comment/src/facade/f-workbook.ts:78

redo()

redo(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

FWorkbook.redo

Defined in

sheets/src/facade/f-workbook.ts:205

save()

save(): IWorkbookData

save workbook snapshot data, including conditional formatting, data validation, and other plugin data.

Returns

IWorkbookData

Inherited from

FWorkbook.save

Defined in

sheets/src/facade/f-workbook.ts:53

setActiveRange()

setActiveRange(range): void

Sets the active selection region for this sheet.

Parameters

Returns

void

Inherited from

FWorkbook.setActiveRange

Defined in

sheets/src/facade/f-workbook.ts:274

setActiveSheet()

setActiveSheet(sheet): FWorksheet

Sets the given worksheet to be the active worksheet in the workbook.

Parameters

Returns

FWorksheet

The active worksheet

Inherited from

FWorkbook.setActiveSheet

Defined in

sheets/src/facade/f-workbook.ts:153

setEditable()

setEditable(value): void

Used to modify the editing permissions of the workbook. When the value is false, editing is not allowed.

Parameters

Returns

void

Inherited from

FWorkbook.setEditable

Defined in

sheets/src/facade/f-workbook.ts:261

undo()

undo(): Promise<boolean>

Returns

Promise<boolean>

Inherited from

FWorkbook.undo

Defined in

sheets/src/facade/f-workbook.ts:200

extend()

static extend(source): void

Parameters

Returns

void

Inherited from

FWorkbook.extend

Defined in

core/src/facade/f-base.ts:35