import{ax as i,z as a,A as l,b5 as n}from"./chunks/framework.V2ssSR2R.js";const c=JSON.parse('{"title":"historyService方法","description":"","frontmatter":{},"headers":[],"relativePath":"api/editor/historyServiceMethods.md","filePath":"api/editor/historyServiceMethods.md"}'),e={name:"api/editor/historyServiceMethods.md"};function h(t,s,p,k,d,r){return l(),a("div",null,[...s[0]||(s[0]=[n(`

historyService方法

reset

详情：
重置全部历史记录（包括页面节点栈、代码块栈、数据源栈），并重置当前页面 id / canRedo / canUndo

resetPage

详情：
重置当前页面的历史记录状态（清空当前页面id，重置 canRedo/canUndo）

resetState

详情：
重置历史记录全部内部状态（清空 pageId、pageSteps、canRedo、canUndo、codeBlockState、dataSourceState）

changePage

参数：

{MPage | MPageFragment} page

查看 MPage / MPageFragment 类型定义

export interface MPage extends MContainer {
  /** 页面类型 */
  type: NodeType.PAGE;
}

export interface MPageFragment extends MContainer {
  /** 页面类型 */
  type: NodeType.PAGE_FRAGMENT;
}

详情：
按页面切换历史堆栈

push

参数：

{StepValue} state

查看 StepValue 及关联类型定义

export interface StepValue {
  /** 页面信息 */
  data: { name: string; id: Id };
  opType: HistoryOpType;
  /** 操作前选中的节点 ID，用于撤销后恢复选择状态 */
  selectedBefore: Id[];
  /** 操作后选中的节点 ID，用于重做后恢复选择状态 */
  selectedAfter: Id[];
  modifiedNodeIds: Map<Id, Id>;
  /** opType 'add': 新增的节点 */
  nodes?: MNode[];
  /** opType 'add': 父节点 ID */
  parentId?: Id;
  /** opType 'add': 每个新增节点在父节点 items 中的索引 */
  indexMap?: Record<string, number>;
  /** opType 'remove': 被删除的节点及其位置信息 */
  removedItems?: { node: MNode; parentId: Id; index: number }[];
  /**
   * opType 'update': 变更前后的节点快照
   *
   * \`changeRecords\` 来自 form 端的 propPath/value 列表，撤销/重做时只对这些 propPath 做局部更新；
   * 缺省（未传 / 空数组）才退化为整节点替换。
   */
  updatedItems?: { oldNode: MNode; newNode: MNode; changeRecords?: ChangeRecord[] }[];
  /**
   * 调用方可选传入的人类可读描述（如「调整按钮颜色」），用于历史面板展示。
   * 不影响 undo/redo 行为；缺省时面板会根据节点 / propPath 自动生成描述。
   */
  historyDescription?: string;
}

export type HistoryOpType = 'add' | 'remove' | 'update';

export type Id = string | number;

export type MNode = MComponent | MContainer | MIteratorContainer | MPage | MApp | MPageFragment;

export interface ChangeRecord {
  propPath?: string;
  value: any;
}

返回：
- {StepValue | null}
详情：
添加一条历史记录
TIP
opType: 'update' 的每个 updatedItems[i] 上可携带 changeRecords，用于撤销 / 重做时仅按 propPath 局部更新对应字段，避免整节点替换冲掉同节点上的其它无关变更；不带 changeRecords 时退化为整节点替换（如 sort / moveLayer / 拖动等纯快照场景）。

undo

返回：
- {StepValue | null}
详情：
撤销当前操作。opType: 'update' 时，若 updatedItems[i].changeRecords 存在，会按 propPath 从 oldNode 取值做局部回滚；否则用 oldNode 整节点替换。

redo

返回：
- {StepValue | null}
详情：
恢复到下一步。opType: 'update' 时，若 updatedItems[i].changeRecords 存在，会按 propPath 从 newNode 取值做局部重做；否则用 newNode 整节点替换。

pushCodeBlock

参数：

{Id} codeBlockId 代码块 id
{Object} payload
- {CodeBlockContent | null} oldContent 变更前的代码块内容；新增时为 null
- {CodeBlockContent | null} newContent 变更后的代码块内容；删除时为 null
- {ChangeRecord[]} changeRecords 可选；form 端 propPath/value 变更列表，撤销/重做时若有则按 propPath 局部更新；缺省（或空数组）才退化为整内容替换

查看 CodeBlockStepValue 及关联类型定义

/**
 * 代码块历史记录条目。按 codeBlock.id 分组保存到 historyState.codeBlockState。
 * - 新增：oldContent = null，newContent = 新内容
 * - 更新：oldContent / newContent 都为对应内容
 * - 删除：newContent = null，oldContent = 删除前内容
 */
export interface CodeBlockStepValue {
  /** 关联的代码块 id */
  id: Id;
  /** 变更前的代码块内容，新增时为 null */
  oldContent: CodeBlockContent | null;
  /** 变更后的代码块内容，删除时为 null */
  newContent: CodeBlockContent | null;
  /**
   * form 端 propPath/value 列表。撤销/重做时若有则按 propPath 局部更新；
   * 缺省才退化为整内容替换。新增/删除场景通常无 changeRecords。
   */
  changeRecords?: ChangeRecord[];
  /** 调用方可选传入的人类可读描述，用于历史面板展示；不影响 undo/redo 行为。 */
  historyDescription?: string;
}

export interface CodeBlockContent {
  /** 代码块名称 */
  name: string;
  /** 代码块内容 */
  content: ((...args: any[]) => any) | Function;
  /** 参数定义 */
  params: CodeParam[] | [];
  /** 注释 */
  desc?: string;
  /** 扩展字段 */
  [propName: string]: any;
}

export interface ChangeRecord {
  propPath?: string;
  value: any;
}

返回：
- {CodeBlockStepValue | null} 入栈失败（未传 id）时返回 null
详情：
推入一条代码块变更记录。与页面 / 节点完全无关，按 codeBlockId 维度独立一份 UndoRedo 栈，栈实例存放在 historyService.state.codeBlockState[codeBlockId]。
入栈成功后会触发 code-block-history-change 事件。
TIP
codeBlockService.setCodeDslByIdSync 与 codeBlockService.deleteCodeDslByIds 内部已经自动调用本方法，业务代码通常无需手动调用。

undoCodeBlock

参数：
- {Id} codeBlockId
返回：
- {CodeBlockStepValue | null} 栈不存在或已无可撤销记录时返回 null
详情：
撤销指定代码块的最近一次变更。成功时会触发 code-block-history-change 事件。拿到 step 后由调用方根据 step.oldContent 写回 codeBlockService（本方法不会自动回放）。

redoCodeBlock

参数：
- {Id} codeBlockId
返回：
- {CodeBlockStepValue | null} 栈不存在或已无可重做记录时返回 null
详情：
重做指定代码块的下一次变更。成功时会触发 code-block-history-change 事件。

canUndoCodeBlock

参数：
- {Id} codeBlockId
返回：
- {boolean}
详情：
指定代码块当前是否可撤销。栈不存在时返回 false。

canRedoCodeBlock

参数：
- {Id} codeBlockId
返回：
- {boolean}
详情：
指定代码块当前是否可重做。栈不存在时返回 false。

pushDataSource

参数：

{Id} dataSourceId 数据源 id
{Object} payload
- {DataSourceSchema | null} oldSchema 变更前的数据源 schema；新增时为 null
- {DataSourceSchema | null} newSchema 变更后的数据源 schema；删除时为 null
- {ChangeRecord[]} changeRecords 可选；form 端 propPath/value 变更列表，撤销/重做时若有则按 propPath 局部更新；缺省（或空数组）才退化为整 schema 替换

查看 DataSourceStepValue 及关联类型定义

/**
 * 数据源历史记录条目。按 dataSource.id 分组保存到 historyState.dataSourceState。
 * - 新增：oldSchema = null，newSchema = 新 schema
 * - 更新：oldSchema / newSchema 都为对应 schema
 * - 删除：newSchema = null，oldSchema = 删除前 schema
 */
export interface DataSourceStepValue {
  /** 关联的数据源 id */
  id: Id;
  /** 变更前的数据源 schema，新增时为 null */
  oldSchema: DataSourceSchema | null;
  /** 变更后的数据源 schema，删除时为 null */
  newSchema: DataSourceSchema | null;
  /**
   * form 端 propPath/value 列表。撤销/重做时若有则按 propPath 局部更新；
   * 缺省才退化为整 schema 替换。新增/删除场景通常无 changeRecords。
   */
  changeRecords?: ChangeRecord[];
  /** 调用方可选传入的人类可读描述，用于历史面板展示；不影响 undo/redo 行为。 */
  historyDescription?: string;
}

export interface ChangeRecord {
  propPath?: string;
  value: any;
}

返回：
- {DataSourceStepValue | null} 入栈失败（未传 id）时返回 null
详情：
推入一条数据源变更记录。与页面 / 节点完全无关，按 dataSourceId 维度独立一份 UndoRedo 栈，栈实例存放在 historyService.state.dataSourceState[dataSourceId]。
入栈成功后会触发 data-source-history-change 事件。
TIP
dataSourceService.add / update / remove 内部已经自动调用本方法，业务代码通常无需手动调用。

undoDataSource

参数：
- {Id} dataSourceId
返回：
- {DataSourceStepValue | null}
详情：
撤销指定数据源的最近一次变更。成功时会触发 data-source-history-change 事件。拿到 step 后由调用方根据 step.oldSchema 写回 dataSourceService（本方法不会自动回放）。

redoDataSource

参数：
- {Id} dataSourceId
返回：
- {DataSourceStepValue | null}
详情：
重做指定数据源的下一次变更。成功时会触发 data-source-history-change 事件。

canUndoDataSource

参数：
- {Id} dataSourceId
返回：
- {boolean}
详情：
指定数据源当前是否可撤销。栈不存在时返回 false。

canRedoDataSource

参数：
- {Id} dataSourceId
返回：
- {boolean}
详情：
指定数据源当前是否可重做。栈不存在时返回 false。

destroy

详情：
销毁

`,37)])])}const g=i(e,[["render",h]]);export{c as __pageData,g as default};

historyService方法 ​

reset ​

resetPage ​

resetState ​

changePage ​

push ​

undo ​

redo ​

pushCodeBlock ​

undoCodeBlock ​

redoCodeBlock ​

canUndoCodeBlock ​

canRedoCodeBlock ​

pushDataSource ​

undoDataSource ​

redoDataSource ​

canUndoDataSource ​

canRedoDataSource ​

destroy ​

historyService方法

reset

resetPage

resetState

changePage

push

undo

redo

pushCodeBlock

undoCodeBlock

redoCodeBlock

canUndoCodeBlock

canRedoCodeBlock

pushDataSource

undoDataSource

redoDataSource

canUndoDataSource

canRedoDataSource

destroy