@univerjs/sheets-ui/lib/types/facade/f-sheet-hooks.d.ts

Spreadsheet UI layer for Univer Sheets.

/**
 * Copyright 2023-present DreamNum Co., Ltd.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import type { ICellCustomRender, IDisposable, Nullable } from '@univerjs/core';
import type { IDragCellPosition, IEditorBridgeServiceVisibleParam, IHoverCellPosition } from '@univerjs/sheets-ui';
import { InterceptorEffectEnum } from '@univerjs/core';
import { FSheetHooks } from '@univerjs/sheets/facade';
/**
 * @ignore
 */
export interface IFSheetHooksUIMixin {
    /**
     * The onCellPointerMove event is fired when a pointer changes coordinates.
     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CellPointerMove, (params) => {})` instead
     * @param {function(Nullable<IHoverCellPosition>): void} callback - function that will be called when the event is fired
     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
     * univerAPI.getSheetHooks().onCellPointerMove((cellPos) => { console.log(cellPos)});
     * ```
     */
    onCellPointerMove(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
    /**
     * The onCellPointerOver event is fired when a pointer is moved into a cell's hit test boundaries.
     * @deprecated use `univerAPI.addEvent(univerAPI.Event.CellHover, (params) => {})` instead
     * @param {function(Nullable<IHoverCellPosition>): void} callback - function that will be called when the event is fired
     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
     * univerAPI.getSheetHooks().onCellPointerOver((cellPos) => { console.log(cellPos)});
     * ```
     */
    onCellPointerOver(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
    /**
     * The onCellDragOver event is fired when an element or text selection is being dragged into a cell's hit test boundaries.
     * @deprecated use `univerAPI.addEvent(univerAPI.Event.DragOver, (params) => {})` instead
     * @param {function (Nullable<IDragCellPosition>): void} callback Callback function that will be called when the event is fired
     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
     * univerAPI.getSheetHooks().onCellDragOver((cellPos) => { console.log(cellPos)});
     * ```
     */
    onCellDragOver(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
    /**
     * The onCellDrop event is fired when an element or text selection is being dropped on the cell.
     * @deprecated use `univerAPI.addEvent(univerAPI.Event.Drop, (params) => {})` instead
     * @param {function(Nullable<IDragCellPosition>): void} callback Callback function that will be called when the event is fired
     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
     * univerAPI.getSheetHooks().onCellDrop((cellPos) => { console.log(cellPos)});
     * ```
     */
    onCellDrop(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
    /**
     * The onCellRender event is fired when a cell is rendered.
     * @param {Nullable<ICellCustomRender[]>} customRender Custom render function
     * @param {InterceptorEffectEnum} [effect] The effect of the interceptor
     * @param {number} priority The priority of the interceptor
     * @returns {IDisposable} A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
        univerAPI.getSheetHooks().onCellRender([{
            drawWith: (ctx, info) => {
                const { row, col } = info;
                // Update to any cell location you want
                if (row === 1 && col === 2) {
                    const { primaryWithCoord } = info;
                    const { startX, startY } = primaryWithCoord;
                    ctx.fillText('Univer', startX, startY + 10);
                }
            },
        }])
     * ```
     */
    onCellRender(customRender: Nullable<ICellCustomRender[]>, effect?: InterceptorEffectEnum, priority?: number): IDisposable;
    /**
     * The onBeforeCellEdit event is fired before a cell is edited.
     * @deprecated use `univerAPI.addEvent(univerAPI.Event.BeforeSheetEditStart, (params) => {})` instead
     * @param callback Callback function that will be called when the event is fired
     * @returns A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
     * univerAPI.getSheetHooks().onBeforeCellEdit((params) => {console.log(params)})
     * ```
     */
    onBeforeCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
    /**
     * The onAfterCellEdit event is fired after a cell is edited.
     * @deprecated use `univerAPI.addEvent(univerAPI.Event.SheetEditEnded, (params) => {})` instead
     * @param callback Callback function that will be called when the event is fired
     * @returns A disposable object that can be used to unsubscribe from the event
     * @example
     * ```ts
     * univerAPI.getSheetHooks().onAfterCellEdit((params) => {console.log(params)})
     * ```
     */
    onAfterCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
}
export declare class FSheetHooksUIMixin extends FSheetHooks implements IFSheetHooksUIMixin {
    onCellPointerMove(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
    onCellPointerOver(callback: (cellPos: Nullable<IHoverCellPosition>) => void): IDisposable;
    onCellDragOver(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
    onCellDrop(callback: (cellPos: Nullable<IDragCellPosition>) => void): IDisposable;
    onCellRender(customRender: Nullable<ICellCustomRender[]>, effect?: InterceptorEffectEnum, priority?: number): IDisposable;
    onBeforeCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
    onAfterCellEdit(callback: (params: IEditorBridgeServiceVisibleParam) => void): IDisposable;
}
declare module '@univerjs/sheets/facade' {
    interface FSheetHooks extends IFSheetHooksUIMixin {
    }
}