@hailin-zheng/editor-core 1.0.10 → 1.0.14

package/lib/texteditor.d.ts

@@ -0,0 +1,318 @@
+import { ContentMenuItem } from './framework/element-event-define';
+import { ElementReader } from './framework/element-reader';
+import { Subject } from 'rxjs';
+import { SelectionState } from './framework/document-selection';
+import { BranchElement, Element, ICancelTokenFn, LeafElement, MarginProps, OrientType, Position, TextAlign, ViewOptions } from './framework/element-define';
+import { DataElementInlineGroup, DataElementLeaf } from './framework/impl/data-element/data-element-base-impl';
+import { ParagraphProps, TextProps } from './framework/element-props';
+import { EditorContext } from './framework/document-context';
+import { DocumentElement } from './framework/impl/document/doc-impl';
+export declare class CanvasTextEditor {
+    private docScroll;
+    private holdSpace;
+    private ruleCanvas;
+    private editCanvasContainer;
+    private editCanvas;
+    private editInput;
+    private editCursor;
+    private cursorWrapper;
+    private scaleContainer;
+    private contentCtx;
+    viewOptions: ViewOptions;
+    docCtx: EditorContext;
+    private docComment;
+    private renderContext;
+    private documentPaint;
+    elementReader: ElementReader;
+    private documentEvent;
+    private documentSelection;
+    private documentInput;
+    private documentChange;
+    private selectionOverlays;
+    private docRule;
+    private docHistory;
+    private eventMap;
+    selectionChanged: Subject<SelectionState>;
+    beforeRenderSubject: Subject<void>;
+    afterRenderSubject: Subject<void>;
+    selectionState: SelectionState;
+    onContextMenuItemChanged: Subject<EditorContenxtProps>;
+    onShowDataElementEditPanelEvent: Subject<EditorPanelProps>;
+    onDblClickEvent: Subject<Event>;
+    onClickEvent: Subject<Event>;
+    onScrollViewEvent: Subject<number>;
+    onDocChangedEvent: Subject<void>;
+    constructor(docScroll: HTMLDivElement, holdSpace: HTMLDivElement, ruleCanvas: HTMLCanvasElement, editCanvasContainer: HTMLDivElement, editCanvas: HTMLCanvasElement, editInput: HTMLInputElement, editCursor: HTMLSpanElement, cursorWrapper: HTMLDivElement, scaleContainer: HTMLDivElement);
+    /**
+     * 设置标尺
+     */
+    refreshDocRule(): void;
+    createDocViewer(): void;
+    measureMMToPixs(): number;
+    flushTask: (() => void) | null;
+    flushTaskThen: Array<(() => void)>;
+    private trackChangeState;
+    flushToSchedule(): void;
+    /**
+     * 触发文档改变事件
+     * @returns
+     */
+    triggerDocChange(): void;
+    /**
+     * fn函数执行时，不触发onDocChange
+     * @param fn
+     */
+    noEffectChange(fn: () => void): void;
+    loadDoc(data: any | DocumentElement): void;
+    /**
+     * 更新文档容器高度尺寸
+     */
+    updateDocumentContainerSize(): void;
+    scrollView(evt: Event): void;
+    private refreshDocument;
+    private hitInfoChanged;
+    /**
+     * 设置光标
+     */
+    private setCursor;
+    /**
+     * 判断是否光标可以设置接受编辑
+     * @returns
+     */
+    private canSetCursor;
+    /**
+     * 修改光标
+     * @param newCursor
+     */
+    private changeCursor;
+    /**
+     * 文档点击事件
+     */
+    private docClickHandle;
+    /**
+     * 文档双击事件
+     * 处理全选当前段落
+     */
+    private docDblClickHandle;
+    /**
+     * 获取当前光标所在的数据元
+     * @returns
+     */
+    getCurrentDataElement(): DataElementInlineGroup | DataElementLeaf | null;
+    /**
+     * 设置当前光标所在的数据元的值
+     * @param val
+     */
+    setCurrentDataElementValue(val: any): void;
+    /**
+     * 获取数据元位置
+     * @param element
+     * @returns
+     */
+    getDataElementPosition(element: LeafElement): {
+        x: number;
+        y: number;
+        translateY: number;
+    };
+    /**
+     * 获取文档模型
+     * @returns
+     */
+    getDocSchema(): any;
+    getDocSchemaJSON(): string;
+    /**
+     * 右键菜单
+     * @param evt
+     */
+    onContextMenu(evt: MouseEvent): void;
+    resizeObserver: ResizeObserver | null;
+    listenContainerHeight(): void;
+    private updateDocHeight;
+    resetViewer(type?: 'demand' | 'force' | undefined): void;
+    /**
+     * 缩放视图
+     * @param scale
+     * @returns
+     */
+    scaleView(scale: number): number;
+    getContainerHeight(): {
+        height: number;
+        width: number;
+    };
+    setCanvasProps(): void;
+    /**
+     * 在当前位置插入表格
+     * @param row
+     * @param col
+     */
+    insertTable(rows: number, cols: number): void;
+    /**
+     * 打印所有文档
+     */
+    printAllPages(): void;
+    /**
+     * 导出所有页到base64
+     */
+    exportAllPagesToBase64(fileName: string): void;
+    exportPDF(): void;
+    /**
+     * 清除文档
+     */
+    clearDoc(): void;
+    /**
+     * 新建文档
+     * @param options
+     */
+    createNewDoc(doc?: DocumentElement | null): void;
+    destroy(): void;
+    /**
+     * 获取选区文本属性
+     * @returns
+     */
+    getSelectionTextGroupProps(): TextProps | null;
+    getSelectionParaProps(): ParagraphProps | null;
+    /**
+     * 设置文本字体大小
+     * @param fontSize
+     * @returns
+     */
+    setTextFontSize(fontSize: number): void;
+    /**
+     * 设置文本颜色
+     * @param color \
+     */
+    setTextColor(color: string): void;
+    /**
+     * 设置文本字体名称
+     * @param font
+     */
+    setTextFont(font: string): void;
+    /**
+     * 应用选中文本格式,用于批量设置格式,例如：格式刷
+     * @param newStyle
+     */
+    applyStyle(newStyle: TextProps): void;
+    /**
+     * 开启格式刷
+     */
+    enableFormatBrush(): ICancelTokenFn | null;
+    /**
+     * 设置文本背景颜色
+     * @param color
+     */
+    setTextBackColor(color: string): void;
+    /**
+     * 切换文本加粗、下划线、删除等文本样式
+     * @param isEffective
+     * @param style
+     * @param matchValue
+     */
+    switchTextStyle<P extends keyof TextProps, V extends TextProps[P]>(isEffective: boolean, style: P, matchValue: V, defaultValue?: any): void;
+    /**
+     * 修改字间距
+     */
+    setLetterSpace(letterSpace: number): void;
+    /**
+     * 设置段落对齐
+     * @param align
+     */
+    switchParaAlign(align: TextAlign): void;
+    combineCell(): void;
+    /**
+     * 切换当前段落项目符号状态
+     */
+    setParagraphNumberType(): void;
+    /**
+     * 删除当前批注
+     * @param id
+     */
+    removeComment(id: string): void;
+    /**
+     * 移除焦点所在的批注
+     */
+    removeCurrentComment(): void;
+    /**
+     * 插入批注
+     */
+    insertComment(): void;
+    /**
+     * 清除所有批注
+     */
+    clearAllComments(): void;
+    cutTable(): void;
+    /**
+     * 初始化当前文档创建用户信息
+     * 一份文档只需要设置一次
+     */
+    initCurrentDocUser(userId: string, userName: string, date: string): void;
+    /**
+     * 验证文档内容
+     * @returns
+     */
+    validate(): boolean;
+    /**
+     * 撤销
+     */
+    undo(): void;
+    /**
+     * 恢复
+     */
+    redo(): void;
+    /**
+     * 是否可以撤销
+     */
+    canUndo(): boolean;
+    /**
+     * 是否可以恢复
+     */
+    canRedo(): boolean;
+    switchTrackChanges(eleCtx?: BranchElement | null): void;
+    get trackTipsChanged(): Subject<{
+        pos: Position;
+        tips: import("./framework/element-event-define").ITrackTips;
+    }>;
+    switchFullViewPage(): void;
+    getSelectedJSON(): string;
+    getSelectedText(): string;
+    /**
+     * 设置纸张方向
+     * @param orientation
+     */
+    setPaperOrient(orientation: OrientType): void;
+    /**
+     * 设置纸张大小,单位为毫米(mm)
+     * @param width
+     * @param height
+     */
+    setPaperSize(width: number, height: number): void;
+    /**
+     * 插入强制换页符
+     */
+    insertPageBreakPara(): void;
+    /**
+     * 显示当前元素到视图中
+     * @param element
+     */
+    bringToView(element: Element): void;
+    /**
+     * 设置当前文档页边距
+     */
+    setDocumentMargin(pageMargin: Partial<MarginProps>): void;
+    /**
+     * 插入元素
+     * @param targetElement
+     * @param targetOffset
+     * @param destEleArray
+     * @returns
+     */
+    insertElement(targetElement: Element, targetOffset: number, destEleArray: Array<Element>): Element | null;
+}
+export declare type EditorCurrentPos = {
+    pos: Position;
+};
+export declare type EditorContenxtProps = {
+    menus: Array<ContentMenuItem>;
+} & EditorCurrentPos;
+export declare type EditorPanelProps = {
+    type: string;
+} & EditorCurrentPos;