Events

本 API 页面目前提供英文正文。代码签名与标识符不随界面语言变化。

Packages @univerjs/core, @univerjs/sheets, @univerjs/sheets-ui, @univerjs/sheets-data-validation, @univerjs/sheets-drawing, @univerjs/sheets-drawing-ui, @univerjs/sheets-filter, @univerjs/sheets-hyper-link, @univerjs/sheets-note, @univerjs/sheets-sort, @univerjs/sheets-thread-comment, @univerjs-pro/bases, @univerjs-pro/collaboration-client, @univerjs-pro/shape-editor, @univerjs-pro/sheets-pivot, @univerjs-pro/sheets-print, @univerjs-pro/sheets-sparkline

Overview

@univerjs/core

Method	Description
`addEvent`	Add an event listener
`extend`	-
`fireEvent`	Fire an event, used in internal only
`get`	-
`registerEventHandler`	-
`removeEvent`	-

@univerjs-pro/sheets-pivot

Method	Description
`generatePivotTable`	-

Available Event Names

Use these values through univerAPI.Event.

TypeScript

// @univerjs/coreBeforeCommandExecuteBeforeRedoBeforeUndoCommandExecutedDocCreatedDocDisposedLifeCycleChangedRedoUndo// @univerjs/sheetsActiveSheetChangedBeforeActiveSheetChangeBeforeGridlineColorChangeBeforeGridlineEnableChangeBeforeSheetCreateBeforeSheetDeleteBeforeSheetHideChangeBeforeSheetMoveBeforeSheetNameChangeBeforeSheetTabColorChangeGridlineChangedSheetCreatedSheetDeletedSheetHideChangedSheetMovedSheetNameChangedSheetTabColorChangedSheetValueChangedWorkbookCreatedWorkbookDisposed// @univerjs/sheets-crosshair-highlightCrosshairHighlightEnabledChanged// @univerjs/sheets-data-validationBeforeSheetDataValidationAddBeforeSheetDataValidationCriteriaUpdateBeforeSheetDataValidationDeleteBeforeSheetDataValidationDeleteAllBeforeSheetDataValidationOptionsUpdateBeforeSheetDataValidationRangeUpdateSheetDataValidationChangedSheetDataValidatorStatusChanged// @univerjs/sheets-drawingBeforeFloatDomAddBeforeFloatDomDeleteBeforeFloatDomUpdateBeforeOverGridImageChangeBeforeOverGridImageInsertBeforeOverGridImageRemoveBeforeOverGridImageSelectFloatDomAddedFloatDomDeletedFloatDomUpdatedOverGridImageChangedOverGridImageInsertedOverGridImageRemovedOverGridImageSelected// @univerjs/sheets-drawing-uiBeforeFloatDomAddBeforeFloatDomDeleteBeforeFloatDomUpdateFloatDomAddedFloatDomDeletedFloatDomUpdated// @univerjs/sheets-filterSheetBeforeRangeFilterSheetBeforeRangeFilterClearSheetRangeFilterClearedSheetRangeFiltered// @univerjs/sheets-hyper-linkBeforeSheetLinkAddBeforeSheetLinkCancelBeforeSheetLinkUpdate// @univerjs/sheets-noteBeforeSheetNoteAddBeforeSheetNoteDeleteBeforeSheetNoteHideBeforeSheetNoteShowBeforeSheetNoteUpdateSheetNoteAddSheetNoteDeleteSheetNoteHideSheetNoteShowSheetNoteUpdate// @univerjs/sheets-sortSheetBeforeRangeSortSheetRangeSorted// @univerjs/sheets-thread-commentBeforeCommentAddBeforeCommentDeleteBeforeCommentResolveBeforeCommentUpdateCommentAddedCommentDeletedCommentResolvedCommentUpdated// @univerjs/sheets-uiBeforeClipboardChangeBeforeClipboardPasteBeforeSheetEditEndBeforeSheetEditStartBeforeSheetZoomChangeCellClickedCellHoverCellPointerDownCellPointerMoveCellPointerUpClipboardChangedClipboardPastedColumnHeaderClickColumnHeaderHoverColumnHeaderPointerDownColumnHeaderPointerUpDragOverDropRowHeaderClickRowHeaderHoverRowHeaderPointerDownRowHeaderPointerUpScrollSelectionChangedSelectionMoveEndSelectionMoveStartSelectionMovingSheetEditChangingSheetEditEndedSheetEditStartedSheetSkeletonChangedSheetZoomChanged// @univerjs-pro/basesBaseHierarchyChangedBaseTableCellValueChangedBaseTableCreatedBaseTableFieldCreatedBaseTableRecordCreatedBaseTableViewCreatedBeforeBaseHierarchyChangeBeforeBaseTableCellValueChangeBeforeBaseTableCreateBeforeBaseTableFieldCreateBeforeBaseTableRecordCreateBeforeBaseTableViewCreate// @univerjs-pro/collaboration-clientCollaborationStatusChanged// @univerjs-pro/shape-editorFormulaShapeResultChanged// @univerjs-pro/sheets-pivotBeforePivotTableAddPivotTableAddedPivotTableFieldAddedPivotTableFieldCollapseChangedPivotTableFieldFilterChangedPivotTableFieldMovedPivotTableFieldRemovedPivotTableFieldSettingChangedPivotTableFieldSortChangedPivotTableMovedPivotTableRemovedPivotTableRenderedPivotTableValuePositionChanged// @univerjs-pro/sheets-printBeforeSheetPrintCanceledBeforeSheetPrintConfirmBeforeSheetPrintOpenSheetPrintCanceledSheetPrintConfirmedSheetPrintOpen// @univerjs-pro/sheets-sparklineSheetSparklineChanged

