ht-emr 0.6.2 → 0.6.3

package/dist/src/editor/core/draw/Draw.d.ts

@@ -48,171 +48,693 @@ import { Graffiti } from './graffiti/Graffiti';
 import { IPositionContext } from '../../interface/Position';
 import { IControl } from '../../interface/Control';
 import { Command } from '../command/Command';
+/**
+ * 核心渲染引擎类
+ *
+ * Draw是编辑器的核心类，负责：
+ * - Canvas渲染管理（页面、行、元素的绘制）
+ * - 子系统协调（光标、选区、历史管理等）
+ * - 元素数据管理（增删改查）
+ * - 事件处理和分发
+ *
+ * 该类持有所有主要子系统的引用，并提供统一的渲染入口。
+ */
 export declare class Draw {
+    /** 编辑器容器元素 */
     private container;
+    /** 页面容器元素 */
     private pageContainer;
+    /** Canvas页面列表 */
     private pageList;
+    /** Canvas 2D渲染上下文列表 */
     private ctxList;
+    /** 当前页码（从0开始） */
     private pageNo;
+    /** 渲染计数器 */
     private renderCount;
+    /** 页面像素比（用于高清屏适配） */
     private pagePixelRatio;
+    /** 编辑器模式 */
     private mode;
+    /** 编辑器配置选项 */
     private options;
+    /** 位置管理器 */
     private position;
+    /** 区域管理器 */
     private zone;
+    /** 当前元素列表 */
     private elementList;
+    /** 事件监听器 */
     private listener;
+    /** 事件总线 */
     private eventBus;
+    /** 覆盖器（用于自定义行为） */
     private override;
+    /** 国际化管理器 */
     private i18n;
+    /** Canvas事件处理器 */
     private canvasEvent;
+    /** 全局事件处理器 */
     private globalEvent;
+    /** 光标管理器 */
     private cursor;
+    /** 选区管理器 */
     private range;
+    /** 页边距渲染器 */
     private margin;
+    /** 背景渲染器 */
     private background;
+    /** 徽章渲染器 */
     private badge;
+    /** 搜索管理器 */
     private search;
+    /** 分组管理器 */
     private group;
+    /** 区域选择器 */
     private area;
+    /** 下划线渲染器 */
     private underline;
+    /** 删除线渲染器 */
     private strikeout;
+    /** 高亮渲染器 */
     private highlight;
+    /** 历史管理器（撤销/重做） */
     private historyManager;
+    /** 预览器 */
     private previewer;
+    /** 图片粒子渲染器 */
     private imageParticle;
+    /** LaTeX公式渲染器 */
     private laTexParticle;
+    /** 文本粒子渲染器 */
     private textParticle;
+    /** 表格粒子渲染器 */
     private tableParticle;
+    /** 表格工具 */
     private tableTool;
+    /** 表格操作器 */
     private tableOperate;
+    /** 页码渲染器 */
     private pageNumber;
+    /** 行号渲染器 */
     private lineNumber;
+    /** 水印渲染器 */
     private waterMark;
+    /** 占位符渲染器 */
     private placeholder;
+    /** 页眉渲染器 */
     private header;
+    /** 页脚渲染器 */
     private footer;
+    /** 超链接粒子渲染器 */
     private hyperlinkParticle;
+    /** 标签粒子渲染器 */
     private labelParticle;
+    /** 宏粒子渲染器 */
     private macroParticle;
+    /** 日期粒子渲染器 */
     private dateParticle;
+    /** 分隔符粒子渲染器 */
     private separatorParticle;
+    /** 分页符粒子渲染器 */
     private pageBreakParticle;
+    /** 上标粒子渲染器 */
     private superscriptParticle;
+    /** 下标粒子渲染器 */
     private subscriptParticle;
+    /** 复选框粒子渲染器 */
     private checkboxParticle;
+    /** 单选框粒子渲染器 */
     private radioParticle;
+    /** 月经史粒子渲染器 */
     private menstrualHistoryParticle;
+    /** 胎心位置粒子渲染器 */
     private fetalHeartPositionParticle;
+    /** 牙位粒子渲染器 */
     private toothPositionParticle;
+    /** 块级元素渲染器 */
     private blockParticle;
+    /** 列表粒子渲染器 */
     private listParticle;
+    /** 换行符粒子渲染器 */
     private lineBreakParticle;
+    /** 空白字符粒子渲染器 */
     private whiteSpaceParticle;
+    /** 控件管理器 */
     private control;
+    /** 页面边框渲染器 */
     private pageBorder;
+    /** Web Worker管理器 */
     private workerManager;
+    /** 滚动观察器 */
     private scrollObserver;
+    /** 选区观察器 */
     private selectionObserver;
+    /** 图片观察器 */
     private imageObserver;
+    /** 涂鸦管理器 */
     private graffiti;
+    /** 命令实例 */
     private command;
+    /** 交互是否暂停 */
     private interactionPaused;
+    /** 覆盖层激活计数 */
     private overlayActiveCount;
+    /** 全局快捷键是否暂停 */
     private globalShortcutSuspended;
+    /** 字母正则表达式 */
     private LETTER_REG;
+    /** 单词正则表达式 */
     private WORD_LIKE_REG;
+    /** 行列表 */
     private rowList;
+    /** 按页分组的行列表 */
     private pageRowList;
+    /** 格式刷样式 */
     private painterStyle;
+    /** 格式刷选项 */
     private painterOptions;
+    /** 可见页码列表 */
     private visiblePageNoList;
+    /** 交叉观察的页码 */
     private intersectionPageNo;
+    /** 懒渲染交叉观察器 */
     private lazyRenderIntersectionObserver;
+    /** 打印模式数据 */
     private printModeData;
+    /** 拆分单元格值缓存 */
     private splitTdValueMap;
+    /** 单元格映射 */
     private tdMap;
+    /**
+     * 创建Draw实例
+     *
+     * @param rootContainer - 根容器元素
+     * @param options - 编辑器配置选项
+     * @param data - 编辑器数据（包含header、main、footer）
+     * @param listener - 事件监听器
+     * @param eventBus - 事件总线
+     * @param override - 覆盖器
+     */
     constructor(rootContainer: HTMLElement, options: DeepRequired<IEditorOption>, data: IEditorData, listener: Listener, eventBus: EventBus<EventBusMap>, override: Override);
+    /**
+     * 设置打印数据
+     *
+     * 在打印模式下，保存原始数据并进行过滤处理：
+     * - 过滤控件辅助元素
+     * - 移除被删除的文字
+     */
     setPrintData(): void;
+    /**
+     * 递归移除被删除的文字
+     *
+     * 深度遍历对象，过滤掉strikeout为true的元素。
+     *
+     * @param obj - 要处理的对象
+     * @returns 处理后的对象
+     */
     removeStrikeout<T>(obj: T): T;
+    /**
+     * 清除打印数据
+     *
+     * 还原打印前保存的原始数据。
+     */
     clearPrintData(): void;
+    private pushLogicTemplateFieldValue;
+    private collectControlFieldValues;
+    private collectMacroFieldValues;
+    private collectLogicTemplateFieldValueMaps;
+    private getLogicTemplateHiddenState;
+    private updateLogicTemplateVisibility;
+    /**
+     * 获取字母正则表达式
+     * @returns 字母匹配的正则表达式
+     */
     getLetterReg(): RegExp;
+    /**
+     * 获取当前编辑器模式
+     * @returns 当前编辑器模式
+     */
     getMode(): EditorMode;
+    /**
+     * 设置编辑器模式
+     *
+     * 切换编辑器模式时会自动处理：
+     * - 控件元素的显示/隐藏
+     * - 前后缀的显示状态
+     * - 打印数据的设置/清除
+     *
+     * @param payload - 目标编辑器模式
+     */
     setMode(payload: EditorMode): void;
+    /**
+     * 隐藏/显示TextField中的空白字符
+     *
+     * 在表单模式下隐藏纯空白字符，编辑模式下显示。
+     *
+     * @param elementList - 元素列表
+     * @param hide - 是否隐藏空白字符
+     * @private
+     */
     private hideTextFieldWhitespace;
+    /**
+     * 更新TextField占位符和前后缀的可见性
+     *
+     * 根据控件是否有值和当前模式，控制placeholder、prefix、postfix的显示状态。
+     *
+     * @param elementList - 元素列表
+     * @param showPlaceholder - 是否显示placeholder
+     * @param hidePrefixPostfix - 是否隐藏前后缀（有值时）
+     * @private
+     */
     private updateTextFieldPlaceholderVisibility;
     isReadonly(): boolean;
     isDisabled(): boolean;
+    /**
+     * 判断是否为设计模式
+     * @returns 如果是设计模式则返回true
+     */
     isDesignMode(): boolean;
+    /**
+     * 判断是否为打印模式
+     * @returns 如果是打印模式则返回true
+     */
     isPrintMode(): boolean;
+    /**
+     * 判断是否为涂鸦模式
+     * @returns 如果是涂鸦模式则返回true
+     */
     isGraffitiMode(): boolean;
+    /**
+     * 获取原始纸张宽度（未缩放）
+     * @returns 原始宽度值
+     */
     getOriginalWidth(): number;
+    /**
+     * 获取原始纸张高度（未缩放）
+     * @returns 原始高度值
+     */
     getOriginalHeight(): number;
+    /**
+     * 获取缩放后的页面宽度
+     * @returns 缩放后的宽度值
+     */
     getWidth(): number;
+    /**
+     * 获取缩放后的页面高度
+     * @returns 缩放后的高度值
+     */
     getHeight(): number;
+    /**
+     * 获取主内容区域高度
+     *
+     * 主内容区域高度 = 页面高度 - 页眉页脚额外高度 - 页边距
+     *
+     * @returns 主内容区域高度
+     */
     getMainHeight(): number;
+    /**
+     * 获取主内容区域外部高度
+     *
+     * 包括上下页边距和页眉页脚的额外高度。
+     *
+     * @returns 外部高度值
+     */
     getMainOuterHeight(): number;
+    /**
+     * 获取Canvas宽度
+     * @param pageNo - 页码，-1表示当前页
+     * @returns Canvas宽度
+     */
     getCanvasWidth(pageNo?: number): number;
+    /**
+     * 获取Canvas高度
+     * @param pageNo - 页码，-1表示当前页
+     * @returns Canvas高度
+     */
     getCanvasHeight(pageNo?: number): number;
+    /**
+     * 获取内容区域宽度（减去左右页边距）
+     * @returns 内容区域宽度
+     */
     getInnerWidth(): number;
+    /**
+     * 获取原始内容区域宽度（未缩放）
+     * @returns 原始内容区域宽度
+     */
     getOriginalInnerWidth(): number;
+    /**
+     * 获取上下文内容宽度
+     *
+     * 根据当前位置上下文返回宽度：
+     * - 表格内：返回单元格宽度减去内边距
+     * - 非表格：返回原始内容区域宽度
+     *
+     * @returns 上下文内容宽度
+     */
     getContextInnerWidth(): number;
+    /**
+     * 获取缩放后的页边距
+     * @returns 页边距数组 [上, 右, 下, 左]
+     */
     getMargins(): IMargin;
+    /**
+     * 获取原始页边距（未缩放）
+     * @returns 原始页边距数组 [上, 右, 下, 左]
+     */
     getOriginalMargins(): number[];
+    /**
+     * 获取页面间距
+     * @returns 缩放后的页面间距
+     */
     getPageGap(): number;
+    /**
+     * 获取原始页面间距（未缩放）
+     * @returns 原始页面间距
+     */
     getOriginalPageGap(): number;
+    /**
+     * 获取页码底部距离
+     * @returns 缩放后的页码底部距离
+     */
     getPageNumberBottom(): number;
+    /**
+     * 获取页边距指示器大小
+     * @returns 缩放后的指示器大小
+     */
     getMarginIndicatorSize(): number;
+    /**
+     * 获取默认基础行边距高度
+     * @returns 缩放后的基础行边距高度
+     */
     getDefaultBasicRowMarginHeight(): number;
+    /**
+     * 获取高亮边距高度
+     * @returns 缩放后的高亮边距高度
+     */
     getHighlightMarginHeight(): number;
+    /**
+     * 获取表格单元格内边距
+     * @param tableElement - 表格元素，可选
+     * @returns 单元格内边距 [上, 右, 下, 左]
+     */
     getTdPadding(tableElement?: IElement): IPadding;
+    /**
+     * 获取编辑器容器元素
+     * @returns 容器元素
+     */
     getContainer(): HTMLDivElement;
+    /**
+     * 获取页面容器元素
+     * @returns 页面容器元素
+     */
     getPageContainer(): HTMLDivElement;
+    /**
+     * 获取事件目标元素
+     * @param target - 事件目标
+     * @returns Element元素或null
+     */
     getEventTarget(target: EventTarget | null): Element | null;
+    /**
+     * 判断目标是否在编辑器内部
+     * @param target - 事件目标
+     * @returns 如果在编辑器内部则返回true
+     */
     isTargetInsideEditor(target: EventTarget | null): boolean;
+    /**
+     * 判断目标是否在外部覆盖层内
+     * @param target - 事件目标
+     * @returns 如果在外部覆盖层内则返回true
+     */
     isTargetInsideExternalOverlay(target: EventTarget | null): boolean;
+    /**
+     * 暂停交互
+     *
+     * 暂停用户交互，失焦代理输入框，重置副作用。
+     */
     pauseInteraction(): void;
+    /**
+     * 恢复交互
+     *
+     * 恢复用户交互功能。
+     */
     resumeInteraction(): void;
+    /**
+     * 设置覆盖层激活状态
+     *
+     * 当外部覆盖层（如模态框）激活时调用。
+     *
+     * @param payload - 是否激活
+     */
     setOverlayActive(payload: boolean): void;
+    /**
+     * 暂停/恢复全局快捷键
+     * @param payload - true暂停，false恢复
+     */
     suspendGlobalShortcut(payload: boolean): void;
+    /**
+     * 判断交互是否已暂停
+     * @returns 如果交互已暂停则返回true
+     */
     isInteractionSuspended(): boolean;
+    /**
+     * 判断全局快捷键是否激活
+     * @returns 如果全局快捷键激活则返回true
+     */
     isGlobalShortcutActive(): boolean;
+    /**
+     * 获取可见页码列表
+     * @returns 可见页码数组
+     */
     getVisiblePageNoList(): number[];
+    /**
+     * 设置可见页码列表
+     *
+     * 当滚动导致可见页面变化时调用，触发相应事件。
+     *
+     * @param payload - 新的可见页码数组
+     */
     setVisiblePageNoList(payload: number[]): void;
+    /**
+     * 获取交叉观察页码
+     * @returns 当前交叉观察的页码
+     */
     getIntersectionPageNo(): number;
+    /**
+     * 设置交叉观察页码
+     *
+     * 当页面与视口交叉时调用，触发相应事件。
+     *
+     * @param payload - 交叉的页码
+     */
     setIntersectionPageNo(payload: number): void;
+    /**
+     * 获取当前页码
+     * @returns 当前页码（从0开始）
+     */
     getPageNo(): number;
+    /**
+     * 设置当前页码
+     * @param payload - 新的页码
+     */
     setPageNo(payload: number): void;
+    /**
+     * 获取渲染次数
+     * @returns 渲染次数计数
+     */
     getRenderCount(): number;
+    /**
+     * 获取Canvas页面元素
+     * @param pageNo - 页码，-1表示当前页
+     * @returns Canvas元素
+     */
     getPage(pageNo?: number): HTMLCanvasElement;
+    /**
+     * 获取所有Canvas页面元素
+     * @returns Canvas元素数组
+     */
     getPageList(): HTMLCanvasElement[];
+    /**
+     * 获取页面总数
+     * @returns 页面总数
+     */
     getPageCount(): number;
+    /**
+     * 获取表格内的行列表
+     * @param sourceElementList - 源元素列表
+     * @returns 表格单元格内的行列表
+     */
     getTableRowList(sourceElementList: IElement[]): IRow[];
+    /**
+     * 获取原始行列表
+     *
+     * 根据当前活动区域返回对应的行列表：
+     * - 页眉区域：返回页眉行列表
+     * - 页脚区域：返回页脚行列表
+     * - 主区域：返回主内容行列表
+     *
+     * @returns 行列表
+     */
     getOriginalRowList(): IRow[];
+    /**
+     * 获取当前行列表
+     *
+     * 根据当前位置上下文返回行列表：
+     * - 表格内：返回表格单元格的行列表
+     * - 非表格：返回原始行列表
+     *
+     * @returns 当前行列表
+     */
     getRowList(): IRow[];
+    /**
+     * 获取按页分组的行列表
+     * @returns 按页分组的行列表
+     */
     getPageRowList(): IRow[][];
+    /**
+     * 获取当前页的Canvas渲染上下文
+     * @returns Canvas 2D渲染上下文
+     */
     getCtx(): CanvasRenderingContext2D;
+    /**
+     * 获取编辑器配置选项
+     * @returns 编辑器配置选项
+     */
     getOptions(): DeepRequired<IEditorOption>;
+    /**
+     * 获取搜索管理器
+     * @returns 搜索管理器实例
+     */
     getSearch(): Search;
+    /**
+     * 获取分组管理器
+     * @returns 分组管理器实例
+     */
     getGroup(): Group;
+    /**
+     * 获取区域选择器
+     * @returns 区域选择器实例
+     */
     getArea(): Area;
+    /**
+     * 获取徽章渲染器
+     * @returns 徽章渲染器实例
+     */
     getBadge(): Badge;
+    /**
+     * 获取历史管理器
+     * @returns 历史管理器实例
+     */
     getHistoryManager(): HistoryManager;
+    /**
+     * 获取位置管理器
+     * @returns 位置管理器实例
+     */
     getPosition(): Position;
+    /**
+     * 获取区域管理器
+     * @returns 区域管理器实例
+     */
     getZone(): Zone;
+    /**
+     * 获取选区管理器
+     * @returns 选区管理器实例
+     */
     getRange(): RangeManager;
+    /**
+     * 获取换行符粒子渲染器
+     * @returns 换行符粒子渲染器实例
+     */
     getLineBreakParticle(): LineBreakParticle;
+    /**
+     * 获取文本粒子渲染器
+     * @returns 文本粒子渲染器实例
+     */
     getTextParticle(): TextParticle;
+    /**
+     * 获取页眉元素列表
+     * @returns 页眉元素数组
+     */
     getHeaderElementList(): IElement[];
+    /**
+     * 获取表格内的元素列表
+     * @param sourceElementList - 源元素列表
+     * @returns 表格单元格内的元素数组
+     */
     getTableElementList(sourceElementList: IElement[]): IElement[];
+    /**
+     * 获取当前元素列表
+     *
+     * 根据当前位置上下文返回元素列表：
+     * - 表格内：返回表格单元格的元素列表
+     * - 非表格：返回原始元素列表
+     *
+     * @returns 当前元素列表
+     */
     getElementList(): IElement[];
+    /**
+     * 获取主内容元素列表
+     *
+     * 根据当前位置上下文返回主内容元素列表：
+     * - 表格内：返回表格单元格的元素列表
+     * - 非表格：返回主内容元素列表
+     *
+     * @returns 主内容元素列表
+     */
     getMainElementList(): IElement[];
+    /**
+     * 获取原始元素列表
+     *
+     * 根据当前活动区域返回对应的元素列表：
+     * - 页眉区域：返回页眉元素列表
+     * - 页脚区域：返回页脚元素列表
+     * - 主区域：返回主内容元素列表
+     *
+     * @returns 原始元素列表
+     */
     getOriginalElementList(): IElement[];
+    /**
+     * 获取原始主内容元素列表
+     * @returns 主内容元素列表
+     */
     getOriginalMainElementList(): IElement[];
+    /**
+     * 获取页脚元素列表
+     * @returns 页脚元素数组
+     */
     getFooterElementList(): IElement[];
+    /**
+     * 获取当前单元格
+     *
+     * 根据当前位置上下文返回表格单元格。
+     *
+     * @returns 单元格对象，如果不在表格内则返回null
+     */
     getTd(): ITd | null;
+    /**
+     * 根据位置上下文获取单元格
+     * @param positionContext - 位置上下文
+     * @returns 单元格对象，如果不在表格内则返回null
+     */
     getTdByPosition(positionContext: IPositionContext): ITd | null;
+    /**
+     * 插入文本域元素
+     *
+     * 在当前光标位置插入文本域元素列表。
+     *
+     * @param payload - 要插入的元素列表
+     * @param options - 插入选项
+     */
     insertElementTextField(payload: IElement[], options?: IInsertElementListOption): void;
+    /**
+     * 插入元素列表
+     *
+     * 在当前光标位置插入元素列表，支持在控件内插入。
+     * 会自动处理控件激活、占位符移除、前后缀颜色重置等逻辑。
+     *
+     * @param payload - 要插入的元素列表
+     * @param options - 插入选项
+     */
     insertElementList(payload: IElement[], options?: IInsertElementListOption): void;
     appendElementList(elementList: IElement[], options?: IAppendElementListOption): void;
     spliceElementList(elementList: IElement[], start: number, deleteCount: number, items?: IElement[], options?: ISpliceElementListOption): void;
@@ -285,6 +807,23 @@ export declare class Draw {
     private _disconnectLazyRender;
     private _lazyRender;
     private _immediateRender;
+    /**
+     * 渲染编辑器
+     *
+     * 这是编辑器的核心渲染方法，执行以下操作：
+     * 1. 计算文档结构（行列表、页面列表、位置列表）
+     * 2. 创建/更新Canvas页面
+     * 3. 绘制所有元素（文本、图片、表格等）
+     * 4. 更新光标和选区状态
+     * 5. 提交历史记录
+     *
+     * @param payload - 渲染选项
+     * @param payload.isSubmitHistory - 是否提交到历史记录
+     * @param payload.isSetCursor - 是否设置光标
+     * @param payload.isCompute - 是否重新计算文档结构
+     * @param payload.isLazy - 是否使用懒加载渲染
+     * @param payload.curIndex - 当前光标索引
+     */
     render(payload?: IDrawOption): void;
     fixPosition(prev?: boolean): number | undefined;
     setCursor(curIndex: number | undefined): number | undefined;