API Reference
@univerjs
@univerjs/sheets-ui
classes
Editorbridgeservice

@univerjs/sheets-ui v0.4.2Docs


Class: EditorBridgeService

Extends

Implements

Constructors

new EditorBridgeService()

new EditorBridgeService(
   _renderManagerService, 
   _themeService, 
   _univerInstanceService, 
   _editorService, 
   _refSelectionsService, 
   _contextService): EditorBridgeService

Parameters

ParameterType
_renderManagerServiceIRenderManagerService
_themeServiceThemeService
_univerInstanceServiceIUniverInstanceService
_editorServiceIEditorService
_refSelectionsServiceSheetsSelectionsService
_contextServiceIContextService

Returns

EditorBridgeService

Overrides

Disposable.constructor

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:166 (opens in a new tab)

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedpackages/core/src/shared/lifecycle.ts:93 (opens in a new tab)
afterVisible$readonlyObservable<IEditorBridgeServiceVisibleParam>undefined-packages/sheets-ui/src/services/editor-bridge.service.ts:158 (opens in a new tab)
currentEditCell$readonlyObservable<null | { canvasOffset: { left: number; top: number; }; column: number; documentLayoutObject: IDocumentLayoutObject; editorUnitId: string; isInArrayFormulaRange: Nullable<boolean>; position: IPosition; row: number; scaleX: number; scaleY: number; sheetId: string; unitId: string; }>undefined-packages/sheets-ui/src/services/editor-bridge.service.ts:150 (opens in a new tab)
currentEditCellLayout$readonlyObservable<Nullable<ICellEditorLayout>>undefined-packages/sheets-ui/src/services/editor-bridge.service.ts:148 (opens in a new tab)
currentEditCellState$readonlyObservable<Nullable<ICellEditorState>>undefined-packages/sheets-ui/src/services/editor-bridge.service.ts:145 (opens in a new tab)
interceptorreadonlyInterceptorManager<{ AFTER_CELL_EDIT: IInterceptor<ICellDataForSheetInterceptor, ISheetLocationForEditor>; AFTER_CELL_EDIT_ASYNC: IInterceptor<Promise<Nullable<ICellDataForSheetInterceptor>>, ISheetLocationForEditor>; BEFORE_CELL_EDIT: IInterceptor<ICellDataForSheetInterceptor, ISheetLocationForEditor>; }>undefined-packages/sheets-ui/src/services/editor-bridge.service.ts:160 (opens in a new tab)
visible$readonlyObservable<IEditorBridgeServiceVisibleParam>undefined-packages/sheets-ui/src/services/editor-bridge.service.ts:155 (opens in a new tab)

Methods

beforeSetRangeValue()

beforeSetRangeValue(
   workbook, 
   worksheet, 
   row, 
   column, 
cellData): Promise<Nullable<ICellDataForSheetInterceptor>>

Parameters

ParameterType
workbookWorkbook
worksheetWorksheet
rownumber
columnnumber
cellDataICellData

Returns

Promise<Nullable<ICellDataForSheetInterceptor>>

Implementation of

IEditorBridgeService.beforeSetRangeValue

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:501 (opens in a new tab)


changeEditorDirty()

changeEditorDirty(dirtyStatus): void

Parameters

ParameterType
dirtyStatusboolean

Returns

void

Implementation of

IEditorBridgeService.changeEditorDirty

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:493 (opens in a new tab)


changeVisible()

changeVisible(param): void

Parameters

ParameterType
paramIEditorBridgeServiceVisibleParam

Returns

void

Implementation of

IEditorBridgeService.changeVisible

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:456 (opens in a new tab)


disableForceKeepVisible()

disableForceKeepVisible(): void

Returns

void

Implementation of

IEditorBridgeService.disableForceKeepVisible

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:485 (opens in a new tab)


dispose()

dispose(): void

Returns

void

Implementation of

IDisposable.dispose

Inherited from

Disposable.dispose

Defined in

packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)


disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe

Defined in

packages/core/src/shared/lifecycle.ts:96 (opens in a new tab)


enableForceKeepVisible()

enableForceKeepVisible(): void

Returns

void

Implementation of

IEditorBridgeService.enableForceKeepVisible

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:481 (opens in a new tab)


ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)


getCurrentEditorId()

getCurrentEditorId(): string

Returns

string

Implementation of

IEditorBridgeService.getCurrentEditorId

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:452 (opens in a new tab)


getEditCellLayout()

getEditCellLayout(): Readonly<Nullable<ICellEditorLayout>>

Returns

Readonly<Nullable<ICellEditorLayout>>

Implementation of

IEditorBridgeService.getEditCellLayout

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:325 (opens in a new tab)


getEditCellState()

getEditCellState(): Readonly<Nullable<IEditorBridgeServiceParam>>

Returns

Readonly<Nullable<IEditorBridgeServiceParam>>

Implementation of

IEditorBridgeService.getEditCellState

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:317 (opens in a new tab)


getEditLocation()

getEditLocation(): Readonly<Nullable<ICellEditorState>>

Returns

Readonly<Nullable<ICellEditorState>>

Implementation of

IEditorBridgeService.getEditLocation

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:329 (opens in a new tab)


getEditorDirty()

getEditorDirty(): boolean

Returns

boolean

Implementation of

IEditorBridgeService.getEditorDirty

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:497 (opens in a new tab)


getLatestEditCellState()

getLatestEditCellState(): undefined | {
  canvasOffset: {
     left: 0;
     top: 0;
    };
  column: startColumn;
  documentLayoutObject: IDocumentLayoutObject;
  editorUnitId: string;
  isInArrayFormulaRange: cell.isInArrayFormulaRange;
  position: {
     endX: number;
     endY: number;
     startX: number;
     startY: number;
    };
  row: startRow;
  scaleX: number;
  scaleY: number;
  sheetId: string;
  unitId: string;
}

Returns

undefined | { canvasOffset: { left: 0; top: 0; }; column: startColumn; documentLayoutObject: IDocumentLayoutObject; editorUnitId: string; isInArrayFormulaRange: cell.isInArrayFormulaRange; position: { endX: number; endY: number; startX: number; startY: number; }; row: startRow; scaleX: number; scaleY: number; sheetId: string; unitId: string; }

Implementation of

IEditorBridgeService.getLatestEditCellState

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:334 (opens in a new tab)


isForceKeepVisible()

isForceKeepVisible(): boolean

Returns

boolean

Implementation of

IEditorBridgeService.isForceKeepVisible

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:489 (opens in a new tab)


isVisible()

isVisible(): IEditorBridgeServiceVisibleParam

Returns

IEditorBridgeServiceVisibleParam

Implementation of

IEditorBridgeService.isVisible

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:477 (opens in a new tab)


refreshEditCellPosition()

refreshEditCellPosition(resetSizeOnly?): void

Parameters

ParameterType
resetSizeOnly?boolean

Returns

void

Implementation of

IEditorBridgeService.refreshEditCellPosition

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:219 (opens in a new tab)


refreshEditCellState()

refreshEditCellState(): void

Returns

void

Implementation of

IEditorBridgeService.refreshEditCellState

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:203 (opens in a new tab)


setEditCell()

setEditCell(param): void

Parameters

ParameterType
paramICurrentEditCellParam

Returns

void

Implementation of

IEditorBridgeService.setEditCell

Defined in

packages/sheets-ui/src/services/editor-bridge.service.ts:277 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.