APIs

Lifecycle & Creation

`addEvent`

Add an event listener

Signature

TypeScript

addEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): IDisposable

Parameters

event T — No description
callback (params: IEventParamConfig[T]) => void — when event triggered

Returns

IDisposable — The Disposable instance, for remove the listener

Examples

TypeScript

univerAPI.addEvent(univerAPI.Event.LifeCycleChanged, (params) => {  const { stage } = params;  console.log('life cycle changed', params);});

Source: @univerjs/core

Getters & Queries

`get`

Signature

TypeScript

static get(): FEventName

Returns

FEventName — See signature above.

Source: @univerjs/core

Actions & Operations

`removeEvent`

Signature

TypeScript

removeEvent<T extends keyof IEventParamConfig>(event: T, callback: (params: IEventParamConfig[T]) => void): void

Parameters

event T — No description
callback (params: IEventParamConfig[T]) => void — No description

Source: @univerjs/core

Events

`fireEvent`

Fire an event, used in internal only.

Signature

TypeScript

fireEvent<T extends keyof IEventParamConfig>(event: T, params: IEventParamConfig[T]): boolean | undefined

Parameters

event T — No description
params IEventParamConfig[T] — of event

Returns

boolean — should cancel

Examples

TypeScript

this.fireEvent(univerAPI.Event.LifeCycleChanged, params);

Source: @univerjs/core

`registerEventHandler`

Signature

TypeScript

registerEventHandler(event: string, handler: () => IDisposable | Subscription): IDisposable

Parameters

event string — No description
handler () => any — No description

Returns

IDisposable — See signature above.

Source: @univerjs/core

Miscellaneous

`extend`

Signature

TypeScript

static extend(source: any): void

Parameters

source any — No description

Source: @univerjs/core

`generatePivotTable`

Signature

TypeScript

generatePivotTable<T extends DataFieldManager>(data: IDataFieldDataArray, CustomDataFieldManager?: new (...args: unknown[]) => T): FGenericPivotTable

Parameters

data [string[], ...(IDataFieldValue & Date)[][]] — No description
CustomDataFieldManager new (...args: unknown[]) => T (optional) — No description

Returns

FGenericPivotTable — See signature above.

Source: @univerjs-pro/sheets-pivot

你觉得这篇文档如何？