@alilc/lowcode-shell/lib/model/history.d.ts

Shell Layer for AliLowCodeEngine

import type { IDocumentModel as InnerDocumentModel } from '@alilc/lowcode-designer';
import { historySymbol, documentSymbol } from '../symbols';
import { IPublicModelHistory, IPublicTypeDisposable } from '@alilc/lowcode-types';
export declare class History implements IPublicModelHistory {
    private readonly [documentSymbol];
    private get [historySymbol]();
    constructor(document: InnerDocumentModel);
    /**
     * 历史记录跳转到指定位置
     * @param cursor
     */
    go(cursor: number): void;
    /**
     * 历史记录后退
     */
    back(): void;
    /**
     * 历史记录前进
     */
    forward(): void;
    /**
     * 保存当前状态
     */
    savePoint(): void;
    /**
     * 当前是否是「保存点」，即是否有状态变更但未保存
     * @returns
     */
    isSavePoint(): boolean;
    /**
     * 获取 state，判断当前是否为「可回退」、「可前进」的状态
     * @returns
     */
    getState(): number;
    /**
     * 监听 state 变更事件
     * @param func
     * @returns
     */
    onChangeState(func: () => any): IPublicTypeDisposable;
    /**
     * 监听历史记录游标位置变更事件
     * @param func
     * @returns
     */
    onChangeCursor(func: () => any): IPublicTypeDisposable;
}