# FlowGram.AI > FlowGram.AI ## 指引 - [简介](/guide/getting-started/introduction.md): FlowGram 是一个工作流开发框架与工具集。帮助开发者以更快、更简单的方式搭建 AI 工作流平台。 FlowGram 内置开箱开箱即用的工作流开发能力：可视化流程画布、节点配置表单、变量作用域链，以及开箱即用的物料。 使用 FlowGram 构建你自己的 AI 工作流平台吧。 - [快速上手](/guide/getting-started/quick-start.md): import { PackageManagerTabs // @ts-ignore } from '@theme'; :::info 快速体验 FlowGram.AI，你可以直接 在 CodeSandbox 中打开 或者 在 StackBlitz 中打开 ::: 选择开始方式： 方式一：使用官方模板脚手架搭建新项目（⭐️ 推荐用于快速入门）。方式二：通过安装编辑器包集成到现有项目中。 - [自由布局](/guide/getting-started/free-layout.md): import { PackageManagerTabs // @ts-ignore } from '@theme'; - [固定布局](/guide/getting-started/fixed-layout.md): import { PackageManagerTabs // @ts-ignore } from '@theme'; - [加载与保存](/guide/free-layout/load.md): 画布的数据通过 WorkflowDocument 来存储 - [节点](/guide/free-layout/node.md): 节点通过 FlowNodeEntity 定义 - [线条](/guide/free-layout/line.md): WorkflowLinesManager 管理所有的线条WorkflowNodeLinesData 节点上连接的线条管理WorkflowLineEntity 线条实体 - [端口](/guide/free-layout/port.md): WorkflowNodePortsData 管理节点的所有端口信息WorkflowPortEntity 端口实例WorkflowPortRender 端口渲染组件 - [子画布](/guide/free-layout/sub-canvas.md): 详细代码见 自由布局最佳实践 - [加载与保存](/guide/fixed-layout/load.md): 画布的数据通过 FlowDocument 来存储 - [节点](/guide/fixed-layout/node.md): 节点通过 FlowNodeEntity 定义 - [复合节点](/guide/fixed-layout/composite-nodes.md): 复合节点由多个节点组合，并支持自定义线条，如 分支节点、Loop 节点、TryCatch 节点: - [节点表单](/guide/form/form.md) - [不使用表单](/guide/form/without-form.md): 当节点引擎不开启，节点的 data 数据会存在 node.getExtInfo 中, 如下 - [官方表单物料](/guide/form/form-materials.md): 文档已迁移到：物料 - [介绍](/guide/variable/basic.md): 介绍什么是变量，以及变量引擎的作用 - [输出变量](/guide/variable/variable-output.md): 介绍如何在 FlowGram 中使用变量引擎输出变量 - [消费变量](/guide/variable/variable-consume.md): 介绍如何在 FlowGram 中消费变量引擎输出的变量 - [概念](/guide/variable/concept.md): 介绍变量引擎的核心概念 - [作用域链](/guide/variable/custom-scope-chain.md): 介绍如何定制作用域链 - [@flowgram.ai/background-plugin](/guide/plugin/background-plugin.md): 背景插件用于自定义画布的背景效果，支持点阵背景、Logo显示和新拟态(Neumorphism)视觉效果。 - [@flowgram.ai/minimap-plugin](/guide/plugin/minimap-plugin.md): - [@flowgram.ai/export-plugin](/guide/plugin/export-plugin.md): 导出插件提供了将工作流导出为图片（PNG、JPEG、SVG）或数据文件（JSON、YAML）的功能。 - [@flowgram.ai/panel-manager-plugin](/guide/plugin/panel-manager-plugin.md): 管理各类面板的插件。 - [@flowgram.ai/free-auto-layout-plugin](/guide/plugin/free-auto-layout-plugin.md): 基于 Dagre 算法的自动布局插件，为自由布局画布提供智能的节点排列功能。 - [@flowgram.ai/free-stack-plugin](/guide/plugin/free-stack-plugin.md): 层级管理插件，为自由布局画布提供节点和连线的 z-index 层级控制功能。 - [画布滚动和缩放](/guide/advanced/zoom-scroll.md): > 详细用法参考 Playground - [历史记录](/guide/advanced/history.md): Undo/Redo 是 FlowGram.AI 的一个插件，在 @flowgram.ai/fixed-layout-editor 和 @flowgram.ai/free-layout-editor 两种模式的编辑器中均有提供该功能。 - [快捷键](/guide/advanced/shortcuts.md) - [自定义 Service](/guide/advanced/custom-service.md): 业务中需要抽象出单例服务便于插件化管理 - [自定义 Layer](/guide/advanced/custom-layer.md): 我们将画布拆分成多个 Layer，实现交互分层的思想，便于插件化管理，详细见 画布引擎 通过 observeEntityDatas observeEntities observeEntity 监听画布节点任意数据模块的更新通过 onZoom onScroll onViewportChange 等监听画布的缩放或者滚动通过 render 往画布中插入 react 元素, 如绘制 svg 线条 - [自定义插件](/guide/advanced/custom-plugin.md) - [概念](/guide/concepts/index.md): CanvasEngine：画布引擎负责绘制“点-线”构成的图, 保障大规模节点时的流畅性NodeEngine: 节点引擎提供 渲染、校验、数据修改等表单能力VariableEngine: 变量引擎引入作用域模型, 抽象各业务场景的变量Material: 物料库包含默认 ICON 等 UI, 业务接入后可覆盖扩展 - [画布引擎](/guide/concepts/canvas-engine.md) - [节点引擎](/guide/concepts/node-engine.md): 节点引擎 NodeEngine 是一个流程节点逻辑的书写框架，让业务专注于业务自身的渲染与数据逻辑，无需关注画布以及节点间联动的底层api。与此同时，节点引擎沉淀了最佳的节点书写范式，帮助业务解决流程业务中可能遇到的各种问题， 如数据逻辑与渲染耦合等。 节点引擎是可选启用的。如果你不存在以下这些复杂的节点逻辑，可以选择不启用节点引擎，自己维护节点数据与渲染。复杂节点逻辑如：1）节点不渲染也能校验或触发数据副作用；2）节点间联动丰富；3）redo/undo; 等等。 - [ECS](/guide/concepts/ecs.md) - [IOC](/guide/concepts/ioc.md) - [对比 ReactFlow](/guide/concepts/reactflow.md): Reactflow 是很优秀的开源项目，架构及代码清晰，但偏流程渲染引擎的底层架构 (Node、Edge、Handle)，需要在上层开发大量功能才能适配复杂场景(如 固定布局，需要对数据建模写布局算法), 高级功能收费。 相比 Reactflow，FlowGram 的目标是提供流程编辑一整套开箱即用的解决方案。 下边是 Reactflow 官方提供的 pro 收费能力 Reactflow 事件都是绑定在原子化的 dom 节点上，且内置，交互定制成本高，需要理解它的源码才能深度开发，如下，在画布缩放很小时候无法选到点位 - [介绍](/guide/runtime/introduction.md): FlowGram Runtime 的基本概念和设计理念 - [快速开始](/guide/runtime/quick-start.md): 快速上手使用 FlowGram Runtime - [认识 Schema](/guide/runtime/schema.md): FlowGram Schema 结构和配置的详细介绍 - [内置节点](/guide/runtime/node.md): 本文档详细介绍FlowGram Runtime中的节点系统，包括节点的基本概念、现有节点类型及其用法，以及如何创建自定义节点。 现有节点： 开始节点结束节点LLM节点条件节点循环节点 后续会支持代码节点、意图识别节点、批处理节点、终止循环节点、继续循环节点、HTTP节点 - [运行时 API](/guide/runtime/api.md): FlowGram Runtime API - [源码导读](/guide/runtime/source-code-guide.md): FlowGram Runtime 源码结构和实现细节解析 - [贡献指南](/guide/contributing.md): 本文帮助你快速在本仓库完成开发、测试与提 PR。仓库采用 Rush + pnpm 的 Monorepo 管理方式，文档站基于 Rspress 构建。 - [联系我们](/guide/contact-us.md): Issues: IssuesDiscord: https://discord.gg/SwDWdrgA9fLark: 通过 注册飞书 并扫描下边的二维码加入飞书群 - [注意事项及常见问题](/guide/question.md): 画布的 editor 版本及导入的插件版本必须一致，如果出现以下错误都是这个问题造成画布的事件监听，在 react 中使用都要配套写销毁逻辑，防止无限注册导致内存泄漏 - [批处理变量实现思路 (WIP)](/guide/variable/cases/case-batch-variable.md): 介绍如何实现批处理节点中的变量逻辑 - [底层 API (WIP)](/guide/variable/core-api.md): 介绍变量引擎的底层 API 的设计与使用 - [内置 AST(WIP)](/guide/variable/core-ast.md): 介绍变量引擎的内置 AST 节点 ## 物料 - [快速上手](/materials/introduction.md) - [物料管理 CLI](/materials/cli.md): Flowgram 提供了专门的 CLI 命令行工具，帮助你管理项目中的官方物料。 - [TypeSelector](/materials/components/type-selector.md): TypeSelector 是一个类型选择器组件，用于在表单中选择 JSON Schema 类型。它支持基本类型和复合类型（如数组类型）的选择。 :::tip If you want to add new variable types, please read Type Management ::: - [JsonSchemaEditor](/materials/components/json-schema-editor.md): JsonSchemaEditor 是一个可视化的 JSON Schema 编辑器，支持创建和编辑复杂的 JSON Schema 结构。它提供了树形结构的界面，可以直观地定义对象、数组、字符串、数字等各种类型的属性，支持嵌套结构和必填字段标记。 JsonSchema 协议可以通过以下文档学习： Json Schema 官网Json Schema 规范（中文版） - [JsonSchemaCreator](/materials/components/json-schema-creator.md): JsonSchemaCreator 是一个用于从 JSON 字符串自动生成 JSON Schema 的组件。它提供了一个按钮来触发弹窗，用户可以在弹窗中粘贴 JSON 数据，组件会自动分析数据结构并生成对应的 JSON Schema。 - [VariableSelector](/materials/components/variable-selector.md): VariableSelector 是一个用于选择当前作用域变量的组件，它可以根据变量的类型进行过滤。 :::warning VariableSelector 的变量树中，每一个叶子节点和非叶子节点，都是一个变量。 在官方物料库的设计中，每个节点都会输出 一个 ObjectType 变量声明，这个变量声明中： 变量的元信息包含节点的标题和节点的 Icon，被 VariableSelector 解析展示变量的下钻字段会被 VariableSelector 递归展示在节点变量内 ::: - [DynamicValueInput](/materials/components/dynamic-value-input.md): DynamicValueInput 是一个动态值输入组件，支持常量和变量两种输入模式。它可以根据提供的 schema 自动选择合适的输入类型，并提供变量选择功能。组件能够智能地在常量输入和变量选择之间切换。 - [ConditionRow](/materials/components/condition-row.md): ConditionRow 是一个条件表达式组件，用于构建变量比较逻辑。它支持选择变量、选择比较操作符、输入比较值，能够根据变量类型自动适配可用的操作符和值类型。 - [DBConditionRow](/materials/components/db-condition-row.md): DBConditionRow 是一个数据库条件行组件，用于构建数据库查询条件。它提供了字段选择、操作符选择和值输入功能，可以根据字段类型自动显示合适的操作符和输入控件。 - [ConditionContext](/materials/components/condition-context.md): ConditionContext 是一个条件配置的上下文管理系统，用于统一管理条件规则和操作符配置，为条件组件提供一致的配置环境。 :::tip ConditionContext 的条件配置上下文可以影响到以下物料： ConditionRowDBConditionRow ::: - [InputsValues](/materials/components/inputs-values.md): InputsValues 是一个键值对输入列表组件，用于收集和管理一组输入参数。每个键值对都支持常量和变量两种输入模式，通过 DynamicValueInput 组件实现灵活的输入方式。 - [InputsValuesTree](/materials/components/inputs-values-tree.md): InputsValuesTree 是一个用于展示和编辑树状结构输入值的组件，每个叶子节点为一个键值对，值支持常量和变量两种输入模式，通过 DynamicValueInput 组件实现灵活的输入方式。组件采用树形层级展示，支持节点的展开和折叠，适用于构建复杂的嵌套数据结构。 :::tip{title="和 InputsValues 的区别"} 结构差异：InputsValues 仅支持一级键值对列表，而 InputsValuesTree 支持树形嵌套结构展示方式：InputsValues 使用简单的行列表展示，InputsValuesTree 使用树形结构展示，带有缩进和展开/折叠功能适用场景：InputsValues 适用于简单的键值对配置，InputsValuesTree 适用于复杂的多层级数据结构配置 ::: - [PromptEditor](/materials/components/prompt-editor.md): PromptEditor 是一个专业的提示词编辑器组件，基于 Coze Editor 构建，支持 Markdown 语法高亮、Jinja 模板语法高亮等功能，适用于创建和编辑 AI 提示词模板。 - [PromptEditorWithVariables](/materials/components/prompt-editor-with-variables.md): PromptEditorWithVariables 是一个增强版的提示编辑器，集成了变量引用功能。 它基于 PromptEditor 构建，通过 @, { 弹出变量树选择器，并将输入变量回显为标签，使用户能够在提示模板中方便地引用和管理变量。 - [PromptEditorWithInputs](/materials/components/prompt-editor-with-inputs.md): PromptEditorWithInputs 是一个增强版的提示编辑器，集成了节点输入提示功能。 它基于 PromptEditor 构建，通过 @, { 字符弹出节点输入选择器，使用户能够在提示模板中方便地引用节点的输入。 - [CodeEditor](/materials/components/code-editor.md): CodeEditor 是一个功能强大的代码编辑器组件，基于 CodeMirror 6 构建，支持多种编程语言的语法高亮和智能提示。它提供了 TypeScript、Python、SQL、Shell、JSON 等语言的专用编辑器版本。 - [JsonEditorWithVariables](/materials/components/json-editor-with-variables.md): JsonEditorWithVariables 是一个增强版的 JSON 编辑器，支持在 JSON 中插入变量引用。它基于 JsonCodeEditor 构建，集成了变量选择器和变量标签注入功能，使用户能够在 JSON 字符串中使用 {{variable}} 语法引用变量。 - [SQLEditorWithVariables](/materials/components/sql-editor-with-variables.md): SQLEditorWithVariables 是一个增强版的 SQL 编辑器，支持在 SQL 中插入变量引用。它基于 SQLCodeEditor 构建，集成了变量选择器和变量标签注入功能，使用户能够在 SQL 字符串中使用 {{variable}} 语法引用变量。 - [CozeEditorExtensions](/materials/components/coze-editor-extensions.md): CozeEditorExtensions 是一组基于 coze-editor 的功能扩展，提供变量、Inputs 选择器与变量标签回显能力。 EditorVariableTree：监听 @/{ 等触发字符，弹出可用变量树并将选中项写入编辑器。EditorVariableTagInject：对 {{variable.path}} 文本进行标记渲染，展示变量图标、标题与回显提示。EditorInputsTree：基于节点 inputsValues 构造层级树，支持在提示词中插入 {{inputs.xxx}} 引用。 - [ConstantInput](/materials/components/constant-input.md): ConstantInput 是一个常量输入组件，它根据提供的 JSON Schema 自动选择合适的输入类型渲染器。 组件支持自定义渲染策略和兜底渲染器，能够处理各种数据类型的常量输入。 - [DisplaySchemaTag](/materials/components/display-schema-tag.md): DisplaySchemaTag 是一个用于展示 JSON Schema 的标签组件，当用户点击标签时，会弹出详细的 schema 树形结构，方便查看复杂的数据结构。 - [DisplaySchemaTree](/materials/components/display-schema-tree.md): DisplaySchemaTree 是一个用于可视化展示 JSON Schema 结构的树形组件，可以递归地展示对象、数组等复杂数据结构的层级关系。 - [DisplayFlowValue](/materials/components/display-flow-value.md): DisplayFlowValue 是一个用于可视化展示 Flow Value 数据类型的组件，它能够根据 Flow Value 的类型推断出相应的 JSON Schema，并通过友好的界面展示给用户。 - [DisplayInputsValues](/materials/components/display-inputs-values.md): DisplayInputsValues 是一个用于可视化展示树状结构输入值的组件。 它能够递归地遍历输入值对象，对于解析其中 Flow Value 的类型，并推导出每一个字段的 Json Schema 结构。 :::tip DisplayInputsValues 支持展示 InputsValues 和 InputsValuesTree 两个组件配置的值。 ::: - [DisplayOutputs](/materials/components/display-outputs.md): DisplayOutputs 是一个用于可视化展示节点输出变量的组件，支持从作用域自动获取输出变量或通过字段值手动指定输出模式。 - [AssignRow](/materials/components/assign-row.md): AssignRow 是一个赋值行组件，支持两种操作模式：赋值模式 (assign) 和 声明模式 (declare)。 在赋值模式下：左侧是变量选择器，右侧是动态值输入；在声明模式下：左侧是文本输入框，右侧是动态值输入。 - [AssignRows](/materials/components/assign-rows.md): AssignRows 是一个赋值行列表组件，基于 FieldArray 实现，支持动态添加和删除赋值行。 组件提供了两个操作按钮：赋值 和 声明，可以分别添加赋值模式和声明模式的赋值行。每个赋值行都可以独立配置和删除。 :::tip AssignRows 通常和 infer-assign-plugin 表单插件一起使用，用于将定义的声明转换为节点的输出变量，并实现类型的自动联动。 ::: - [BatchOutputs](/materials/components/batch-outputs.md): BatchOutputs 是一个用于配置循环输出的键值对编辑器组件。在循环节点场景中，它允许用户定义每次迭代需要收集的输出值，这些值最终会被聚合成数组。 核心特性： ➕ 动态添加/删除：用户可以自由添加或删除输出键值对✏️ 键名编辑：为每个输出定义一个唯一的键名🔗 变量引用：通过变量选择器引用循环体内可用的变量👁️ 只读模式：支持只读展示，适用于查看场景 :::warning BatchOutputs 必须搭配 batchOutputsPlugin 使用才能正常工作。这是因为： 组件负责 UI 交互，收集用户配置的输出键值对插件负责将配置转换为变量声明，并调整作用域链 ::: :::info{title="完整方案概览"} 实现一个完整的循环节点需要以下三个物料配合使用： ::: - [BatchVariableSelector](/materials/components/batch-variable-selector.md): BatchVariableSelector 是一个用于选择数组类型变量的组件，它是 VariableSelector 的封装版本。 该组件自动过滤变量树，只显示数组类型的变量，并自动设定私有作用域，常用于批处理场景（如 Loop 节点的循环数据源选择）。 核心特性： 🔍 自动过滤：只显示数组类型（type: 'array'）的变量。🔐 私有作用域：通过 PrivateScopeProvider 提供独立的变量作用域。🎯 专用场景：专为批处理、循环等需要数组数据源的场景设计。 - [BlurInput](/materials/components/blur-input.md): BlurInput 是一个特殊的输入框组件，它只在输入框失焦时才会触发值的更新，适用于需要避免频繁触发更新操作的场景。 - [autoRenameRef](/materials/effects/auto-rename-ref.md): autoRenameRef 是一个自动重命名引用效果，当表单字段的键名发生变化时，自动更新所有引用该字段的引用值和模板值。 - [listenRefValueChange](/materials/effects/listen-ref-value-change.md): 监听引用变量定义的变化，并在变化时触发回调函数。 - [listenRefSchemaChange](/materials/effects/listen-ref-schema-change.md): 监听引用变量类型的 json schema 变化，并在变化时触发回调函数。 - [provideBatchInputEffect](/materials/effects/provide-batch-input.md): provideBatchInputEffect 是一个表单副作用，专门用于循环节点场景。它能够将循环输入的数组变量解析为两个局部变量： item：当前迭代的数组元素，类型会根据输入数组的元素类型自动推导index：当前迭代的索引，类型为 number 核心特性： 🔄 自动类型推导：从数组类型自动推导出 item 的元素类型🔒 私有作用域：生成的变量存储在节点私有作用域，仅当前节点及子节点可访问🎯 循环专用：专为批处理/循环场景设计 这使得循环体内的子节点可以引用 item 和 index 变量，实现对数组元素的逐个处理。 :::info{title="完整方案概览"} 实现一个完整的循环节点需要以下三个物料配合使用： ::: - [provideJsonSchemaOutputs](/materials/effects/provide-json-schema-outputs.md): provideJsonSchemaOutputs 是一个表单副作用，用于将 JSON Schema 定义转换为 FlowGram 变量引擎中的输出变量。 它能够自动将表单中定义的 JSON Schema 结构解析为变量声明，使工作流中的其他节点可以引用这些输出。 - [syncVariableTitle](/materials/effects/sync-variable-title.md): syncVariableTitle 是一个表单副作用（Effect），用于同步节点的标题到该节点输出变量的元数据中。 当节点标题发生变化时，会自动更新所有输出变量的 title 和 icon 元数据。 - [validateWhenVariableSync](/materials/effects/validate-when-variable-sync.md): 当字段可访问的变量发生了变化时，则重新触发指定错误字段的校验。 :::note{title="为什么是错误字段？"} 错误字段的错误信息可能源于变量引用的有效性。 如果字段的可访问变量发生了变化，使得字段的变量引用从无效变为有效，就需要需要重新校验当前字段，清空之前的错误信息。 ::: - [batchOutputsPlugin](/materials/form-plugins/batch-outputs-plugin.md): batchOutputsPlugin 是一个用于循环节点的表单插件，它实现了两个核心功能： 输出变量生成：将循环体内收集的变量引用转换为数组类型的输出变量作用域链转换：调整变量作用域链，使循环节点的输出能正确依赖子节点的输出 核心特性： 🔄 数组包装：自动将循环体内引用的变量包装为数组类型输出🔗 作用域链调整：让循环节点的输出变量能正确依赖子节点的输出📊 Schema 推导：可选配置，自动推导输出变量的 JSON Schema :::tip{title="适用场景"} 循环节点：需要在每次迭代中收集数据并聚合成数组批处理节点：需要将多个子任务的结果汇总输出任何包含子节点的容器节点：需要从子节点收集输出变量 ::: :::warning BatchOutputs 组件必须搭配 batchOutputsPlugin 使用才能正常工作。这是因为： 组件负责 UI 交互，收集用户配置的输出键值对插件负责将配置转换为变量声明，并调整作用域链 ::: :::info{title="完整方案概览"} 实现一个完整的循环节点需要以下三个物料配合使用： ::: - [inferInputsPlugin](/materials/form-plugins/infer-inputs-plugin.md): inferInputsPlugin是一个用于自动推断输入参数 JSON Schema 的表单插件，它能在数据传送到后端运行时前，根据 IFlowValue 类型 (常量或变量引用) 自动生成对应的 JSON Schema 结构，为后端的运行时类型验证和后端接口提供类型信息。 :::tip{title="适用场景"} HTTP 节点：推断请求头 (headers)、查询参数 (params) 的 Schema代码节点：推断代码输入参数的类型结构函数调用节点：推断函数参数的 Schema任何接受动态输入的节点：需要为后端提供输入类型信息 ::: - [inferAssignPlugin](/materials/form-plugins/infer-assign-plugin.md): inferAssignPlugin 是用于变量赋值节点，进行输出变量自动推导的表单插件，通常和 AssignRows 物料配合使用。 插件针对 AssignRows 的 declare (声明新变量) 实现了以下能力： 自动生成节点输出变量，变量名即 declare 操作符中的左值，变量类型会自动根据 right 进行联动推导。当提交数据到后端时，自动根据输出变量的变量类型，联动生成对应的 JSON Schema。 - [validateFlowValue](/materials/validate/validate-flow-value.md): validateFlowValue 是一个用于验证 FlowValue 必填性和变量引用有效性 的验证函数。 - [FlowValue](/materials/common/flow-value.md): FlowValue 是指在 Flowgram 官方物料库 中用于表示数据的一种特殊类型。它可以是常量、引用、表达式或模板，为流程中的数据传递和处理提供了灵活的方式。 - [类型管理](/materials/common/json-schema-preset.md): 物料库类型管理分为两部分实现： 物料层（物料库预设类型定义）：扩展类型引擎，使其可以定义类型的默认渲染器、Condition 规则配置等提供了默认类型在物料库中的预设定义（常量输入器渲染、Condition 规则配置等）提供 Editor Plugin 方便扩展自定义类型引擎层（核心类型引擎，由 @flowgram.ai/json-schema 提供）提供了 Json 类型的基本定义，包括 icon，名称展示等提供 BaseTypeManager，可以扩展 JsonSchema 官方定义之外的类型定义提供 JsonSchemaUtils 实现 JsonSchema 和 AST 的互相转换 - [物料组件依赖注入](/materials/common/inject-material.md): :::tip{title="目前物料库中支持依赖注入的组件物料"} InjectDynamicValueInputInjectTypeSelectorInjectVariableSelector ::: - [DisableDeclarationPlugin](/materials/common/disable-declaration-plugin.md): :::note{title=""} 在物料库的设计中，“节点本身”作为一种变量声明，是可选的。 物料库中 VariableSelector, PromptEditorWithVariables, SQLEditorWithVariables 等组件，都默认支持选择 “节点变量”。 ::: DisableDeclarationPlugin 可以禁用变量声明的可选性（只能选下钻），从而使“节点变量”不可选。 ## 例子 - [预览](/examples/index.md) - [无限画布](/examples/playground.md): PlaygroundReact 是固定布局和自由布局的底层模块，可以单独使用, 功能： 无限拖动画布鼠标/触摸板手势缩放内置背景插件内置快捷键插件 - [基础用法](/examples/fixed-layout/fixed-layout-simple.md) - [复合节点](/examples/fixed-layout/fixed-composite-nodes.md) - [最佳实践](/examples/fixed-layout/fixed-feature-overview.md) - [基础用法](/examples/free-layout/free-layout-simple.md) - [最佳实践](/examples/free-layout/free-feature-overview.md) - [基础用法](/examples/node-form/basic.md) - [副作用](/examples/node-form/effect.md): 以下例子展示了表单副作用的配置方式。举了两个个例子，行为描述如下 Basic effect(基础例子)：当表单项值变更时，控制台会打印表单当前值。Control other fields (控制其他表单项的值)：当前表单项数据变更时要同时改变另一个表单项的值。 - [数组](/examples/node-form/array.md): 以下例子展示了数组的基本用法，包含： 基本写法（渲染、增删）。如何对数组每项配置校验逻辑。 此处的校验规则为每项最大长度不超过8个英文字符。如何对数组每项配置副作用。 此处的副作用为每项在初始化时控制台输出 ${name} value init to ${value}, 值变更时输出 ${name} value changed to ${value}数组项如何做交换。 - [联动](/examples/node-form/dynamic.md): 当前例子展示了如何通过 deps 字段来声明表单项之间的联动更新关系。 例子说明：当 Country 有值时才会显示 City 字段。 你也可以将form.getValueIn('country') 作为 city Field 下组件的入参，来控制组件内的行为, 如筛选当前country下的cities。 ## API - [API 预览](/api/index.md) - [FlowDocument](/api/core/flow-document.md): 流程数据文档 (固定布局), 存储流程的所有节点数据 > API Detail :::danger 对节点的操作最好通过 ctx.operation 进行操作, 这样才能绑定到 redo/undo ::: - [FlowNodeEntity/WorkflowNodeEntity](/api/core/flow-node-entity.md): 节点实体，WorkflowNodeEntity 为节点别名用于自由布局节点, 节点实体采用 ECS 架构, 为 Entity > API Detail - [WorkflowDocument (free)](/api/core/workflow-document.md): 自由布局文档数据，继承自 FlowDocument > API Detail :::tip 由于历史原因， 带 Workflow 前缀的都代表自由布局 ::: - [WorkflowLinesManager (free)](/api/core/workflow-lines-manager.md): 自由布局线条管理, 目前挂在自由布局 document 下边 > API Detail - [WorkflowLineEntity (free)](/api/core/workflow-line-entity.md): 自由布局线条实体 > API Detail - [Playground](/api/core/playground.md): 画布实例 > API Detail - [useClientContext](/api/hooks/use-client-context.md): 提供在 react 内部访问画布的上下文, 目前固定布局和 自由布局有一定区别 - [useNodeRender](/api/hooks/use-node-render.md): 提供节点渲染相关的方法, 返回结果的 form 等价于 getNodeForm - [usePlaygroundTools](/api/hooks/use-playground-tools.md): 画布工具方法 - [useRefresh](/api/hooks/use-refresh.md) - [useService](/api/hooks/use-service.md): 获取底层 IOC 的所有单例模块 - [EditorRenderer](/api/components/editor-renderer.md): 画布渲染组件，需要 配合 FixedLayoutEditorProvider 或 FreeLayoutEditorProvider 使用 - [FixedLayoutEditorProvider](/api/components/fixed-layout-editor-provider.md): 固定布局画布配置器，支持 ref - [FixedLayoutEditor](/api/components/fixed-layout-editor.md): 固定布局画布, 等价于 FixedLayoutEditorProvider 和 EditorRenderer 的组合 - [FreeLayoutEditorProvider](/api/components/free-layout-editor-provider.md): 自由布局画布配置器，支持 ref - [FreeLayoutEditor](/api/components/free-layout-editor.md): 自由布局画布, 等价于 FreeLayoutEditorProvider 和 EditorRenderer 的组合 - [WorkflowNodeRenderer(free)](/api/components/workflow-node-renderer.md): 自由布局节点容器 - [ClipboardService](/api/services/clipboard-service.md): 剪贴板服务 > API Detail - [CommandService](/api/services/command-service.md): 指令服务，需要和 Shortcuts 一起使用 > API Detail - [FlowOperationService](/api/services/flow-operation-service.md): 节点操作服务, 目前用于固定布局，自由布局现阶段可通过 WorkflowDocument 直接操作, 后续也会抽象出 operation > API Detail - [](/api/services/history-service.md) - [SelectionService](/api/services/selection-service.md): 用于控制选择的节点 > API Detail - [DisposableCollection](/api/utils/disposable-collection.md) - [Disposable](/api/utils/disposable.md) - [Emitter](/api/utils/emitter.md): 事件模块 - [getNodeForm](/api/utils/get-node-form.md): 获取节点的表单能力，需要开启 节点引擎才能使用 > API Detail - [常用 API](/api/common-apis.md) - [](/api/plugins.md) ## TypeDocs - [](/auto-docs/index.md) - [Class: CommandRegistry](/auto-docs/core/classes/CommandRegistry.md) - [Class: ConfigEntity](/auto-docs/core/classes/ConfigEntity.md): 用于专门的数据配置，且是单例 - [Class: ContextMenuService](/auto-docs/core/classes/ContextMenuService.md): 圈选右键菜单相关 service - [Class: DefaultClipboardService](/auto-docs/core/classes/DefaultClipboardService.md): 剪贴板服务，一般用于管理临时的复制黏贴数据 TODO: 后续可以支持调用浏览器 - [Class: EditorStateConfigEntity](/auto-docs/core/classes/EditorStateConfigEntity.md): 编辑状态管理 - [Class: Entity](/auto-docs/core/classes/Entity-1.md) - [Class: EntityData](/auto-docs/core/classes/EntityData.md): 实体的数据块 - [Class: EntityManager](/auto-docs/core/classes/EntityManager.md): TODO registry 改成 decorator Entity 管理器，全局唯一 - [Class: FlushLayerMessage](/auto-docs/core/classes/FlushLayerMessage.md) - [Class: Layer](/auto-docs/core/classes/Layer.md): 基础 layer - [Class: LocalStorageService](/auto-docs/core/classes/LocalStorageService.md) - [Class: LoggerService](/auto-docs/core/classes/LoggerService.md): 画布全局的选择器，可以放任何东西 - [Class: OpacityData](/auto-docs/core/classes/OpacityData.md): 实体的数据块 - [Class: OriginData](/auto-docs/core/classes/OriginData.md): 实体的数据块 - [Class: PipelineEntitiesImpl](/auto-docs/core/classes/PipelineEntitiesImpl.md): 注入到 Layer 中的实体选择器 - [Class: PipelineEntitiesSelector](/auto-docs/core/classes/PipelineEntitiesSelector.md): 选择器用来在 pipeline 绘制之前，筛选并注入 entities - [Class: PipelineRegistry](/auto-docs/core/classes/PipelineRegistry.md): pipeline 注册器，用于注册一些事件 - [Class: PipelineRenderer](/auto-docs/core/classes/PipelineRenderer.md): pipeline 渲染器 - [Class: Playground](/auto-docs/core/classes/Playground.md) - [Class: PlaygroundConfigEntity](/auto-docs/core/classes/PlaygroundConfigEntity.md): 全局画布的配置信息 - [Class: PlaygroundDrag](/auto-docs/core/classes/PlaygroundDrag-1.md) - [Class: PlaygroundGesture](/auto-docs/core/classes/PlaygroundGesture.md) - [Class: PlaygroundLayer](/auto-docs/core/classes/PlaygroundLayer.md): 基础层，控制画布缩放/滚动等操作 - [Class: LayerTestState](/auto-docs/core/classes/PlaygroundMockTools.LayerTestState.md): PlaygroundMockTools.LayerTestState - [Class: PlaygroundRegistry](/auto-docs/core/classes/PlaygroundRegistry.md) - [Class: PlaygroundSchedule](/auto-docs/core/classes/PlaygroundSchedule.md) - [Class: PositionData](/auto-docs/core/classes/PositionData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: RotationData](/auto-docs/core/classes/RotationData.md): 实体的数据块 - [Class: ScaleData](/auto-docs/core/classes/ScaleData.md): 实体的数据块 - [Class: SelectionService](/auto-docs/core/classes/SelectionService.md): 画布全局的选择器，可以放任何东西 - [Class: SizeData](/auto-docs/core/classes/SizeData.md): 实体的数据块 - [Class: SkewData](/auto-docs/core/classes/SkewData.md): 实体的数据块 - [Class: TransformData](/auto-docs/core/classes/TransformData-1.md): 实体的数据块 - [Enumeration: Default](/auto-docs/core/enums/Command.Default.md): Command.Default - [Enumeration: LoggerEvent](/auto-docs/core/enums/LoggerEvent.md) - [Enumeration: PipelineLayerPriority](/auto-docs/core/enums/PipelineLayerPriority.md) - [Enumeration: PipelineMessage](/auto-docs/core/enums/PipelineMessage.md) - [Function: applyMatrix](/auto-docs/core/functions/Bounds.applyMatrix.md): Bounds.applyMatrix applyMatrix(bounds, matrix): Rectangle Parameters Returns Rectangle - [Function: getBottomCenter](/auto-docs/core/functions/Bounds.getBottomCenter.md): Bounds.getBottomCenter getBottomCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomLeft](/auto-docs/core/functions/Bounds.getBottomLeft.md): Bounds.getBottomLeft getBottomLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomRight](/auto-docs/core/functions/Bounds.getBottomRight.md): Bounds.getBottomRight getBottomRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBounds](/auto-docs/core/functions/Bounds.getBounds.md): Bounds.getBounds getBounds(target, matrix?): Rectangle 获取外围边界矩形 Parameters Returns Rectangle - [Function: getCenter](/auto-docs/core/functions/Bounds.getCenter.md): Bounds.getCenter getCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftCenter](/auto-docs/core/functions/Bounds.getLeftCenter.md): Bounds.getLeftCenter getLeftCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftPointFromBounds](/auto-docs/core/functions/Bounds.getLeftPointFromBounds.md): Bounds.getLeftPointFromBounds getLeftPointFromBounds(target, matrix?): PositionSchema 找到边框中最左边的点 Parameters Returns PositionSchema - [Function: getPointWithMatrix](/auto-docs/core/functions/Bounds.getPointWithMatrix.md): Bounds.getPointWithMatrix getPointWithMatrix(output, matrix?): PositionSchema 位置做矩阵偏移 Parameters Returns PositionSchema - [Function: getRightCenter](/auto-docs/core/functions/Bounds.getRightCenter.md): Bounds.getRightCenter getRightCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopCenter](/auto-docs/core/functions/Bounds.getTopCenter.md): Bounds.getTopCenter getTopCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopLeft](/auto-docs/core/functions/Bounds.getTopLeft.md): Bounds.getTopLeft getTopLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopPointFromBounds](/auto-docs/core/functions/Bounds.getTopPointFromBounds.md): Bounds.getTopPointFromBounds getTopPointFromBounds(target, matrix?): PositionSchema 找到边框中最上边的点 Parameters Returns PositionSchema - [Function: getTopRight](/auto-docs/core/functions/Bounds.getTopRight.md): Bounds.getTopRight getTopRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: is](/auto-docs/core/functions/Command.is.md): Command.is is(arg): arg is Command 判断是否是 command Parameters Returns arg is Command - [Function: checkDataChanged](/auto-docs/core/functions/Entity.checkDataChanged.md): Entity.checkDataChanged checkDataChanged(oldProps, newProps): boolean 默认数据比较，采用浅比较 Parameters Returns boolean - [Function: getType](/auto-docs/core/functions/Entity.getType.md): Entity.getType getType(registry): string Parameters Returns string - [Function: isRegistryOf](/auto-docs/core/functions/Entity.isRegistryOf.md): Entity.isRegistryOf isRegistryOf(target, Registry): boolean Parameters Returns boolean - [Function: MOUSE_SCROLL_DELTA](/auto-docs/core/functions/MOUSE_SCROLL_DELTA.md): MOUSE_SCROLL_DELTA(zoom): number 鼠标缩放 delta Parameters Returns number - [Function: getEventCoord](/auto-docs/core/functions/MouseTouchEvent.getEventCoord.md): MouseTouchEvent.getEventCoord getEventCoord(e): Object Parameters Returns Object - [Function: isTouchEvent](/auto-docs/core/functions/MouseTouchEvent.isTouchEvent.md): MouseTouchEvent.isTouchEvent isTouchEvent(event): event is TouchEvent Parameters Returns event is TouchEvent - [Function: onTouched](/auto-docs/core/functions/MouseTouchEvent.onTouched.md): MouseTouchEvent.onTouched onTouched(touchStartEvent, callback): void Parameters Returns void - [Function: preventDefault](/auto-docs/core/functions/MouseTouchEvent.preventDefault.md): MouseTouchEvent.preventDefault preventDefault(e): void Parameters Returns void - [Function: touchToMouseEvent](/auto-docs/core/functions/MouseTouchEvent.touchToMouseEvent.md): MouseTouchEvent.touchToMouseEvent touchToMouseEvent(event): MouseEvent | Event Parameters Returns MouseEvent | Event - [Function: startDrag](/auto-docs/core/functions/PlaygroundDrag.startDrag.md): PlaygroundDrag.startDrag startDrag(clientX, clientY, opts?): Disposable 拖拽实体 Type parameters Parameters Returns Disposable - [Function: createContainer](/auto-docs/core/functions/PlaygroundMockTools.createContainer.md): PlaygroundMockTools.createContainer createContainer(modules?): interfaces.Container Parameters Returns interfaces.Container - [Function: createLayerTestState](/auto-docs/core/functions/PlaygroundMockTools.createLayerTestState.md): PlaygroundMockTools.createLayerTestState createLayerTestState(layerRegistry, opts?, modules?): LayerTestState 创建layer, 并记录layer的回调数据 Type parameters Parameters Returns LayerTestState - [Function: createPlayground](/auto-docs/core/functions/PlaygroundMockTools.createPlayground.md): PlaygroundMockTools.createPlayground createPlayground(modules?): Playground Parameters Returns Playground - [Function: getLayerTestState](/auto-docs/core/functions/PlaygroundMockTools.getLayerTestState.md): PlaygroundMockTools.getLayerTestState getLayerTestState(container, layerRegistry): LayerTestState Type parameters Parameters Returns LayerTestState - [Function: PlaygroundReactProvider](/auto-docs/core/functions/PlaygroundReactProvider.md): PlaygroundReactProvider(props): null | ReactElement> Playground react 组件 Parameters Returns null | ReactElement> - [Function: PlaygroundReactRenderer](/auto-docs/core/functions/PlaygroundReactRenderer.md): PlaygroundReactRenderer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: coverSize](/auto-docs/core/functions/SizeSchema.coverSize.md): SizeSchema.coverSize coverSize(currentSize, parentSize): number 填充父节点的宽高 Parameters Returns number 返回放大的比例 - [Function: empty](/auto-docs/core/functions/SizeSchema.empty.md): SizeSchema.empty empty(): SizeSchema Returns SizeSchema - [Function: fixSize](/auto-docs/core/functions/SizeSchema.fixSize.md): SizeSchema.fixSize fixSize(currentSize, parentSize): number 适配父节点宽高 Parameters Returns number 返回需要缩放的比例，为 1 则不缩放 - [Function: isParentOrChildrenTransform](/auto-docs/core/functions/TransformData.isParentOrChildrenTransform.md): TransformData.isParentOrChildrenTransform isParentOrChildrenTransform(dragableEntities, target): boolean Parameters Returns boolean - [Function: createDefault](/auto-docs/core/functions/TransformSchema.createDefault.md): TransformSchema.createDefault createDefault(): TransformSchema Returns TransformSchema - [Function: getDelta](/auto-docs/core/functions/TransformSchema.getDelta.md): TransformSchema.getDelta getDelta(oldTransform, newTransform): TransformSchema Parameters Returns TransformSchema - [Function: is](/auto-docs/core/functions/TransformSchema.is.md): TransformSchema.is is(obj): obj is TransformSchema Parameters Returns obj is TransformSchema - [Function: mergeDelta](/auto-docs/core/functions/TransformSchema.mergeDelta.md): TransformSchema.mergeDelta mergeDelta(oldTransform, newTransformDelta, toFixedNum?): TransformSchema Parameters Returns TransformSchema - [Function: toJSON](/auto-docs/core/functions/TransformSchema.toJSON.md): TransformSchema.toJSON toJSON(obj): TransformSchema Parameters Returns TransformSchema - [Function: bindConfigEntity](/auto-docs/core/functions/bindConfigEntity.md): bindConfigEntity(bind, entityRegistry): void 让 entity 可以注入到类中 Parameters Returns void Example - [Function: bindContributionProvider](/auto-docs/core/functions/bindContributionProvider.md): bindContributionProvider(bind, id): void Parameters Returns void - [Function: bindContributions](/auto-docs/core/functions/bindContributions.md): bindContributions(bind, target, contribs): void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns void - [Function: bindPlaygroundContextProvider](/auto-docs/core/functions/bindPlaygroundContextProvider.md): bindPlaygroundContextProvider(bind): void Parameters Returns void - [Function: createConfigDataRegistry](/auto-docs/core/functions/createConfigDataRegistry.md): createConfigDataRegistry

(entity): EntityDataRegistry Type parameters Parameters Returns EntityDataRegistry - [Function: createDefaultPlaygroundConfig](/auto-docs/core/functions/createDefaultPlaygroundConfig.md): createDefaultPlaygroundConfig(): PlaygroundConfig 默认配置 Returns PlaygroundConfig - [Function: createPlaygroundContainer](/auto-docs/core/functions/createPlaygroundContainer.md): createPlaygroundContainer(config?, parent?, container?): interfaces.Container Parameters Returns interfaces.Container - [Function: createPlaygroundLayerDefault](/auto-docs/core/functions/createPlaygroundLayerDefault.md): createPlaygroundLayerDefault(container, layerRegistry, options?): Layer Parameters Returns Layer - [Function: createPlaygroundPlugin](/auto-docs/core/functions/createPlaygroundPlugin.md): createPlaygroundPlugin(options): Plugin Type parameters Parameters Returns Plugin Example - [Function: createPluginContextDefault](/auto-docs/core/functions/createPluginContextDefault.md): createPluginContextDefault(container): PluginContext Parameters Returns PluginContext - [Function: createRegistryDecorator](/auto-docs/core/functions/createRegistryDecorator.md): createRegistryDecorator(key, data, getValue?, init?): any Parameters Returns any - [Function: definePluginCreator](/auto-docs/core/functions/definePluginCreator.md): definePluginCreator(config): PluginCreator Type parameters Parameters Returns PluginCreator - [Function: getEntityDatasMetadata](/auto-docs/core/functions/getEntityDatasMetadata.md): getEntityDatasMetadata(layer): { data: EntityDataRegistry ; entity: EntityRegistry }[] Parameters Returns { data: EntityDataRegistry ; entity: EntityRegistry }[] - [Function: getEntityMetadata](/auto-docs/core/functions/getEntityMetadata.md): getEntityMetadata(layer): EntityRegistry[] Parameters Returns EntityRegistry[] - [Function: getRegistryMetadata](/auto-docs/core/functions/getRegistryMetadata.md): getRegistryMetadata(target, key): any[] Parameters Returns any[] - [Function: injectByProvider](/auto-docs/core/functions/injectByProvider.md): injectByProvider(provider): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectPlaygroundContext](/auto-docs/core/functions/injectPlaygroundContext.md): injectPlaygroundContext(): (target: any, propertyKey: string) => any Returns fn (target, propertyKey): any Parameters Returns any - [Function: lazyInject](/auto-docs/core/functions/lazyInject.md): lazyInject(serviceIdentifier): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: loadPlugins](/auto-docs/core/functions/loadPlugins.md): loadPlugins(plugins, container): void Parameters Returns void - [Function: observeEntities](/auto-docs/core/functions/observeEntities.md): observeEntities(registry): any 监听 entity 变化 Parameters Returns any - [Function: observeEntity](/auto-docs/core/functions/observeEntity.md): observeEntity(registry): any Parameters Returns any - [Function: observeEntityDatas](/auto-docs/core/functions/observeEntityDatas.md): observeEntityDatas(entityRegistry, dataRegistry): any 监听 entity 对应的 data 数据变化 Parameters Returns any - [Function: removeInjectedProperties](/auto-docs/core/functions/removeInjectedProperties.md): removeInjectedProperties(instance): void 在 rspack 场景编译ts文件时候 decorator 注入的 property 会被当成 this 的属性, 导致 Reflect.metadata 失效 Parameters Returns void - [Function: scrollIntoViewWithTween](/auto-docs/core/functions/scrollIntoViewWithTween.md): scrollIntoViewWithTween(opts): Disposable 滚动到可视区域 Parameters Returns Disposable - [Function: startTween](/auto-docs/core/functions/startTween.md): startTween(opts): Disposable Type parameters Parameters Returns Disposable - [Function: useConfigEntity](/auto-docs/core/functions/useConfigEntity.md): useConfigEntity(entityRegistry, listenChange?): T 获取 config entity Type parameters Parameters Returns T - [Function: useEntities](/auto-docs/core/functions/useEntities.md): useEntities(entityRegistry): T[] 获取 entities 并监听变化 Type parameters Parameters Returns T[] Deprecated - [Function: useEntityDataFromContext](/auto-docs/core/functions/useEntityDataFromContext.md): useEntityDataFromContext(dataRegistry, listenChange?): T 从上下 PlaygroundEntityContext 获取 entity data 并监听变化 (默认不监听) Type parameters Parameters Returns T - [Function: useEntityFromContext](/auto-docs/core/functions/useEntityFromContext.md): useEntityFromContext(listenChange?): T 从上下 PlaygroundEntityContext 获取 entity 并监听变化(默认不监听) Type parameters Parameters Returns T - [Function: useListenEvents](/auto-docs/core/functions/useListenEvents.md): useListenEvents(...events): void 监听 event 事件变化 Parameters Returns void - [Function: usePlayground](/auto-docs/core/functions/usePlayground.md): usePlayground(): Playground 获取 playground Returns Playground - [Function: usePlaygroundContainer](/auto-docs/core/functions/usePlaygroundContainer.md): usePlaygroundContainer(): interfaces.Container 获取 playground inversify container Returns interfaces.Container - [Function: usePlaygroundContext](/auto-docs/core/functions/usePlaygroundContext.md): usePlaygroundContext(): T 获取 playground context 数据 Type parameters Returns T - [Function: usePlaygroundDrag](/auto-docs/core/functions/usePlaygroundDrag.md): usePlaygroundDrag(): UsePlaygroundDragReturn Returns UsePlaygroundDragReturn - [Function: useRefresh](/auto-docs/core/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (v?): void Parameters Returns void - [Function: useService](/auto-docs/core/functions/useService.md): useService(identifier): T 获取画布的 IOC 模块 Type parameters Parameters Returns T - [Interface: ClipboardService](/auto-docs/core/interfaces/ClipboardService.md) - [Interface: Command](/auto-docs/core/interfaces/Command-1.md) - [Interface: CommandService](/auto-docs/core/interfaces/CommandService.md): command service 执行接口 - [Interface: ConfigEntityProps](/auto-docs/core/interfaces/ConfigEntityProps.md) - [Interface: ContributionProvider](/auto-docs/core/interfaces/ContributionProvider.md) - [Interface: EditorState](/auto-docs/core/interfaces/EditorState-1.md): 编辑态 - [Interface: EditorStateChangeEvent](/auto-docs/core/interfaces/EditorStateChangeEvent.md) - [Interface: EntityDataChangedEvent](/auto-docs/core/interfaces/EntityDataChangedEvent.md) - [Interface: EntityDataRegistry](/auto-docs/core/interfaces/EntityDataRegistry.md) - [Interface: EntityJSON](/auto-docs/core/interfaces/EntityJSON.md): 持久化数据 - [Interface: EntityManagerContribution](/auto-docs/core/interfaces/EntityManagerContribution.md) - [Interface: EntityOpts](/auto-docs/core/interfaces/EntityOpts.md) - [Interface: EntityRegistry](/auto-docs/core/interfaces/EntityRegistry.md): 注册类 - [Interface: LayerEntitiesSelector](/auto-docs/core/interfaces/LayerEntitiesSelector.md) - [Interface: LayerOptions](/auto-docs/core/interfaces/LayerOptions.md) - [Interface: LayerRegistry

](/auto-docs/core/interfaces/LayerRegistry.md) - [Interface: LoggerProps](/auto-docs/core/interfaces/LoggerProps.md) - [Interface: NodeSchema](/auto-docs/core/interfaces/NodeSchema.md) - [Interface: OriginSchema](/auto-docs/core/interfaces/OriginSchema.md) - [Interface: PipelineDimension](/auto-docs/core/interfaces/PipelineDimension.md) - [Interface: PipelineEntities](/auto-docs/core/interfaces/PipelineEntities.md): 注入到 Layer 中的实体选择器 - [Interface: PipelineEventRegsiter](/auto-docs/core/interfaces/PipelineEventRegsiter.md) - [Interface: PlaygroundConfig](/auto-docs/core/interfaces/PlaygroundConfig.md): 画布配置 - [Interface: PlaygroundConfigEntityData](/auto-docs/core/interfaces/PlaygroundConfigEntityData.md) - [Interface: PlaygroundConfigRevealOpts](/auto-docs/core/interfaces/PlaygroundConfigRevealOpts.md) - [Interface: PlaygroundContainerFactory](/auto-docs/core/interfaces/PlaygroundContainerFactory.md) - [Interface: PlaygroundContribution](/auto-docs/core/interfaces/PlaygroundContribution.md) - [Interface: PlaygroundDragEntitiesOpts](/auto-docs/core/interfaces/PlaygroundDragEntitiesOpts.md) - [Interface: PlaygroundDragEvent](/auto-docs/core/interfaces/PlaygroundDragEvent.md) - [Interface: PlaygroundDragOptions](/auto-docs/core/interfaces/PlaygroundDragOptions.md) - [Interface: PlaygroundLayerOptions](/auto-docs/core/interfaces/PlaygroundLayerOptions.md) - [Interface: PlaygroundReactProviderProps](/auto-docs/core/interfaces/PlaygroundReactProviderProps.md) - [Interface: PlaygroundReactRendererProps](/auto-docs/core/interfaces/PlaygroundReactRendererProps.md) - [Interface: PluginBindConfig](/auto-docs/core/interfaces/PluginBindConfig.md) - [Interface: PluginConfig](/auto-docs/core/interfaces/PluginConfig.md) - [Interface: PluginContext](/auto-docs/core/interfaces/PluginContext.md) - [Interface: PluginsProvider](/auto-docs/core/interfaces/PluginsProvider.md) - [Interface: PositionSchema](/auto-docs/core/interfaces/PositionSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: RegistryInit](/auto-docs/core/interfaces/RegistryInit.md) - [Interface: RegistryValueGetter](/auto-docs/core/interfaces/RegistryValueGetter.md) - [Interface: ScaleSchema](/auto-docs/core/interfaces/ScaleSchema.md) - [Interface: ScrollIntoViewOpts](/auto-docs/core/interfaces/ScrollIntoViewOpts.md) - [Interface: SizeSchema](/auto-docs/core/interfaces/SizeSchema-1.md) - [Interface: SkewSchema](/auto-docs/core/interfaces/SkewSchema.md) - [Interface: StorageService](/auto-docs/core/interfaces/StorageService.md): 存储数据到缓存 - [Interface: TransformNodeSchema](/auto-docs/core/interfaces/TransformNodeSchema.md) - [Interface: TransformSchema](/auto-docs/core/interfaces/TransformSchema-1.md) - [Interface: TweenOpts](/auto-docs/core/interfaces/TweenOpts.md) - [Namespace: Bounds](/auto-docs/core/modules/Bounds.md) - [Namespace: Command](/auto-docs/core/modules/Command.md) - [Namespace: EditorState](/auto-docs/core/modules/EditorState.md) - [Namespace: Entity](/auto-docs/core/modules/Entity.md) - [Namespace: MouseTouchEvent](/auto-docs/core/modules/MouseTouchEvent.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: PlaygroundDrag](/auto-docs/core/modules/PlaygroundDrag.md) - [Namespace: PlaygroundMockTools](/auto-docs/core/modules/PlaygroundMockTools.md): 画布测试工具 Example - [Namespace: SizeSchema](/auto-docs/core/modules/SizeSchema.md) - [Namespace: TransformData](/auto-docs/core/modules/TransformData.md) - [Namespace: TransformSchema](/auto-docs/core/modules/TransformSchema.md) - [Type alias: Cursors](/auto-docs/core/types/Cursors.md): Cursors: Record - [Type alias: EntityDataInjector](/auto-docs/core/types/EntityDataInjector.md): EntityDataInjector: () => OPTS Type declaration (): OPTS Type parameters Returns OPTS - [Type alias: EntityDataProps](/auto-docs/core/types/EntityDataProps.md): EntityDataProps: E["data"] Type parameters - [Type alias: OpacitySchema](/auto-docs/core/types/OpacitySchema.md): OpacitySchema: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipeEventName](/auto-docs/core/types/PipeEventName.md): PipeEventName: string - [Type alias: PipeSupportEvent](/auto-docs/core/types/PipeSupportEvent.md): PipeSupportEvent: MouseEvent | DragEvent | KeyboardEvent | UIEvent | TouchEvent | any - [Type alias: PipelineEventHandler](/auto-docs/core/types/PipelineEventHandler.md): PipelineEventHandler: (event: PipeSupportEvent) => boolean | undefined Type declaration (event): boolean | undefined Parameters Returns boolean | undefined - [Type alias: PipelineLayerFactory](/auto-docs/core/types/PipelineLayerFactory.md): PipelineLayerFactory: (layerRegistry: LayerRegistry, layerOptions?: any) => Layer Type declaration (layerRegistry, layerOptions?): Layer Parameters Returns Layer - [Type alias: PlaygroundContext](/auto-docs/core/types/PlaygroundContext.md): PlaygroundContext: any - [Type alias: PlaygroundContextProvider](/auto-docs/core/types/PlaygroundContextProvider.md): PlaygroundContextProvider: () => any Type declaration (): any Returns any - [Type alias: PlaygroundInteractiveType](/auto-docs/core/types/PlaygroundInteractiveType.md): PlaygroundInteractiveType: "MOUSE" | "PAD" MOUSE: 鼠标友好模式，鼠标左键拖动画布，滚动缩放 (适合 windows ) PAD: 双指同向移动拖动，双指张开捏合缩放 (适合 mac) - [Type alias: PlaygroundScrollLimitFn](/auto-docs/core/types/PlaygroundScrollLimitFn.md): PlaygroundScrollLimitFn: (scroll: { scrollX: number ; scrollY: number }) => { scrollX: number ; scrollY: number } Type declaration (scroll): Object Parameters Returns Object - [Type alias: Plugin](/auto-docs/core/types/Plugin.md): Plugin: Object Type parameters Type declaration - [Type alias: PluginCreator](/auto-docs/core/types/PluginCreator.md): PluginCreator: (opts: Options) => Plugin Type parameters Type declaration (opts): Plugin Parameters Returns Plugin - [Type alias: ProtectWheelArea](/auto-docs/core/types/ProtectWheelArea.md): ProtectWheelArea: (dom: Element) => boolean Type declaration (dom): boolean Parameters Returns boolean - [Type alias: RotationSchema](/auto-docs/core/types/RotationSchema.md): RotationSchema: number - [Variable: ClipboardService](/auto-docs/core/variables/ClipboardService-1.md): Const ClipboardService: typeof ClipboardService - [Variable: CommandService](/auto-docs/core/variables/CommandService-1.md): Const CommandService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: ContributionProvider](/auto-docs/core/variables/ContributionProvider-1.md): Const ContributionProvider: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: EDITOR_STATE_DEFAULTS](/auto-docs/core/variables/EDITOR_STATE_DEFAULTS.md): Const EDITOR_STATE_DEFAULTS: EditorState[] - [Variable: ENTITIES_BY_DATA_DECO_KEY](/auto-docs/core/variables/ENTITIES_BY_DATA_DECO_KEY.md): Const ENTITIES_BY_DATA_DECO_KEY: typeof ENTITIES_BY_DATA_DECO_KEY - [Variable: ENTITIES_DECO_KEY](/auto-docs/core/variables/ENTITIES_DECO_KEY.md): Const ENTITIES_DECO_KEY: typeof ENTITIES_DECO_KEY - [Variable: STATE_GRAB](/auto-docs/core/variables/EditorState.STATE_GRAB.md): EditorState.STATE_GRAB Const STATE_GRAB: EditorState - [Variable: STATE_MOUSE_FRIENDLY_SELECT](/auto-docs/core/variables/EditorState.STATE_MOUSE_FRIENDLY_SELECT.md): EditorState.STATE_MOUSE_FRIENDLY_SELECT Const STATE_MOUSE_FRIENDLY_SELECT: EditorState 鼠标友好模式状态 - [Variable: STATE_SELECT](/auto-docs/core/variables/EditorState.STATE_SELECT.md): EditorState.STATE_SELECT Const STATE_SELECT: EditorState - [Variable: EntityManagerContribution](/auto-docs/core/variables/EntityManagerContribution-1.md): Const EntityManagerContribution: typeof EntityManagerContribution - [Variable: FLUSH_LAYER_REQUEST](/auto-docs/core/variables/FLUSH_LAYER_REQUEST.md): Const FLUSH_LAYER_REQUEST: "flush-layer-request" - [Variable: LayerOptions](/auto-docs/core/variables/LayerOptions-1.md): LayerOptions: typeof LayerOptions - [Variable: LazyInjectContext](/auto-docs/core/variables/LazyInjectContext.md): Const LazyInjectContext: typeof LazyInjectContext - [Variable: OpacitySchemaDecoration](/auto-docs/core/variables/OpacitySchemaDecoration.md): Const OpacitySchemaDecoration: SchemaDecoration - [Variable: OriginSchemaDecoration](/auto-docs/core/variables/OriginSchemaDecoration.md): Const OriginSchemaDecoration: SchemaDecoration - [Variable: PipelineLayerFactory](/auto-docs/core/variables/PipelineLayerFactory-1.md): Const PipelineLayerFactory: typeof PipelineLayerFactory - [Variable: PlaygroundConfig](/auto-docs/core/variables/PlaygroundConfig-1.md): Const PlaygroundConfig: typeof PlaygroundConfig - [Variable: PlaygroundContainerFactory](/auto-docs/core/variables/PlaygroundContainerFactory-1.md): Const PlaygroundContainerFactory: typeof PlaygroundContainerFactory - [Variable: PlaygroundContainerModule](/auto-docs/core/variables/PlaygroundContainerModule.md): Const PlaygroundContainerModule: ContainerModule - [Variable: PlaygroundContext](/auto-docs/core/variables/PlaygroundContext-1.md): Const PlaygroundContext: typeof PlaygroundContext 会被注入到 layer 层，可以在使用的时候替换它 - [Variable: PlaygroundContextProvider](/auto-docs/core/variables/PlaygroundContextProvider-1.md): Const PlaygroundContextProvider: typeof PlaygroundContextProvider - [Variable: PlaygroundContribution](/auto-docs/core/variables/PlaygroundContribution-1.md): Const PlaygroundContribution: typeof PlaygroundContribution - [Variable: PlaygroundEntityContext](/auto-docs/core/variables/PlaygroundEntityContext.md): Const PlaygroundEntityContext: Context 当前 entity - [Variable: PlaygroundReactContainerContext](/auto-docs/core/variables/PlaygroundReactContainerContext.md): Const PlaygroundReactContainerContext: Context - [Variable: PlaygroundReactContext](/auto-docs/core/variables/PlaygroundReactContext.md): Const PlaygroundReactContext: Context - [Variable: PlaygroundReactRefContext](/auto-docs/core/variables/PlaygroundReactRefContext.md): Const PlaygroundReactRefContext: Context - [Variable: Plugin](/auto-docs/core/variables/Plugin-1.md): Const Plugin: typeof Plugin - [Variable: PluginContext](/auto-docs/core/variables/PluginContext-1.md): PluginContext: typeof PluginContext - [Variable: PositionSchemaDecoration](/auto-docs/core/variables/PositionSchemaDecoration.md): Const PositionSchemaDecoration: SchemaDecoration - [Variable: ProtectWheelArea](/auto-docs/core/variables/ProtectWheelArea-1.md): Const ProtectWheelArea: typeof ProtectWheelArea 保护区域不被画布劫持滚动事件 - [Variable: RotationSchemaDecoration](/auto-docs/core/variables/RotationSchemaDecoration.md): Const RotationSchemaDecoration: SchemaDecoration - [Variable: SCALE_WIDTH](/auto-docs/core/variables/SCALE_WIDTH.md): Const SCALE_WIDTH: 0 - [Variable: ScaleSchemaDecoration](/auto-docs/core/variables/ScaleSchemaDecoration.md): Const ScaleSchemaDecoration: SchemaDecoration - [Variable: SizeSchemaDecoration](/auto-docs/core/variables/SizeSchemaDecoration.md): Const SizeSchemaDecoration: SchemaDecoration - [Variable: SkewSchemaDecoration](/auto-docs/core/variables/SkewSchemaDecoration.md): Const SkewSchemaDecoration: SchemaDecoration - [Variable: StorageService](/auto-docs/core/variables/StorageService-1.md): Const StorageService: typeof StorageService - [Variable: TransformSchemaDecoration](/auto-docs/core/variables/TransformSchemaDecoration.md): Const TransformSchemaDecoration: SchemaDecoration - [Class: FlowDocument](/auto-docs/document/classes/FlowDocument.md): 流程整个文档数据 - [Class: FlowDocumentConfig](/auto-docs/document/classes/FlowDocumentConfig.md): 用于文档扩展配置 - [Class: FlowDocumentTransformerEntity](/auto-docs/document/classes/FlowDocumentTransformerEntity.md): 用于通知所有 layer 更新 - [Class: FlowDragService](/auto-docs/document/classes/FlowDragService.md): 拖拽相关操作 外部实现抽象类 - [Class: FlowGroupController](/auto-docs/document/classes/FlowGroupController.md): 分组控制器 - [Class: FlowGroupService](/auto-docs/document/classes/FlowGroupService.md) - [Class: FlowNodeEntity](/auto-docs/document/classes/FlowNodeEntity-1.md) - [Class: FlowNodeRenderData](/auto-docs/document/classes/FlowNodeRenderData.md): 节点渲染状态相关数据 - [Class: FlowNodeTransformData](/auto-docs/document/classes/FlowNodeTransformData.md) - [Class: FlowNodeTransitionData](/auto-docs/document/classes/FlowNodeTransitionData.md) - [Class: FlowOperationBaseServiceImpl](/auto-docs/document/classes/FlowOperationBaseServiceImpl.md): 操作服务 - [Class: FlowRendererStateEntity](/auto-docs/document/classes/FlowRendererStateEntity.md): 渲染相关的全局状态管理 - [Class: FlowVirtualTree](/auto-docs/document/classes/FlowVirtualTree-1.md): 存储节点的 tree 结构信息 策略是 "重修改轻查询"，即修改时候做的事情更多，查询都通过指针来操作 - [Enumeration: DRAGGING_TYPE](/auto-docs/document/enums/DRAGGING_TYPE.md): 拖拽种类枚举 节点拖拽分支拖拽 - [Enumeration: FlowDocumentConfigEnum](/auto-docs/document/enums/FlowDocumentConfigEnum.md) - [Enumeration: FlowLayoutDefault](/auto-docs/document/enums/FlowLayoutDefault-1.md) - [Enumeration: FlowNodeBaseType](/auto-docs/document/enums/FlowNodeBaseType.md) - [Enumeration: FlowNodeSplitType](/auto-docs/document/enums/FlowNodeSplitType.md) - [Enumeration: FlowTransitionLabelEnum](/auto-docs/document/enums/FlowTransitionLabelEnum.md) - [Enumeration: FlowTransitionLineEnum](/auto-docs/document/enums/FlowTransitionLineEnum.md) - [Enumeration: LABEL_SIDE_TYPE](/auto-docs/document/enums/LABEL_SIDE_TYPE.md): 拖拽分支 Adder、Line 类型 - [Enumeration: OperationType](/auto-docs/document/enums/OperationType.md) - [Function: DEFAULT_FLOW_NODE_META](/auto-docs/document/functions/DEFAULT_FLOW_NODE_META.md): DEFAULT_FLOW_NODE_META(nodeType, document): FlowNodeMeta 默认 meta 配置 Parameters Returns FlowNodeMeta - [Function: isVertical](/auto-docs/document/functions/FlowLayoutDefault.isVertical.md): FlowLayoutDefault.isVertical isVertical(layout): boolean Parameters Returns boolean - [Function: is](/auto-docs/document/functions/FlowNodeEntity.is.md): FlowNodeEntity.is is(obj): obj is FlowNodeEntity Parameters Returns obj is FlowNodeEntity - [Function: extend](/auto-docs/document/functions/FlowNodeRegistry.extend.md): FlowNodeRegistry.extend extend(registry, extendRegistries): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: merge](/auto-docs/document/functions/FlowNodeRegistry.merge.md): FlowNodeRegistry.merge merge(registry1, registry2, finalType): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: mergeChildRegistries](/auto-docs/document/functions/FlowNodeRegistry.mergeChildRegistries.md): FlowNodeRegistry.mergeChildRegistries mergeChildRegistries(r1?, r2?): FlowNodeRegistry[] Parameters Returns FlowNodeRegistry[] - [Function: drawLineToBottom](/auto-docs/document/functions/drawLineToBottom.md): drawLineToBottom(transition): { from: IPoint = currentOutput; to: IPoint = parentOutput; type: FlowTransitionLineEnum = FlowTransitionLineEnum.STRAIGHT_LINE }[] Parameters Returns { from: IPoint = currentOutput; to: IPoint = parentOutput; type: FlowTransitionLineEnum = FlowTransitionLineEnum.STRAIGHT_LINE }[] - [Function: drawLineToNext](/auto-docs/document/functions/drawLineToNext.md): drawLineToNext(transition): { from: IPoint = currentOutput; to: IPoint = transform.next.inputPoint; type: FlowTransitionLineEnum = FlowTransitionLineEnum.STRAIGHT_LINE }[] Parameters Returns { from: IPoint = currentOutput; to: IPoint = transform.next.inputPoint; type: FlowTransitionLineEnum = FlowTransitionLineEnum.STRAIGHT_LINE }[] - [Function: getDefaultSpacing](/auto-docs/document/functions/getDefaultSpacing.md): getDefaultSpacing(node, key, defaultSpacing?): any Parameters Returns any - [Interface: AddBlockConfig](/auto-docs/document/interfaces/AddBlockConfig.md): 添加block时的配置 - [Interface: AddBlockOperation](/auto-docs/document/interfaces/AddBlockOperation.md) - [Interface: AddChildNodeOperation](/auto-docs/document/interfaces/AddChildNodeOperation.md) - [Interface: AddFromNodeOperation](/auto-docs/document/interfaces/AddFromNodeOperation.md) - [Interface: AddNodeOperation](/auto-docs/document/interfaces/AddNodeOperation.md) - [Interface: AddNodesOperation](/auto-docs/document/interfaces/AddNodesOperation.md) - [Interface: AddOrDeleteBlockValue](/auto-docs/document/interfaces/AddOrDeleteBlockValue.md) - [Interface: AddOrDeleteChildNodeValue](/auto-docs/document/interfaces/AddOrDeleteChildNodeValue.md) - [Interface: AddOrDeleteFromNodeOperationValue](/auto-docs/document/interfaces/AddOrDeleteFromNodeOperationValue.md) - [Interface: AddOrDeleteNodeOperationValue](/auto-docs/document/interfaces/AddOrDeleteNodeOperationValue.md) - [Interface: AddOrDeleteNodeValue](/auto-docs/document/interfaces/AddOrDeleteNodeValue.md) - [Interface: AddOrDeleteNodesOperationValue](/auto-docs/document/interfaces/AddOrDeleteNodesOperationValue.md) - [Interface: AdderProps](/auto-docs/document/interfaces/AdderProps.md) - [Interface: CollapseAdderProps](/auto-docs/document/interfaces/CollapseAdderProps.md) - [Interface: CollapseProps](/auto-docs/document/interfaces/CollapseProps.md) - [Interface: CreateGroupOperation](/auto-docs/document/interfaces/CreateGroupOperation.md) - [Interface: CustomLabelProps](/auto-docs/document/interfaces/CustomLabelProps.md) - [Interface: DeleteBlockOperation](/auto-docs/document/interfaces/DeleteBlockOperation.md) - [Interface: DeleteChildNodeOperation](/auto-docs/document/interfaces/DeleteChildNodeOperation.md) - [Interface: DeleteFromNodeOperation](/auto-docs/document/interfaces/DeleteFromNodeOperation.md) - [Interface: DeleteNodeOperation](/auto-docs/document/interfaces/DeleteNodeOperation.md) - [Interface: DeleteNodesOperation](/auto-docs/document/interfaces/DeleteNodesOperation.md) - [Interface: DragNodeProps](/auto-docs/document/interfaces/DragNodeProps.md) - [Interface: FlowDocumentContribution](/auto-docs/document/interfaces/FlowDocumentContribution.md) - [Interface: FlowDocumentOptions](/auto-docs/document/interfaces/FlowDocumentOptions.md): 流程画布配置 - [Interface: FlowGroupJSON](/auto-docs/document/interfaces/FlowGroupJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowLayout](/auto-docs/document/interfaces/FlowLayout.md): 流程布局算法 - [Interface: FlowLayoutContribution](/auto-docs/document/interfaces/FlowLayoutContribution.md) - [Interface: FlowNodeEntityConfig](/auto-docs/document/interfaces/FlowNodeEntityConfig.md) - [Interface: FlowNodeInitData](/auto-docs/document/interfaces/FlowNodeInitData.md) - [Interface: FlowNodeJSON](/auto-docs/document/interfaces/FlowNodeJSON.md): Flow node json data - [Interface: FlowNodeMeta](/auto-docs/document/interfaces/FlowNodeMeta.md): 节点渲染相关配置信息，可扩展 - [Interface: FlowNodeRegistry](/auto-docs/document/interfaces/FlowNodeRegistry-1.md): 节点注册 - [Interface: FlowNodeRenderSchema](/auto-docs/document/interfaces/FlowNodeRenderSchema.md) - [Interface: FlowNodeTransformSchema](/auto-docs/document/interfaces/FlowNodeTransformSchema.md) - [Interface: FlowNodeTransitionSchema](/auto-docs/document/interfaces/FlowNodeTransitionSchema.md) - [Interface: FlowOperationBaseService](/auto-docs/document/interfaces/FlowOperationBaseService.md) - [Interface: FlowTransitionLabel](/auto-docs/document/interfaces/FlowTransitionLabel.md) - [Interface: FlowTransitionLine](/auto-docs/document/interfaces/FlowTransitionLine.md) - [Interface: NodeInfo](/auto-docs/document/interfaces/FlowVirtualTree.NodeInfo.md): FlowVirtualTree.NodeInfo - [Interface: MoveBlockOperation](/auto-docs/document/interfaces/MoveBlockOperation.md) - [Interface: MoveChildNodesOperation](/auto-docs/document/interfaces/MoveChildNodesOperation.md) - [Interface: MoveChildNodesOperationValue](/auto-docs/document/interfaces/MoveChildNodesOperationValue.md) - [Interface: MoveNodeConfig](/auto-docs/document/interfaces/MoveNodeConfig.md): 移动节点时的配置 - [Interface: MoveNodesOperation](/auto-docs/document/interfaces/MoveNodesOperation.md) - [Interface: MoveNodesOperationValue](/auto-docs/document/interfaces/MoveNodesOperationValue.md) - [Interface: OnNodeAddEvent](/auto-docs/document/interfaces/OnNodeAddEvent.md): 节点添加事件 - [Interface: OnNodeMoveEvent](/auto-docs/document/interfaces/OnNodeMoveEvent.md): 节点移动事件 - [Interface: UngroupOperation](/auto-docs/document/interfaces/UngroupOperation.md) - [Interface: Vertex](/auto-docs/document/interfaces/Vertex.md) - [Interface: createOrUngroupValue](/auto-docs/document/interfaces/createOrUngroupValue.md) - [Namespace: FlowLayoutDefault](/auto-docs/document/modules/FlowLayoutDefault.md) - [Namespace: FlowNodeEntity](/auto-docs/document/modules/FlowNodeEntity.md) - [Namespace: FlowNodeRegistry](/auto-docs/document/modules/FlowNodeRegistry.md) - [Namespace: FlowVirtualTree](/auto-docs/document/modules/FlowVirtualTree.md) - [Type alias: AddNodeConfig](/auto-docs/document/types/AddNodeConfig.md): AddNodeConfig: Object Type declaration - [Type alias: AddNodeData](/auto-docs/document/types/AddNodeData.md): AddNodeData: FlowNodeJSON & { hidden?: boolean ; index?: number ; originParent?: FlowNodeEntity ; parent?: FlowNodeEntity } - [Type alias: FlowDocumentJSON](/auto-docs/document/types/FlowDocumentJSON.md): FlowDocumentJSON: Object Type declaration - [Type alias: FlowDocumentProvider](/auto-docs/document/types/FlowDocumentProvider.md): FlowDocumentProvider: () => FlowDocument Type declaration (): FlowDocument Returns FlowDocument - [Type alias: FlowNodeEntityOrId](/auto-docs/document/types/FlowNodeEntityOrId.md): FlowNodeEntityOrId: string | FlowNodeEntity - [Type alias: FlowNodeType](/auto-docs/document/types/FlowNodeType.md): FlowNodeType: string | number - [Type alias: FlowOperation](/auto-docs/document/types/FlowOperation.md): FlowOperation: AddFromNodeOperation | DeleteFromNodeOperation | AddBlockOperation | DeleteBlockOperation | CreateGroupOperation | UngroupOperation | MoveNodesOperation | AddNodesOperation | DeleteNodesOperation | MoveBlockOperation | AddChildNodeOperation | DeleteChildNodeOperation | MoveChildNodesOperation | AddNodeOperation | DeleteNodeOperation - [Type alias: MoveBlockOperationValue](/auto-docs/document/types/MoveBlockOperationValue.md): MoveBlockOperationValue: Object Type declaration - [Variable: ConstantKeys](/auto-docs/document/variables/ConstantKeys.md): Const ConstantKeys: Object 支持外部 constants 自定义的 key 枚举 Type declaration - [Variable: DEFAULT_SIZE](/auto-docs/document/variables/DEFAULT_SIZE.md): Const DEFAULT_SIZE: Object 默认节点大小 Type declaration - [Variable: DEFAULT_SPACING](/auto-docs/document/variables/DEFAULT_SPACING.md): Const DEFAULT_SPACING: Object 默认一些间隔参数 Type declaration - [Variable: DefaultSpacingKey](/auto-docs/document/variables/DefaultSpacingKey.md): Const DefaultSpacingKey: Object spacing default key 值 Type declaration - [Variable: FLOW_DEFAULT_HIDDEN_TYPES](/auto-docs/document/variables/FLOW_DEFAULT_HIDDEN_TYPES.md): Const FLOW_DEFAULT_HIDDEN_TYPES: FlowNodeType[] - [Variable: FlowDocumentConfigDefaultData](/auto-docs/document/variables/FlowDocumentConfigDefaultData.md): Const FlowDocumentConfigDefaultData: typeof FlowDocumentConfigDefaultData - [Variable: FlowDocumentContainerModule](/auto-docs/document/variables/FlowDocumentContainerModule.md): Const FlowDocumentContainerModule: ContainerModule - [Variable: FlowDocumentContribution](/auto-docs/document/variables/FlowDocumentContribution-1.md): Const FlowDocumentContribution: typeof FlowDocumentContribution - [Variable: FlowDocumentOptions](/auto-docs/document/variables/FlowDocumentOptions-1.md): Const FlowDocumentOptions: typeof FlowDocumentOptions - [Variable: FlowDocumentOptionsDefault](/auto-docs/document/variables/FlowDocumentOptionsDefault.md): Const FlowDocumentOptionsDefault: FlowDocumentOptions - [Variable: FlowDocumentProvider](/auto-docs/document/variables/FlowDocumentProvider-1.md): FlowDocumentProvider: typeof FlowDocumentProvider - [Variable: FlowLayout](/auto-docs/document/variables/FlowLayout-1.md): Const FlowLayout: typeof FlowLayout - [Variable: FlowLayoutContribution](/auto-docs/document/variables/FlowLayoutContribution-1.md): Const FlowLayoutContribution: typeof FlowLayoutContribution - [Variable: FlowOperationBaseService](/auto-docs/document/variables/FlowOperationBaseService-1.md): FlowOperationBaseService: typeof FlowOperationBaseService - [Variable: FixedLayoutContainerModule](/auto-docs/fixed-layout-core/variables/FixedLayoutContainerModule.md): Const FixedLayoutContainerModule: ContainerModule - [Variable: FixedLayoutRegistries](/auto-docs/fixed-layout-core/variables/FixedLayoutRegistries.md): Const FixedLayoutRegistries: Object Type declaration - [Variable: SlotSpacingKey](/auto-docs/fixed-layout-core/variables/SlotSpacingKey.md): Const SlotSpacingKey: Object Type declaration - [Class: WorkflowDocument](/auto-docs/free-layout-core/classes/WorkflowDocument.md) - [Class: WorkflowDragService](/auto-docs/free-layout-core/classes/WorkflowDragService.md) - [Class: WorkflowHoverService](/auto-docs/free-layout-core/classes/WorkflowHoverService.md): hover 状态管理 - [Class: WorkflowLineEntity](/auto-docs/free-layout-core/classes/WorkflowLineEntity.md): 线条 - [Class: WorkflowLineRenderData](/auto-docs/free-layout-core/classes/WorkflowLineRenderData.md) - [Class: WorkflowLinesManager](/auto-docs/free-layout-core/classes/WorkflowLinesManager.md): 线条管理 - [Class: WorkflowNodeLinesData](/auto-docs/free-layout-core/classes/WorkflowNodeLinesData.md): 节点的关联的线条 - [Class: WorkflowNodePortsData](/auto-docs/free-layout-core/classes/WorkflowNodePortsData.md): 节点的点位信息 portsData 只监听点位的数目和类型，不监听点位的 position 变化 - [Class: WorkflowOperationBaseServiceImpl](/auto-docs/free-layout-core/classes/WorkflowOperationBaseServiceImpl.md) - [Class: WorkflowPortEntity](/auto-docs/free-layout-core/classes/WorkflowPortEntity.md): Port 抽象的 Entity - [Class: WorkflowResetLayoutService](/auto-docs/free-layout-core/classes/WorkflowResetLayoutService.md): 重置布局服务 - [Class: WorkflowSelectService](/auto-docs/free-layout-core/classes/WorkflowSelectService.md) - [Enumeration: EditorCursorState](/auto-docs/free-layout-core/enums/EditorCursorState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: InteractiveType](/auto-docs/free-layout-core/enums/InteractiveType.md) - [Enumeration: LineColors](/auto-docs/free-layout-core/enums/LineColors.md) - [Enumeration: LineType](/auto-docs/free-layout-core/enums/LineType.md) - [Enumeration: WorkflowCommands](/auto-docs/free-layout-core/enums/WorkflowCommands.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: WorkflowContentChangeType](/auto-docs/free-layout-core/enums/WorkflowContentChangeType.md) - [Function: bindConfigEntity](/auto-docs/free-layout-core/functions/bindConfigEntity.md): bindConfigEntity(bind, entityRegistry): void 让 entity 可以注入到类中 Parameters Returns void Example - [Function: buildGroupJSON](/auto-docs/free-layout-core/functions/buildGroupJSON.md): buildGroupJSON(json): WorkflowJSON Parameters Returns WorkflowJSON - [Function: compose](/auto-docs/free-layout-core/functions/compose.md): compose(...fns): Func Type parameters Parameters Returns Func - [Function: composeAsync](/auto-docs/free-layout-core/functions/composeAsync.md): composeAsync(...fns): FuncPromise Type parameters Parameters Returns FuncPromise - [Function: delay](/auto-docs/free-layout-core/functions/delay.md): delay(ms, token?): Promise Parameters Returns Promise resolves after a specified number of milliseconds Throws cancelled if a given token is cancelled before a specified number of milliseconds - [Function: domReactToBounds](/auto-docs/free-layout-core/functions/domReactToBounds.md): domReactToBounds(react): Rectangle Parameters Returns Rectangle - [Function: fitView](/auto-docs/free-layout-core/functions/fitView.md): fitView(doc, playgroundConfig, easing?): Promise Parameters Returns Promise - [Function: getAntiOverlapPosition](/auto-docs/free-layout-core/functions/getAntiOverlapPosition.md): getAntiOverlapPosition(doc, position, containerNode?): IPoint 获取没有碰撞的位置 距离很小时，xy 各偏移 30 Parameters Returns IPoint - [Function: getLineCenter](/auto-docs/free-layout-core/functions/getLineCenter.md): getLineCenter(from, to, bbox, linePadding): LineCenterPoint Parameters Returns LineCenterPoint - [Function: getPortEntityId](/auto-docs/free-layout-core/functions/getPortEntityId.md): getPortEntityId(node, portType, portID?): string Parameters Returns string - [Function: getPortEntityIdByNodeId](/auto-docs/free-layout-core/functions/getPortEntityIdByNodeId.md): getPortEntityIdByNodeId(nodeId, portType, portID?): string Parameters Returns string - [Function: nanoid](/auto-docs/free-layout-core/functions/nanoid.md): nanoid(n?): string Parameters Returns string - [Function: useConfigEntity](/auto-docs/free-layout-core/functions/useConfigEntity.md): useConfigEntity(entityRegistry, listenChange?): T 获取 config entity Type parameters Parameters Returns T - [Function: useCurrentDomNode](/auto-docs/free-layout-core/functions/useCurrentDomNode.md): useCurrentDomNode(): HTMLDivElement 获取当前渲染的 dom 节点 Returns HTMLDivElement - [Function: useCurrentEntity](/auto-docs/free-layout-core/functions/useCurrentEntity.md): useCurrentEntity(): WorkflowNodeEntity 获取当前节点 Returns WorkflowNodeEntity - [Function: useEntities](/auto-docs/free-layout-core/functions/useEntities.md): useEntities(entityRegistry): T[] 获取 entities 并监听变化 Type parameters Parameters Returns T[] Deprecated - [Function: useEntityDataFromContext](/auto-docs/free-layout-core/functions/useEntityDataFromContext.md): useEntityDataFromContext(dataRegistry, listenChange?): T 从上下 PlaygroundEntityContext 获取 entity data 并监听变化 (默认不监听) Type parameters Parameters Returns T - [Function: useEntityFromContext](/auto-docs/free-layout-core/functions/useEntityFromContext.md): useEntityFromContext(listenChange?): T 从上下 PlaygroundEntityContext 获取 entity 并监听变化(默认不监听) Type parameters Parameters Returns T - [Function: useListenEvents](/auto-docs/free-layout-core/functions/useListenEvents.md): useListenEvents(...events): void 监听 event 事件变化 Parameters Returns void - [Function: useNodeRender](/auto-docs/free-layout-core/functions/useNodeRender.md): useNodeRender(nodeFromProps?): NodeRenderReturnType Parameters Returns NodeRenderReturnType - [Function: usePlayground](/auto-docs/free-layout-core/functions/usePlayground.md): usePlayground(): Playground 获取 playground Returns Playground - [Function: usePlaygroundContainer](/auto-docs/free-layout-core/functions/usePlaygroundContainer.md): usePlaygroundContainer(): interfaces.Container 获取 playground inversify container Returns interfaces.Container - [Function: usePlaygroundContext](/auto-docs/free-layout-core/functions/usePlaygroundContext.md): usePlaygroundContext(): T 获取 playground context 数据 Type parameters Returns T - [Function: usePlaygroundReadonlyState](/auto-docs/free-layout-core/functions/usePlaygroundReadonlyState.md): usePlaygroundReadonlyState(listenChange?): boolean 获取 readonly 状态 Parameters Returns boolean - [Function: useRefresh](/auto-docs/free-layout-core/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (v?): void Parameters Returns void - [Function: useService](/auto-docs/free-layout-core/functions/useService.md): useService(identifier): T 获取画布的 IOC 模块 Type parameters Parameters Returns T - [Function: useWorkflowDocument](/auto-docs/free-layout-core/functions/useWorkflowDocument.md): useWorkflowDocument(): WorkflowDocument Returns WorkflowDocument - [Interface: HoverPosition](/auto-docs/free-layout-core/interfaces/HoverPosition.md) - [Interface: LineCenterPoint](/auto-docs/free-layout-core/interfaces/LineCenterPoint.md) - [Interface: LineColor](/auto-docs/free-layout-core/interfaces/LineColor.md) - [Interface: LineEventProps](/auto-docs/free-layout-core/interfaces/LineEventProps.md) - [Interface: LinePoint](/auto-docs/free-layout-core/interfaces/LinePoint.md) - [Interface: LinePosition](/auto-docs/free-layout-core/interfaces/LinePosition.md) - [Interface: NodePostionUpdateEvent](/auto-docs/free-layout-core/interfaces/NodePostionUpdateEvent.md) - [Interface: NodeRenderReturnType](/auto-docs/free-layout-core/interfaces/NodeRenderReturnType.md) - [Interface: NodesDragEndEvent](/auto-docs/free-layout-core/interfaces/NodesDragEndEvent.md) - [Interface: NodesDragStartEvent](/auto-docs/free-layout-core/interfaces/NodesDragStartEvent.md) - [Interface: NodesDraggingEvent](/auto-docs/free-layout-core/interfaces/NodesDraggingEvent.md) - [Interface: URLParams](/auto-docs/free-layout-core/interfaces/URLParams.md) - [Interface: WorkflowContentChangeEvent](/auto-docs/free-layout-core/interfaces/WorkflowContentChangeEvent.md) - [Interface: WorkflowDocumentOptions](/auto-docs/free-layout-core/interfaces/WorkflowDocumentOptions.md): 线条配置 - [Interface: WorkflowEdgeJSON](/auto-docs/free-layout-core/interfaces/WorkflowEdgeJSON.md): 边数据 - [Interface: WorkflowJSON](/auto-docs/free-layout-core/interfaces/WorkflowJSON.md) - [Interface: WorkflowLineEntityOpts](/auto-docs/free-layout-core/interfaces/WorkflowLineEntityOpts.md) - [Interface: WorkflowLineInfo](/auto-docs/free-layout-core/interfaces/WorkflowLineInfo.md) - [Interface: WorkflowLinePortInfo](/auto-docs/free-layout-core/interfaces/WorkflowLinePortInfo.md) - [Interface: WorkflowLineRenderContribution](/auto-docs/free-layout-core/interfaces/WorkflowLineRenderContribution.md) - [Interface: WorkflowLineRenderDataSchema](/auto-docs/free-layout-core/interfaces/WorkflowLineRenderDataSchema.md) - [Interface: WorkflowLineUIState](/auto-docs/free-layout-core/interfaces/WorkflowLineUIState.md) - [Interface: WorkflowNodeJSON](/auto-docs/free-layout-core/interfaces/WorkflowNodeJSON.md): 节点数据 - [Interface: WorkflowNodeLines](/auto-docs/free-layout-core/interfaces/WorkflowNodeLines.md) - [Interface: WorkflowNodeMeta](/auto-docs/free-layout-core/interfaces/WorkflowNodeMeta.md): 节点 meta 信息 - [Interface: WorkflowNodeRegistry](/auto-docs/free-layout-core/interfaces/WorkflowNodeRegistry.md): 节点注册 - [Interface: WorkflowNodeRenderProps](/auto-docs/free-layout-core/interfaces/WorkflowNodeRenderProps.md) - [Interface: WorkflowOperationBaseService](/auto-docs/free-layout-core/interfaces/WorkflowOperationBaseService.md) - [Interface: WorkflowPort](/auto-docs/free-layout-core/interfaces/WorkflowPort.md) - [Interface: WorkflowPortEntityOpts](/auto-docs/free-layout-core/interfaces/WorkflowPortEntityOpts.md) - [Type alias: LinePointLocation](/auto-docs/free-layout-core/types/LinePointLocation.md): LinePointLocation: "left" | "top" | "right" | "bottom" - [Type alias: LineRenderType](/auto-docs/free-layout-core/types/LineRenderType.md): LineRenderType: LineType | string - [Type alias: NodesDragEvent](/auto-docs/free-layout-core/types/NodesDragEvent.md): NodesDragEvent: NodesDragStartEvent | NodesDraggingEvent | NodesDragEndEvent - [Type alias: OnDragLineEnd](/auto-docs/free-layout-core/types/OnDragLineEnd.md): OnDragLineEnd: (params: onDragLineEndParams) => Promise Type declaration (params): Promise Parameters Returns Promise - [Type alias: PositionMap](/auto-docs/free-layout-core/types/PositionMap.md): PositionMap: Record - [Type alias: WorkfloEntityHoverable](/auto-docs/free-layout-core/types/WorkfloEntityHoverable.md): WorkfloEntityHoverable: WorkflowEntityHoverable Deprecated - [Type alias: WorkflowDocumentProvider](/auto-docs/free-layout-core/types/WorkflowDocumentProvider.md): WorkflowDocumentProvider: () => WorkflowDocument Type declaration (): WorkflowDocument Returns WorkflowDocument - [Type alias: WorkflowEntityHoverable](/auto-docs/free-layout-core/types/WorkflowEntityHoverable.md): WorkflowEntityHoverable: WorkflowNodeEntity | WorkflowLineEntity | WorkflowPortEntity 可 Hover 的节点 类型 - [Type alias: WorkflowLineRenderContributionFactory](/auto-docs/free-layout-core/types/WorkflowLineRenderContributionFactory.md): WorkflowLineRenderContributionFactory: (entity: WorkflowLineEntity) => WorkflowLineRenderContribution & { type: LineRenderType } - [Type alias: WorkflowNodeEntity](/auto-docs/free-layout-core/types/WorkflowNodeEntity.md): WorkflowNodeEntity: FlowNodeEntity - [Type alias: WorkflowNodeFormMeta](/auto-docs/free-layout-core/types/WorkflowNodeFormMeta.md): WorkflowNodeFormMeta: FormMetaOrFormMetaGenerator | FormMeta 节点表单引擎配置 - [Type alias: WorkflowPortType](/auto-docs/free-layout-core/types/WorkflowPortType.md): WorkflowPortType: "input" | "output" - [Type alias: WorkflowPorts](/auto-docs/free-layout-core/types/WorkflowPorts.md): WorkflowPorts: WorkflowPort[] - [Type alias: WorkflowSubCanvas](/auto-docs/free-layout-core/types/WorkflowSubCanvas.md): WorkflowSubCanvas: Object 子画布配置 Type declaration - [Type alias: onDragLineEndParams](/auto-docs/free-layout-core/types/onDragLineEndParams.md): onDragLineEndParams: Object Type declaration - [Variable: LINE_HOVER_DISTANCE](/auto-docs/free-layout-core/variables/LINE_HOVER_DISTANCE.md): Const LINE_HOVER_DISTANCE: 8 - [Variable: POINT_RADIUS](/auto-docs/free-layout-core/variables/POINT_RADIUS.md): Const POINT_RADIUS: 10 - [Variable: PORT_SIZE](/auto-docs/free-layout-core/variables/PORT_SIZE.md): Const PORT_SIZE: 24 - [Variable: URLParams](/auto-docs/free-layout-core/variables/URLParams-1.md): Const URLParams: typeof URLParams - [Variable: WORKFLOW_LINE_ENTITY](/auto-docs/free-layout-core/variables/WORKFLOW_LINE_ENTITY.md): Const WORKFLOW_LINE_ENTITY: "WorkflowLineEntity" - [Variable: WorkflowDocumentContainerModule](/auto-docs/free-layout-core/variables/WorkflowDocumentContainerModule.md): Const WorkflowDocumentContainerModule: ContainerModule - [Variable: WorkflowDocumentOptions](/auto-docs/free-layout-core/variables/WorkflowDocumentOptions-1.md): Const WorkflowDocumentOptions: typeof WorkflowDocumentOptions - [Variable: WorkflowDocumentOptionsDefault](/auto-docs/free-layout-core/variables/WorkflowDocumentOptionsDefault.md): Const WorkflowDocumentOptionsDefault: WorkflowDocumentOptions - [Variable: WorkflowDocumentProvider](/auto-docs/free-layout-core/variables/WorkflowDocumentProvider-1.md): Const WorkflowDocumentProvider: typeof WorkflowDocumentProvider - [Variable: WorkflowNodeEntity](/auto-docs/free-layout-core/variables/WorkflowNodeEntity-1.md): WorkflowNodeEntity: typeof FlowNodeEntity - [Variable: WorkflowOperationBaseService](/auto-docs/free-layout-core/variables/WorkflowOperationBaseService-1.md): WorkflowOperationBaseService: typeof WorkflowOperationBaseService - [Class: FlowContextMenuLayer](/auto-docs/renderer/classes/FlowContextMenuLayer.md): 流程右键菜单 - [Class: FlowDebugLayer](/auto-docs/renderer/classes/FlowDebugLayer.md): 调试用，会绘出所有节点的边界 - [Class: FlowDragEntity](/auto-docs/renderer/classes/FlowDragEntity.md) - [Class: FlowDragLayer](/auto-docs/renderer/classes/FlowDragLayer.md): 监听节点的激活状态 - [Class: FlowLabelsLayer](/auto-docs/renderer/classes/FlowLabelsLayer.md) - [Class: FlowLinesLayer](/auto-docs/renderer/classes/FlowLinesLayer.md) - [Class: FlowNodesContentLayer](/auto-docs/renderer/classes/FlowNodesContentLayer.md): 渲染节点内容 - [Class: FlowNodesTransformLayer](/auto-docs/renderer/classes/FlowNodesTransformLayer.md): 渲染节点位置 - [Class: FlowRendererRegistry](/auto-docs/renderer/classes/FlowRendererRegistry.md) - [Class: FlowScrollBarLayer](/auto-docs/renderer/classes/FlowScrollBarLayer.md): 渲染滚动条 layer - [Class: FlowScrollLimitLayer](/auto-docs/renderer/classes/FlowScrollLimitLayer.md): 控制滚动边界 - [Class: FlowSelectConfigEntity](/auto-docs/renderer/classes/FlowSelectConfigEntity.md): 圈选节点相关数据存储 - [Class: FlowSelectorBoundsLayer](/auto-docs/renderer/classes/FlowSelectorBoundsLayer.md): 流程节点被框选后的边界区域渲染 - [Class: FlowSelectorBoxLayer](/auto-docs/renderer/classes/FlowSelectorBoxLayer.md): 流程选择框 - [Class: SelectorBoxConfigEntity](/auto-docs/renderer/classes/SelectorBoxConfigEntity.md): 选择框配置 - [Enumeration: FlowRendererCommandCategory](/auto-docs/renderer/enums/FlowRendererCommandCategory.md): 命令分类 - [Enumeration: FlowRendererComponentType](/auto-docs/renderer/enums/FlowRendererComponentType.md) - [Enumeration: FlowRendererKey](/auto-docs/renderer/enums/FlowRendererKey.md) - [Enumeration: FlowTextKey](/auto-docs/renderer/enums/FlowTextKey.md) - [Function: createLines](/auto-docs/renderer/functions/createLines.md): createLines(props): void Parameters Returns void - [Function: useBaseColor](/auto-docs/renderer/functions/useBaseColor.md): useBaseColor(): Object Returns Object - [Interface: CollisionRetType](/auto-docs/renderer/interfaces/CollisionRetType.md) - [Interface: FlowDragOptions](/auto-docs/renderer/interfaces/FlowDragOptions.md) - [Interface: FlowNodesTransformLayerOptions](/auto-docs/renderer/interfaces/FlowNodesTransformLayerOptions.md) - [Interface: FlowRendererComponent](/auto-docs/renderer/interfaces/FlowRendererComponent.md) - [Interface: FlowRendererContribution](/auto-docs/renderer/interfaces/FlowRendererContribution.md) - [Interface: FlowSelectorBoundsLayerOptions](/auto-docs/renderer/interfaces/FlowSelectorBoundsLayerOptions.md) - [Interface: FlowSelectorBoxOptions](/auto-docs/renderer/interfaces/FlowSelectorBoxOptions.md) - [Interface: ScrollBarEvents](/auto-docs/renderer/interfaces/ScrollBarEvents.md) - [Interface: ScrollBarOptions](/auto-docs/renderer/interfaces/ScrollBarOptions.md) - [Interface: SelectorBoxConfigData](/auto-docs/renderer/interfaces/SelectorBoxConfigData.md) - [Interface: SelectorBoxPopoverProps](/auto-docs/renderer/interfaces/SelectorBoxPopoverProps.md) - [Variable: FlowRendererContainerModule](/auto-docs/renderer/variables/FlowRendererContainerModule.md): Const FlowRendererContainerModule: ContainerModule - [Variable: FlowRendererContribution](/auto-docs/renderer/variables/FlowRendererContribution-1.md): Const FlowRendererContribution: typeof FlowRendererContribution - [Variable: MARK_ACTIVATED_ARROW_ID](/auto-docs/renderer/variables/MARK_ACTIVATED_ARROW_ID.md): Const MARK_ACTIVATED_ARROW_ID: "$marker_arrow_activated$" - [Variable: MARK_ARROW_ID](/auto-docs/renderer/variables/MARK_ARROW_ID.md): Const MARK_ARROW_ID: "$marker_arrow$" - [Variable: ScrollBarEvents](/auto-docs/renderer/variables/ScrollBarEvents-1.md): Const ScrollBarEvents: typeof ScrollBarEvents 滚动条点击事件监听 - [Class: ASTNode](/auto-docs/editor/classes/ASTNode.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: ASTRegisters](/auto-docs/editor/classes/ASTRegisters.md): Register the AST node to the engine. - [Class: ArrayType](/auto-docs/editor/classes/ArrayType.md): Represents an array type. - [Class: AsyncContainerModule](/auto-docs/editor/classes/AsyncContainerModule.md) - [Class: BaseExpression](/auto-docs/editor/classes/BaseExpression.md): Base class for all expressions. All other expressions should extend this class. - [Class: BaseType](/auto-docs/editor/classes/BaseType.md): Base class for all types. All other types should extend this class. - [Class: BaseVariableField](/auto-docs/editor/classes/BaseVariableField.md): Variable Field abstract class, which is the base class for VariableDeclaration and Property VariableDeclaration is used to declare a variable in a block scope.Property is used to declare a property in an object. - [Class: BooleanType](/auto-docs/editor/classes/BooleanType.md): Represents a boolean type. - [Class: CancellationTokenSource](/auto-docs/editor/classes/CancellationTokenSource.md) - [Class: Circle](/auto-docs/editor/classes/Circle.md): The Circle object is used to help draw graphics and can also be used to specify a hit area for displayObjects. - [Class: CommandRegistry](/auto-docs/editor/classes/CommandRegistry.md) - [Class: ConfigEntity](/auto-docs/editor/classes/ConfigEntity.md): 用于专门的数据配置，且是单例 - [Class: Container](/auto-docs/editor/classes/Container.md) - [Class: ContainerModule](/auto-docs/editor/classes/ContainerModule.md) - [Class: ContextMenuService](/auto-docs/editor/classes/ContextMenuService.md): 圈选右键菜单相关 service - [Class: CustomType](/auto-docs/editor/classes/CustomType.md): Represents a custom type. - [Class: DataNode](/auto-docs/editor/classes/DataNode.md): Represents a general data node with no child nodes. - [Class: DefaultClipboardService](/auto-docs/editor/classes/DefaultClipboardService.md): 剪贴板服务，一般用于管理临时的复制黏贴数据 TODO: 后续可以支持调用浏览器 - [Class: DisposableCollection](/auto-docs/editor/classes/DisposableCollection.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: DisposableImpl](/auto-docs/editor/classes/DisposableImpl.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: EditorStateConfigEntity](/auto-docs/editor/classes/EditorStateConfigEntity.md): 编辑状态管理 - [Class: Emitter](/auto-docs/editor/classes/Emitter.md) - [Class: Entity](/auto-docs/editor/classes/Entity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: EntityData](/auto-docs/editor/classes/EntityData.md): 实体的数据块 - [Class: EntityManager](/auto-docs/editor/classes/EntityManager.md): TODO registry 改成 decorator Entity 管理器，全局唯一 - [Class: EnumerateExpression](/auto-docs/editor/classes/EnumerateExpression.md): Represents an enumeration expression, which iterates over a list and returns the type of the enumerated variable. - [Class: FlowContextMenuLayer](/auto-docs/editor/classes/FlowContextMenuLayer.md): 流程右键菜单 - [Class: FlowDebugLayer](/auto-docs/editor/classes/FlowDebugLayer.md): 调试用，会绘出所有节点的边界 - [Class: FlowDocument](/auto-docs/editor/classes/FlowDocument.md): 流程整个文档数据 - [Class: FlowDocumentConfig](/auto-docs/editor/classes/FlowDocumentConfig.md): 用于文档扩展配置 - [Class: FlowDocumentTransformerEntity](/auto-docs/editor/classes/FlowDocumentTransformerEntity.md): 用于通知所有 layer 更新 - [Class: FlowDragEntity](/auto-docs/editor/classes/FlowDragEntity.md): 用于专门的数据配置，且是单例 - [Class: FlowDragLayer](/auto-docs/editor/classes/FlowDragLayer.md): 监听节点的激活状态 - [Class: FlowDragService](/auto-docs/editor/classes/FlowDragService.md): 拖拽相关操作 外部实现抽象类 - [Class: FlowEditorClient](/auto-docs/editor/classes/FlowEditorClient.md) - [Class: FlowGroupController](/auto-docs/editor/classes/FlowGroupController.md): 分组控制器 - [Class: FlowGroupService](/auto-docs/editor/classes/FlowGroupService.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowLabelsLayer](/auto-docs/editor/classes/FlowLabelsLayer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowLinesLayer](/auto-docs/editor/classes/FlowLinesLayer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowNodeEntity](/auto-docs/editor/classes/FlowNodeEntity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FlowNodeFormData](/auto-docs/editor/classes/FlowNodeFormData.md): 实体的数据块 - [Class: FlowNodeRenderData](/auto-docs/editor/classes/FlowNodeRenderData.md): 节点渲染状态相关数据 - [Class: FlowNodeTransformData](/auto-docs/editor/classes/FlowNodeTransformData.md): 实体的数据块 - [Class: FlowNodeTransitionData](/auto-docs/editor/classes/FlowNodeTransitionData.md): 实体的数据块 - [Class: FlowNodeVariableData](/auto-docs/editor/classes/FlowNodeVariableData.md): Manages variable data for a flow node, including public and private scopes. - [Class: FlowNodesContentLayer](/auto-docs/editor/classes/FlowNodesContentLayer.md): 渲染节点内容 - [Class: FlowNodesTransformLayer](/auto-docs/editor/classes/FlowNodesTransformLayer.md): 渲染节点位置 - [Class: FlowOperationBaseServiceImpl](/auto-docs/editor/classes/FlowOperationBaseServiceImpl.md): 操作服务 - [Class: FlowRendererRegistry](/auto-docs/editor/classes/FlowRendererRegistry.md) - [Class: FlowRendererStateEntity](/auto-docs/editor/classes/FlowRendererStateEntity.md): 渲染相关的全局状态管理 - [Class: FlowScrollBarLayer](/auto-docs/editor/classes/FlowScrollBarLayer.md): 渲染滚动条 layer - [Class: FlowScrollLimitLayer](/auto-docs/editor/classes/FlowScrollLimitLayer.md): 控制滚动边界 - [Class: FlowSelectConfigEntity](/auto-docs/editor/classes/FlowSelectConfigEntity.md): 圈选节点相关数据存储 - [Class: FlowSelectorBoundsLayer](/auto-docs/editor/classes/FlowSelectorBoundsLayer.md): 流程节点被框选后的边界区域渲染 - [Class: FlowSelectorBoxLayer](/auto-docs/editor/classes/FlowSelectorBoxLayer.md): 流程选择框 - [Class: FlowVirtualTree](/auto-docs/editor/classes/FlowVirtualTree-1.md): 存储节点的 tree 结构信息 策略是 "重修改轻查询"，即修改时候做的事情更多，查询都通过指针来操作 - [Class: FlushLayerMessage](/auto-docs/editor/classes/FlushLayerMessage.md) - [Class: FormModel](/auto-docs/editor/classes/FormModel.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FormPlugin](/auto-docs/editor/classes/FormPlugin.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: GlobalScope](/auto-docs/editor/classes/GlobalScope.md): Global Scope stores all variables that are not scoped to any node. Variables in Global Scope can be accessed by any node.Any other scope's variables can not be accessed by Global Scope. - [Class: IntegerType](/auto-docs/editor/classes/IntegerType.md): Represents an integer type. - [Class: KeyPathExpression](/auto-docs/editor/classes/KeyPathExpression.md): Represents a key path expression, which is used to reference a variable by its key path. This is the V2 of KeyPathExpression, with the following improvements: returnType is copied to a new instance to avoid reference issues.Circular reference detection is introduced. - [Class: Layer](/auto-docs/editor/classes/Layer.md): 基础 layer - [Class: LegacyKeyPathExpression](/auto-docs/editor/classes/LegacyKeyPathExpression.md): Deprecated Use KeyPathExpression instead. Represents a key path expression, which is used to reference a variable by its key path. - [Class: ListNode](/auto-docs/editor/classes/ListNode.md): Represents a list of nodes. - [Class: LocalStorageService](/auto-docs/editor/classes/LocalStorageService.md) - [Class: LoggerService](/auto-docs/editor/classes/LoggerService.md): 画布全局的选择器，可以放任何东西 - [Class: MapNode](/auto-docs/editor/classes/MapNode.md): Represents a map of nodes. - [Class: MapType](/auto-docs/editor/classes/MapType.md): Represents a map type. - [Class: Matrix](/auto-docs/editor/classes/Matrix.md): The PIXIJS Matrix as a class makes it a lot faster. Here is a representation of it: - [Class: MutableToken](/auto-docs/editor/classes/MutableToken.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: NodeClient](/auto-docs/editor/classes/NodeClient.md) - [Class: NodeFocusService](/auto-docs/editor/classes/NodeFocusService.md) - [Class: NumberType](/auto-docs/editor/classes/NumberType.md): Represents a number type. - [Class: OBBRect](/auto-docs/editor/classes/OBBRect.md): Oriented Bounding Box (OBB) See https://en.wikipedia.org/wiki/Bounding_volume - [Class: ObjectType](/auto-docs/editor/classes/ObjectType.md): Represents an object type. - [Class: OpacityData](/auto-docs/editor/classes/OpacityData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OriginData](/auto-docs/editor/classes/OriginData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PipelineEntitiesImpl](/auto-docs/editor/classes/PipelineEntitiesImpl.md): 注入到 Layer 中的实体选择器 - [Class: PipelineEntitiesSelector](/auto-docs/editor/classes/PipelineEntitiesSelector.md): 选择器用来在 pipeline 绘制之前，筛选并注入 entities - [Class: PipelineRegistry](/auto-docs/editor/classes/PipelineRegistry.md): pipeline 注册器，用于注册一些事件 - [Class: PipelineRenderer](/auto-docs/editor/classes/PipelineRenderer.md): pipeline 渲染器 - [Class: Playground](/auto-docs/editor/classes/Playground.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundConfigEntity](/auto-docs/editor/classes/PlaygroundConfigEntity.md): 全局画布的配置信息 - [Class: PlaygroundDrag](/auto-docs/editor/classes/PlaygroundDrag-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: PlaygroundGesture](/auto-docs/editor/classes/PlaygroundGesture.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundLayer](/auto-docs/editor/classes/PlaygroundLayer.md): 基础层，控制画布缩放/滚动等操作 - [Class: LayerTestState](/auto-docs/editor/classes/PlaygroundMockTools.LayerTestState.md): PlaygroundMockTools.LayerTestState - [Class: PlaygroundRegistry](/auto-docs/editor/classes/PlaygroundRegistry.md) - [Class: PlaygroundSchedule](/auto-docs/editor/classes/PlaygroundSchedule.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Point](/auto-docs/editor/classes/Point-1.md): The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis. Memberof PIXI Implements IPoint - [Class: PositionData](/auto-docs/editor/classes/PositionData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PromiseDeferred](/auto-docs/editor/classes/PromiseDeferred.md): Simple implementation of the deferred pattern. An object that exposes a promise and functions to resolve and reject it. - [Class: PromisePool](/auto-docs/editor/classes/PromisePool.md) - [Class: Property](/auto-docs/editor/classes/Property.md): Property is a variable field that represents a property of a ObjectType. - [Class: ReactiveBaseState](/auto-docs/editor/classes/ReactiveBaseState.md) - [Class: ReactiveState](/auto-docs/editor/classes/ReactiveState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Rectangle](/auto-docs/editor/classes/Rectangle-1.md): Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. - [Class: RotationData](/auto-docs/editor/classes/RotationData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: ScaleData](/auto-docs/editor/classes/ScaleData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Scope](/auto-docs/editor/classes/Scope.md): Represents a variable scope, which manages its own set of variables and their lifecycle. scope.output represents the variables declared within this scope.scope.available represents all variables accessible from this scope, including those from parent scopes. - [Class: ScopeChain](/auto-docs/editor/classes/ScopeChain.md): Manages the dependency relationships between scopes. This is an abstract class, and specific implementations determine how the scope order is managed. - [Class: ScopeChainTransformService](/auto-docs/editor/classes/ScopeChainTransformService.md): A service for transforming scope chains. - [Class: ScopeOutputData](/auto-docs/editor/classes/ScopeOutputData.md): Manages the output variables of a scope. - [Class: SelectionService](/auto-docs/editor/classes/SelectionService.md): 画布全局的选择器，可以放任何东西 - [Class: SelectorBoxConfigEntity](/auto-docs/editor/classes/SelectorBoxConfigEntity.md): 选择框配置 - [Class: ShortcutsRegistry](/auto-docs/editor/classes/ShortcutsRegistry.md) - [Class: SizeData](/auto-docs/editor/classes/SizeData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: SkewData](/auto-docs/editor/classes/SkewData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StringType](/auto-docs/editor/classes/StringType.md): Base class for all types. All other types should extend this class. - [Class: Computation](/auto-docs/editor/classes/Tracker.Computation.md): Tracker.Computation A Computation object represents code that is repeatedly rerun in response to reactive data changes. Computations don't have return values; they just perform actions, such as rerendering a template on the screen. Computations are created using Tracker.autorun. Use stop to prevent further rerunning of a computation. - [Class: Dependency](/auto-docs/editor/classes/Tracker.Dependency.md): Tracker.Dependency A Dependency represents an atomic unit of reactive data that a computation might depend on. Reactive data sources such as Session or Minimongo internally create different Dependency objects for different pieces of data, each of which may be depended on by multiple computations. When the data changes, the computations are invalidated. - [Class: Transform](/auto-docs/editor/classes/Transform.md): Transform that takes care about its versions Memberof PIXI - [Class: TransformData](/auto-docs/editor/classes/TransformData-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: VariableDeclaration](/auto-docs/editor/classes/VariableDeclaration.md): VariableDeclaration is a variable field that represents a variable declaration. - [Class: VariableDeclarationList](/auto-docs/editor/classes/VariableDeclarationList.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: VariableEngine](/auto-docs/editor/classes/VariableEngine.md): The core of the variable engine system. It manages scopes, variables, and events within the system. - [Class: VariableFieldKeyRenameService](/auto-docs/editor/classes/VariableFieldKeyRenameService.md): This service is responsible for detecting when a variable field's key is renamed. It listens for changes in variable declaration lists and object properties, and determines if a change constitutes a rename operation. - [Class: WrapArrayExpression](/auto-docs/editor/classes/WrapArrayExpression.md): Represents a wrap expression, which wraps an expression with an array. - [Enumeration: ASTKind](/auto-docs/editor/enums/ASTKind.md): Core AST node types. - [Enumeration: ASTNodeFlags](/auto-docs/editor/enums/ASTNodeFlags.md): ASTNode flags. Stored in the flags property of the ASTNode. - [Enumeration: Default](/auto-docs/editor/enums/Command.Default.md): Command.Default - [Enumeration: DRAGGING_TYPE](/auto-docs/editor/enums/DRAGGING_TYPE.md): 拖拽种类枚举 节点拖拽分支拖拽 - [Enumeration: DataEvent](/auto-docs/editor/enums/DataEvent.md) - [Enumeration: FeedbackLevel](/auto-docs/editor/enums/FeedbackLevel.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowDocumentConfigEnum](/auto-docs/editor/enums/FlowDocumentConfigEnum.md) - [Enumeration: FlowLayoutDefault](/auto-docs/editor/enums/FlowLayoutDefault-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowNodeBaseType](/auto-docs/editor/enums/FlowNodeBaseType.md) - [Enumeration: FlowNodeScopeType](/auto-docs/editor/enums/FlowNodeScopeType.md): Enum for flow node scope types. - [Enumeration: FlowNodeSplitType](/auto-docs/editor/enums/FlowNodeSplitType.md) - [Enumeration: FlowRendererCommandCategory](/auto-docs/editor/enums/FlowRendererCommandCategory.md): 命令分类 - [Enumeration: FlowRendererComponentType](/auto-docs/editor/enums/FlowRendererComponentType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowRendererKey](/auto-docs/editor/enums/FlowRendererKey.md) - [Enumeration: FlowTextKey](/auto-docs/editor/enums/FlowTextKey.md) - [Enumeration: FlowTransitionLabelEnum](/auto-docs/editor/enums/FlowTransitionLabelEnum.md) - [Enumeration: FlowTransitionLineEnum](/auto-docs/editor/enums/FlowTransitionLineEnum.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: LABEL_SIDE_TYPE](/auto-docs/editor/enums/LABEL_SIDE_TYPE.md): 拖拽分支 Adder、Line 类型 - [Enumeration: LoggerEvent](/auto-docs/editor/enums/LoggerEvent.md) - [Enumeration: OperationType](/auto-docs/editor/enums/OperationType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: PipelineLayerPriority](/auto-docs/editor/enums/PipelineLayerPriority.md) - [Enumeration: PipelineMessage](/auto-docs/editor/enums/PipelineMessage.md) - [Enumeration: RectangleAlignTitle](/auto-docs/editor/enums/RectangleAlignTitle.md) - [Enumeration: RectangleAlignType](/auto-docs/editor/enums/RectangleAlignType.md) - [Enumeration: SHAPES](/auto-docs/editor/enums/SHAPES.md): Constants that identify shapes. - [Enumeration: ValidateTrigger](/auto-docs/editor/enums/ValidateTrigger.md) - [Function: create](/auto-docs/editor/functions/ASTFactory.create.md): ASTFactory.create create(targetType, json): { kind: string } & JSON Creates Type-Safe ASTNodeJSON object based on the provided AST class. Type parameters Parameters Returns { kind: string } & JSON The ASTNode JSON object. - [Function: createArray](/auto-docs/editor/functions/ASTFactory.createArray.md): ASTFactory.createArray createArray(json): Object Creates an Array type node. Parameters Returns Object - [Function: createBoolean](/auto-docs/editor/functions/ASTFactory.createBoolean.md): ASTFactory.createBoolean createBoolean(): Object Creates a Boolean type node. Returns Object - [Function: createCustomType](/auto-docs/editor/functions/ASTFactory.createCustomType.md): ASTFactory.createCustomType createCustomType(json): Object Creates a CustomType node. Parameters Returns Object - [Function: createEnumerateExpression](/auto-docs/editor/functions/ASTFactory.createEnumerateExpression.md): ASTFactory.createEnumerateExpression createEnumerateExpression(json): Object Creates an EnumerateExpression node. Parameters Returns Object - [Function: createInteger](/auto-docs/editor/functions/ASTFactory.createInteger.md): ASTFactory.createInteger createInteger(): Object Creates an Integer type node. Returns Object - [Function: createKeyPathExpression](/auto-docs/editor/functions/ASTFactory.createKeyPathExpression.md): ASTFactory.createKeyPathExpression createKeyPathExpression(json): Object Creates a KeyPathExpression node. Parameters Returns Object - [Function: createMap](/auto-docs/editor/functions/ASTFactory.createMap.md): ASTFactory.createMap createMap(json): Object Creates a Map type node. Parameters Returns Object - [Function: createNumber](/auto-docs/editor/functions/ASTFactory.createNumber.md): ASTFactory.createNumber createNumber(): Object Creates a Number type node. Returns Object - [Function: createObject](/auto-docs/editor/functions/ASTFactory.createObject.md): ASTFactory.createObject createObject(json): Object Creates an Object type node. Parameters Returns Object - [Function: createProperty](/auto-docs/editor/functions/ASTFactory.createProperty.md): ASTFactory.createProperty createProperty(json): Object Creates a Property node. Type parameters Parameters Returns Object - [Function: createString](/auto-docs/editor/functions/ASTFactory.createString.md): ASTFactory.createString createString(json?): Object Creates a String type node. Parameters Returns Object - [Function: createUnion](/auto-docs/editor/functions/ASTFactory.createUnion.md): ASTFactory.createUnion createUnion(json): Object Creates a Union type node. Parameters Returns Object - [Function: createVariableDeclaration](/auto-docs/editor/functions/ASTFactory.createVariableDeclaration.md): ASTFactory.createVariableDeclaration createVariableDeclaration(json): Object Creates a VariableDeclaration node. Type parameters Parameters Returns Object - [Function: createVariableDeclarationList](/auto-docs/editor/functions/ASTFactory.createVariableDeclarationList.md): ASTFactory.createVariableDeclarationList createVariableDeclarationList(json): Object Creates a VariableDeclarationList node. Parameters Returns Object - [Function: createWrapArrayExpression](/auto-docs/editor/functions/ASTFactory.createWrapArrayExpression.md): ASTFactory.createWrapArrayExpression createWrapArrayExpression(json): Object Creates a WrapArrayExpression node. Parameters Returns Object - [Function: is](/auto-docs/editor/functions/ASTMatch.is.md): ASTMatch.is is(node?, targetType?): node is TargetASTNode Check ASTNode Match by ASTClass Type parameters Parameters Returns node is TargetASTNode Whether the node is of the target type. - [Function: isArray](/auto-docs/editor/functions/ASTMatch.isArray.md): ASTMatch.isArray isArray(node?): node is ArrayType Check if the node is a ArrayType. Parameters Returns node is ArrayType - [Function: isBaseVariableField](/auto-docs/editor/functions/ASTMatch.isBaseVariableField.md): ASTMatch.isBaseVariableField isBaseVariableField(node?): node is BaseVariableField Check if the node is a BaseVariableField. Parameters Returns node is BaseVariableField - [Function: isBoolean](/auto-docs/editor/functions/ASTMatch.isBoolean.md): ASTMatch.isBoolean isBoolean(node?): node is BooleanType Check if the node is a BooleanType. Parameters Returns node is BooleanType - [Function: isCustomType](/auto-docs/editor/functions/ASTMatch.isCustomType.md): ASTMatch.isCustomType isCustomType(node?): node is CustomType Check if the node is a CustomType. Parameters Returns node is CustomType - [Function: isEnumerateExpression](/auto-docs/editor/functions/ASTMatch.isEnumerateExpression.md): ASTMatch.isEnumerateExpression isEnumerateExpression(node?): node is EnumerateExpression Check if the node is a EnumerateExpression. Parameters Returns node is EnumerateExpression - [Function: isInteger](/auto-docs/editor/functions/ASTMatch.isInteger.md): ASTMatch.isInteger isInteger(node?): node is IntegerType Check if the node is a IntegerType. Parameters Returns node is IntegerType - [Function: isKeyPathExpression](/auto-docs/editor/functions/ASTMatch.isKeyPathExpression.md): ASTMatch.isKeyPathExpression isKeyPathExpression(node?): node is KeyPathExpression Check if the node is a KeyPathExpression. Parameters Returns node is KeyPathExpression - [Function: isMap](/auto-docs/editor/functions/ASTMatch.isMap.md): ASTMatch.isMap isMap(node?): node is MapType Check if the node is a MapType. Parameters Returns node is MapType - [Function: isNumber](/auto-docs/editor/functions/ASTMatch.isNumber.md): ASTMatch.isNumber isNumber(node?): node is NumberType Check if the node is a NumberType. Parameters Returns node is NumberType - [Function: isObject](/auto-docs/editor/functions/ASTMatch.isObject.md): ASTMatch.isObject isObject(node?): node is ObjectType Check if the node is a ObjectType. Parameters Returns node is ObjectType - [Function: isProperty](/auto-docs/editor/functions/ASTMatch.isProperty.md): ASTMatch.isProperty isProperty(node?): node is Property Check if the node is a Property. Type parameters Parameters Returns node is Property - [Function: isString](/auto-docs/editor/functions/ASTMatch.isString.md): ASTMatch.isString isString(node?): node is StringType Check if the node is a StringType. Parameters Returns node is StringType - [Function: isVariableDeclaration](/auto-docs/editor/functions/ASTMatch.isVariableDeclaration.md): ASTMatch.isVariableDeclaration isVariableDeclaration(node?): node is VariableDeclaration Check if the node is a VariableDeclaration. Type parameters Parameters Returns node is VariableDeclaration - [Function: isVariableDeclarationList](/auto-docs/editor/functions/ASTMatch.isVariableDeclarationList.md): ASTMatch.isVariableDeclarationList isVariableDeclarationList(node?): node is VariableDeclarationList Check if the node is a VariableDeclarationList. Parameters Returns node is VariableDeclarationList - [Function: isWrapArrayExpression](/auto-docs/editor/functions/ASTMatch.isWrapArrayExpression.md): ASTMatch.isWrapArrayExpression isWrapArrayExpression(node?): node is WrapArrayExpression Check if the node is a WrapArrayExpression. Parameters Returns node is WrapArrayExpression - [Function: betweenPoints](/auto-docs/editor/functions/Angle.betweenPoints.md): Angle.betweenPoints betweenPoints(point1, point2, originPoint?): number 计算两个点的夹角 Parameters Returns number The angle in radians. - [Function: wrap](/auto-docs/editor/functions/Angle.wrap.md): Angle.wrap wrap(angle): number Wrap an angle. Wraps the angle to a value in the range of -PI to PI. Parameters Returns number The wrapped angle, in radians. - [Function: wrapDegrees](/auto-docs/editor/functions/Angle.wrapDegrees.md): Angle.wrapDegrees wrapDegrees(angle): number Wrap an angle in degrees. Wraps the angle to a value in the range of -180 to 180. Parameters Returns number The wrapped angle, in degrees. - [Function: applyMatrix](/auto-docs/editor/functions/Bounds.applyMatrix.md): Bounds.applyMatrix applyMatrix(bounds, matrix): Rectangle Parameters Returns Rectangle - [Function: getBottomCenter](/auto-docs/editor/functions/Bounds.getBottomCenter.md): Bounds.getBottomCenter getBottomCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomLeft](/auto-docs/editor/functions/Bounds.getBottomLeft.md): Bounds.getBottomLeft getBottomLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomRight](/auto-docs/editor/functions/Bounds.getBottomRight.md): Bounds.getBottomRight getBottomRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBounds](/auto-docs/editor/functions/Bounds.getBounds.md): Bounds.getBounds getBounds(target, matrix?): Rectangle 获取外围边界矩形 Parameters Returns Rectangle - [Function: getCenter](/auto-docs/editor/functions/Bounds.getCenter.md): Bounds.getCenter getCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftCenter](/auto-docs/editor/functions/Bounds.getLeftCenter.md): Bounds.getLeftCenter getLeftCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftPointFromBounds](/auto-docs/editor/functions/Bounds.getLeftPointFromBounds.md): Bounds.getLeftPointFromBounds getLeftPointFromBounds(target, matrix?): PositionSchema 找到边框中最左边的点 Parameters Returns PositionSchema - [Function: getPointWithMatrix](/auto-docs/editor/functions/Bounds.getPointWithMatrix.md): Bounds.getPointWithMatrix getPointWithMatrix(output, matrix?): PositionSchema 位置做矩阵偏移 Parameters Returns PositionSchema - [Function: getRightCenter](/auto-docs/editor/functions/Bounds.getRightCenter.md): Bounds.getRightCenter getRightCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopCenter](/auto-docs/editor/functions/Bounds.getTopCenter.md): Bounds.getTopCenter getTopCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopLeft](/auto-docs/editor/functions/Bounds.getTopLeft.md): Bounds.getTopLeft getTopLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopPointFromBounds](/auto-docs/editor/functions/Bounds.getTopPointFromBounds.md): Bounds.getTopPointFromBounds getTopPointFromBounds(target, matrix?): PositionSchema 找到边框中最上边的点 Parameters Returns PositionSchema - [Function: getTopRight](/auto-docs/editor/functions/Bounds.getTopRight.md): Bounds.getTopRight getTopRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: assign](/auto-docs/editor/functions/Cache.assign.md): Cache.assign assign(target, fn): Cache Type parameters Parameters Returns Cache - [Function: create](/auto-docs/editor/functions/Cache.create.md): Cache.create create(cacheFactory, opts?): CacheManager Type parameters Parameters Returns CacheManager - [Function: createShortCache](/auto-docs/editor/functions/Cache.createShortCache.md): Cache.createShortCache createShortCache(timeout?): ShortCache 短存储 Type parameters Parameters Returns ShortCache - [Function: createWeakCache](/auto-docs/editor/functions/Cache.createWeakCache.md): Cache.createWeakCache createWeakCache(): WeakCache Returns WeakCache - [Function: isCancellationToken](/auto-docs/editor/functions/CancellationToken.isCancellationToken.md): CancellationToken.isCancellationToken isCancellationToken(thing): thing is CancellationToken Parameters Returns thing is CancellationToken - [Function: is](/auto-docs/editor/functions/Command.is.md): Command.is is(arg): arg is Command 判断是否是 command Parameters Returns arg is Command - [Function: isArrayShallowChanged](/auto-docs/editor/functions/Compare.isArrayShallowChanged.md): Compare.isArrayShallowChanged isArrayShallowChanged(arr1, arr2): boolean Parameters Returns boolean - [Function: isChanged](/auto-docs/editor/functions/Compare.isChanged.md): Compare.isChanged isChanged(oldProps, newProps, depth?, partial?): boolean 比较，默认浅比较 Parameters Returns boolean - [Function: isDeepChanged](/auto-docs/editor/functions/Compare.isDeepChanged.md): Compare.isDeepChanged isDeepChanged(oldProps, newProps, partial?): boolean 深度比较 Parameters Returns boolean - [Function: DEFAULT_FLOW_NODE_META](/auto-docs/editor/functions/DEFAULT_FLOW_NODE_META.md): DEFAULT_FLOW_NODE_META(nodeType, document): FlowNodeMeta 默认 meta 配置 Parameters Returns FlowNodeMeta - [Function: create](/auto-docs/editor/functions/Disposable.create.md): Disposable.create create(func): Disposable Parameters Returns Disposable - [Function: is](/auto-docs/editor/functions/Disposable.is.md): Disposable.is is(thing): thing is Disposable Parameters Returns thing is Disposable - [Function: Editor](/auto-docs/editor/functions/Editor.md): Editor(props, deprecatedLegacyContext?): null | ReactElement 画布编辑器 Parameters Returns null | ReactElement - [Function: EditorProvider](/auto-docs/editor/functions/EditorProvider.md): EditorProvider(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: checkDataChanged](/auto-docs/editor/functions/Entity.checkDataChanged.md): Entity.checkDataChanged checkDataChanged(oldProps, newProps): boolean 默认数据比较，采用浅比较 Parameters Returns boolean - [Function: getType](/auto-docs/editor/functions/Entity.getType.md): Entity.getType getType(registry): string Parameters Returns string - [Function: isRegistryOf](/auto-docs/editor/functions/Entity.isRegistryOf.md): Entity.isRegistryOf isRegistryOf(target, Registry): boolean Parameters Returns boolean - [Function: None](/auto-docs/editor/functions/Event.None.md): Event.None None(listener, thisArgs?): Disposable Parameters Returns Disposable - [Function: Field](/auto-docs/editor/functions/Field.md): Field(«destructured»): React$1.ReactElement HOC That declare a field, an Field model will be created it's rendered. Multiple Field rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React$1.ReactElement - [Function: FieldArray](/auto-docs/editor/functions/FieldArray.md): FieldArray(«destructured»): React$1.ReactElement HOC That declare an array field, an FieldArray model will be created when it's rendered. Multiple FieldArray rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React$1.ReactElement - [Function: isVertical](/auto-docs/editor/functions/FlowLayoutDefault.isVertical.md): FlowLayoutDefault.isVertical isVertical(layout): boolean Parameters Returns boolean - [Function: is](/auto-docs/editor/functions/FlowNodeEntity.is.md): FlowNodeEntity.is is(obj): obj is FlowNodeEntity Parameters Returns obj is FlowNodeEntity - [Function: extend](/auto-docs/editor/functions/FlowNodeRegistry.extend.md): FlowNodeRegistry.extend extend(registry, extendRegistries): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: merge](/auto-docs/editor/functions/FlowNodeRegistry.merge.md): FlowNodeRegistry.merge merge(registry1, registry2, finalType): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: mergeChildRegistries](/auto-docs/editor/functions/FlowNodeRegistry.mergeChildRegistries.md): FlowNodeRegistry.mergeChildRegistries mergeChildRegistries(r1?, r2?): FlowNodeRegistry[] Parameters Returns FlowNodeRegistry[] - [Function: Form](/auto-docs/editor/functions/Form.md): Form(props): React__default.JSX.Element Hoc That init and provide Form instance. You can also provide form instance from outside by using control prop Type parameters Parameters Returns React__default.JSX.Element - [Function: MOUSE_SCROLL_DELTA](/auto-docs/editor/functions/MOUSE_SCROLL_DELTA.md): MOUSE_SCROLL_DELTA(zoom): number 鼠标缩放 delta Parameters Returns number - [Function: getEventCoord](/auto-docs/editor/functions/MouseTouchEvent.getEventCoord.md): MouseTouchEvent.getEventCoord getEventCoord(e): Object Parameters Returns Object - [Function: isTouchEvent](/auto-docs/editor/functions/MouseTouchEvent.isTouchEvent.md): MouseTouchEvent.isTouchEvent isTouchEvent(event): event is TouchEvent Parameters Returns event is TouchEvent - [Function: onTouched](/auto-docs/editor/functions/MouseTouchEvent.onTouched.md): MouseTouchEvent.onTouched onTouched(touchStartEvent, callback): void Parameters Returns void - [Function: preventDefault](/auto-docs/editor/functions/MouseTouchEvent.preventDefault.md): MouseTouchEvent.preventDefault preventDefault(e): void Parameters Returns void - [Function: touchToMouseEvent](/auto-docs/editor/functions/MouseTouchEvent.touchToMouseEvent.md): MouseTouchEvent.touchToMouseEvent touchToMouseEvent(event): Event | MouseEvent Parameters Returns Event | MouseEvent - [Function: NOOP](/auto-docs/editor/functions/NOOP.md): NOOP(): void Returns void - [Function: NodeRender](/auto-docs/editor/functions/NodeRender.md): NodeRender(props): null | ReactElement> Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns null | ReactElement> - [Function: empty](/auto-docs/editor/functions/PaddingSchema.empty.md): PaddingSchema.empty empty(): Object Returns Object - [Function: startDrag](/auto-docs/editor/functions/PlaygroundDrag.startDrag.md): PlaygroundDrag.startDrag startDrag(clientX, clientY, opts?): Disposable 拖拽实体 Type parameters Parameters Returns Disposable - [Function: createContainer](/auto-docs/editor/functions/PlaygroundMockTools.createContainer.md): PlaygroundMockTools.createContainer createContainer(modules?): Container Parameters Returns Container - [Function: createLayerTestState](/auto-docs/editor/functions/PlaygroundMockTools.createLayerTestState.md): PlaygroundMockTools.createLayerTestState createLayerTestState(layerRegistry, opts?, modules?): LayerTestState 创建layer, 并记录layer的回调数据 Type parameters Parameters Returns LayerTestState - [Function: createPlayground](/auto-docs/editor/functions/PlaygroundMockTools.createPlayground.md): PlaygroundMockTools.createPlayground createPlayground(modules?): Playground Parameters Returns Playground - [Function: getLayerTestState](/auto-docs/editor/functions/PlaygroundMockTools.getLayerTestState.md): PlaygroundMockTools.getLayerTestState getLayerTestState(container, layerRegistry): LayerTestState Type parameters Parameters Returns LayerTestState - [Function: PlaygroundReactProvider](/auto-docs/editor/functions/PlaygroundReactProvider.md): PlaygroundReactProvider(props): null | ReactElement> Playground react 组件 Parameters Returns null | ReactElement> - [Function: PlaygroundReactRenderer](/auto-docs/editor/functions/PlaygroundReactRenderer.md): PlaygroundReactRenderer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: fixZero](/auto-docs/editor/functions/Point.fixZero.md): Point.fixZero fixZero(output): IPoint Parameters Returns IPoint - [Function: getDistance](/auto-docs/editor/functions/Point.getDistance.md): Point.getDistance getDistance(p1, p2): number 获取两点间的距离 Parameters Returns number - [Function: getMiddlePoint](/auto-docs/editor/functions/Point.getMiddlePoint.md): Point.getMiddlePoint getMiddlePoint(p1, p2): IPoint 获取两点间的中间点 Parameters Returns IPoint - [Function: getRatioPoint](/auto-docs/editor/functions/Point.getRatioPoint.md): Point.getRatioPoint getRatioPoint(p1, p2, ratio): IPoint 按一定比例，获取两点间的中间点 Parameters Returns IPoint - [Function: move](/auto-docs/editor/functions/Point.move.md): Point.move move(current, m): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: moveDistanceToDirection](/auto-docs/editor/functions/Point.moveDistanceToDirection.md): Point.moveDistanceToDirection moveDistanceToDirection(current, direction, distance): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: PrivateScopeProvider](/auto-docs/editor/functions/PrivateScopeProvider.md): PrivateScopeProvider(«destructured»): Element PrivateScopeProvider provides the private scope to its children via context. Parameters Returns Element - [Function: PublicScopeProvider](/auto-docs/editor/functions/PublicScopeProvider.md): PublicScopeProvider(«destructured»): Element PublicScopeProvider provides the public scope to its children via context. Parameters Returns Element - [Function: align](/auto-docs/editor/functions/Rectangle.align.md): Rectangle.align align(rectangles, type): Rectangle[] 矩形对齐 Parameters Returns Rectangle[] - [Function: createRectangleWithTwoPoints](/auto-docs/editor/functions/Rectangle.createRectangleWithTwoPoints.md): Rectangle.createRectangleWithTwoPoints createRectangleWithTwoPoints(point1, point2): Rectangle 根据两点创建矩形 Parameters Returns Rectangle - [Function: enlarge](/auto-docs/editor/functions/Rectangle.enlarge.md): Rectangle.enlarge enlarge(rectangles): Rectangle 获取所有矩形的外围最大边框 Parameters Returns Rectangle - [Function: intersects](/auto-docs/editor/functions/Rectangle.intersects.md): Rectangle.intersects intersects(target1, target2, direction?): boolean 判断矩形相交 Parameters Returns boolean - [Function: intersectsWithRotation](/auto-docs/editor/functions/Rectangle.intersectsWithRotation.md): Rectangle.intersectsWithRotation intersectsWithRotation(rect1, rotate1, rect2, rotate2): boolean 使用 OBB 算法判断两个旋转矩形是否相交 Parameters Returns boolean - [Function: isViewportVisible](/auto-docs/editor/functions/Rectangle.isViewportVisible.md): Rectangle.isViewportVisible isViewportVisible(rect, viewport, rotation?, isContains?): boolean 判断指定 rect 是否在 viewport 可见 Parameters Returns boolean - [Function: setViewportVisible](/auto-docs/editor/functions/Rectangle.setViewportVisible.md): Rectangle.setViewportVisible setViewportVisible(bounds, viewport, padding?): Rectangle 保证bounds 永远在 viewport 里边 Parameters Returns Rectangle - [Function: createDefault](/auto-docs/editor/functions/Schema.createDefault.md): Schema.createDefault createDefault(decoration, mixinDefaults?, _key?): T Type parameters Parameters Returns T - [Function: isBaseType](/auto-docs/editor/functions/Schema.isBaseType.md): Schema.isBaseType isBaseType(decoration): boolean 非 object 类 Parameters Returns boolean - [Function: create](/auto-docs/editor/functions/SchemaDecoration.create.md): SchemaDecoration.create create(properties, baseDecoration?, mixinDefaults?): SchemaDecoration 扩展 SchemaDecoration Type parameters Parameters Returns SchemaDecoration Example - [Function: ScopeProvider](/auto-docs/editor/functions/ScopeProvider.md): ScopeProvider(props): Element ScopeProvider provides the scope to its children via context. Parameters Returns Element - [Function: coverSize](/auto-docs/editor/functions/SizeSchema.coverSize.md): SizeSchema.coverSize coverSize(currentSize, parentSize): number 填充父节点的宽高 Parameters Returns number 返回放大的比例 - [Function: empty](/auto-docs/editor/functions/SizeSchema.empty.md): SizeSchema.empty empty(): SizeSchema Returns SizeSchema - [Function: fixSize](/auto-docs/editor/functions/SizeSchema.fixSize.md): SizeSchema.fixSize fixSize(currentSize, parentSize): number 适配父节点宽高 Parameters Returns number 返回需要缩放的比例，为 1 则不缩放 - [Function: isEmpty](/auto-docs/editor/functions/TintSchema.isEmpty.md): TintSchema.isEmpty isEmpty(tint): boolean Parameters Returns boolean - [Function: afterFlush](/auto-docs/editor/functions/Tracker.afterFlush.md): Tracker.afterFlush afterFlush(f): void Schedules a function to be called during the next flush, or later in the current flush if one is in progress, after all invalidated computations have been rerun. The function will be run once and not on subsequent flushes unless afterFlush is called again. Parameters Returns void - [Function: autorun](/auto-docs/editor/functions/Tracker.autorun.md): Tracker.autorun autorun(f, options?): Computation Run a function now and rerun it later whenever its dependencies change. Returns a Computation object that can be used to stop or observe the rerunning. Type parameters Parameters Returns Computation - [Function: flush](/auto-docs/editor/functions/Tracker.flush.md): Tracker.flush flush(options?): void Process all reactive updates immediately and ensure that all invalidated computations are rerun. Parameters Returns void - [Function: getCurrentComputation](/auto-docs/editor/functions/Tracker.getCurrentComputation.md): Tracker.getCurrentComputation getCurrentComputation(): Computation | undefined Returns Computation | undefined - [Function: inFlush](/auto-docs/editor/functions/Tracker.inFlush.md): Tracker.inFlush inFlush(): boolean True if we are computing a computation now, either first time or recompute. This matches Tracker.active unless we are inside Tracker.nonreactive, which nullfies currentComputation even though an enclosing computation may still be running. Returns boolean - [Function: isActive](/auto-docs/editor/functions/Tracker.isActive.md): Tracker.isActive isActive(): boolean Returns boolean - [Function: onInvalidate](/auto-docs/editor/functions/Tracker.onInvalidate.md): Tracker.onInvalidate onInvalidate(f): void Parameters Returns void - [Function: withComputation](/auto-docs/editor/functions/Tracker.withComputation.md): Tracker.withComputation withComputation(computation, f): T 函数在响应式模块中执行 Type parameters Parameters Returns T - [Function: withoutComputation](/auto-docs/editor/functions/Tracker.withoutComputation.md): Tracker.withoutComputation withoutComputation(f): T 函数在非响应式模块中执行 Type parameters Parameters Returns T - [Function: isParentOrChildrenTransform](/auto-docs/editor/functions/TransformData.isParentOrChildrenTransform.md): TransformData.isParentOrChildrenTransform isParentOrChildrenTransform(dragableEntities, target): boolean Parameters Returns boolean - [Function: createDefault](/auto-docs/editor/functions/TransformSchema.createDefault.md): TransformSchema.createDefault createDefault(): TransformSchema Returns TransformSchema - [Function: getDelta](/auto-docs/editor/functions/TransformSchema.getDelta.md): TransformSchema.getDelta getDelta(oldTransform, newTransform): TransformSchema Parameters Returns TransformSchema - [Function: is](/auto-docs/editor/functions/TransformSchema.is.md): TransformSchema.is is(obj): obj is TransformSchema Parameters Returns obj is TransformSchema - [Function: mergeDelta](/auto-docs/editor/functions/TransformSchema.mergeDelta.md): TransformSchema.mergeDelta mergeDelta(oldTransform, newTransformDelta, toFixedNum?): TransformSchema Parameters Returns TransformSchema - [Function: toJSON](/auto-docs/editor/functions/TransformSchema.toJSON.md): TransformSchema.toJSON toJSON(obj): TransformSchema Parameters Returns TransformSchema - [Function: addEventListener](/auto-docs/editor/functions/addEventListener.md): addEventListener(element, type, listener, useCapture?): Disposable Type parameters Parameters Returns Disposable - [Function: arrayToSet](/auto-docs/editor/functions/arrayToSet.md): arrayToSet(arr): Set Parameters Returns Set - [Function: arrayUnion](/auto-docs/editor/functions/arrayUnion.md): arrayUnion(arr): any[] Parameters Returns any[] See https://stackoverflow.com/a/9229821 export function arrayUnion(arr: any[]): any[] { return [...new Set(arr)] } - [Function: bindConfigEntity](/auto-docs/editor/functions/bindConfigEntity.md): bindConfigEntity(bind, entityRegistry): void 让 entity 可以注入到类中 Parameters Returns void Example - [Function: bindContributionProvider](/auto-docs/editor/functions/bindContributionProvider.md): bindContributionProvider(bind, id): void Parameters Returns void - [Function: bindContributions](/auto-docs/editor/functions/bindContributions.md): bindContributions(bind, target, contribs): void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns void - [Function: bindPlaygroundContextProvider](/auto-docs/editor/functions/bindPlaygroundContextProvider.md): bindPlaygroundContextProvider(bind): void Parameters Returns void - [Function: cancelled](/auto-docs/editor/functions/cancelled.md): cancelled(): Error Returns Error - [Function: checkCancelled](/auto-docs/editor/functions/checkCancelled.md): checkCancelled(token?): void Parameters Returns void - [Function: clearRequestCache](/auto-docs/editor/functions/clearRequestCache.md): clearRequestCache(): void Returns void - [Function: compose](/auto-docs/editor/functions/compose.md): compose(...fns): Func Type parameters Parameters Returns Func - [Function: composeAsync](/auto-docs/editor/functions/composeAsync.md): composeAsync(...fns): FuncPromise Type parameters Parameters Returns FuncPromise - [Function: createConfigDataRegistry](/auto-docs/editor/functions/createConfigDataRegistry.md): createConfigDataRegistry

(entity): EntityDataRegistry Type parameters Parameters Returns EntityDataRegistry - [Function: createDefaultPlaygroundConfig](/auto-docs/editor/functions/createDefaultPlaygroundConfig.md): createDefaultPlaygroundConfig(): PlaygroundConfig 默认配置 Returns PlaygroundConfig - [Function: createDefaultPreset](/auto-docs/editor/functions/createDefaultPreset.md): createDefaultPreset(opts, plugins?): PluginsProvider Type parameters Parameters Returns PluginsProvider - [Function: createEffectFromVariableProvider](/auto-docs/editor/functions/createEffectFromVariableProvider.md): createEffectFromVariableProvider(options): EffectOptions[] 根据 VariableProvider 生成 FormV2 的 Effect Parameters Returns EffectOptions[] - [Function: createEffectOptions](/auto-docs/editor/functions/createEffectOptions.md): createEffectOptions(event, effect): Object Type parameters Parameters Returns Object - [Function: createFlowEditorClientPlugin](/auto-docs/editor/functions/createFlowEditorClientPlugin.md): createFlowEditorClientPlugin(opts): Plugin<{}> Parameters Returns Plugin<{}> - [Function: createFlowEditorClientPlugins](/auto-docs/editor/functions/createFlowEditorClientPlugins.md): createFlowEditorClientPlugins(): Plugin<{}>[] Returns Plugin<{}>[] - [Function: createI18nPlugin](/auto-docs/editor/functions/createI18nPlugin.md): createI18nPlugin(opts): Plugin I18n Plugin Parameters Returns Plugin - [Function: createLines](/auto-docs/editor/functions/createLines.md): createLines(props): void Parameters Returns void - [Function: createNodeCorePlugin](/auto-docs/editor/functions/createNodeCorePlugin.md): createNodeCorePlugin(opts): Plugin Parameters Returns Plugin - [Function: createNodeVariablePlugin](/auto-docs/editor/functions/createNodeVariablePlugin.md): createNodeVariablePlugin(opts): Plugin Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Plugin - [Function: createPlaygroundContainer](/auto-docs/editor/functions/createPlaygroundContainer.md): createPlaygroundContainer(config?, parent?, container?): Container Parameters Returns Container - [Function: createPlaygroundLayerDefault](/auto-docs/editor/functions/createPlaygroundLayerDefault.md): createPlaygroundLayerDefault(container, layerRegistry, options?): Layer Parameters Returns Layer - [Function: createPlaygroundPlugin](/auto-docs/editor/functions/createPlaygroundPlugin.md): createPlaygroundPlugin(options): Plugin Type parameters Parameters Returns Plugin Example - [Function: createPlaygroundReactPreset](/auto-docs/editor/functions/createPlaygroundReactPreset.md): createPlaygroundReactPreset(opts, plugins?): PluginsProvider Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns PluginsProvider - [Function: createPluginContextDefault](/auto-docs/editor/functions/createPluginContextDefault.md): createPluginContextDefault(container): PluginContext Parameters Returns PluginContext - [Function: createRegistryDecorator](/auto-docs/editor/functions/createRegistryDecorator.md): createRegistryDecorator(key, data, getValue?, init?): any Parameters Returns any - [Function: createShortcutsPlugin](/auto-docs/editor/functions/createShortcutsPlugin.md): createShortcutsPlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariablePlugin](/auto-docs/editor/functions/createVariablePlugin.md): createVariablePlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariableProviderPlugin](/auto-docs/editor/functions/createVariableProviderPlugin.md): createVariableProviderPlugin(opts): FormPlugin Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns FormPlugin - [Function: deepFreeze](/auto-docs/editor/functions/deepFreeze.md): deepFreeze(obj): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: defineFormPluginCreator](/auto-docs/editor/functions/defineFormPluginCreator.md): defineFormPluginCreator(config): FormPluginCreator Type parameters Parameters Returns FormPluginCreator - [Function: definePluginCreator](/auto-docs/editor/functions/definePluginCreator.md): definePluginCreator(config): PluginCreator Type parameters Parameters Returns PluginCreator - [Function: delay](/auto-docs/editor/functions/delay.md): delay(ms, token?): Promise Parameters Returns Promise resolves after a specified number of milliseconds Throws cancelled if a given token is cancelled before a specified number of milliseconds - [Function: addClass](/auto-docs/editor/functions/domUtils.addClass.md): domUtils.addClass addClass(element, ...classNames): void Parameters Returns void - [Function: addStandardDisposableListener](/auto-docs/editor/functions/domUtils.addStandardDisposableListener.md): domUtils.addStandardDisposableListener addStandardDisposableListener(dom, type, listener, options?): Disposable Parameters Returns Disposable - [Function: classNameWithPrefix](/auto-docs/editor/functions/domUtils.classNameWithPrefix.md): domUtils.classNameWithPrefix classNameWithPrefix(prefix): (key: string, opts?: any) => string Parameters Returns fn (key, opts?): string Parameters Returns string - [Function: clearChildren](/auto-docs/editor/functions/domUtils.clearChildren.md): domUtils.clearChildren clearChildren(container): void Parameters Returns void - [Function: coverClass](/auto-docs/editor/functions/domUtils.coverClass.md): domUtils.coverClass coverClass(element, ...classNames): void Parameters Returns void - [Function: createDOMCache](/auto-docs/editor/functions/domUtils.createDOMCache.md): domUtils.createDOMCache createDOMCache(parent, className, children?): CacheManager dom 缓存 Type parameters Parameters Returns CacheManager - [Function: createDivWithClass](/auto-docs/editor/functions/domUtils.createDivWithClass.md): domUtils.createDivWithClass createDivWithClass(...classNames): HTMLDivElement Parameters Returns HTMLDivElement - [Function: createElement](/auto-docs/editor/functions/domUtils.createElement.md): domUtils.createElement createElement(ele, ...classNames): T Type parameters Parameters Returns T - [Function: delClass](/auto-docs/editor/functions/domUtils.delClass.md): domUtils.delClass delClass(element, ...classNames): void Parameters Returns void - [Function: disableEvent](/auto-docs/editor/functions/domUtils.disableEvent.md): domUtils.disableEvent disableEvent(element): void Parameters Returns void - [Function: enableEvent](/auto-docs/editor/functions/domUtils.enableEvent.md): domUtils.enableEvent enableEvent(element): void Parameters Returns void - [Function: fromPercent](/auto-docs/editor/functions/domUtils.fromPercent.md): domUtils.fromPercent fromPercent(percent): number Parameters Returns number - [Function: setStyle](/auto-docs/editor/functions/domUtils.setStyle.md): domUtils.setStyle setStyle(node, styles): void Parameters Returns void - [Function: toPercent](/auto-docs/editor/functions/domUtils.toPercent.md): domUtils.toPercent toPercent(percent): string Parameters Returns string - [Function: toPixel](/auto-docs/editor/functions/domUtils.toPixel.md): domUtils.toPixel toPixel(num): string Parameters Returns string - [Function: translatePercent](/auto-docs/editor/functions/domUtils.translatePercent.md): domUtils.translatePercent translatePercent(node, x, y): void Parameters Returns void - [Function: translateXPercent](/auto-docs/editor/functions/domUtils.translateXPercent.md): domUtils.translateXPercent translateXPercent(node, x): void Parameters Returns void - [Function: translateYPercent](/auto-docs/editor/functions/domUtils.translateYPercent.md): domUtils.translateYPercent translateYPercent(node, y): void Parameters Returns void - [Function: drawLineToBottom](/auto-docs/editor/functions/drawLineToBottom.md): drawLineToBottom(transition): { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] Parameters Returns { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] - [Function: drawLineToNext](/auto-docs/editor/functions/drawLineToNext.md): drawLineToNext(transition): { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] Parameters Returns { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] - [Function: each](/auto-docs/editor/functions/each.md): each(obj, fn): void Type parameters Parameters Returns void - [Function: filter](/auto-docs/editor/functions/filter.md): filter(obj, fn, dest?): any Parameters Returns any - [Function: generateLocalId](/auto-docs/editor/functions/generateLocalId.md): generateLocalId(): LocalId Returns LocalId - [Function: getByKey](/auto-docs/editor/functions/getByKey.md): getByKey(target, key): any | undefined Parameters Returns any | undefined Example - [Function: getDefaultSpacing](/auto-docs/editor/functions/getDefaultSpacing.md): getDefaultSpacing(node, key, defaultSpacing?): any Parameters Returns any - [Function: getEntityDatasMetadata](/auto-docs/editor/functions/getEntityDatasMetadata.md): getEntityDatasMetadata(layer): { data: EntityDataRegistry ; entity: EntityRegistry }[] Parameters Returns { data: EntityDataRegistry ; entity: EntityRegistry }[] - [Function: getEntityMetadata](/auto-docs/editor/functions/getEntityMetadata.md): getEntityMetadata(layer): EntityRegistry[] Parameters Returns EntityRegistry[] - [Function: getNodeForm](/auto-docs/editor/functions/getNodeForm.md): getNodeForm(node): NodeFormProps | undefined Use node.form instead Type parameters Parameters Returns NodeFormProps | undefined Deprecated - [Function: getNodePrivateScope](/auto-docs/editor/functions/getNodePrivateScope.md): getNodePrivateScope(node): FlowNodeScope Use node.privateScope instead. Parameters Returns FlowNodeScope The private scope of the node. Deprecated - [Function: getNodeScope](/auto-docs/editor/functions/getNodeScope.md): getNodeScope(node): FlowNodeScope Use node.scope instead. Parameters Returns FlowNodeScope The public scope of the node. Deprecated - [Function: getRegistryMetadata](/auto-docs/editor/functions/getRegistryMetadata.md): getRegistryMetadata(target, key): any[] Parameters Returns any[] - [Function: getTag](/auto-docs/editor/functions/getTag.md): getTag(v): string Parameters Returns string - [Function: highlightFormItem](/auto-docs/editor/functions/highlightFormItem.md): highlightFormItem(formItem, options?): HTMLDivElement | undefined Parameters Returns HTMLDivElement | undefined - [Function: inject](/auto-docs/editor/functions/inject.md): inject(serviceIdentifier): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Type parameters Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Parameters Returns void - [Function: injectByProvider](/auto-docs/editor/functions/injectByProvider.md): injectByProvider(provider): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectPlaygroundContext](/auto-docs/editor/functions/injectPlaygroundContext.md): injectPlaygroundContext(): (target: any, propertyKey: string) => any Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectToAST](/auto-docs/editor/functions/injectToAST.md): injectToAST(serviceIdentifier): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectable](/auto-docs/editor/functions/injectable.md): injectable(): (target: T) => T Returns fn (target): T Type parameters Parameters Returns T - [Function: isCancelled](/auto-docs/editor/functions/isCancelled.md): isCancelled(err): boolean Parameters Returns boolean - [Function: isEmpty](/auto-docs/editor/functions/isEmpty.md): isEmpty(arg): boolean true if the argument is an empty object. Otherwise, false. Parameters Returns boolean - [Function: isFormMetaV2](/auto-docs/editor/functions/isFormMetaV2.md): isFormMetaV2(formMeta): formMeta is FormMeta Parameters Returns formMeta is FormMeta - [Function: isFormModelV2](/auto-docs/editor/functions/isFormModelV2.md): isFormModelV2(fm): fm is FormModel Parameters Returns fm is FormModel - [Function: isFormV2](/auto-docs/editor/functions/isFormV2.md): isFormV2(node): boolean Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns boolean - [Function: isFunction](/auto-docs/editor/functions/isFunction.md): isFunction(v): v is T Type parameters Parameters Returns v is T - [Function: isMatchAST](/auto-docs/editor/functions/isMatchAST.md): isMatchAST(node?, targetType?): node is TargetASTNode isMatchAST is same as ASTMatch.is Type parameters Parameters Returns node is TargetASTNode - [Function: isNumber](/auto-docs/editor/functions/isNumber.md): isNumber(v): v is number Parameters Returns v is number - [Function: isObject](/auto-docs/editor/functions/isObject.md): isObject(v): v is UnknownObject Type parameters Parameters Returns v is UnknownObject - [Function: isPlainObject](/auto-docs/editor/functions/isPlainObject.md): isPlainObject(obj): boolean Parameters Returns boolean True if the argument appears to be a plain object. - [Function: isString](/auto-docs/editor/functions/isString.md): isString(v): v is string Parameters Returns v is string - [Function: iterToArray](/auto-docs/editor/functions/iterToArray.md): iterToArray(iter): T[] Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T[] - [Function: lazyInject](/auto-docs/editor/functions/lazyInject.md): lazyInject(serviceIdentifier): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: loadPlugins](/auto-docs/editor/functions/loadPlugins.md): loadPlugins(plugins, container): void Parameters Returns void - [Function: mapKeys](/auto-docs/editor/functions/mapKeys.md): mapKeys(obj, fn): any Type parameters Parameters Returns any - [Function: mapValues](/auto-docs/editor/functions/mapValues.md): mapValues(obj, fn): any Type parameters Parameters Returns any - [Function: multiInject](/auto-docs/editor/functions/multiInject.md): multiInject(serviceIdentifier): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Type parameters Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Parameters Returns void - [Function: named](/auto-docs/editor/functions/named.md): named(name): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Type parameters Parameters Returns void - [Function: notEmpty](/auto-docs/editor/functions/notEmpty.md): notEmpty(arg): arg is T Type parameters Parameters Returns arg is T - [Function: observe](/auto-docs/editor/functions/observe.md): observe(fc): React.FC Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns React.FC - [Function: observeEntities](/auto-docs/editor/functions/observeEntities.md): observeEntities(registry): any 监听 entity 变化 Parameters Returns any - [Function: observeEntity](/auto-docs/editor/functions/observeEntity.md): observeEntity(registry): any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns any - [Function: observeEntityDatas](/auto-docs/editor/functions/observeEntityDatas.md): observeEntityDatas(entityRegistry, dataRegistry): any 监听 entity 对应的 data 数据变化 Parameters Returns any - [Function: omit](/auto-docs/editor/functions/omit.md): omit(obj, fields, dest?): any Parameters Returns any - [Function: pick](/auto-docs/editor/functions/pick.md): pick(obj, fields, dest?): any Parameters Returns any - [Function: postConstruct](/auto-docs/editor/functions/postConstruct.md): postConstruct(): (target: { constructor: NewableFunction }, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: postConstructAST](/auto-docs/editor/functions/postConstructAST.md): postConstructAST(): (target: any, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: reduce](/auto-docs/editor/functions/reduce.md): reduce(obj, fn, res?): R Type parameters Parameters Returns R - [Function: registerNodeMaterial](/auto-docs/editor/functions/registerNodeMaterial.md): registerNodeMaterial(«destructured»): void Parameters Returns void - [Function: removeInjectedProperties](/auto-docs/editor/functions/removeInjectedProperties.md): removeInjectedProperties(instance): void 在 rspack 场景编译ts文件时候 decorator 注入的 property 会被当成 this 的属性, 导致 Reflect.metadata 失效 Parameters Returns void - [Function: requestWithMemo](/auto-docs/editor/functions/requestWithMemo.md): requestWithMemo(req, cacheTime?, createCacheKey?): RequestFn Parameters Returns RequestFn - [Function: retry](/auto-docs/editor/functions/retry.md): retry(task, delayTime, retries, shouldRetry?): Promise Type parameters Parameters Returns Promise - [Function: safeKey](/auto-docs/editor/functions/safeKey.md): safeKey(key): string filter dangerous key, prevent prototype pollution injection Parameters Returns string filtered key - [Function: scrollIntoViewWithTween](/auto-docs/editor/functions/scrollIntoViewWithTween.md): scrollIntoViewWithTween(opts): Disposable 滚动到可视区域 Parameters Returns Disposable - [Function: setByKey](/auto-docs/editor/functions/setByKey.md): setByKey(target, key, newValue, autoCreateObject?, clone?): any Parameters Returns any Example - [Function: _setIdx](/auto-docs/editor/functions/setIdx.md): _setIdx(idx): void Parameters Returns void - [Function: startTween](/auto-docs/editor/functions/startTween.md): startTween(opts): Disposable Type parameters Parameters Returns Disposable - [Function: useAvailableVariables](/auto-docs/editor/functions/useAvailableVariables.md): useAvailableVariables(): VariableDeclaration[] Get available variable list in the current scope. If no scope, return global variable list.The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useBaseColor](/auto-docs/editor/functions/useBaseColor.md): useBaseColor(): Object Returns Object - [Function: useConfigEntity](/auto-docs/editor/functions/useConfigEntity.md): useConfigEntity(entityRegistry, listenChange?): T 获取 config entity Type parameters Parameters Returns T - [Function: useCurrentField](/auto-docs/editor/functions/useCurrentField.md): useCurrentField(): IField | IFieldArray Get the current Field. It should be used in a child component of , otherwise it throws an error Type parameters Returns IField | IFieldArray - [Function: useCurrentFieldState](/auto-docs/editor/functions/useCurrentFieldState.md): useCurrentFieldState(): FieldState Get the current field state. It should be used in a child component of , otherwise it throws an error Returns FieldState - [Function: useCurrentScope](/auto-docs/editor/functions/useCurrentScope.md): useCurrentScope(params?): Strict extends true ? Scope> : undefined | Scope> useCurrentScope returns the scope provided by ScopeProvider. Type parameters Parameters Returns Strict extends true ? Scope> : undefined | Scope> - [Function: useEntities](/auto-docs/editor/functions/useEntities.md): useEntities(entityRegistry): T[] 获取 entities 并监听变化 Type parameters Parameters Returns T[] Deprecated - [Function: useEntityDataFromContext](/auto-docs/editor/functions/useEntityDataFromContext.md): useEntityDataFromContext(dataRegistry, listenChange?): T 从上下 PlaygroundEntityContext 获取 entity data 并监听变化 (默认不监听) Type parameters Parameters Returns T - [Function: useEntityFromContext](/auto-docs/editor/functions/useEntityFromContext.md): useEntityFromContext(listenChange?): T 从上下 PlaygroundEntityContext 获取 entity 并监听变化(默认不监听) Type parameters Parameters Returns T - [Function: useField](/auto-docs/editor/functions/useField.md): useField(name?): TField | undefined Type parameters Parameters Returns TField | undefined Deprecated useField is deprecated because its return relies on React render. if the Field is not rendered, the return would be undefined. If you simply want to monitor the change of the value of a certain path, please use useWatch(fieldName) - [Function: useFieldValidate](/auto-docs/editor/functions/useFieldValidate.md): useFieldValidate(name?): () => void Get validate method of a field with given name. the returned function could possibly do nothing if the field is not found. The reason could be that the field is not rendered yet or the name given is wrong. Parameters Returns fn (): void Returns void - [Function: useFlowEditor](/auto-docs/editor/functions/useFlowEditor.md): useFlowEditor(): FlowEditorClient Returns FlowEditorClient - [Function: useForm](/auto-docs/editor/functions/useForm.md): useForm(): IForm Get Form instance. It should be use in a child component of

Returns IForm - [Function: useHighlight](/auto-docs/editor/functions/useHighlight.md): useHighlight(props): null | MutableRefObject Parameters Returns null | MutableRefObject - [Function: useInitializedFormModel](/auto-docs/editor/functions/useInitializedFormModel.md): useInitializedFormModel(node): FormModel Listen to FormModel's initialization and refresh React component. By providing related node, you can use this hook outside the Form Component. Parameters Returns FormModel - [Function: useListenEvents](/auto-docs/editor/functions/useListenEvents.md): useListenEvents(...events): void 监听 event 事件变化 Parameters Returns void - [Function: useObserve](/auto-docs/editor/functions/useObserve.md): useObserve(value): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: useOutputVariables](/auto-docs/editor/functions/useOutputVariables.md): useOutputVariables(): VariableDeclaration[] Get output variable list in the current scope. The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: usePlayground](/auto-docs/editor/functions/usePlayground.md): usePlayground(): Playground 获取 playground Returns Playground - [Function: usePlaygroundContainer](/auto-docs/editor/functions/usePlaygroundContainer.md): usePlaygroundContainer(): Container 获取 playground inversify container Returns Container - [Function: usePlaygroundContext](/auto-docs/editor/functions/usePlaygroundContext.md): usePlaygroundContext(): T 获取 playground context 数据 Type parameters Returns T - [Function: usePlaygroundDrag](/auto-docs/editor/functions/usePlaygroundDrag.md): usePlaygroundDrag(): UsePlaygroundDragReturn Returns UsePlaygroundDragReturn - [Function: useReactiveState](/auto-docs/editor/functions/useReactiveState.md): useReactiveState(v): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: useReadonlyReactiveState](/auto-docs/editor/functions/useReadonlyReactiveState.md): useReadonlyReactiveState(state): Readonly Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns Readonly - [Function: useRefresh](/auto-docs/editor/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (v?): void Parameters Returns void - [Function: useScopeAvailable](/auto-docs/editor/functions/useScopeAvailable.md): useScopeAvailable(params?): ScopeAvailableData Get the available variables in the current scope. 获取作用域的可访问变量 Parameters Returns ScopeAvailableData the available variables in the current scope - [Function: useService](/auto-docs/editor/functions/useService.md): useService(identifier): T 获取画布的 IOC 模块 Type parameters Parameters Returns T - [Function: useWatch](/auto-docs/editor/functions/useWatch.md): useWatch(name): TValue Listen to the field data change and refresh the React component. Type parameters Parameters Returns TValue - [Function: useWatchFormErrors](/auto-docs/editor/functions/useWatchFormErrors.md): useWatchFormErrors(node): Errors | undefined Get Form's errors, Form errors is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Errors | undefined - [Function: useWatchFormState](/auto-docs/editor/functions/useWatchFormState.md): useWatchFormState(node): FormState | undefined Get Form's state, Form State is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns FormState | undefined - [Function: useWatchFormValueIn](/auto-docs/editor/functions/useWatchFormValueIn.md): useWatchFormValueIn(node, name): T | undefined Listen to Form's value in a certain path and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormValues](/auto-docs/editor/functions/useWatchFormValues.md): useWatchFormValues(node): T | undefined Listen to Form's values and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormWarnings](/auto-docs/editor/functions/useWatchFormWarnings.md): useWatchFormWarnings(node): Warnings | undefined Get Form's warnings, Form warnings is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Warnings | undefined - [Function: values](/auto-docs/editor/functions/values.md): values(obj): any[] Parameters Returns any[] - [Interface: ASTNodeJSON](/auto-docs/editor/interfaces/ASTNodeJSON.md): ASTNodeJSON is the JSON representation of an ASTNode. - [Interface: ASTNodeRegistry](/auto-docs/editor/interfaces/ASTNodeRegistry.md) - [Interface: AddBlockConfig](/auto-docs/editor/interfaces/AddBlockConfig.md): 添加block时的配置 - [Interface: AddBlockOperation](/auto-docs/editor/interfaces/AddBlockOperation.md) - [Interface: AddChildNodeOperation](/auto-docs/editor/interfaces/AddChildNodeOperation.md) - [Interface: AddFromNodeOperation](/auto-docs/editor/interfaces/AddFromNodeOperation.md) - [Interface: AddNodeOperation](/auto-docs/editor/interfaces/AddNodeOperation.md) - [Interface: AddNodesOperation](/auto-docs/editor/interfaces/AddNodesOperation.md) - [Interface: AddOrDeleteBlockValue](/auto-docs/editor/interfaces/AddOrDeleteBlockValue.md) - [Interface: AddOrDeleteChildNodeValue](/auto-docs/editor/interfaces/AddOrDeleteChildNodeValue.md) - [Interface: AddOrDeleteFromNodeOperationValue](/auto-docs/editor/interfaces/AddOrDeleteFromNodeOperationValue.md) - [Interface: AddOrDeleteNodeOperationValue](/auto-docs/editor/interfaces/AddOrDeleteNodeOperationValue.md) - [Interface: AddOrDeleteNodeValue](/auto-docs/editor/interfaces/AddOrDeleteNodeValue.md) - [Interface: AddOrDeleteNodesOperationValue](/auto-docs/editor/interfaces/AddOrDeleteNodesOperationValue.md) - [Interface: AdderProps](/auto-docs/editor/interfaces/AdderProps.md) - [Interface: AsClass](/auto-docs/editor/interfaces/AsClass.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheManager](/auto-docs/editor/interfaces/CacheManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheOpts](/auto-docs/editor/interfaces/CacheOpts.md) - [Interface: CacheOriginItem](/auto-docs/editor/interfaces/CacheOriginItem.md) - [Interface: CancellationToken](/auto-docs/editor/interfaces/CancellationToken-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ClipboardService](/auto-docs/editor/interfaces/ClipboardService.md) - [Interface: CollapseAdderProps](/auto-docs/editor/interfaces/CollapseAdderProps.md) - [Interface: CollapseProps](/auto-docs/editor/interfaces/CollapseProps.md) - [Interface: CollisionRetType](/auto-docs/editor/interfaces/CollisionRetType.md) - [Interface: Command](/auto-docs/editor/interfaces/Command-1.md) - [Interface: CommandService](/auto-docs/editor/interfaces/CommandService.md): command service 执行接口 - [Interface: ConfigEntityProps](/auto-docs/editor/interfaces/ConfigEntityProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ContributionProvider](/auto-docs/editor/interfaces/ContributionProvider.md) - [Interface: CreateASTParams](/auto-docs/editor/interfaces/CreateASTParams.md) - [Interface: CreateGroupOperation](/auto-docs/editor/interfaces/CreateGroupOperation.md) - [Interface: CustomLabelProps](/auto-docs/editor/interfaces/CustomLabelProps.md) - [Interface: CustomTypeJSON](/auto-docs/editor/interfaces/CustomTypeJSON.md): ASTNodeJSON representation of CustomType - [Interface: DOMCache](/auto-docs/editor/interfaces/DOMCache.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: DeleteBlockOperation](/auto-docs/editor/interfaces/DeleteBlockOperation.md) - [Interface: DeleteChildNodeOperation](/auto-docs/editor/interfaces/DeleteChildNodeOperation.md) - [Interface: DeleteFromNodeOperation](/auto-docs/editor/interfaces/DeleteFromNodeOperation.md) - [Interface: DeleteNodeOperation](/auto-docs/editor/interfaces/DeleteNodeOperation.md) - [Interface: DeleteNodesOperation](/auto-docs/editor/interfaces/DeleteNodesOperation.md) - [Interface: Disposable](/auto-docs/editor/interfaces/Disposable-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: DragNodeProps](/auto-docs/editor/interfaces/DragNodeProps.md) - [Interface: EditorPluginContext](/auto-docs/editor/interfaces/EditorPluginContext.md) - [Interface: EditorProps](/auto-docs/editor/interfaces/EditorProps-1.md) - [Interface: EditorState](/auto-docs/editor/interfaces/EditorState-1.md): 编辑态 - [Interface: EditorStateChangeEvent](/auto-docs/editor/interfaces/EditorStateChangeEvent.md) - [Interface: EffectFuncProps](/auto-docs/editor/interfaces/EffectFuncProps.md) - [Interface: EntityDataChangedEvent](/auto-docs/editor/interfaces/EntityDataChangedEvent.md) - [Interface: EntityDataRegistry](/auto-docs/editor/interfaces/EntityDataRegistry.md) - [Interface: EntityJSON](/auto-docs/editor/interfaces/EntityJSON.md): 持久化数据 - [Interface: EntityManagerContribution](/auto-docs/editor/interfaces/EntityManagerContribution.md) - [Interface: EntityOpts](/auto-docs/editor/interfaces/EntityOpts.md) - [Interface: EntityRegistry](/auto-docs/editor/interfaces/EntityRegistry.md): 注册类 - [Interface: EnumerateExpressionJSON](/auto-docs/editor/interfaces/EnumerateExpressionJSON.md): ASTNodeJSON representation of EnumerateExpression - [Interface: Event](/auto-docs/editor/interfaces/Event-1.md) - [Interface: EventListener](/auto-docs/editor/interfaces/EventListener.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FieldArrayRenderProps](/auto-docs/editor/interfaces/FieldArrayRenderProps.md) - [Interface: FieldRenderProps](/auto-docs/editor/interfaces/FieldRenderProps.md) - [Interface: FieldState](/auto-docs/editor/interfaces/FieldState.md) - [Interface: FlipSchema](/auto-docs/editor/interfaces/FlipSchema.md) - [Interface: Flow](/auto-docs/editor/interfaces/Flow.md) - [Interface: FlowDocumentContribution](/auto-docs/editor/interfaces/FlowDocumentContribution.md) - [Interface: FlowDocumentOptions](/auto-docs/editor/interfaces/FlowDocumentOptions.md): 流程画布配置 - [Interface: FlowDragOptions](/auto-docs/editor/interfaces/FlowDragOptions.md) - [Interface: FlowGroupJSON](/auto-docs/editor/interfaces/FlowGroupJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowLayout](/auto-docs/editor/interfaces/FlowLayout.md): 流程布局算法 - [Interface: FlowLayoutContribution](/auto-docs/editor/interfaces/FlowLayoutContribution.md) - [Interface: FlowNodeEntityConfig](/auto-docs/editor/interfaces/FlowNodeEntityConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowNodeInitData](/auto-docs/editor/interfaces/FlowNodeInitData.md) - [Interface: FlowNodeJSON](/auto-docs/editor/interfaces/FlowNodeJSON.md): Flow node json data - [Interface: FlowNodeMeta](/auto-docs/editor/interfaces/FlowNodeMeta.md): 节点渲染相关配置信息，可扩展 - [Interface: FlowNodeRegistry](/auto-docs/editor/interfaces/FlowNodeRegistry-1.md): 节点注册 - [Interface: FlowNodeRenderSchema](/auto-docs/editor/interfaces/FlowNodeRenderSchema.md) - [Interface: FlowNodeScope](/auto-docs/editor/interfaces/FlowNodeScope.md): Represents a scope associated with a flow node. - [Interface: FlowNodeScopeMeta](/auto-docs/editor/interfaces/FlowNodeScopeMeta.md): Metadata for a flow node scope. - [Interface: FlowNodeTransformSchema](/auto-docs/editor/interfaces/FlowNodeTransformSchema.md) - [Interface: FlowNodeTransitionSchema](/auto-docs/editor/interfaces/FlowNodeTransitionSchema.md) - [Interface: FlowNodesTransformLayerOptions](/auto-docs/editor/interfaces/FlowNodesTransformLayerOptions.md) - [Interface: FlowOperationBaseService](/auto-docs/editor/interfaces/FlowOperationBaseService.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: FlowRendererComponent](/auto-docs/editor/interfaces/FlowRendererComponent.md) - [Interface: FlowRendererContribution](/auto-docs/editor/interfaces/FlowRendererContribution.md) - [Interface: FlowSelectorBoundsLayerOptions](/auto-docs/editor/interfaces/FlowSelectorBoundsLayerOptions.md) - [Interface: FlowSelectorBoxOptions](/auto-docs/editor/interfaces/FlowSelectorBoxOptions.md) - [Interface: FlowTransitionLabel](/auto-docs/editor/interfaces/FlowTransitionLabel.md) - [Interface: FlowTransitionLine](/auto-docs/editor/interfaces/FlowTransitionLine.md) - [Interface: NodeInfo](/auto-docs/editor/interfaces/FlowVirtualTree.NodeInfo.md): FlowVirtualTree.NodeInfo - [Interface: FocusNodeFormItemOptions](/auto-docs/editor/interfaces/FocusNodeFormItemOptions.md) - [Interface: FormControl](/auto-docs/editor/interfaces/FormControl.md) - [Interface: FormMeta](/auto-docs/editor/interfaces/FormMeta.md) - [Interface: FormPluginConfig](/auto-docs/editor/interfaces/FormPluginConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FormRenderProps](/auto-docs/editor/interfaces/FormRenderProps.md) - [Interface: FormState](/auto-docs/editor/interfaces/FormState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: GlobalEventActionType](/auto-docs/editor/interfaces/GlobalEventActionType.md): Global event action type. Global event might be dispatched from ASTNode or Scope. - [Interface: HighLightOptions](/auto-docs/editor/interfaces/HighLightOptions.md) - [Interface: I18nLanguage](/auto-docs/editor/interfaces/I18nLanguage.md) - [Interface: I18nPluginOptions](/auto-docs/editor/interfaces/I18nPluginOptions.md) - [Interface: IField](/auto-docs/editor/interfaces/IField.md): Field render model, it's only available when Field is rendered - [Interface: IFieldArray](/auto-docs/editor/interfaces/IFieldArray.md): FieldArray render model, it's only available when FieldArray is rendered - [Interface: IForm](/auto-docs/editor/interfaces/IForm.md) - [Interface: IPoint](/auto-docs/editor/interfaces/IPoint.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: IVariableTable](/auto-docs/editor/interfaces/IVariableTable.md): Interface for a variable table. - [Interface: KeyPathExpressionJSON](/auto-docs/editor/interfaces/KeyPathExpressionJSON.md): ASTNodeJSON representation of KeyPathExpression - [Interface: LayerEntitiesSelector](/auto-docs/editor/interfaces/LayerEntitiesSelector.md) - [Interface: LayerOptions](/auto-docs/editor/interfaces/LayerOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: LayerRegistry

](/auto-docs/editor/interfaces/LayerRegistry.md) - [Interface: ListNodeJSON](/auto-docs/editor/interfaces/ListNodeJSON.md): ASTNodeJSON representation of ListNode - [Interface: LoggerProps](/auto-docs/editor/interfaces/LoggerProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: MapNodeJSON](/auto-docs/editor/interfaces/MapNodeJSON.md): ASTNodeJSON representation of MapNode - [Interface: MoveBlockOperation](/auto-docs/editor/interfaces/MoveBlockOperation.md) - [Interface: MoveChildNodesOperation](/auto-docs/editor/interfaces/MoveChildNodesOperation.md) - [Interface: MoveChildNodesOperationValue](/auto-docs/editor/interfaces/MoveChildNodesOperationValue.md) - [Interface: MoveNodeConfig](/auto-docs/editor/interfaces/MoveNodeConfig.md): 移动节点时的配置 - [Interface: MoveNodesOperation](/auto-docs/editor/interfaces/MoveNodesOperation.md) - [Interface: MoveNodesOperationValue](/auto-docs/editor/interfaces/MoveNodesOperationValue.md) - [Interface: Node](/auto-docs/editor/interfaces/Node.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeCorePluginOptions](/auto-docs/editor/interfaces/NodeCorePluginOptions.md) - [Interface: NodeEngineMaterialOptions](/auto-docs/editor/interfaces/NodeEngineMaterialOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeFormProps](/auto-docs/editor/interfaces/NodeFormProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeRenderProps](/auto-docs/editor/interfaces/NodeRenderProps.md) - [Interface: NodeSchema](/auto-docs/editor/interfaces/NodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ObjectJSON](/auto-docs/editor/interfaces/ObjectJSON.md): ASTNodeJSON representation of ObjectType - [Interface: Observer](/auto-docs/editor/interfaces/Observer.md): An object interface that defines a set of callback functions a user can use to get notified of any set of Observable guide/glossary-and-semantics#notification notification events. For more info, please refer to guide/observer this guide. - [Interface: OnNodeAddEvent](/auto-docs/editor/interfaces/OnNodeAddEvent.md): 节点添加事件 - [Interface: OnNodeMoveEvent](/auto-docs/editor/interfaces/OnNodeMoveEvent.md): 节点移动事件 - [Interface: OriginSchema](/auto-docs/editor/interfaces/OriginSchema.md) - [Interface: PaddingSchema](/auto-docs/editor/interfaces/PaddingSchema-1.md) - [Interface: PipelineDimension](/auto-docs/editor/interfaces/PipelineDimension.md) - [Interface: PipelineEntities](/auto-docs/editor/interfaces/PipelineEntities.md): 注入到 Layer 中的实体选择器 - [Interface: PipelineEventRegsiter](/auto-docs/editor/interfaces/PipelineEventRegsiter.md) - [Interface: PlaygroundConfig](/auto-docs/editor/interfaces/PlaygroundConfig.md): 画布配置 - [Interface: PlaygroundConfigEntityData](/auto-docs/editor/interfaces/PlaygroundConfigEntityData.md) - [Interface: PlaygroundConfigRevealOpts](/auto-docs/editor/interfaces/PlaygroundConfigRevealOpts.md) - [Interface: PlaygroundContainerFactory](/auto-docs/editor/interfaces/PlaygroundContainerFactory.md) - [Interface: PlaygroundContribution](/auto-docs/editor/interfaces/PlaygroundContribution.md) - [Interface: PlaygroundDragEntitiesOpts](/auto-docs/editor/interfaces/PlaygroundDragEntitiesOpts.md) - [Interface: PlaygroundDragEvent](/auto-docs/editor/interfaces/PlaygroundDragEvent.md) - [Interface: PlaygroundDragOptions](/auto-docs/editor/interfaces/PlaygroundDragOptions.md) - [Interface: PlaygroundLayerOptions](/auto-docs/editor/interfaces/PlaygroundLayerOptions.md) - [Interface: PlaygroundReactProviderProps](/auto-docs/editor/interfaces/PlaygroundReactProviderProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PlaygroundReactRendererProps](/auto-docs/editor/interfaces/PlaygroundReactRendererProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PluginBindConfig](/auto-docs/editor/interfaces/PluginBindConfig.md) - [Interface: PluginConfig](/auto-docs/editor/interfaces/PluginConfig.md) - [Interface: PluginContext](/auto-docs/editor/interfaces/PluginContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PluginsProvider](/auto-docs/editor/interfaces/PluginsProvider.md) - [Interface: PositionSchema](/auto-docs/editor/interfaces/PositionSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PromisePoolOpts](/auto-docs/editor/interfaces/PromisePoolOpts.md) - [Interface: PromiseTask](/auto-docs/editor/interfaces/PromiseTask.md) - [Interface: RegistryInit](/auto-docs/editor/interfaces/RegistryInit.md) - [Interface: RegistryValueGetter](/auto-docs/editor/interfaces/RegistryValueGetter.md) - [Interface: ScaleSchema](/auto-docs/editor/interfaces/ScaleSchema.md) - [Interface: SchemaDecoration](/auto-docs/editor/interfaces/SchemaDecoration-1.md) - [Interface: ScrollBarEvents](/auto-docs/editor/interfaces/ScrollBarEvents.md) - [Interface: ScrollBarOptions](/auto-docs/editor/interfaces/ScrollBarOptions.md) - [Interface: ScrollIntoViewOpts](/auto-docs/editor/interfaces/ScrollIntoViewOpts.md) - [Interface: ScrollSchema](/auto-docs/editor/interfaces/ScrollSchema.md) - [Interface: SelectorBoxConfigData](/auto-docs/editor/interfaces/SelectorBoxConfigData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: SelectorBoxPopoverProps](/auto-docs/editor/interfaces/SelectorBoxPopoverProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ShadowSchema](/auto-docs/editor/interfaces/ShadowSchema.md) - [Interface: ShortCache](/auto-docs/editor/interfaces/ShortCache.md) - [Interface: ShortcutsContribution](/auto-docs/editor/interfaces/ShortcutsContribution.md) - [Interface: ShortcutsHandler](/auto-docs/editor/interfaces/ShortcutsHandler.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: SizeSchema](/auto-docs/editor/interfaces/SizeSchema-1.md) - [Interface: SkewSchema](/auto-docs/editor/interfaces/SkewSchema.md) - [Interface: StorageService](/auto-docs/editor/interfaces/StorageService.md): 存储数据到缓存 - [Interface: TintSchema](/auto-docs/editor/interfaces/TintSchema-1.md) - [Interface: FlushOptions](/auto-docs/editor/interfaces/Tracker.FlushOptions.md): Tracker.FlushOptions - [Interface: TransformNodeSchema](/auto-docs/editor/interfaces/TransformNodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: TransformSchema](/auto-docs/editor/interfaces/TransformSchema-1.md) - [Interface: TweenOpts](/auto-docs/editor/interfaces/TweenOpts.md) - [Interface: UngroupOperation](/auto-docs/editor/interfaces/UngroupOperation.md) - [Interface: UnionJSON](/auto-docs/editor/interfaces/UnionJSON.md): ASTNodeJSON representation of UnionType, which union multiple BaseType. - [Interface: VariableAbilityParseContext](/auto-docs/editor/interfaces/VariableAbilityParseContext.md) - [Interface: VariableConsumerAbilityOptions](/auto-docs/editor/interfaces/VariableConsumerAbilityOptions.md) - [Interface: VariableDeclarationListJSON](/auto-docs/editor/interfaces/VariableDeclarationListJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: VariablePluginOptions](/auto-docs/editor/interfaces/VariablePluginOptions.md) - [Interface: VariableProviderAbilityOptions](/auto-docs/editor/interfaces/VariableProviderAbilityOptions.md) - [Interface: Vertex](/auto-docs/editor/interfaces/Vertex.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: WeakCache](/auto-docs/editor/interfaces/WeakCache.md) - [Interface: WrapArrayExpressionJSON](/auto-docs/editor/interfaces/WrapArrayExpressionJSON.md): ASTNodeJSON representation of WrapArrayExpression - [Interface: createOrUngroupValue](/auto-docs/editor/interfaces/createOrUngroupValue.md) - [Interface: Abstract](/auto-docs/editor/interfaces/interfaces.Abstract.md): interfaces.Abstract - [Interface: AsyncContainerModule](/auto-docs/editor/interfaces/interfaces.AsyncContainerModule.md): interfaces.AsyncContainerModule - [Interface: Binding](/auto-docs/editor/interfaces/interfaces.Binding.md): interfaces.Binding - [Interface: BindingInSyntax](/auto-docs/editor/interfaces/interfaces.BindingInSyntax.md): interfaces.BindingInSyntax - [Interface: BindingInWhenOnSyntax](/auto-docs/editor/interfaces/interfaces.BindingInWhenOnSyntax.md): interfaces.BindingInWhenOnSyntax - [Interface: BindingOnSyntax](/auto-docs/editor/interfaces/interfaces.BindingOnSyntax.md): interfaces.BindingOnSyntax - [Interface: BindingScopeEnum](/auto-docs/editor/interfaces/interfaces.BindingScopeEnum.md): interfaces.BindingScopeEnum - [Interface: BindingToSyntax](/auto-docs/editor/interfaces/interfaces.BindingToSyntax.md): interfaces.BindingToSyntax - [Interface: BindingTypeEnum](/auto-docs/editor/interfaces/interfaces.BindingTypeEnum.md): interfaces.BindingTypeEnum - [Interface: BindingWhenOnSyntax](/auto-docs/editor/interfaces/interfaces.BindingWhenOnSyntax.md): interfaces.BindingWhenOnSyntax - [Interface: BindingWhenSyntax](/auto-docs/editor/interfaces/interfaces.BindingWhenSyntax.md): interfaces.BindingWhenSyntax - [Interface: Clonable](/auto-docs/editor/interfaces/interfaces.Clonable.md): interfaces.Clonable - [Interface: ConstraintFunction](/auto-docs/editor/interfaces/interfaces.ConstraintFunction.md): interfaces.ConstraintFunction - [Interface: ConstructorMetadata](/auto-docs/editor/interfaces/interfaces.ConstructorMetadata.md): interfaces.ConstructorMetadata - [Interface: Container](/auto-docs/editor/interfaces/interfaces.Container.md): interfaces.Container - [Interface: ContainerModule](/auto-docs/editor/interfaces/interfaces.ContainerModule.md): interfaces.ContainerModule - [Interface: ContainerModuleBase](/auto-docs/editor/interfaces/interfaces.ContainerModuleBase.md): interfaces.ContainerModuleBase - [Interface: ContainerOptions](/auto-docs/editor/interfaces/interfaces.ContainerOptions.md): interfaces.ContainerOptions - [Interface: ContainerSnapshot](/auto-docs/editor/interfaces/interfaces.ContainerSnapshot.md): interfaces.ContainerSnapshot - [Interface: Context](/auto-docs/editor/interfaces/interfaces.Context.md): interfaces.Context - [Interface: FactoryDetails](/auto-docs/editor/interfaces/interfaces.FactoryDetails.md): interfaces.FactoryDetails - [Interface: GetAllOptions](/auto-docs/editor/interfaces/interfaces.GetAllOptions.md): interfaces.GetAllOptions - [Interface: Lookup](/auto-docs/editor/interfaces/interfaces.Lookup.md): interfaces.Lookup - [Interface: Metadata](/auto-docs/editor/interfaces/interfaces.Metadata.md): interfaces.Metadata - [Interface: MetadataMap](/auto-docs/editor/interfaces/interfaces.MetadataMap.md): interfaces.MetadataMap - [Interface: MetadataReader](/auto-docs/editor/interfaces/interfaces.MetadataReader.md): interfaces.MetadataReader - [Interface: ModuleActivationHandlers](/auto-docs/editor/interfaces/interfaces.ModuleActivationHandlers.md): interfaces.ModuleActivationHandlers - [Interface: ModuleActivationStore](/auto-docs/editor/interfaces/interfaces.ModuleActivationStore.md): interfaces.ModuleActivationStore - [Interface: NextArgs](/auto-docs/editor/interfaces/interfaces.NextArgs.md): interfaces.NextArgs - [Interface: Plan](/auto-docs/editor/interfaces/interfaces.Plan.md): interfaces.Plan - [Interface: QueryableString](/auto-docs/editor/interfaces/interfaces.QueryableString.md): interfaces.QueryableString - [Interface: Request](/auto-docs/editor/interfaces/interfaces.Request.md): interfaces.Request - [Interface: TargetTypeEnum](/auto-docs/editor/interfaces/interfaces.TargetTypeEnum.md): interfaces.TargetTypeEnum - [Interface: onFormValueChangeInPayload](/auto-docs/editor/interfaces/onFormValueChangeInPayload.md) - [Namespace: ASTFactory](/auto-docs/editor/modules/ASTFactory.md): Variable-core ASTNode factories. - [Namespace: ASTMatch](/auto-docs/editor/modules/ASTMatch.md): Variable-core ASTNode matchers. Typescript code inside if statement will be type guarded. - [Namespace: Angle](/auto-docs/editor/modules/Angle.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Bounds](/auto-docs/editor/modules/Bounds.md) - [Namespace: Cache](/auto-docs/editor/modules/Cache.md): 缓存工具： 可延迟按需创建，提升性能可支持多个或单个，有些动态创建多个的场景可以共享已有的实例，提升性能自动删除，超过一定的数目会自动做清空回收 Example - [Namespace: CancellationToken](/auto-docs/editor/modules/CancellationToken.md) - [Namespace: Command](/auto-docs/editor/modules/Command.md) - [Namespace: Compare](/auto-docs/editor/modules/Compare.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Disposable](/auto-docs/editor/modules/Disposable.md) - [Namespace: EditorProps](/auto-docs/editor/modules/EditorProps.md) - [Namespace: EditorState](/auto-docs/editor/modules/EditorState.md) - [Namespace: Entity](/auto-docs/editor/modules/Entity.md) - [Namespace: Event](/auto-docs/editor/modules/Event.md) - [Namespace: FlowLayoutDefault](/auto-docs/editor/modules/FlowLayoutDefault.md) - [Namespace: FlowNodeEntity](/auto-docs/editor/modules/FlowNodeEntity.md) - [Namespace: FlowNodeRegistry](/auto-docs/editor/modules/FlowNodeRegistry.md) - [Namespace: FlowVirtualTree](/auto-docs/editor/modules/FlowVirtualTree.md) - [Namespace: MouseTouchEvent](/auto-docs/editor/modules/MouseTouchEvent.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: PaddingSchema](/auto-docs/editor/modules/PaddingSchema.md) - [Namespace: PlaygroundDrag](/auto-docs/editor/modules/PlaygroundDrag.md) - [Namespace: PlaygroundMockTools](/auto-docs/editor/modules/PlaygroundMockTools.md): 画布测试工具 Example - [Namespace: Point](/auto-docs/editor/modules/Point.md) - [Namespace: Rectangle](/auto-docs/editor/modules/Rectangle.md) - [Namespace: Schema](/auto-docs/editor/modules/Schema.md) - [Namespace: SchemaDecoration](/auto-docs/editor/modules/SchemaDecoration.md) - [Namespace: SizeSchema](/auto-docs/editor/modules/SizeSchema.md) - [Namespace: TintSchema](/auto-docs/editor/modules/TintSchema.md) - [Namespace: Tracker](/auto-docs/editor/modules/Tracker.md): Tracker 是一套 响应式依赖追踪 库，来源于 Meteor.Tracker https://docs.meteor.com/api/Tracker.html#tracker-autorun-and-async-callbacks https://github.com/meteor/meteor/blob/devel/packages/tracker/tracker.js 相关论文：https://dl.acm.org/doi/fullHtml/10.1145/3184558.3185978 - [Namespace: TransformData](/auto-docs/editor/modules/TransformData.md) - [Namespace: TransformSchema](/auto-docs/editor/modules/TransformSchema.md) - [Namespace: domUtils](/auto-docs/editor/modules/domUtils.md) - [Namespace: interfaces](/auto-docs/editor/modules/interfaces.md) - [Type alias: AddNodeConfig](/auto-docs/editor/types/AddNodeConfig.md): AddNodeConfig: Object Type declaration - [Type alias: AddNodeData](/auto-docs/editor/types/AddNodeData.md): AddNodeData: FlowNodeJSON & { hidden?: boolean ; index?: number ; originParent?: FlowNodeEntity ; parent?: FlowNodeEntity } - [Type alias: ArrayAppendEffect](/auto-docs/editor/types/ArrayAppendEffect.md): ArrayAppendEffect: (props: { arrayValues: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number ; value: TFieldValue }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: ArrayDeleteEffect](/auto-docs/editor/types/ArrayDeleteEffect.md): ArrayDeleteEffect: (props: { arrayValue: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: CSSStyle](/auto-docs/editor/types/CSSStyle.md): CSSStyle: { [P in keyof CSSStyleDeclaration]?: string | number } Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: Cache](/auto-docs/editor/types/Cache-1.md): Cache: { [P in keyof T]: T[P] } & { dispose?: () => void ; key?: any } Type parameters - [Type alias: Cursors](/auto-docs/editor/types/Cursors.md): Cursors: Record - [Type alias: Effect](/auto-docs/editor/types/Effect.md): Effect: (props: EffectFuncProps) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: EffectOptions](/auto-docs/editor/types/EffectOptions.md): EffectOptions: { effect: Effect ; event: DataEvent } | { effect: ArrayAppendEffect ; event: DataEvent } | { effect: ArrayDeleteEffect ; event: DataEvent } - [Type alias: EffectReturn](/auto-docs/editor/types/EffectReturn.md): EffectReturn: () => void Type declaration (): void Returns void - [Type alias: EntityDataInjector](/auto-docs/editor/types/EntityDataInjector.md): EntityDataInjector: () => OPTS Type declaration (): OPTS Type parameters Returns OPTS - [Type alias: EntityDataProps](/auto-docs/editor/types/EntityDataProps.md): EntityDataProps: E["data"] Type parameters - [Type alias: Errors](/auto-docs/editor/types/Errors.md): Errors: Record - [Type alias: FieldError](/auto-docs/editor/types/FieldError.md): FieldError: Feedback - [Type alias: FieldName](/auto-docs/editor/types/FieldName.md): FieldName: string - [Type alias: FieldWarning](/auto-docs/editor/types/FieldWarning.md): FieldWarning: Feedback - [Type alias: FlowDocumentJSON](/auto-docs/editor/types/FlowDocumentJSON.md): FlowDocumentJSON: Object Type declaration - [Type alias: FlowDocumentProvider](/auto-docs/editor/types/FlowDocumentProvider.md): FlowDocumentProvider: () => FlowDocument Type declaration (): FlowDocument Returns FlowDocument - [Type alias: FlowNodeEntityOrId](/auto-docs/editor/types/FlowNodeEntityOrId.md): FlowNodeEntityOrId: string | FlowNodeEntity - [Type alias: FlowNodeType](/auto-docs/editor/types/FlowNodeType.md): FlowNodeType: string | number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: FlowOperation](/auto-docs/editor/types/FlowOperation.md): FlowOperation: AddFromNodeOperation | DeleteFromNodeOperation | AddBlockOperation | DeleteBlockOperation | CreateGroupOperation | UngroupOperation | MoveNodesOperation | AddNodesOperation | DeleteNodesOperation | MoveBlockOperation | AddChildNodeOperation | DeleteChildNodeOperation | MoveChildNodesOperation | AddNodeOperation | DeleteNodeOperation - [Type alias: FocusNodeCanvasOptions](/auto-docs/editor/types/FocusNodeCanvasOptions.md): FocusNodeCanvasOptions: PlaygroundConfigRevealOpts - [Type alias: FormPluginCreator](/auto-docs/editor/types/FormPluginCreator.md): FormPluginCreator: (opts: Opts) => FormPlugin Type parameters Type declaration (opts): FormPlugin Parameters Returns FormPlugin - [Type alias: FormPluginCtx](/auto-docs/editor/types/FormPluginCtx.md): FormPluginCtx: { formModel: FormModel } & NodeContext - [Type alias: FormPluginSetupMetaCtx](/auto-docs/editor/types/FormPluginSetupMetaCtx.md): FormPluginSetupMetaCtx: { addFormatOnInit: (formatOnInit: FormMeta["formatOnInit"]) => void ; addFormatOnSubmit: (formatOnSubmit: FormMeta["formatOnSubmit"]) => void ; mergeEffect: (effect: Record) => void ; mergeValidate: (validate: Record) => void } & NodeContext - [Type alias: GetKindJSON](/auto-docs/editor/types/GetKindJSON.md): GetKindJSON: { key?: Identifier ; kind: KindType } & JSON TypeUtils to get the JSON representation of an AST node with a specific kind. Type parameters - [Type alias: GetKindJSONOrKind](/auto-docs/editor/types/GetKindJSONOrKind.md): GetKindJSONOrKind: { key?: Identifier ; kind: KindType } & JSON | KindType TypeUtils to get the JSON representation of an AST node with a specific kind or just the kind string. Type parameters - [Type alias: ISize](/auto-docs/editor/types/ISize.md): ISize: Object Size object, contains width and height Type declaration - [Type alias: LocalId](/auto-docs/editor/types/LocalId.md): LocalId: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: MarginSchema](/auto-docs/editor/types/MarginSchema.md): MarginSchema: PaddingSchema - [Type alias: MaybeArray](/auto-docs/editor/types/MaybeArray.md): MaybeArray: T | T[] Type parameters - [Type alias: MaybePromise](/auto-docs/editor/types/MaybePromise.md): MaybePromise: T | PromiseLike Type parameters - [Type alias: MoveBlockOperationValue](/auto-docs/editor/types/MoveBlockOperationValue.md): MoveBlockOperationValue: Object Type declaration - [Type alias: ObjectPropertiesChangeAction](/auto-docs/editor/types/ObjectPropertiesChangeAction.md): ObjectPropertiesChangeAction: GlobalEventActionType<"ObjectPropertiesChange", { next: Property[] ; prev: Property[] }, ObjectType> Action type for object properties change. - [Type alias: OpacitySchema](/auto-docs/editor/types/OpacitySchema.md): OpacitySchema: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipeEventName](/auto-docs/editor/types/PipeEventName.md): PipeEventName: string - [Type alias: PipeSupportEvent](/auto-docs/editor/types/PipeSupportEvent.md): PipeSupportEvent: MouseEvent | DragEvent | KeyboardEvent | UIEvent | TouchEvent | any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipelineEventHandler](/auto-docs/editor/types/PipelineEventHandler.md): PipelineEventHandler: (event: PipeSupportEvent) => boolean | undefined Type declaration (event): boolean | undefined Parameters Returns boolean | undefined - [Type alias: PipelineLayerFactory](/auto-docs/editor/types/PipelineLayerFactory.md): PipelineLayerFactory: (layerRegistry: LayerRegistry, layerOptions?: any) => Layer Type declaration (layerRegistry, layerOptions?): Layer Parameters Returns Layer - [Type alias: PlaygroundContext](/auto-docs/editor/types/PlaygroundContext.md): PlaygroundContext: any - [Type alias: PlaygroundContextProvider](/auto-docs/editor/types/PlaygroundContextProvider.md): PlaygroundContextProvider: () => any Type declaration (): any Returns any - [Type alias: PlaygroundInteractiveType](/auto-docs/editor/types/PlaygroundInteractiveType.md): PlaygroundInteractiveType: "MOUSE" | "PAD" MOUSE: 鼠标友好模式，鼠标左键拖动画布，滚动缩放 (适合 windows ) PAD: 双指同向移动拖动，双指张开捏合缩放 (适合 mac) - [Type alias: PlaygroundScrollLimitFn](/auto-docs/editor/types/PlaygroundScrollLimitFn.md): PlaygroundScrollLimitFn: (scroll: { scrollX: number ; scrollY: number }) => { scrollX: number ; scrollY: number } Type declaration (scroll): Object Parameters Returns Object - [Type alias: Plugin](/auto-docs/editor/types/Plugin.md): Plugin: Object Type parameters Type declaration - [Type alias: PluginCreator](/auto-docs/editor/types/PluginCreator.md): PluginCreator: (opts: Options) => Plugin Type parameters Type declaration (opts): Plugin Parameters Returns Plugin - [Type alias: PropertyJSON](/auto-docs/editor/types/PropertyJSON.md): PropertyJSON: BaseVariableFieldJSON ASTNodeJSON representation of the Property. Type parameters - [Type alias: ProtectWheelArea](/auto-docs/editor/types/ProtectWheelArea.md): ProtectWheelArea: (dom: Element) => boolean Type declaration (dom): boolean Parameters Returns boolean - [Type alias: RecursivePartial](/auto-docs/editor/types/RecursivePartial.md): RecursivePartial: { [P in keyof T]?: T[P] extends (infer I)[] ? RecursivePartial[] : RecursivePartial } Type parameters - [Type alias: RotationSchema](/auto-docs/editor/types/RotationSchema.md): RotationSchema: number - [Type alias: SchemaType](/auto-docs/editor/types/SchemaType.md): SchemaType: "string" | "integer" | "float" | "boolean" | "enum" | "object" | "range" | "color" | "array" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: IComputationCallback](/auto-docs/editor/types/Tracker.IComputationCallback.md): Tracker.IComputationCallback IComputationCallback: ICallback Type parameters - [Type alias: Validate](/auto-docs/editor/types/Validate.md): Validate: (props: { context: Context ; formValues: TFormValues ; name: FieldName ; value: TFieldValue }) => MaybePromise | MaybePromise | MaybePromise | MaybePromise Type parameters Type declaration (props): MaybePromise | MaybePromise | MaybePromise | MaybePromise Parameters Returns MaybePromise | MaybePromise | MaybePromise | MaybePromise - [Type alias: VariableDeclarationJSON](/auto-docs/editor/types/VariableDeclarationJSON.md): VariableDeclarationJSON: BaseVariableFieldJSON & { order?: number } ASTNodeJSON representation of the VariableDeclaration. Type parameters - [Type alias: VariableDeclarationListChangeAction](/auto-docs/editor/types/VariableDeclarationListChangeAction.md): VariableDeclarationListChangeAction: GlobalEventActionType<"VariableListChange", { next: VariableDeclaration[] ; prev: VariableDeclaration[] }, VariableDeclarationList> - [Type alias: VariableEngineProvider](/auto-docs/editor/types/VariableEngineProvider.md): VariableEngineProvider: () => VariableEngine Type declaration (): VariableEngine Returns VariableEngine - [Type alias: Warnings](/auto-docs/editor/types/Warnings.md): Warnings: Record - [Type alias: Xor](/auto-docs/editor/types/Xor.md): Xor: T | U extends object ? Without & U | Without & T : T | U Type parameters - [Type alias: AsyncContainerModuleCallBack](/auto-docs/editor/types/interfaces.AsyncContainerModuleCallBack.md): interfaces.AsyncContainerModuleCallBack AsyncContainerModuleCallBack: AsyncCallback - [Type alias: AutoFactory](/auto-docs/editor/types/interfaces.AutoFactory.md): interfaces.AutoFactory AutoFactory: SimpleFactory Type parameters - [Type alias: AutoNamedFactory](/auto-docs/editor/types/interfaces.AutoNamedFactory.md): interfaces.AutoNamedFactory AutoNamedFactory: SimpleFactory Type parameters - [Type alias: Bind](/auto-docs/editor/types/interfaces.Bind.md): interfaces.Bind Bind: (serviceIdentifier: ServiceIdentifier) => BindingToSyntax Type declaration (serviceIdentifier): BindingToSyntax Type parameters Parameters Returns BindingToSyntax - [Type alias: BindingActivation](/auto-docs/editor/types/interfaces.BindingActivation.md): interfaces.BindingActivation BindingActivation: (context: Context, injectable: T) => T | Promise Type parameters Type declaration (context, injectable): T | Promise Parameters Returns T | Promise - [Type alias: BindingDeactivation](/auto-docs/editor/types/interfaces.BindingDeactivation.md): interfaces.BindingDeactivation BindingDeactivation: (injectable: T) => void | Promise Type parameters Type declaration (injectable): void | Promise Parameters Returns void | Promise - [Type alias: BindingScope](/auto-docs/editor/types/interfaces.BindingScope.md): interfaces.BindingScope BindingScope: "Singleton" | "Transient" | "Request" - [Type alias: BindingType](/auto-docs/editor/types/interfaces.BindingType.md): interfaces.BindingType BindingType: "ConstantValue" | "Constructor" | "DynamicValue" | "Factory" | "Function" | "Instance" | "Invalid" | "Provider" - [Type alias: ContainerModuleCallBack](/auto-docs/editor/types/interfaces.ContainerModuleCallBack.md): interfaces.ContainerModuleCallBack ContainerModuleCallBack: (bind: Bind, unbind: Unbind, isBound: IsBound, rebind: Rebind, unbindAsync: UnbindAsync, onActivation: Container["onActivation"], onDeactivation: Container["onDeactivation"]) => void Type declaration (bind, unbind, isBound, rebind, unbindAsync, onActivation, onDeactivation): void Parameters Returns void - [Type alias: ContainerResolution](/auto-docs/editor/types/interfaces.ContainerResolution.md): interfaces.ContainerResolution ContainerResolution: undefined | T | Promise | (T | Promise)[] Type parameters - [Type alias: ContextInterceptor](/auto-docs/editor/types/interfaces.ContextInterceptor.md): interfaces.ContextInterceptor ContextInterceptor: (context: Context) => Context Type declaration (context): Context Parameters Returns Context - [Type alias: DynamicValue](/auto-docs/editor/types/interfaces.DynamicValue.md): interfaces.DynamicValue DynamicValue: (context: Context) => T | Promise Type parameters Type declaration (context): T | Promise Parameters Returns T | Promise - [Type alias: Factory](/auto-docs/editor/types/interfaces.Factory.md): interfaces.Factory Factory: SimpleFactory | MultiFactory Type parameters - [Type alias: FactoryCreator](/auto-docs/editor/types/interfaces.FactoryCreator.md): interfaces.FactoryCreator FactoryCreator: (context: Context) => Factory Type parameters Type declaration (context): Factory Parameters Returns Factory - [Type alias: FactoryTypeFunction](/auto-docs/editor/types/interfaces.FactoryTypeFunction.md): interfaces.FactoryTypeFunction FactoryTypeFunction: (context: Context) => T | Promise Type parameters Type declaration (context): T | Promise Parameters Returns T | Promise - [Type alias: Instance](/auto-docs/editor/types/interfaces.Instance.md): interfaces.Instance Instance: T & Record void> Type parameters - [Type alias: IsBound](/auto-docs/editor/types/interfaces.IsBound.md): interfaces.IsBound IsBound: (serviceIdentifier: ServiceIdentifier) => boolean Type declaration (serviceIdentifier): boolean Type parameters Parameters Returns boolean - [Type alias: MetadataOrMetadataArray](/auto-docs/editor/types/interfaces.MetadataOrMetadataArray.md): interfaces.MetadataOrMetadataArray MetadataOrMetadataArray: Metadata | Metadata[] - [Type alias: Middleware](/auto-docs/editor/types/interfaces.Middleware.md): interfaces.Middleware Middleware: (next: Next) => Next Type declaration (next): Next Parameters Returns Next - [Type alias: MultiFactory](/auto-docs/editor/types/interfaces.MultiFactory.md): interfaces.MultiFactory MultiFactory: (...args: U) => SimpleFactory Type parameters Type declaration (...args): SimpleFactory Parameters Returns SimpleFactory - [Type alias: Newable](/auto-docs/editor/types/interfaces.Newable.md): interfaces.Newable Newable: CommonNewable Type parameters - [Type alias: Next](/auto-docs/editor/types/interfaces.Next.md): interfaces.Next Next: (args: NextArgs) => unknown | unknown[] Type declaration (args): unknown | unknown[] Parameters Returns unknown | unknown[] - [Type alias: Provider](/auto-docs/editor/types/interfaces.Provider.md): interfaces.Provider Provider: (...args: any[]) => (...args: any[]) => Promise | Promise Type parameters Type declaration (...args): (...args: any[]) => Promise | Promise Parameters Returns (...args: any[]) => Promise | Promise - [Type alias: ProviderCreator](/auto-docs/editor/types/interfaces.ProviderCreator.md): interfaces.ProviderCreator ProviderCreator: (context: Context) => Provider Type parameters Type declaration (context): Provider Parameters Returns Provider - [Type alias: Rebind](/auto-docs/editor/types/interfaces.Rebind.md): interfaces.Rebind Rebind: (serviceIdentifier: ServiceIdentifier) => BindingToSyntax Type declaration (serviceIdentifier): BindingToSyntax Type parameters Parameters Returns BindingToSyntax - [Type alias: RequestScope](/auto-docs/editor/types/interfaces.RequestScope.md): interfaces.RequestScope RequestScope: Map - [Type alias: ResolveRequestHandler](/auto-docs/editor/types/interfaces.ResolveRequestHandler.md): interfaces.ResolveRequestHandler ResolveRequestHandler: (request: Request) => unknown Type declaration (request): unknown Parameters Returns unknown - [Type alias: ServiceIdentifier](/auto-docs/editor/types/interfaces.ServiceIdentifier.md): interfaces.ServiceIdentifier ServiceIdentifier: CommonServiceIdentifier Type parameters - [Type alias: SimpleFactory](/auto-docs/editor/types/interfaces.SimpleFactory.md): interfaces.SimpleFactory SimpleFactory: (...args: U) => T Type parameters Type declaration (...args): T Parameters Returns T - [Type alias: Target](/auto-docs/editor/types/interfaces.Target.md): interfaces.Target Target: LegacyTarget - [Type alias: TargetType](/auto-docs/editor/types/interfaces.TargetType.md): interfaces.TargetType TargetType: "ConstructorArgument" | "ClassProperty" | "Variable" - [Type alias: Unbind](/auto-docs/editor/types/interfaces.Unbind.md): interfaces.Unbind Unbind: (serviceIdentifier: ServiceIdentifier) => void Type declaration (serviceIdentifier): void Type parameters Parameters Returns void - [Type alias: UnbindAsync](/auto-docs/editor/types/interfaces.UnbindAsync.md): interfaces.UnbindAsync UnbindAsync: (serviceIdentifier: ServiceIdentifier) => Promise Type declaration (serviceIdentifier): Promise Type parameters Parameters Returns Promise - [Variable: Cancelled](/auto-docs/editor/variables/CancellationToken.Cancelled.md): CancellationToken.Cancelled Const Cancelled: Readonly - [Variable: None](/auto-docs/editor/variables/CancellationToken.None.md): CancellationToken.None Const None: Readonly - [Variable: ClipboardService](/auto-docs/editor/variables/ClipboardService-1.md): Const ClipboardService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CommandService](/auto-docs/editor/variables/CommandService-1.md): Const CommandService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: ConstantKeys](/auto-docs/editor/variables/ConstantKeys.md): Const ConstantKeys: Object 支持外部 constants 自定义的 key 枚举 Type declaration - [Variable: ContributionProvider](/auto-docs/editor/variables/ContributionProvider-1.md): Const ContributionProvider: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CropSchemaDecoration](/auto-docs/editor/variables/CropSchemaDecoration.md): Const CropSchemaDecoration: SchemaDecoration - [Variable: DEFAULT_SIZE](/auto-docs/editor/variables/DEFAULT_SIZE.md): Const DEFAULT_SIZE: Object 默认节点大小 Type declaration - [Variable: DEFAULT_SPACING](/auto-docs/editor/variables/DEFAULT_SPACING.md): Const DEFAULT_SPACING: Object 默认一些间隔参数 Type declaration - [Variable: DEG_TO_RAD](/auto-docs/editor/variables/DEG_TO_RAD.md): Const DEG_TO_RAD: number Conversion factor for converting degrees to radians. - [Variable: DecorationStyle](/auto-docs/editor/variables/DecorationStyle.md): Const DecorationStyle: Object Type declaration - [Variable: DefaultSpacingKey](/auto-docs/editor/variables/DefaultSpacingKey.md): Const DefaultSpacingKey: Object spacing default key 值 Type declaration - [Variable: Deferred](/auto-docs/editor/variables/Deferred.md): Const Deferred: typeof PromiseDeferred - [Variable: NULL](/auto-docs/editor/variables/Disposable.NULL.md): Disposable.NULL Const NULL: Readonly - [Variable: EDITOR_STATE_DEFAULTS](/auto-docs/editor/variables/EDITOR_STATE_DEFAULTS.md): Const EDITOR_STATE_DEFAULTS: EditorState[] - [Variable: ENTITIES_BY_DATA_DECO_KEY](/auto-docs/editor/variables/ENTITIES_BY_DATA_DECO_KEY.md): Const ENTITIES_BY_DATA_DECO_KEY: unique symbol - [Variable: ENTITIES_DECO_KEY](/auto-docs/editor/variables/ENTITIES_DECO_KEY.md): Const ENTITIES_DECO_KEY: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: DEFAULT](/auto-docs/editor/variables/EditorProps.DEFAULT.md): EditorProps.DEFAULT Const DEFAULT: EditorProps 默认配置 - [Variable: STATE_GRAB](/auto-docs/editor/variables/EditorState.STATE_GRAB.md): EditorState.STATE_GRAB Const STATE_GRAB: EditorState - [Variable: STATE_MOUSE_FRIENDLY_SELECT](/auto-docs/editor/variables/EditorState.STATE_MOUSE_FRIENDLY_SELECT.md): EditorState.STATE_MOUSE_FRIENDLY_SELECT Const STATE_MOUSE_FRIENDLY_SELECT: EditorState 鼠标友好模式状态 - [Variable: STATE_SELECT](/auto-docs/editor/variables/EditorState.STATE_SELECT.md): EditorState.STATE_SELECT Const STATE_SELECT: EditorState - [Variable: EntityManagerContribution](/auto-docs/editor/variables/EntityManagerContribution-1.md): Const EntityManagerContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FLOW_DEFAULT_HIDDEN_TYPES](/auto-docs/editor/variables/FLOW_DEFAULT_HIDDEN_TYPES.md): Const FLOW_DEFAULT_HIDDEN_TYPES: FlowNodeType[] - [Variable: FLUSH_LAYER_REQUEST](/auto-docs/editor/variables/FLUSH_LAYER_REQUEST.md): Const FLUSH_LAYER_REQUEST: "flush-layer-request" - [Variable: FlipSchemaDecoration](/auto-docs/editor/variables/FlipSchemaDecoration.md): Const FlipSchemaDecoration: SchemaDecoration - [Variable: FlowDocumentConfigDefaultData](/auto-docs/editor/variables/FlowDocumentConfigDefaultData.md): Const FlowDocumentConfigDefaultData: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentContainerModule](/auto-docs/editor/variables/FlowDocumentContainerModule.md): Const FlowDocumentContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentContribution](/auto-docs/editor/variables/FlowDocumentContribution-1.md): Const FlowDocumentContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentOptions](/auto-docs/editor/variables/FlowDocumentOptions-1.md): Const FlowDocumentOptions: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentOptionsDefault](/auto-docs/editor/variables/FlowDocumentOptionsDefault.md): Const FlowDocumentOptionsDefault: FlowDocumentOptions - [Variable: FlowDocumentProvider](/auto-docs/editor/variables/FlowDocumentProvider-1.md): FlowDocumentProvider: typeof FlowDocumentProvider - [Variable: FlowLayout](/auto-docs/editor/variables/FlowLayout-1.md): Const FlowLayout: unique symbol - [Variable: FlowLayoutContribution](/auto-docs/editor/variables/FlowLayoutContribution-1.md): Const FlowLayoutContribution: unique symbol - [Variable: FlowOperationBaseService](/auto-docs/editor/variables/FlowOperationBaseService-1.md): FlowOperationBaseService: typeof FlowOperationBaseService - [Variable: FlowRendererContainerModule](/auto-docs/editor/variables/FlowRendererContainerModule.md): Const FlowRendererContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowRendererContribution](/auto-docs/editor/variables/FlowRendererContribution-1.md): Const FlowRendererContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: I18n](/auto-docs/editor/variables/I18n.md): Const I18n: I18nImpl - [Variable: LayerOptions](/auto-docs/editor/variables/LayerOptions-1.md): LayerOptions: typeof LayerOptions - [Variable: LazyInjectContext](/auto-docs/editor/variables/LazyInjectContext.md): Const LazyInjectContext: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: MARK_ACTIVATED_ARROW_ID](/auto-docs/editor/variables/MARK_ACTIVATED_ARROW_ID.md): Const MARK_ACTIVATED_ARROW_ID: "$marker_arrow_activated$" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: MARK_ARROW_ID](/auto-docs/editor/variables/MARK_ARROW_ID.md): Const MARK_ARROW_ID: "$marker_arrow$" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OpacitySchemaDecoration](/auto-docs/editor/variables/OpacitySchemaDecoration.md): Const OpacitySchemaDecoration: SchemaDecoration - [Variable: OriginSchemaDecoration](/auto-docs/editor/variables/OriginSchemaDecoration.md): Const OriginSchemaDecoration: SchemaDecoration - [Variable: PI](/auto-docs/editor/variables/PI.md): Const PI: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PI_2](/auto-docs/editor/variables/PI_2.md): Const PI_2: number Two Pi. - [Variable: PaddingSchemaDecoration](/auto-docs/editor/variables/PaddingSchemaDecoration.md): Const PaddingSchemaDecoration: SchemaDecoration - [Variable: PipelineLayerFactory](/auto-docs/editor/variables/PipelineLayerFactory-1.md): Const PipelineLayerFactory: unique symbol - [Variable: PlaygroundConfig](/auto-docs/editor/variables/PlaygroundConfig-1.md): Const PlaygroundConfig: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundContainerFactory](/auto-docs/editor/variables/PlaygroundContainerFactory-1.md): Const PlaygroundContainerFactory: unique symbol - [Variable: PlaygroundContainerModule](/auto-docs/editor/variables/PlaygroundContainerModule.md): Const PlaygroundContainerModule: ContainerModule - [Variable: PlaygroundContext](/auto-docs/editor/variables/PlaygroundContext-1.md): Const PlaygroundContext: unique symbol 会被注入到 layer 层，可以在使用的时候替换它 - [Variable: PlaygroundContextProvider](/auto-docs/editor/variables/PlaygroundContextProvider-1.md): Const PlaygroundContextProvider: unique symbol - [Variable: PlaygroundContribution](/auto-docs/editor/variables/PlaygroundContribution-1.md): Const PlaygroundContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundEntityContext](/auto-docs/editor/variables/PlaygroundEntityContext.md): Const PlaygroundEntityContext: React$1.Context 当前 entity - [Variable: PlaygroundReactContainerContext](/auto-docs/editor/variables/PlaygroundReactContainerContext.md): Const PlaygroundReactContainerContext: React$1.Context - [Variable: PlaygroundReactContext](/auto-docs/editor/variables/PlaygroundReactContext.md): Const PlaygroundReactContext: React$1.Context Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundReactRefContext](/auto-docs/editor/variables/PlaygroundReactRefContext.md): Const PlaygroundReactRefContext: React$1.Context - [Variable: Plugin](/auto-docs/editor/variables/Plugin-1.md): Const Plugin: unique symbol - [Variable: PluginContext](/auto-docs/editor/variables/PluginContext-1.md): PluginContext: typeof PluginContext - [Variable: EMPTY](/auto-docs/editor/variables/Point.EMPTY.md): Point.EMPTY Const EMPTY: IPoint - [Variable: PositionSchemaDecoration](/auto-docs/editor/variables/PositionSchemaDecoration.md): Const PositionSchemaDecoration: SchemaDecoration - [Variable: ProtectWheelArea](/auto-docs/editor/variables/ProtectWheelArea-1.md): Const ProtectWheelArea: unique symbol 保护区域不被画布劫持滚动事件 - [Variable: RAD_TO_DEG](/auto-docs/editor/variables/RAD_TO_DEG.md): Const RAD_TO_DEG: number Conversion factor for converting radians to degrees. - [Variable: RequestCache](/auto-docs/editor/variables/RequestCache.md): Const RequestCache: Map> 请求缓存 Param - [Variable: RotationSchemaDecoration](/auto-docs/editor/variables/RotationSchemaDecoration.md): Const RotationSchemaDecoration: SchemaDecoration - [Variable: SCALE_WIDTH](/auto-docs/editor/variables/SCALE_WIDTH.md): Const SCALE_WIDTH: 0 - [Variable: ScaleSchemaDecoration](/auto-docs/editor/variables/ScaleSchemaDecoration.md): Const ScaleSchemaDecoration: SchemaDecoration - [Variable: ScrollBarEvents](/auto-docs/editor/variables/ScrollBarEvents-1.md): Const ScrollBarEvents: unique symbol 滚动条点击事件监听 - [Variable: ShadowSchemaDecoration](/auto-docs/editor/variables/ShadowSchemaDecoration.md): Const ShadowSchemaDecoration: SchemaDecoration - [Variable: ShortcutsContribution](/auto-docs/editor/variables/ShortcutsContribution-1.md): Const ShortcutsContribution: unique symbol - [Variable: SizeSchemaDecoration](/auto-docs/editor/variables/SizeSchemaDecoration.md): Const SizeSchemaDecoration: SchemaDecoration - [Variable: SkewSchemaDecoration](/auto-docs/editor/variables/SkewSchemaDecoration.md): Const SkewSchemaDecoration: SchemaDecoration - [Variable: StorageService](/auto-docs/editor/variables/StorageService-1.md): Const StorageService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: TintSchemaDecoration](/auto-docs/editor/variables/TintSchemaDecoration.md): Const TintSchemaDecoration: SchemaDecoration - [Variable: TransformSchemaDecoration](/auto-docs/editor/variables/TransformSchemaDecoration.md): Const TransformSchemaDecoration: SchemaDecoration - [Variable: VariableContainerModule](/auto-docs/editor/variables/VariableContainerModule.md): Const VariableContainerModule: ContainerModule An InversifyJS container module that binds all the necessary services for the variable engine. This module sets up the dependency injection for the core components of the variable engine. - [Variable: VariableEngineProvider](/auto-docs/editor/variables/VariableEngineProvider-1.md): Const VariableEngineProvider: unique symbol A provider for dynamically obtaining the VariableEngine instance. This is used to prevent circular dependencies when injecting VariableEngine. - [Variable: logger](/auto-docs/editor/variables/logger.md): Const logger: Logger - [Class: ASTNode](/auto-docs/fixed-layout-editor/classes/ASTNode.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: ASTRegisters](/auto-docs/fixed-layout-editor/classes/ASTRegisters.md): Register the AST node to the engine. - [Class: ArrayType](/auto-docs/fixed-layout-editor/classes/ArrayType.md): Represents an array type. - [Class: AsyncContainerModule](/auto-docs/fixed-layout-editor/classes/AsyncContainerModule.md) - [Class: BaseExpression](/auto-docs/fixed-layout-editor/classes/BaseExpression.md): Base class for all expressions. All other expressions should extend this class. - [Class: BaseType](/auto-docs/fixed-layout-editor/classes/BaseType.md): Base class for all types. All other types should extend this class. - [Class: BaseVariableField](/auto-docs/fixed-layout-editor/classes/BaseVariableField.md): Variable Field abstract class, which is the base class for VariableDeclaration and Property VariableDeclaration is used to declare a variable in a block scope.Property is used to declare a property in an object. - [Class: BooleanType](/auto-docs/fixed-layout-editor/classes/BooleanType.md): Represents a boolean type. - [Class: CancellationTokenSource](/auto-docs/fixed-layout-editor/classes/CancellationTokenSource.md) - [Class: Circle](/auto-docs/fixed-layout-editor/classes/Circle.md): The Circle object is used to help draw graphics and can also be used to specify a hit area for displayObjects. - [Class: CommandRegistry](/auto-docs/fixed-layout-editor/classes/CommandRegistry.md) - [Class: ConfigEntity](/auto-docs/fixed-layout-editor/classes/ConfigEntity.md): 用于专门的数据配置，且是单例 - [Class: Container](/auto-docs/fixed-layout-editor/classes/Container.md) - [Class: ContainerModule](/auto-docs/fixed-layout-editor/classes/ContainerModule.md) - [Class: ContextMenuService](/auto-docs/fixed-layout-editor/classes/ContextMenuService.md): 圈选右键菜单相关 service - [Class: CustomType](/auto-docs/fixed-layout-editor/classes/CustomType.md): Represents a custom type. - [Class: DataNode](/auto-docs/fixed-layout-editor/classes/DataNode.md): Represents a general data node with no child nodes. - [Class: DefaultClipboardService](/auto-docs/fixed-layout-editor/classes/DefaultClipboardService.md): 剪贴板服务，一般用于管理临时的复制黏贴数据 TODO: 后续可以支持调用浏览器 - [Class: DisposableCollection](/auto-docs/fixed-layout-editor/classes/DisposableCollection.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: DisposableImpl](/auto-docs/fixed-layout-editor/classes/DisposableImpl.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: EditorStateConfigEntity](/auto-docs/fixed-layout-editor/classes/EditorStateConfigEntity.md): 编辑状态管理 - [Class: Emitter](/auto-docs/fixed-layout-editor/classes/Emitter.md) - [Class: Entity](/auto-docs/fixed-layout-editor/classes/Entity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: EntityData](/auto-docs/fixed-layout-editor/classes/EntityData.md): 实体的数据块 - [Class: EntityManager](/auto-docs/fixed-layout-editor/classes/EntityManager.md): TODO registry 改成 decorator Entity 管理器，全局唯一 - [Class: EnumerateExpression](/auto-docs/fixed-layout-editor/classes/EnumerateExpression.md): Represents an enumeration expression, which iterates over a list and returns the type of the enumerated variable. - [Class: FixedHistoryConfig](/auto-docs/fixed-layout-editor/classes/FixedHistoryConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FixedHistoryFormDataService](/auto-docs/fixed-layout-editor/classes/FixedHistoryFormDataService.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FixedHistoryOperationService](/auto-docs/fixed-layout-editor/classes/FixedHistoryOperationService.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FixedHistoryService](/auto-docs/fixed-layout-editor/classes/FixedHistoryService.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowContextMenuLayer](/auto-docs/fixed-layout-editor/classes/FlowContextMenuLayer.md): 流程右键菜单 - [Class: FlowDebugLayer](/auto-docs/fixed-layout-editor/classes/FlowDebugLayer.md): 调试用，会绘出所有节点的边界 - [Class: FlowDocument](/auto-docs/fixed-layout-editor/classes/FlowDocument.md): 流程整个文档数据 - [Class: FlowDocumentConfig](/auto-docs/fixed-layout-editor/classes/FlowDocumentConfig.md): 用于文档扩展配置 - [Class: FlowDocumentTransformerEntity](/auto-docs/fixed-layout-editor/classes/FlowDocumentTransformerEntity.md): 用于通知所有 layer 更新 - [Class: FlowDragEntity](/auto-docs/fixed-layout-editor/classes/FlowDragEntity.md): 用于专门的数据配置，且是单例 - [Class: FlowDragLayer](/auto-docs/fixed-layout-editor/classes/FlowDragLayer.md): 监听节点的激活状态 - [Class: FlowDragService](/auto-docs/fixed-layout-editor/classes/FlowDragService.md): 拖拽相关操作 外部实现抽象类 - [Class: FlowEditorClient](/auto-docs/fixed-layout-editor/classes/FlowEditorClient.md) - [Class: FlowGroupController](/auto-docs/fixed-layout-editor/classes/FlowGroupController.md): 分组控制器 - [Class: FlowGroupService](/auto-docs/fixed-layout-editor/classes/FlowGroupService.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowLabelsLayer](/auto-docs/fixed-layout-editor/classes/FlowLabelsLayer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowLinesLayer](/auto-docs/fixed-layout-editor/classes/FlowLinesLayer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowNodeEntity](/auto-docs/fixed-layout-editor/classes/FlowNodeEntity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FlowNodeFormData](/auto-docs/fixed-layout-editor/classes/FlowNodeFormData.md): 实体的数据块 - [Class: FlowNodeRenderData](/auto-docs/fixed-layout-editor/classes/FlowNodeRenderData.md): 节点渲染状态相关数据 - [Class: FlowNodeTransformData](/auto-docs/fixed-layout-editor/classes/FlowNodeTransformData.md): 实体的数据块 - [Class: FlowNodeTransitionData](/auto-docs/fixed-layout-editor/classes/FlowNodeTransitionData.md): 实体的数据块 - [Class: FlowNodeVariableData](/auto-docs/fixed-layout-editor/classes/FlowNodeVariableData.md): Manages variable data for a flow node, including public and private scopes. - [Class: FlowNodesContentLayer](/auto-docs/fixed-layout-editor/classes/FlowNodesContentLayer.md): 渲染节点内容 - [Class: FlowNodesTransformLayer](/auto-docs/fixed-layout-editor/classes/FlowNodesTransformLayer.md): 渲染节点位置 - [Class: FlowOperationBaseServiceImpl](/auto-docs/fixed-layout-editor/classes/FlowOperationBaseServiceImpl.md): 操作服务 - [Class: FlowRendererRegistry](/auto-docs/fixed-layout-editor/classes/FlowRendererRegistry.md) - [Class: FlowRendererStateEntity](/auto-docs/fixed-layout-editor/classes/FlowRendererStateEntity.md): 渲染相关的全局状态管理 - [Class: FlowScrollBarLayer](/auto-docs/fixed-layout-editor/classes/FlowScrollBarLayer.md): 渲染滚动条 layer - [Class: FlowScrollLimitLayer](/auto-docs/fixed-layout-editor/classes/FlowScrollLimitLayer.md): 控制滚动边界 - [Class: FlowSelectConfigEntity](/auto-docs/fixed-layout-editor/classes/FlowSelectConfigEntity.md): 圈选节点相关数据存储 - [Class: FlowSelectorBoundsLayer](/auto-docs/fixed-layout-editor/classes/FlowSelectorBoundsLayer.md): 流程节点被框选后的边界区域渲染 - [Class: FlowSelectorBoxLayer](/auto-docs/fixed-layout-editor/classes/FlowSelectorBoxLayer.md): 流程选择框 - [Class: FlowVirtualTree](/auto-docs/fixed-layout-editor/classes/FlowVirtualTree-1.md): 存储节点的 tree 结构信息 策略是 "重修改轻查询"，即修改时候做的事情更多，查询都通过指针来操作 - [Class: FlushLayerMessage](/auto-docs/fixed-layout-editor/classes/FlushLayerMessage.md) - [Class: FormModel](/auto-docs/fixed-layout-editor/classes/FormModel.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FormPlugin](/auto-docs/fixed-layout-editor/classes/FormPlugin.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: GlobalScope](/auto-docs/fixed-layout-editor/classes/GlobalScope.md): Global Scope stores all variables that are not scoped to any node. Variables in Global Scope can be accessed by any node.Any other scope's variables can not be accessed by Global Scope. - [Class: HistoryConfig](/auto-docs/fixed-layout-editor/classes/HistoryConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryContext](/auto-docs/fixed-layout-editor/classes/HistoryContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryManager](/auto-docs/fixed-layout-editor/classes/HistoryManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryService](/auto-docs/fixed-layout-editor/classes/HistoryService.md): 历史服务 - [Class: HistoryStack](/auto-docs/fixed-layout-editor/classes/HistoryStack.md): 历史栈，聚合所有历史操作 - [Class: IntegerType](/auto-docs/fixed-layout-editor/classes/IntegerType.md): Represents an integer type. - [Class: KeyPathExpression](/auto-docs/fixed-layout-editor/classes/KeyPathExpression.md): Represents a key path expression, which is used to reference a variable by its key path. This is the V2 of KeyPathExpression, with the following improvements: returnType is copied to a new instance to avoid reference issues.Circular reference detection is introduced. - [Class: Layer](/auto-docs/fixed-layout-editor/classes/Layer.md): 基础 layer - [Class: LegacyKeyPathExpression](/auto-docs/fixed-layout-editor/classes/LegacyKeyPathExpression.md): Deprecated Use KeyPathExpression instead. Represents a key path expression, which is used to reference a variable by its key path. - [Class: ListNode](/auto-docs/fixed-layout-editor/classes/ListNode.md): Represents a list of nodes. - [Class: LocalStorageService](/auto-docs/fixed-layout-editor/classes/LocalStorageService.md) - [Class: LoggerService](/auto-docs/fixed-layout-editor/classes/LoggerService.md): 画布全局的选择器，可以放任何东西 - [Class: MapNode](/auto-docs/fixed-layout-editor/classes/MapNode.md): Represents a map of nodes. - [Class: MapType](/auto-docs/fixed-layout-editor/classes/MapType.md): Represents a map type. - [Class: Matrix](/auto-docs/fixed-layout-editor/classes/Matrix.md): The PIXIJS Matrix as a class makes it a lot faster. Here is a representation of it: - [Class: MutableToken](/auto-docs/fixed-layout-editor/classes/MutableToken.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: NodeClient](/auto-docs/fixed-layout-editor/classes/NodeClient.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: NodeFocusService](/auto-docs/fixed-layout-editor/classes/NodeFocusService.md) - [Class: NumberType](/auto-docs/fixed-layout-editor/classes/NumberType.md): Represents a number type. - [Class: OBBRect](/auto-docs/fixed-layout-editor/classes/OBBRect.md): Oriented Bounding Box (OBB) See https://en.wikipedia.org/wiki/Bounding_volume - [Class: ObjectType](/auto-docs/fixed-layout-editor/classes/ObjectType.md): Represents an object type. - [Class: OpacityData](/auto-docs/fixed-layout-editor/classes/OpacityData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OperationRegistry](/auto-docs/fixed-layout-editor/classes/OperationRegistry.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OperationService](/auto-docs/fixed-layout-editor/classes/OperationService.md) - [Class: OriginData](/auto-docs/fixed-layout-editor/classes/OriginData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PipelineEntitiesImpl](/auto-docs/fixed-layout-editor/classes/PipelineEntitiesImpl.md): 注入到 Layer 中的实体选择器 - [Class: PipelineEntitiesSelector](/auto-docs/fixed-layout-editor/classes/PipelineEntitiesSelector.md): 选择器用来在 pipeline 绘制之前，筛选并注入 entities - [Class: PipelineRegistry](/auto-docs/fixed-layout-editor/classes/PipelineRegistry.md): pipeline 注册器，用于注册一些事件 - [Class: PipelineRenderer](/auto-docs/fixed-layout-editor/classes/PipelineRenderer.md): pipeline 渲染器 - [Class: Playground](/auto-docs/fixed-layout-editor/classes/Playground.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundConfigEntity](/auto-docs/fixed-layout-editor/classes/PlaygroundConfigEntity.md): 全局画布的配置信息 - [Class: PlaygroundDrag](/auto-docs/fixed-layout-editor/classes/PlaygroundDrag-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: PlaygroundGesture](/auto-docs/fixed-layout-editor/classes/PlaygroundGesture.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundLayer](/auto-docs/fixed-layout-editor/classes/PlaygroundLayer.md): 基础层，控制画布缩放/滚动等操作 - [Class: LayerTestState](/auto-docs/fixed-layout-editor/classes/PlaygroundMockTools.LayerTestState.md): PlaygroundMockTools.LayerTestState - [Class: PlaygroundRegistry](/auto-docs/fixed-layout-editor/classes/PlaygroundRegistry.md) - [Class: PlaygroundSchedule](/auto-docs/fixed-layout-editor/classes/PlaygroundSchedule.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Point](/auto-docs/fixed-layout-editor/classes/Point-1.md): The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis. Memberof PIXI Implements IPoint - [Class: PositionData](/auto-docs/fixed-layout-editor/classes/PositionData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PromiseDeferred](/auto-docs/fixed-layout-editor/classes/PromiseDeferred.md): Simple implementation of the deferred pattern. An object that exposes a promise and functions to resolve and reject it. - [Class: PromisePool](/auto-docs/fixed-layout-editor/classes/PromisePool.md) - [Class: Property](/auto-docs/fixed-layout-editor/classes/Property.md): Property is a variable field that represents a property of a ObjectType. - [Class: ReactiveBaseState](/auto-docs/fixed-layout-editor/classes/ReactiveBaseState.md) - [Class: ReactiveState](/auto-docs/fixed-layout-editor/classes/ReactiveState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Rectangle](/auto-docs/fixed-layout-editor/classes/Rectangle-1.md): Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. - [Class: RotationData](/auto-docs/fixed-layout-editor/classes/RotationData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: ScaleData](/auto-docs/fixed-layout-editor/classes/ScaleData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Scope](/auto-docs/fixed-layout-editor/classes/Scope.md): Represents a variable scope, which manages its own set of variables and their lifecycle. scope.output represents the variables declared within this scope.scope.available represents all variables accessible from this scope, including those from parent scopes. - [Class: ScopeChain](/auto-docs/fixed-layout-editor/classes/ScopeChain.md): Manages the dependency relationships between scopes. This is an abstract class, and specific implementations determine how the scope order is managed. - [Class: ScopeChainTransformService](/auto-docs/fixed-layout-editor/classes/ScopeChainTransformService.md): A service for transforming scope chains. - [Class: ScopeOutputData](/auto-docs/fixed-layout-editor/classes/ScopeOutputData.md): Manages the output variables of a scope. - [Class: SelectionService](/auto-docs/fixed-layout-editor/classes/SelectionService.md): 画布全局的选择器，可以放任何东西 - [Class: SelectorBoxConfigEntity](/auto-docs/fixed-layout-editor/classes/SelectorBoxConfigEntity.md): 选择框配置 - [Class: ShortcutsRegistry](/auto-docs/fixed-layout-editor/classes/ShortcutsRegistry.md) - [Class: SizeData](/auto-docs/fixed-layout-editor/classes/SizeData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: SkewData](/auto-docs/fixed-layout-editor/classes/SkewData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StackOperation](/auto-docs/fixed-layout-editor/classes/StackOperation.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StringType](/auto-docs/fixed-layout-editor/classes/StringType.md): Base class for all types. All other types should extend this class. - [Class: Computation](/auto-docs/fixed-layout-editor/classes/Tracker.Computation.md): Tracker.Computation A Computation object represents code that is repeatedly rerun in response to reactive data changes. Computations don't have return values; they just perform actions, such as rerendering a template on the screen. Computations are created using Tracker.autorun. Use stop to prevent further rerunning of a computation. - [Class: Dependency](/auto-docs/fixed-layout-editor/classes/Tracker.Dependency.md): Tracker.Dependency A Dependency represents an atomic unit of reactive data that a computation might depend on. Reactive data sources such as Session or Minimongo internally create different Dependency objects for different pieces of data, each of which may be depended on by multiple computations. When the data changes, the computations are invalidated. - [Class: Transform](/auto-docs/fixed-layout-editor/classes/Transform.md): Transform that takes care about its versions Memberof PIXI - [Class: TransformData](/auto-docs/fixed-layout-editor/classes/TransformData-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: UndoRedoService](/auto-docs/fixed-layout-editor/classes/UndoRedoService.md): UndoRedo服务 - [Class: VariableDeclaration](/auto-docs/fixed-layout-editor/classes/VariableDeclaration.md): VariableDeclaration is a variable field that represents a variable declaration. - [Class: VariableDeclarationList](/auto-docs/fixed-layout-editor/classes/VariableDeclarationList.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: VariableEngine](/auto-docs/fixed-layout-editor/classes/VariableEngine.md): The core of the variable engine system. It manages scopes, variables, and events within the system. - [Class: VariableFieldKeyRenameService](/auto-docs/fixed-layout-editor/classes/VariableFieldKeyRenameService.md): This service is responsible for detecting when a variable field's key is renamed. It listens for changes in variable declaration lists and object properties, and determines if a change constitutes a rename operation. - [Class: WrapArrayExpression](/auto-docs/fixed-layout-editor/classes/WrapArrayExpression.md): Represents a wrap expression, which wraps an expression with an array. - [Enumeration: ASTKind](/auto-docs/fixed-layout-editor/enums/ASTKind.md): Core AST node types. - [Enumeration: ASTNodeFlags](/auto-docs/fixed-layout-editor/enums/ASTNodeFlags.md): ASTNode flags. Stored in the flags property of the ASTNode. - [Enumeration: Default](/auto-docs/fixed-layout-editor/enums/Command.Default.md): Command.Default - [Enumeration: DRAGGING_TYPE](/auto-docs/fixed-layout-editor/enums/DRAGGING_TYPE.md): 拖拽种类枚举 节点拖拽分支拖拽 - [Enumeration: DataEvent](/auto-docs/fixed-layout-editor/enums/DataEvent.md) - [Enumeration: FeedbackLevel](/auto-docs/fixed-layout-editor/enums/FeedbackLevel.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowDocumentConfigEnum](/auto-docs/fixed-layout-editor/enums/FlowDocumentConfigEnum.md) - [Enumeration: FlowLayoutDefault](/auto-docs/fixed-layout-editor/enums/FlowLayoutDefault-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowNodeBaseType](/auto-docs/fixed-layout-editor/enums/FlowNodeBaseType.md) - [Enumeration: FlowNodeScopeType](/auto-docs/fixed-layout-editor/enums/FlowNodeScopeType.md): Enum for flow node scope types. - [Enumeration: FlowNodeSplitType](/auto-docs/fixed-layout-editor/enums/FlowNodeSplitType.md) - [Enumeration: FlowRendererCommandCategory](/auto-docs/fixed-layout-editor/enums/FlowRendererCommandCategory.md): 命令分类 - [Enumeration: FlowRendererComponentType](/auto-docs/fixed-layout-editor/enums/FlowRendererComponentType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowRendererKey](/auto-docs/fixed-layout-editor/enums/FlowRendererKey.md) - [Enumeration: FlowTextKey](/auto-docs/fixed-layout-editor/enums/FlowTextKey.md) - [Enumeration: FlowTransitionLabelEnum](/auto-docs/fixed-layout-editor/enums/FlowTransitionLabelEnum.md) - [Enumeration: FlowTransitionLineEnum](/auto-docs/fixed-layout-editor/enums/FlowTransitionLineEnum.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: HistoryMergeEventType](/auto-docs/fixed-layout-editor/enums/HistoryMergeEventType.md) - [Enumeration: HistoryStackChangeType](/auto-docs/fixed-layout-editor/enums/HistoryStackChangeType.md): 历史栈变化类型 - [Enumeration: LABEL_SIDE_TYPE](/auto-docs/fixed-layout-editor/enums/LABEL_SIDE_TYPE.md): 拖拽分支 Adder、Line 类型 - [Enumeration: LoggerEvent](/auto-docs/fixed-layout-editor/enums/LoggerEvent.md) - [Enumeration: OperationType](/auto-docs/fixed-layout-editor/enums/OperationType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: PipelineLayerPriority](/auto-docs/fixed-layout-editor/enums/PipelineLayerPriority.md) - [Enumeration: PipelineMessage](/auto-docs/fixed-layout-editor/enums/PipelineMessage.md) - [Enumeration: RectangleAlignTitle](/auto-docs/fixed-layout-editor/enums/RectangleAlignTitle.md) - [Enumeration: RectangleAlignType](/auto-docs/fixed-layout-editor/enums/RectangleAlignType.md) - [Enumeration: SHAPES](/auto-docs/fixed-layout-editor/enums/SHAPES.md): Constants that identify shapes. - [Enumeration: UndoRedoChangeType](/auto-docs/fixed-layout-editor/enums/UndoRedoChangeType.md): undo redo 类型 - [Enumeration: ValidateTrigger](/auto-docs/fixed-layout-editor/enums/ValidateTrigger.md) - [Function: create](/auto-docs/fixed-layout-editor/functions/ASTFactory.create.md): ASTFactory.create create(targetType, json): { kind: string } & JSON Creates Type-Safe ASTNodeJSON object based on the provided AST class. Type parameters Parameters Returns { kind: string } & JSON The ASTNode JSON object. - [Function: createArray](/auto-docs/fixed-layout-editor/functions/ASTFactory.createArray.md): ASTFactory.createArray createArray(json): Object Creates an Array type node. Parameters Returns Object - [Function: createBoolean](/auto-docs/fixed-layout-editor/functions/ASTFactory.createBoolean.md): ASTFactory.createBoolean createBoolean(): Object Creates a Boolean type node. Returns Object - [Function: createCustomType](/auto-docs/fixed-layout-editor/functions/ASTFactory.createCustomType.md): ASTFactory.createCustomType createCustomType(json): Object Creates a CustomType node. Parameters Returns Object - [Function: createEnumerateExpression](/auto-docs/fixed-layout-editor/functions/ASTFactory.createEnumerateExpression.md): ASTFactory.createEnumerateExpression createEnumerateExpression(json): Object Creates an EnumerateExpression node. Parameters Returns Object - [Function: createInteger](/auto-docs/fixed-layout-editor/functions/ASTFactory.createInteger.md): ASTFactory.createInteger createInteger(): Object Creates an Integer type node. Returns Object - [Function: createKeyPathExpression](/auto-docs/fixed-layout-editor/functions/ASTFactory.createKeyPathExpression.md): ASTFactory.createKeyPathExpression createKeyPathExpression(json): Object Creates a KeyPathExpression node. Parameters Returns Object - [Function: createMap](/auto-docs/fixed-layout-editor/functions/ASTFactory.createMap.md): ASTFactory.createMap createMap(json): Object Creates a Map type node. Parameters Returns Object - [Function: createNumber](/auto-docs/fixed-layout-editor/functions/ASTFactory.createNumber.md): ASTFactory.createNumber createNumber(): Object Creates a Number type node. Returns Object - [Function: createObject](/auto-docs/fixed-layout-editor/functions/ASTFactory.createObject.md): ASTFactory.createObject createObject(json): Object Creates an Object type node. Parameters Returns Object - [Function: createProperty](/auto-docs/fixed-layout-editor/functions/ASTFactory.createProperty.md): ASTFactory.createProperty createProperty(json): Object Creates a Property node. Type parameters Parameters Returns Object - [Function: createString](/auto-docs/fixed-layout-editor/functions/ASTFactory.createString.md): ASTFactory.createString createString(json?): Object Creates a String type node. Parameters Returns Object - [Function: createUnion](/auto-docs/fixed-layout-editor/functions/ASTFactory.createUnion.md): ASTFactory.createUnion createUnion(json): Object Creates a Union type node. Parameters Returns Object - [Function: createVariableDeclaration](/auto-docs/fixed-layout-editor/functions/ASTFactory.createVariableDeclaration.md): ASTFactory.createVariableDeclaration createVariableDeclaration(json): Object Creates a VariableDeclaration node. Type parameters Parameters Returns Object - [Function: createVariableDeclarationList](/auto-docs/fixed-layout-editor/functions/ASTFactory.createVariableDeclarationList.md): ASTFactory.createVariableDeclarationList createVariableDeclarationList(json): Object Creates a VariableDeclarationList node. Parameters Returns Object - [Function: createWrapArrayExpression](/auto-docs/fixed-layout-editor/functions/ASTFactory.createWrapArrayExpression.md): ASTFactory.createWrapArrayExpression createWrapArrayExpression(json): Object Creates a WrapArrayExpression node. Parameters Returns Object - [Function: is](/auto-docs/fixed-layout-editor/functions/ASTMatch.is.md): ASTMatch.is is(node?, targetType?): node is TargetASTNode Check ASTNode Match by ASTClass Type parameters Parameters Returns node is TargetASTNode Whether the node is of the target type. - [Function: isArray](/auto-docs/fixed-layout-editor/functions/ASTMatch.isArray.md): ASTMatch.isArray isArray(node?): node is ArrayType Check if the node is a ArrayType. Parameters Returns node is ArrayType - [Function: isBaseVariableField](/auto-docs/fixed-layout-editor/functions/ASTMatch.isBaseVariableField.md): ASTMatch.isBaseVariableField isBaseVariableField(node?): node is BaseVariableField Check if the node is a BaseVariableField. Parameters Returns node is BaseVariableField - [Function: isBoolean](/auto-docs/fixed-layout-editor/functions/ASTMatch.isBoolean.md): ASTMatch.isBoolean isBoolean(node?): node is BooleanType Check if the node is a BooleanType. Parameters Returns node is BooleanType - [Function: isCustomType](/auto-docs/fixed-layout-editor/functions/ASTMatch.isCustomType.md): ASTMatch.isCustomType isCustomType(node?): node is CustomType Check if the node is a CustomType. Parameters Returns node is CustomType - [Function: isEnumerateExpression](/auto-docs/fixed-layout-editor/functions/ASTMatch.isEnumerateExpression.md): ASTMatch.isEnumerateExpression isEnumerateExpression(node?): node is EnumerateExpression Check if the node is a EnumerateExpression. Parameters Returns node is EnumerateExpression - [Function: isInteger](/auto-docs/fixed-layout-editor/functions/ASTMatch.isInteger.md): ASTMatch.isInteger isInteger(node?): node is IntegerType Check if the node is a IntegerType. Parameters Returns node is IntegerType - [Function: isKeyPathExpression](/auto-docs/fixed-layout-editor/functions/ASTMatch.isKeyPathExpression.md): ASTMatch.isKeyPathExpression isKeyPathExpression(node?): node is KeyPathExpression Check if the node is a KeyPathExpression. Parameters Returns node is KeyPathExpression - [Function: isMap](/auto-docs/fixed-layout-editor/functions/ASTMatch.isMap.md): ASTMatch.isMap isMap(node?): node is MapType Check if the node is a MapType. Parameters Returns node is MapType - [Function: isNumber](/auto-docs/fixed-layout-editor/functions/ASTMatch.isNumber.md): ASTMatch.isNumber isNumber(node?): node is NumberType Check if the node is a NumberType. Parameters Returns node is NumberType - [Function: isObject](/auto-docs/fixed-layout-editor/functions/ASTMatch.isObject.md): ASTMatch.isObject isObject(node?): node is ObjectType Check if the node is a ObjectType. Parameters Returns node is ObjectType - [Function: isProperty](/auto-docs/fixed-layout-editor/functions/ASTMatch.isProperty.md): ASTMatch.isProperty isProperty(node?): node is Property Check if the node is a Property. Type parameters Parameters Returns node is Property - [Function: isString](/auto-docs/fixed-layout-editor/functions/ASTMatch.isString.md): ASTMatch.isString isString(node?): node is StringType Check if the node is a StringType. Parameters Returns node is StringType - [Function: isVariableDeclaration](/auto-docs/fixed-layout-editor/functions/ASTMatch.isVariableDeclaration.md): ASTMatch.isVariableDeclaration isVariableDeclaration(node?): node is VariableDeclaration Check if the node is a VariableDeclaration. Type parameters Parameters Returns node is VariableDeclaration - [Function: isVariableDeclarationList](/auto-docs/fixed-layout-editor/functions/ASTMatch.isVariableDeclarationList.md): ASTMatch.isVariableDeclarationList isVariableDeclarationList(node?): node is VariableDeclarationList Check if the node is a VariableDeclarationList. Parameters Returns node is VariableDeclarationList - [Function: isWrapArrayExpression](/auto-docs/fixed-layout-editor/functions/ASTMatch.isWrapArrayExpression.md): ASTMatch.isWrapArrayExpression isWrapArrayExpression(node?): node is WrapArrayExpression Check if the node is a WrapArrayExpression. Parameters Returns node is WrapArrayExpression - [Function: betweenPoints](/auto-docs/fixed-layout-editor/functions/Angle.betweenPoints.md): Angle.betweenPoints betweenPoints(point1, point2, originPoint?): number 计算两个点的夹角 Parameters Returns number The angle in radians. - [Function: wrap](/auto-docs/fixed-layout-editor/functions/Angle.wrap.md): Angle.wrap wrap(angle): number Wrap an angle. Wraps the angle to a value in the range of -PI to PI. Parameters Returns number The wrapped angle, in radians. - [Function: wrapDegrees](/auto-docs/fixed-layout-editor/functions/Angle.wrapDegrees.md): Angle.wrapDegrees wrapDegrees(angle): number Wrap an angle in degrees. Wraps the angle to a value in the range of -180 to 180. Parameters Returns number The wrapped angle, in degrees. - [Function: applyMatrix](/auto-docs/fixed-layout-editor/functions/Bounds.applyMatrix.md): Bounds.applyMatrix applyMatrix(bounds, matrix): Rectangle Parameters Returns Rectangle - [Function: getBottomCenter](/auto-docs/fixed-layout-editor/functions/Bounds.getBottomCenter.md): Bounds.getBottomCenter getBottomCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomLeft](/auto-docs/fixed-layout-editor/functions/Bounds.getBottomLeft.md): Bounds.getBottomLeft getBottomLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomRight](/auto-docs/fixed-layout-editor/functions/Bounds.getBottomRight.md): Bounds.getBottomRight getBottomRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBounds](/auto-docs/fixed-layout-editor/functions/Bounds.getBounds.md): Bounds.getBounds getBounds(target, matrix?): Rectangle 获取外围边界矩形 Parameters Returns Rectangle - [Function: getCenter](/auto-docs/fixed-layout-editor/functions/Bounds.getCenter.md): Bounds.getCenter getCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftCenter](/auto-docs/fixed-layout-editor/functions/Bounds.getLeftCenter.md): Bounds.getLeftCenter getLeftCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftPointFromBounds](/auto-docs/fixed-layout-editor/functions/Bounds.getLeftPointFromBounds.md): Bounds.getLeftPointFromBounds getLeftPointFromBounds(target, matrix?): PositionSchema 找到边框中最左边的点 Parameters Returns PositionSchema - [Function: getPointWithMatrix](/auto-docs/fixed-layout-editor/functions/Bounds.getPointWithMatrix.md): Bounds.getPointWithMatrix getPointWithMatrix(output, matrix?): PositionSchema 位置做矩阵偏移 Parameters Returns PositionSchema - [Function: getRightCenter](/auto-docs/fixed-layout-editor/functions/Bounds.getRightCenter.md): Bounds.getRightCenter getRightCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopCenter](/auto-docs/fixed-layout-editor/functions/Bounds.getTopCenter.md): Bounds.getTopCenter getTopCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopLeft](/auto-docs/fixed-layout-editor/functions/Bounds.getTopLeft.md): Bounds.getTopLeft getTopLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopPointFromBounds](/auto-docs/fixed-layout-editor/functions/Bounds.getTopPointFromBounds.md): Bounds.getTopPointFromBounds getTopPointFromBounds(target, matrix?): PositionSchema 找到边框中最上边的点 Parameters Returns PositionSchema - [Function: getTopRight](/auto-docs/fixed-layout-editor/functions/Bounds.getTopRight.md): Bounds.getTopRight getTopRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: assign](/auto-docs/fixed-layout-editor/functions/Cache.assign.md): Cache.assign assign(target, fn): Cache Type parameters Parameters Returns Cache - [Function: create](/auto-docs/fixed-layout-editor/functions/Cache.create.md): Cache.create create(cacheFactory, opts?): CacheManager Type parameters Parameters Returns CacheManager - [Function: createShortCache](/auto-docs/fixed-layout-editor/functions/Cache.createShortCache.md): Cache.createShortCache createShortCache(timeout?): ShortCache 短存储 Type parameters Parameters Returns ShortCache - [Function: createWeakCache](/auto-docs/fixed-layout-editor/functions/Cache.createWeakCache.md): Cache.createWeakCache createWeakCache(): WeakCache Returns WeakCache - [Function: isCancellationToken](/auto-docs/fixed-layout-editor/functions/CancellationToken.isCancellationToken.md): CancellationToken.isCancellationToken isCancellationToken(thing): thing is CancellationToken Parameters Returns thing is CancellationToken - [Function: is](/auto-docs/fixed-layout-editor/functions/Command.is.md): Command.is is(arg): arg is Command 判断是否是 command Parameters Returns arg is Command - [Function: isArrayShallowChanged](/auto-docs/fixed-layout-editor/functions/Compare.isArrayShallowChanged.md): Compare.isArrayShallowChanged isArrayShallowChanged(arr1, arr2): boolean Parameters Returns boolean - [Function: isChanged](/auto-docs/fixed-layout-editor/functions/Compare.isChanged.md): Compare.isChanged isChanged(oldProps, newProps, depth?, partial?): boolean 比较，默认浅比较 Parameters Returns boolean - [Function: isDeepChanged](/auto-docs/fixed-layout-editor/functions/Compare.isDeepChanged.md): Compare.isDeepChanged isDeepChanged(oldProps, newProps, partial?): boolean 深度比较 Parameters Returns boolean - [Function: DEFAULT_FLOW_NODE_META](/auto-docs/fixed-layout-editor/functions/DEFAULT_FLOW_NODE_META.md): DEFAULT_FLOW_NODE_META(nodeType, document): FlowNodeMeta 默认 meta 配置 Parameters Returns FlowNodeMeta - [Function: create](/auto-docs/fixed-layout-editor/functions/Disposable.create.md): Disposable.create create(func): Disposable Parameters Returns Disposable - [Function: is](/auto-docs/fixed-layout-editor/functions/Disposable.is.md): Disposable.is is(thing): thing is Disposable Parameters Returns thing is Disposable - [Function: Editor](/auto-docs/fixed-layout-editor/functions/Editor.md): Editor(props, deprecatedLegacyContext?): null | ReactElement 画布编辑器 Parameters Returns null | ReactElement - [Function: EditorProvider](/auto-docs/fixed-layout-editor/functions/EditorProvider.md): EditorProvider(props, deprecatedLegacyContext?): null | ReactElement Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns null | ReactElement - [Function: EditorRenderer](/auto-docs/fixed-layout-editor/functions/EditorRenderer.md): EditorRenderer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: checkDataChanged](/auto-docs/fixed-layout-editor/functions/Entity.checkDataChanged.md): Entity.checkDataChanged checkDataChanged(oldProps, newProps): boolean 默认数据比较，采用浅比较 Parameters Returns boolean - [Function: getType](/auto-docs/fixed-layout-editor/functions/Entity.getType.md): Entity.getType getType(registry): string Parameters Returns string - [Function: isRegistryOf](/auto-docs/fixed-layout-editor/functions/Entity.isRegistryOf.md): Entity.isRegistryOf isRegistryOf(target, Registry): boolean Parameters Returns boolean - [Function: None](/auto-docs/fixed-layout-editor/functions/Event.None.md): Event.None None(listener, thisArgs?): Disposable Parameters Returns Disposable - [Function: Field](/auto-docs/fixed-layout-editor/functions/Field.md): Field(«destructured»): React$1.ReactElement HOC That declare a field, an Field model will be created it's rendered. Multiple Field rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React$1.ReactElement - [Function: FieldArray](/auto-docs/fixed-layout-editor/functions/FieldArray.md): FieldArray(«destructured»): React$1.ReactElement HOC That declare an array field, an FieldArray model will be created when it's rendered. Multiple FieldArray rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React$1.ReactElement - [Function: FixedLayoutEditor](/auto-docs/fixed-layout-editor/functions/FixedLayoutEditor.md): FixedLayoutEditor(props): null | ReactElement> 固定布局编辑器 Parameters Returns null | ReactElement> - [Function: FixedLayoutEditorProvider](/auto-docs/fixed-layout-editor/functions/FixedLayoutEditorProvider.md): FixedLayoutEditorProvider(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: isVertical](/auto-docs/fixed-layout-editor/functions/FlowLayoutDefault.isVertical.md): FlowLayoutDefault.isVertical isVertical(layout): boolean Parameters Returns boolean - [Function: is](/auto-docs/fixed-layout-editor/functions/FlowNodeEntity.is.md): FlowNodeEntity.is is(obj): obj is FlowNodeEntity Parameters Returns obj is FlowNodeEntity - [Function: extend](/auto-docs/fixed-layout-editor/functions/FlowNodeRegistry.extend.md): FlowNodeRegistry.extend extend(registry, extendRegistries): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: merge](/auto-docs/fixed-layout-editor/functions/FlowNodeRegistry.merge.md): FlowNodeRegistry.merge merge(registry1, registry2, finalType): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: mergeChildRegistries](/auto-docs/fixed-layout-editor/functions/FlowNodeRegistry.mergeChildRegistries.md): FlowNodeRegistry.mergeChildRegistries mergeChildRegistries(r1?, r2?): FlowNodeRegistry[] Parameters Returns FlowNodeRegistry[] - [Function: Form](/auto-docs/fixed-layout-editor/functions/Form.md): Form(props): React__default.JSX.Element Hoc That init and provide Form instance. You can also provide form instance from outside by using control prop Type parameters Parameters Returns React__default.JSX.Element - [Function: MOUSE_SCROLL_DELTA](/auto-docs/fixed-layout-editor/functions/MOUSE_SCROLL_DELTA.md): MOUSE_SCROLL_DELTA(zoom): number 鼠标缩放 delta Parameters Returns number - [Function: getEventCoord](/auto-docs/fixed-layout-editor/functions/MouseTouchEvent.getEventCoord.md): MouseTouchEvent.getEventCoord getEventCoord(e): Object Parameters Returns Object - [Function: isTouchEvent](/auto-docs/fixed-layout-editor/functions/MouseTouchEvent.isTouchEvent.md): MouseTouchEvent.isTouchEvent isTouchEvent(event): event is TouchEvent Parameters Returns event is TouchEvent - [Function: onTouched](/auto-docs/fixed-layout-editor/functions/MouseTouchEvent.onTouched.md): MouseTouchEvent.onTouched onTouched(touchStartEvent, callback): void Parameters Returns void - [Function: preventDefault](/auto-docs/fixed-layout-editor/functions/MouseTouchEvent.preventDefault.md): MouseTouchEvent.preventDefault preventDefault(e): void Parameters Returns void - [Function: touchToMouseEvent](/auto-docs/fixed-layout-editor/functions/MouseTouchEvent.touchToMouseEvent.md): MouseTouchEvent.touchToMouseEvent touchToMouseEvent(event): Event | MouseEvent Parameters Returns Event | MouseEvent - [Function: NOOP](/auto-docs/fixed-layout-editor/functions/NOOP.md): NOOP(): void Returns void - [Function: NodeRender](/auto-docs/fixed-layout-editor/functions/NodeRender.md): NodeRender(props): null | ReactElement> Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns null | ReactElement> - [Function: empty](/auto-docs/fixed-layout-editor/functions/PaddingSchema.empty.md): PaddingSchema.empty empty(): Object Returns Object - [Function: startDrag](/auto-docs/fixed-layout-editor/functions/PlaygroundDrag.startDrag.md): PlaygroundDrag.startDrag startDrag(clientX, clientY, opts?): Disposable 拖拽实体 Type parameters Parameters Returns Disposable - [Function: createContainer](/auto-docs/fixed-layout-editor/functions/PlaygroundMockTools.createContainer.md): PlaygroundMockTools.createContainer createContainer(modules?): Container Parameters Returns Container - [Function: createLayerTestState](/auto-docs/fixed-layout-editor/functions/PlaygroundMockTools.createLayerTestState.md): PlaygroundMockTools.createLayerTestState createLayerTestState(layerRegistry, opts?, modules?): LayerTestState 创建layer, 并记录layer的回调数据 Type parameters Parameters Returns LayerTestState - [Function: createPlayground](/auto-docs/fixed-layout-editor/functions/PlaygroundMockTools.createPlayground.md): PlaygroundMockTools.createPlayground createPlayground(modules?): Playground Parameters Returns Playground - [Function: getLayerTestState](/auto-docs/fixed-layout-editor/functions/PlaygroundMockTools.getLayerTestState.md): PlaygroundMockTools.getLayerTestState getLayerTestState(container, layerRegistry): LayerTestState Type parameters Parameters Returns LayerTestState - [Function: PlaygroundReactProvider](/auto-docs/fixed-layout-editor/functions/PlaygroundReactProvider.md): PlaygroundReactProvider(props): null | ReactElement> Playground react 组件 Parameters Returns null | ReactElement> - [Function: fixZero](/auto-docs/fixed-layout-editor/functions/Point.fixZero.md): Point.fixZero fixZero(output): IPoint Parameters Returns IPoint - [Function: getDistance](/auto-docs/fixed-layout-editor/functions/Point.getDistance.md): Point.getDistance getDistance(p1, p2): number 获取两点间的距离 Parameters Returns number - [Function: getMiddlePoint](/auto-docs/fixed-layout-editor/functions/Point.getMiddlePoint.md): Point.getMiddlePoint getMiddlePoint(p1, p2): IPoint 获取两点间的中间点 Parameters Returns IPoint - [Function: getRatioPoint](/auto-docs/fixed-layout-editor/functions/Point.getRatioPoint.md): Point.getRatioPoint getRatioPoint(p1, p2, ratio): IPoint 按一定比例，获取两点间的中间点 Parameters Returns IPoint - [Function: move](/auto-docs/fixed-layout-editor/functions/Point.move.md): Point.move move(current, m): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: moveDistanceToDirection](/auto-docs/fixed-layout-editor/functions/Point.moveDistanceToDirection.md): Point.moveDistanceToDirection moveDistanceToDirection(current, direction, distance): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: PrivateScopeProvider](/auto-docs/fixed-layout-editor/functions/PrivateScopeProvider.md): PrivateScopeProvider(«destructured»): Element PrivateScopeProvider provides the private scope to its children via context. Parameters Returns Element - [Function: PublicScopeProvider](/auto-docs/fixed-layout-editor/functions/PublicScopeProvider.md): PublicScopeProvider(«destructured»): Element PublicScopeProvider provides the public scope to its children via context. Parameters Returns Element - [Function: align](/auto-docs/fixed-layout-editor/functions/Rectangle.align.md): Rectangle.align align(rectangles, type): Rectangle[] 矩形对齐 Parameters Returns Rectangle[] - [Function: createRectangleWithTwoPoints](/auto-docs/fixed-layout-editor/functions/Rectangle.createRectangleWithTwoPoints.md): Rectangle.createRectangleWithTwoPoints createRectangleWithTwoPoints(point1, point2): Rectangle 根据两点创建矩形 Parameters Returns Rectangle - [Function: enlarge](/auto-docs/fixed-layout-editor/functions/Rectangle.enlarge.md): Rectangle.enlarge enlarge(rectangles): Rectangle 获取所有矩形的外围最大边框 Parameters Returns Rectangle - [Function: intersects](/auto-docs/fixed-layout-editor/functions/Rectangle.intersects.md): Rectangle.intersects intersects(target1, target2, direction?): boolean 判断矩形相交 Parameters Returns boolean - [Function: intersectsWithRotation](/auto-docs/fixed-layout-editor/functions/Rectangle.intersectsWithRotation.md): Rectangle.intersectsWithRotation intersectsWithRotation(rect1, rotate1, rect2, rotate2): boolean 使用 OBB 算法判断两个旋转矩形是否相交 Parameters Returns boolean - [Function: isViewportVisible](/auto-docs/fixed-layout-editor/functions/Rectangle.isViewportVisible.md): Rectangle.isViewportVisible isViewportVisible(rect, viewport, rotation?, isContains?): boolean 判断指定 rect 是否在 viewport 可见 Parameters Returns boolean - [Function: setViewportVisible](/auto-docs/fixed-layout-editor/functions/Rectangle.setViewportVisible.md): Rectangle.setViewportVisible setViewportVisible(bounds, viewport, padding?): Rectangle 保证bounds 永远在 viewport 里边 Parameters Returns Rectangle - [Function: createDefault](/auto-docs/fixed-layout-editor/functions/Schema.createDefault.md): Schema.createDefault createDefault(decoration, mixinDefaults?, _key?): T Type parameters Parameters Returns T - [Function: isBaseType](/auto-docs/fixed-layout-editor/functions/Schema.isBaseType.md): Schema.isBaseType isBaseType(decoration): boolean 非 object 类 Parameters Returns boolean - [Function: create](/auto-docs/fixed-layout-editor/functions/SchemaDecoration.create.md): SchemaDecoration.create create(properties, baseDecoration?, mixinDefaults?): SchemaDecoration 扩展 SchemaDecoration Type parameters Parameters Returns SchemaDecoration Example - [Function: ScopeProvider](/auto-docs/fixed-layout-editor/functions/ScopeProvider.md): ScopeProvider(props): Element ScopeProvider provides the scope to its children via context. Parameters Returns Element - [Function: coverSize](/auto-docs/fixed-layout-editor/functions/SizeSchema.coverSize.md): SizeSchema.coverSize coverSize(currentSize, parentSize): number 填充父节点的宽高 Parameters Returns number 返回放大的比例 - [Function: empty](/auto-docs/fixed-layout-editor/functions/SizeSchema.empty.md): SizeSchema.empty empty(): SizeSchema Returns SizeSchema - [Function: fixSize](/auto-docs/fixed-layout-editor/functions/SizeSchema.fixSize.md): SizeSchema.fixSize fixSize(currentSize, parentSize): number 适配父节点宽高 Parameters Returns number 返回需要缩放的比例，为 1 则不缩放 - [Function: isEmpty](/auto-docs/fixed-layout-editor/functions/TintSchema.isEmpty.md): TintSchema.isEmpty isEmpty(tint): boolean Parameters Returns boolean - [Function: afterFlush](/auto-docs/fixed-layout-editor/functions/Tracker.afterFlush.md): Tracker.afterFlush afterFlush(f): void Schedules a function to be called during the next flush, or later in the current flush if one is in progress, after all invalidated computations have been rerun. The function will be run once and not on subsequent flushes unless afterFlush is called again. Parameters Returns void - [Function: autorun](/auto-docs/fixed-layout-editor/functions/Tracker.autorun.md): Tracker.autorun autorun(f, options?): Computation Run a function now and rerun it later whenever its dependencies change. Returns a Computation object that can be used to stop or observe the rerunning. Type parameters Parameters Returns Computation - [Function: flush](/auto-docs/fixed-layout-editor/functions/Tracker.flush.md): Tracker.flush flush(options?): void Process all reactive updates immediately and ensure that all invalidated computations are rerun. Parameters Returns void - [Function: getCurrentComputation](/auto-docs/fixed-layout-editor/functions/Tracker.getCurrentComputation.md): Tracker.getCurrentComputation getCurrentComputation(): Computation | undefined Returns Computation | undefined - [Function: inFlush](/auto-docs/fixed-layout-editor/functions/Tracker.inFlush.md): Tracker.inFlush inFlush(): boolean True if we are computing a computation now, either first time or recompute. This matches Tracker.active unless we are inside Tracker.nonreactive, which nullfies currentComputation even though an enclosing computation may still be running. Returns boolean - [Function: isActive](/auto-docs/fixed-layout-editor/functions/Tracker.isActive.md): Tracker.isActive isActive(): boolean Returns boolean - [Function: onInvalidate](/auto-docs/fixed-layout-editor/functions/Tracker.onInvalidate.md): Tracker.onInvalidate onInvalidate(f): void Parameters Returns void - [Function: withComputation](/auto-docs/fixed-layout-editor/functions/Tracker.withComputation.md): Tracker.withComputation withComputation(computation, f): T 函数在响应式模块中执行 Type parameters Parameters Returns T - [Function: withoutComputation](/auto-docs/fixed-layout-editor/functions/Tracker.withoutComputation.md): Tracker.withoutComputation withoutComputation(f): T 函数在非响应式模块中执行 Type parameters Parameters Returns T - [Function: isParentOrChildrenTransform](/auto-docs/fixed-layout-editor/functions/TransformData.isParentOrChildrenTransform.md): TransformData.isParentOrChildrenTransform isParentOrChildrenTransform(dragableEntities, target): boolean Parameters Returns boolean - [Function: createDefault](/auto-docs/fixed-layout-editor/functions/TransformSchema.createDefault.md): TransformSchema.createDefault createDefault(): TransformSchema Returns TransformSchema - [Function: getDelta](/auto-docs/fixed-layout-editor/functions/TransformSchema.getDelta.md): TransformSchema.getDelta getDelta(oldTransform, newTransform): TransformSchema Parameters Returns TransformSchema - [Function: is](/auto-docs/fixed-layout-editor/functions/TransformSchema.is.md): TransformSchema.is is(obj): obj is TransformSchema Parameters Returns obj is TransformSchema - [Function: mergeDelta](/auto-docs/fixed-layout-editor/functions/TransformSchema.mergeDelta.md): TransformSchema.mergeDelta mergeDelta(oldTransform, newTransformDelta, toFixedNum?): TransformSchema Parameters Returns TransformSchema - [Function: toJSON](/auto-docs/fixed-layout-editor/functions/TransformSchema.toJSON.md): TransformSchema.toJSON toJSON(obj): TransformSchema Parameters Returns TransformSchema - [Function: addEventListener](/auto-docs/fixed-layout-editor/functions/addEventListener.md): addEventListener(element, type, listener, useCapture?): Disposable Type parameters Parameters Returns Disposable - [Function: arrayToSet](/auto-docs/fixed-layout-editor/functions/arrayToSet.md): arrayToSet(arr): Set Parameters Returns Set - [Function: arrayUnion](/auto-docs/fixed-layout-editor/functions/arrayUnion.md): arrayUnion(arr): any[] Parameters Returns any[] See https://stackoverflow.com/a/9229821 export function arrayUnion(arr: any[]): any[] { return [...new Set(arr)] } - [Function: bindConfigEntity](/auto-docs/fixed-layout-editor/functions/bindConfigEntity.md): bindConfigEntity(bind, entityRegistry): void 让 entity 可以注入到类中 Parameters Returns void Example - [Function: bindContributionProvider](/auto-docs/fixed-layout-editor/functions/bindContributionProvider.md): bindContributionProvider(bind, id): void Parameters Returns void - [Function: bindContributions](/auto-docs/fixed-layout-editor/functions/bindContributions.md): bindContributions(bind, target, contribs): void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns void - [Function: bindPlaygroundContextProvider](/auto-docs/fixed-layout-editor/functions/bindPlaygroundContextProvider.md): bindPlaygroundContextProvider(bind): void Parameters Returns void - [Function: cancelled](/auto-docs/fixed-layout-editor/functions/cancelled.md): cancelled(): Error Returns Error - [Function: checkCancelled](/auto-docs/fixed-layout-editor/functions/checkCancelled.md): checkCancelled(token?): void Parameters Returns void - [Function: clearRequestCache](/auto-docs/fixed-layout-editor/functions/clearRequestCache.md): clearRequestCache(): void Returns void - [Function: compose](/auto-docs/fixed-layout-editor/functions/compose.md): compose(...fns): Func Type parameters Parameters Returns Func - [Function: composeAsync](/auto-docs/fixed-layout-editor/functions/composeAsync.md): composeAsync(...fns): FuncPromise Type parameters Parameters Returns FuncPromise - [Function: createConfigDataRegistry](/auto-docs/fixed-layout-editor/functions/createConfigDataRegistry.md): createConfigDataRegistry

(entity): EntityDataRegistry Type parameters Parameters Returns EntityDataRegistry - [Function: createDefaultPlaygroundConfig](/auto-docs/fixed-layout-editor/functions/createDefaultPlaygroundConfig.md): createDefaultPlaygroundConfig(): PlaygroundConfig 默认配置 Returns PlaygroundConfig - [Function: createDefaultPreset](/auto-docs/fixed-layout-editor/functions/createDefaultPreset.md): createDefaultPreset(opts, plugins?): PluginsProvider Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns PluginsProvider - [Function: createEffectFromVariableProvider](/auto-docs/fixed-layout-editor/functions/createEffectFromVariableProvider.md): createEffectFromVariableProvider(options): EffectOptions[] 根据 VariableProvider 生成 FormV2 的 Effect Parameters Returns EffectOptions[] - [Function: createEffectOptions](/auto-docs/fixed-layout-editor/functions/createEffectOptions.md): createEffectOptions(event, effect): Object Type parameters Parameters Returns Object - [Function: createFixedHistoryPlugin](/auto-docs/fixed-layout-editor/functions/createFixedHistoryPlugin.md): createFixedHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: createFixedLayoutPreset](/auto-docs/fixed-layout-editor/functions/createFixedLayoutPreset.md): createFixedLayoutPreset(opts): PluginsProvider Parameters Returns PluginsProvider - [Function: createFlowEditorClientPlugin](/auto-docs/fixed-layout-editor/functions/createFlowEditorClientPlugin.md): createFlowEditorClientPlugin(opts): Plugin<{}> Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Plugin<{}> - [Function: createFlowEditorClientPlugins](/auto-docs/fixed-layout-editor/functions/createFlowEditorClientPlugins.md): createFlowEditorClientPlugins(): Plugin<{}>[] Returns Plugin<{}>[] - [Function: createHistoryPlugin](/auto-docs/fixed-layout-editor/functions/createHistoryPlugin.md): createHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: createI18nPlugin](/auto-docs/fixed-layout-editor/functions/createI18nPlugin.md): createI18nPlugin(opts): Plugin I18n Plugin Parameters Returns Plugin - [Function: createLines](/auto-docs/fixed-layout-editor/functions/createLines.md): createLines(props): void Parameters Returns void - [Function: createNodeCorePlugin](/auto-docs/fixed-layout-editor/functions/createNodeCorePlugin.md): createNodeCorePlugin(opts): Plugin Parameters Returns Plugin - [Function: createNodeVariablePlugin](/auto-docs/fixed-layout-editor/functions/createNodeVariablePlugin.md): createNodeVariablePlugin(opts): Plugin Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Plugin - [Function: createOperationPlugin](/auto-docs/fixed-layout-editor/functions/createOperationPlugin.md): createOperationPlugin(opts): Plugin Parameters Returns Plugin - [Function: createPlaygroundContainer](/auto-docs/fixed-layout-editor/functions/createPlaygroundContainer.md): createPlaygroundContainer(config?, parent?, container?): Container Parameters Returns Container - [Function: createPlaygroundLayerDefault](/auto-docs/fixed-layout-editor/functions/createPlaygroundLayerDefault.md): createPlaygroundLayerDefault(container, layerRegistry, options?): Layer Parameters Returns Layer - [Function: createPlaygroundPlugin](/auto-docs/fixed-layout-editor/functions/createPlaygroundPlugin.md): createPlaygroundPlugin(options): Plugin Type parameters Parameters Returns Plugin Example - [Function: createPlaygroundReactPreset](/auto-docs/fixed-layout-editor/functions/createPlaygroundReactPreset.md): createPlaygroundReactPreset(opts, plugins?): PluginsProvider Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns PluginsProvider - [Function: createPluginContextDefault](/auto-docs/fixed-layout-editor/functions/createPluginContextDefault.md): createPluginContextDefault(container): PluginContext Parameters Returns PluginContext - [Function: createRegistryDecorator](/auto-docs/fixed-layout-editor/functions/createRegistryDecorator.md): createRegistryDecorator(key, data, getValue?, init?): any Parameters Returns any - [Function: createShortcutsPlugin](/auto-docs/fixed-layout-editor/functions/createShortcutsPlugin.md): createShortcutsPlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariablePlugin](/auto-docs/fixed-layout-editor/functions/createVariablePlugin.md): createVariablePlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariableProviderPlugin](/auto-docs/fixed-layout-editor/functions/createVariableProviderPlugin.md): createVariableProviderPlugin(opts): FormPlugin Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns FormPlugin - [Function: deepFreeze](/auto-docs/fixed-layout-editor/functions/deepFreeze.md): deepFreeze(obj): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: defineFormPluginCreator](/auto-docs/fixed-layout-editor/functions/defineFormPluginCreator.md): defineFormPluginCreator(config): FormPluginCreator Type parameters Parameters Returns FormPluginCreator - [Function: definePluginCreator](/auto-docs/fixed-layout-editor/functions/definePluginCreator.md): definePluginCreator(config): PluginCreator Type parameters Parameters Returns PluginCreator - [Function: delay](/auto-docs/fixed-layout-editor/functions/delay.md): delay(ms, token?): Promise Parameters Returns Promise resolves after a specified number of milliseconds Throws cancelled if a given token is cancelled before a specified number of milliseconds - [Function: addClass](/auto-docs/fixed-layout-editor/functions/domUtils.addClass.md): domUtils.addClass addClass(element, ...classNames): void Parameters Returns void - [Function: addStandardDisposableListener](/auto-docs/fixed-layout-editor/functions/domUtils.addStandardDisposableListener.md): domUtils.addStandardDisposableListener addStandardDisposableListener(dom, type, listener, options?): Disposable Parameters Returns Disposable - [Function: classNameWithPrefix](/auto-docs/fixed-layout-editor/functions/domUtils.classNameWithPrefix.md): domUtils.classNameWithPrefix classNameWithPrefix(prefix): (key: string, opts?: any) => string Parameters Returns fn (key, opts?): string Parameters Returns string - [Function: clearChildren](/auto-docs/fixed-layout-editor/functions/domUtils.clearChildren.md): domUtils.clearChildren clearChildren(container): void Parameters Returns void - [Function: coverClass](/auto-docs/fixed-layout-editor/functions/domUtils.coverClass.md): domUtils.coverClass coverClass(element, ...classNames): void Parameters Returns void - [Function: createDOMCache](/auto-docs/fixed-layout-editor/functions/domUtils.createDOMCache.md): domUtils.createDOMCache createDOMCache(parent, className, children?): CacheManager dom 缓存 Type parameters Parameters Returns CacheManager - [Function: createDivWithClass](/auto-docs/fixed-layout-editor/functions/domUtils.createDivWithClass.md): domUtils.createDivWithClass createDivWithClass(...classNames): HTMLDivElement Parameters Returns HTMLDivElement - [Function: createElement](/auto-docs/fixed-layout-editor/functions/domUtils.createElement.md): domUtils.createElement createElement(ele, ...classNames): T Type parameters Parameters Returns T - [Function: delClass](/auto-docs/fixed-layout-editor/functions/domUtils.delClass.md): domUtils.delClass delClass(element, ...classNames): void Parameters Returns void - [Function: disableEvent](/auto-docs/fixed-layout-editor/functions/domUtils.disableEvent.md): domUtils.disableEvent disableEvent(element): void Parameters Returns void - [Function: enableEvent](/auto-docs/fixed-layout-editor/functions/domUtils.enableEvent.md): domUtils.enableEvent enableEvent(element): void Parameters Returns void - [Function: fromPercent](/auto-docs/fixed-layout-editor/functions/domUtils.fromPercent.md): domUtils.fromPercent fromPercent(percent): number Parameters Returns number - [Function: setStyle](/auto-docs/fixed-layout-editor/functions/domUtils.setStyle.md): domUtils.setStyle setStyle(node, styles): void Parameters Returns void - [Function: toPercent](/auto-docs/fixed-layout-editor/functions/domUtils.toPercent.md): domUtils.toPercent toPercent(percent): string Parameters Returns string - [Function: toPixel](/auto-docs/fixed-layout-editor/functions/domUtils.toPixel.md): domUtils.toPixel toPixel(num): string Parameters Returns string - [Function: translatePercent](/auto-docs/fixed-layout-editor/functions/domUtils.translatePercent.md): domUtils.translatePercent translatePercent(node, x, y): void Parameters Returns void - [Function: translateXPercent](/auto-docs/fixed-layout-editor/functions/domUtils.translateXPercent.md): domUtils.translateXPercent translateXPercent(node, x): void Parameters Returns void - [Function: translateYPercent](/auto-docs/fixed-layout-editor/functions/domUtils.translateYPercent.md): domUtils.translateYPercent translateYPercent(node, y): void Parameters Returns void - [Function: drawLineToBottom](/auto-docs/fixed-layout-editor/functions/drawLineToBottom.md): drawLineToBottom(transition): { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] Parameters Returns { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] - [Function: drawLineToNext](/auto-docs/fixed-layout-editor/functions/drawLineToNext.md): drawLineToNext(transition): { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] Parameters Returns { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] - [Function: each](/auto-docs/fixed-layout-editor/functions/each.md): each(obj, fn): void Type parameters Parameters Returns void - [Function: filter](/auto-docs/fixed-layout-editor/functions/filter.md): filter(obj, fn, dest?): any Parameters Returns any - [Function: generateLocalId](/auto-docs/fixed-layout-editor/functions/generateLocalId.md): generateLocalId(): LocalId Returns LocalId - [Function: getByKey](/auto-docs/fixed-layout-editor/functions/getByKey.md): getByKey(target, key): any | undefined Parameters Returns any | undefined Example - [Function: getDefaultSpacing](/auto-docs/fixed-layout-editor/functions/getDefaultSpacing.md): getDefaultSpacing(node, key, defaultSpacing?): any Parameters Returns any - [Function: getEntityDatasMetadata](/auto-docs/fixed-layout-editor/functions/getEntityDatasMetadata.md): getEntityDatasMetadata(layer): { data: EntityDataRegistry ; entity: EntityRegistry }[] Parameters Returns { data: EntityDataRegistry ; entity: EntityRegistry }[] - [Function: getEntityMetadata](/auto-docs/fixed-layout-editor/functions/getEntityMetadata.md): getEntityMetadata(layer): EntityRegistry[] Parameters Returns EntityRegistry[] - [Function: getNodeForm](/auto-docs/fixed-layout-editor/functions/getNodeForm.md): getNodeForm(node): NodeFormProps | undefined Use node.form instead Type parameters Parameters Returns NodeFormProps | undefined Deprecated - [Function: getNodePrivateScope](/auto-docs/fixed-layout-editor/functions/getNodePrivateScope.md): getNodePrivateScope(node): FlowNodeScope Use node.privateScope instead. Parameters Returns FlowNodeScope The private scope of the node. Deprecated - [Function: getNodeScope](/auto-docs/fixed-layout-editor/functions/getNodeScope.md): getNodeScope(node): FlowNodeScope Use node.scope instead. Parameters Returns FlowNodeScope The public scope of the node. Deprecated - [Function: getRegistryMetadata](/auto-docs/fixed-layout-editor/functions/getRegistryMetadata.md): getRegistryMetadata(target, key): any[] Parameters Returns any[] - [Function: getTag](/auto-docs/fixed-layout-editor/functions/getTag.md): getTag(v): string Parameters Returns string - [Function: highlightFormItem](/auto-docs/fixed-layout-editor/functions/highlightFormItem.md): highlightFormItem(formItem, options?): HTMLDivElement | undefined Parameters Returns HTMLDivElement | undefined - [Function: inject](/auto-docs/fixed-layout-editor/functions/inject.md): inject(serviceIdentifier): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Type parameters Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Parameters Returns void - [Function: injectByProvider](/auto-docs/fixed-layout-editor/functions/injectByProvider.md): injectByProvider(provider): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectPlaygroundContext](/auto-docs/fixed-layout-editor/functions/injectPlaygroundContext.md): injectPlaygroundContext(): (target: any, propertyKey: string) => any Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectToAST](/auto-docs/fixed-layout-editor/functions/injectToAST.md): injectToAST(serviceIdentifier): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectable](/auto-docs/fixed-layout-editor/functions/injectable.md): injectable(): (target: T) => T Returns fn (target): T Type parameters Parameters Returns T - [Function: isCancelled](/auto-docs/fixed-layout-editor/functions/isCancelled.md): isCancelled(err): boolean Parameters Returns boolean - [Function: isEmpty](/auto-docs/fixed-layout-editor/functions/isEmpty.md): isEmpty(arg): boolean true if the argument is an empty object. Otherwise, false. Parameters Returns boolean - [Function: isFormMetaV2](/auto-docs/fixed-layout-editor/functions/isFormMetaV2.md): isFormMetaV2(formMeta): formMeta is FormMeta Parameters Returns formMeta is FormMeta - [Function: isFormModelV2](/auto-docs/fixed-layout-editor/functions/isFormModelV2.md): isFormModelV2(fm): fm is FormModel Parameters Returns fm is FormModel - [Function: isFormV2](/auto-docs/fixed-layout-editor/functions/isFormV2.md): isFormV2(node): boolean Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns boolean - [Function: isFunction](/auto-docs/fixed-layout-editor/functions/isFunction.md): isFunction(v): v is T Type parameters Parameters Returns v is T - [Function: isMatchAST](/auto-docs/fixed-layout-editor/functions/isMatchAST.md): isMatchAST(node?, targetType?): node is TargetASTNode isMatchAST is same as ASTMatch.is Type parameters Parameters Returns node is TargetASTNode - [Function: isNumber](/auto-docs/fixed-layout-editor/functions/isNumber.md): isNumber(v): v is number Parameters Returns v is number - [Function: isObject](/auto-docs/fixed-layout-editor/functions/isObject.md): isObject(v): v is UnknownObject Type parameters Parameters Returns v is UnknownObject - [Function: isPlainObject](/auto-docs/fixed-layout-editor/functions/isPlainObject.md): isPlainObject(obj): boolean Parameters Returns boolean True if the argument appears to be a plain object. - [Function: isString](/auto-docs/fixed-layout-editor/functions/isString.md): isString(v): v is string Parameters Returns v is string - [Function: iterToArray](/auto-docs/fixed-layout-editor/functions/iterToArray.md): iterToArray(iter): T[] Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T[] - [Function: lazyInject](/auto-docs/fixed-layout-editor/functions/lazyInject.md): lazyInject(serviceIdentifier): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: loadPlugins](/auto-docs/fixed-layout-editor/functions/loadPlugins.md): loadPlugins(plugins, container): void Parameters Returns void - [Function: mapKeys](/auto-docs/fixed-layout-editor/functions/mapKeys.md): mapKeys(obj, fn): any Type parameters Parameters Returns any - [Function: mapValues](/auto-docs/fixed-layout-editor/functions/mapValues.md): mapValues(obj, fn): any Type parameters Parameters Returns any - [Function: multiInject](/auto-docs/fixed-layout-editor/functions/multiInject.md): multiInject(serviceIdentifier): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Type parameters Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Parameters Returns void - [Function: named](/auto-docs/fixed-layout-editor/functions/named.md): named(name): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Type parameters Parameters Returns void - [Function: notEmpty](/auto-docs/fixed-layout-editor/functions/notEmpty.md): notEmpty(arg): arg is T Type parameters Parameters Returns arg is T - [Function: observe](/auto-docs/fixed-layout-editor/functions/observe.md): observe(fc): React.FC Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns React.FC - [Function: observeEntities](/auto-docs/fixed-layout-editor/functions/observeEntities.md): observeEntities(registry): any 监听 entity 变化 Parameters Returns any - [Function: observeEntity](/auto-docs/fixed-layout-editor/functions/observeEntity.md): observeEntity(registry): any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns any - [Function: observeEntityDatas](/auto-docs/fixed-layout-editor/functions/observeEntityDatas.md): observeEntityDatas(entityRegistry, dataRegistry): any 监听 entity 对应的 data 数据变化 Parameters Returns any - [Function: omit](/auto-docs/fixed-layout-editor/functions/omit.md): omit(obj, fields, dest?): any Parameters Returns any - [Function: pick](/auto-docs/fixed-layout-editor/functions/pick.md): pick(obj, fields, dest?): any Parameters Returns any - [Function: postConstruct](/auto-docs/fixed-layout-editor/functions/postConstruct.md): postConstruct(): (target: { constructor: NewableFunction }, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: postConstructAST](/auto-docs/fixed-layout-editor/functions/postConstructAST.md): postConstructAST(): (target: any, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: reduce](/auto-docs/fixed-layout-editor/functions/reduce.md): reduce(obj, fn, res?): R Type parameters Parameters Returns R - [Function: registerNodeMaterial](/auto-docs/fixed-layout-editor/functions/registerNodeMaterial.md): registerNodeMaterial(«destructured»): void Parameters Returns void - [Function: removeInjectedProperties](/auto-docs/fixed-layout-editor/functions/removeInjectedProperties.md): removeInjectedProperties(instance): void 在 rspack 场景编译ts文件时候 decorator 注入的 property 会被当成 this 的属性, 导致 Reflect.metadata 失效 Parameters Returns void - [Function: requestWithMemo](/auto-docs/fixed-layout-editor/functions/requestWithMemo.md): requestWithMemo(req, cacheTime?, createCacheKey?): RequestFn Parameters Returns RequestFn - [Function: retry](/auto-docs/fixed-layout-editor/functions/retry.md): retry(task, delayTime, retries, shouldRetry?): Promise Type parameters Parameters Returns Promise - [Function: safeKey](/auto-docs/fixed-layout-editor/functions/safeKey.md): safeKey(key): string filter dangerous key, prevent prototype pollution injection Parameters Returns string filtered key - [Function: scrollIntoViewWithTween](/auto-docs/fixed-layout-editor/functions/scrollIntoViewWithTween.md): scrollIntoViewWithTween(opts): Disposable 滚动到可视区域 Parameters Returns Disposable - [Function: setByKey](/auto-docs/fixed-layout-editor/functions/setByKey.md): setByKey(target, key, newValue, autoCreateObject?, clone?): any Parameters Returns any Example - [Function: _setIdx](/auto-docs/fixed-layout-editor/functions/setIdx.md): _setIdx(idx): void Parameters Returns void - [Function: startTween](/auto-docs/fixed-layout-editor/functions/startTween.md): startTween(opts): Disposable Type parameters Parameters Returns Disposable - [Function: useAvailableVariables](/auto-docs/fixed-layout-editor/functions/useAvailableVariables.md): useAvailableVariables(): VariableDeclaration[] Get available variable list in the current scope. If no scope, return global variable list.The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useBaseColor](/auto-docs/fixed-layout-editor/functions/useBaseColor.md): useBaseColor(): Object Returns Object - [Function: useClientContext](/auto-docs/fixed-layout-editor/functions/useClientContext.md): useClientContext(): FixedLayoutPluginContext Returns FixedLayoutPluginContext - [Function: useConfigEntity](/auto-docs/fixed-layout-editor/functions/useConfigEntity.md): useConfigEntity(entityRegistry, listenChange?): T 获取 config entity Type parameters Parameters Returns T - [Function: useCurrentField](/auto-docs/fixed-layout-editor/functions/useCurrentField.md): useCurrentField(): IField | IFieldArray Get the current Field. It should be used in a child component of , otherwise it throws an error Type parameters Returns IField | IFieldArray - [Function: useCurrentFieldState](/auto-docs/fixed-layout-editor/functions/useCurrentFieldState.md): useCurrentFieldState(): FieldState Get the current field state. It should be used in a child component of , otherwise it throws an error Returns FieldState - [Function: useCurrentScope](/auto-docs/fixed-layout-editor/functions/useCurrentScope.md): useCurrentScope(params?): Strict extends true ? Scope> : undefined | Scope> useCurrentScope returns the scope provided by ScopeProvider. Type parameters Parameters Returns Strict extends true ? Scope> : undefined | Scope> - [Function: useEntities](/auto-docs/fixed-layout-editor/functions/useEntities.md): useEntities(entityRegistry): T[] 获取 entities 并监听变化 Type parameters Parameters Returns T[] Deprecated - [Function: useEntityDataFromContext](/auto-docs/fixed-layout-editor/functions/useEntityDataFromContext.md): useEntityDataFromContext(dataRegistry, listenChange?): T 从上下 PlaygroundEntityContext 获取 entity data 并监听变化 (默认不监听) Type parameters Parameters Returns T - [Function: useEntityFromContext](/auto-docs/fixed-layout-editor/functions/useEntityFromContext.md): useEntityFromContext(listenChange?): T 从上下 PlaygroundEntityContext 获取 entity 并监听变化(默认不监听) Type parameters Parameters Returns T - [Function: useField](/auto-docs/fixed-layout-editor/functions/useField.md): useField(name?): TField | undefined Type parameters Parameters Returns TField | undefined Deprecated useField is deprecated because its return relies on React render. if the Field is not rendered, the return would be undefined. If you simply want to monitor the change of the value of a certain path, please use useWatch(fieldName) - [Function: useFieldValidate](/auto-docs/fixed-layout-editor/functions/useFieldValidate.md): useFieldValidate(name?): () => void Get validate method of a field with given name. the returned function could possibly do nothing if the field is not found. The reason could be that the field is not rendered yet or the name given is wrong. Parameters Returns fn (): void Returns void - [Function: useFlowEditor](/auto-docs/fixed-layout-editor/functions/useFlowEditor.md): useFlowEditor(): FlowEditorClient Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Returns FlowEditorClient - [Function: useForm](/auto-docs/fixed-layout-editor/functions/useForm.md): useForm(): IForm Get Form instance. It should be use in a child component of Returns IForm - [Function: useHighlight](/auto-docs/fixed-layout-editor/functions/useHighlight.md): useHighlight(props): React.MutableRefObject | null Parameters Returns React.MutableRefObject | null - [Function: useInitializedFormModel](/auto-docs/fixed-layout-editor/functions/useInitializedFormModel.md): useInitializedFormModel(node): FormModel Listen to FormModel's initialization and refresh React component. By providing related node, you can use this hook outside the Form Component. Parameters Returns FormModel - [Function: useListenEvents](/auto-docs/fixed-layout-editor/functions/useListenEvents.md): useListenEvents(...events): void 监听 event 事件变化 Parameters Returns void - [Function: useNodeRender](/auto-docs/fixed-layout-editor/functions/useNodeRender.md): useNodeRender(nodeFromProps?): NodeRenderReturnType Provides methods related to node rendering Parameters Returns NodeRenderReturnType - [Function: useObserve](/auto-docs/fixed-layout-editor/functions/useObserve.md): useObserve(value): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: useOutputVariables](/auto-docs/fixed-layout-editor/functions/useOutputVariables.md): useOutputVariables(): VariableDeclaration[] Get output variable list in the current scope. The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: usePlayground](/auto-docs/fixed-layout-editor/functions/usePlayground.md): usePlayground(): Playground 获取 playground Returns Playground - [Function: usePlaygroundContainer](/auto-docs/fixed-layout-editor/functions/usePlaygroundContainer.md): usePlaygroundContainer(): Container 获取 playground inversify container Returns Container - [Function: usePlaygroundContext](/auto-docs/fixed-layout-editor/functions/usePlaygroundContext.md): usePlaygroundContext(): T 获取 playground context 数据 Type parameters Returns T - [Function: usePlaygroundDrag](/auto-docs/fixed-layout-editor/functions/usePlaygroundDrag.md): usePlaygroundDrag(): UsePlaygroundDragReturn Returns UsePlaygroundDragReturn - [Function: usePlaygroundTools](/auto-docs/fixed-layout-editor/functions/usePlaygroundTools.md): usePlaygroundTools(props?): PlaygroundTools Parameters Returns PlaygroundTools - [Function: useReactiveState](/auto-docs/fixed-layout-editor/functions/useReactiveState.md): useReactiveState(v): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: useReadonlyReactiveState](/auto-docs/fixed-layout-editor/functions/useReadonlyReactiveState.md): useReadonlyReactiveState(state): Readonly Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns Readonly - [Function: useRefresh](/auto-docs/fixed-layout-editor/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (v?): void Parameters Returns void - [Function: useScopeAvailable](/auto-docs/fixed-layout-editor/functions/useScopeAvailable.md): useScopeAvailable(params?): ScopeAvailableData Get the available variables in the current scope. 获取作用域的可访问变量 Parameters Returns ScopeAvailableData the available variables in the current scope - [Function: useService](/auto-docs/fixed-layout-editor/functions/useService.md): useService(identifier): T 获取画布的 IOC 模块 Type parameters Parameters Returns T - [Function: useStartDragNode](/auto-docs/fixed-layout-editor/functions/useStartDragNode.md): useStartDragNode(): Object Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Returns Object - [Function: useWatch](/auto-docs/fixed-layout-editor/functions/useWatch.md): useWatch(name): TValue Listen to the field data change and refresh the React component. Type parameters Parameters Returns TValue - [Function: useWatchFormErrors](/auto-docs/fixed-layout-editor/functions/useWatchFormErrors.md): useWatchFormErrors(node): Errors | undefined Get Form's errors, Form errors is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Errors | undefined - [Function: useWatchFormState](/auto-docs/fixed-layout-editor/functions/useWatchFormState.md): useWatchFormState(node): FormState | undefined Get Form's state, Form State is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns FormState | undefined - [Function: useWatchFormValueIn](/auto-docs/fixed-layout-editor/functions/useWatchFormValueIn.md): useWatchFormValueIn(node, name): T | undefined Listen to Form's value in a certain path and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormValues](/auto-docs/fixed-layout-editor/functions/useWatchFormValues.md): useWatchFormValues(node): T | undefined Listen to Form's values and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormWarnings](/auto-docs/fixed-layout-editor/functions/useWatchFormWarnings.md): useWatchFormWarnings(node): Warnings | undefined Get Form's warnings, Form warnings is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Warnings | undefined - [Function: values](/auto-docs/fixed-layout-editor/functions/values.md): values(obj): any[] Parameters Returns any[] - [Interface: ASTNodeJSON](/auto-docs/fixed-layout-editor/interfaces/ASTNodeJSON.md): ASTNodeJSON is the JSON representation of an ASTNode. - [Interface: ASTNodeRegistry](/auto-docs/fixed-layout-editor/interfaces/ASTNodeRegistry.md) - [Interface: AddBlockConfig](/auto-docs/fixed-layout-editor/interfaces/AddBlockConfig.md): 添加block时的配置 - [Interface: AddBlockOperation](/auto-docs/fixed-layout-editor/interfaces/AddBlockOperation.md) - [Interface: AddChildNodeOperation](/auto-docs/fixed-layout-editor/interfaces/AddChildNodeOperation.md) - [Interface: AddFromNodeOperation](/auto-docs/fixed-layout-editor/interfaces/AddFromNodeOperation.md) - [Interface: AddNodeOperation](/auto-docs/fixed-layout-editor/interfaces/AddNodeOperation.md) - [Interface: AddNodesOperation](/auto-docs/fixed-layout-editor/interfaces/AddNodesOperation.md) - [Interface: AddOrDeleteBlockValue](/auto-docs/fixed-layout-editor/interfaces/AddOrDeleteBlockValue.md) - [Interface: AddOrDeleteChildNodeValue](/auto-docs/fixed-layout-editor/interfaces/AddOrDeleteChildNodeValue.md) - [Interface: AddOrDeleteFromNodeOperationValue](/auto-docs/fixed-layout-editor/interfaces/AddOrDeleteFromNodeOperationValue.md) - [Interface: AddOrDeleteNodeOperationValue](/auto-docs/fixed-layout-editor/interfaces/AddOrDeleteNodeOperationValue.md) - [Interface: AddOrDeleteNodeValue](/auto-docs/fixed-layout-editor/interfaces/AddOrDeleteNodeValue.md) - [Interface: AddOrDeleteNodesOperationValue](/auto-docs/fixed-layout-editor/interfaces/AddOrDeleteNodesOperationValue.md) - [Interface: AdderProps](/auto-docs/fixed-layout-editor/interfaces/AdderProps.md) - [Interface: AsClass](/auto-docs/fixed-layout-editor/interfaces/AsClass.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheManager](/auto-docs/fixed-layout-editor/interfaces/CacheManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheOpts](/auto-docs/fixed-layout-editor/interfaces/CacheOpts.md) - [Interface: CacheOriginItem](/auto-docs/fixed-layout-editor/interfaces/CacheOriginItem.md) - [Interface: CancellationToken](/auto-docs/fixed-layout-editor/interfaces/CancellationToken-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ClipboardService](/auto-docs/fixed-layout-editor/interfaces/ClipboardService.md) - [Interface: CollapseAdderProps](/auto-docs/fixed-layout-editor/interfaces/CollapseAdderProps.md) - [Interface: CollapseProps](/auto-docs/fixed-layout-editor/interfaces/CollapseProps.md) - [Interface: CollisionRetType](/auto-docs/fixed-layout-editor/interfaces/CollisionRetType.md) - [Interface: Command](/auto-docs/fixed-layout-editor/interfaces/Command-1.md) - [Interface: CommandService](/auto-docs/fixed-layout-editor/interfaces/CommandService.md): command service 执行接口 - [Interface: ConfigEntityProps](/auto-docs/fixed-layout-editor/interfaces/ConfigEntityProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ContributionProvider](/auto-docs/fixed-layout-editor/interfaces/ContributionProvider.md) - [Interface: CreateASTParams](/auto-docs/fixed-layout-editor/interfaces/CreateASTParams.md) - [Interface: CreateGroupOperation](/auto-docs/fixed-layout-editor/interfaces/CreateGroupOperation.md) - [Interface: CustomLabelProps](/auto-docs/fixed-layout-editor/interfaces/CustomLabelProps.md) - [Interface: CustomTypeJSON](/auto-docs/fixed-layout-editor/interfaces/CustomTypeJSON.md): ASTNodeJSON representation of CustomType - [Interface: DOMCache](/auto-docs/fixed-layout-editor/interfaces/DOMCache.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: DeleteBlockOperation](/auto-docs/fixed-layout-editor/interfaces/DeleteBlockOperation.md) - [Interface: DeleteChildNodeOperation](/auto-docs/fixed-layout-editor/interfaces/DeleteChildNodeOperation.md) - [Interface: DeleteFromNodeOperation](/auto-docs/fixed-layout-editor/interfaces/DeleteFromNodeOperation.md) - [Interface: DeleteNodeOperation](/auto-docs/fixed-layout-editor/interfaces/DeleteNodeOperation.md) - [Interface: DeleteNodesOperation](/auto-docs/fixed-layout-editor/interfaces/DeleteNodesOperation.md) - [Interface: Disposable](/auto-docs/fixed-layout-editor/interfaces/Disposable-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: DragNodeProps](/auto-docs/fixed-layout-editor/interfaces/DragNodeProps.md) - [Interface: EditorPluginContext](/auto-docs/fixed-layout-editor/interfaces/EditorPluginContext.md) - [Interface: EditorProps](/auto-docs/fixed-layout-editor/interfaces/EditorProps-1.md) - [Interface: EditorState](/auto-docs/fixed-layout-editor/interfaces/EditorState-1.md): 编辑态 - [Interface: EditorStateChangeEvent](/auto-docs/fixed-layout-editor/interfaces/EditorStateChangeEvent.md) - [Interface: EffectFuncProps](/auto-docs/fixed-layout-editor/interfaces/EffectFuncProps.md) - [Interface: EntityDataChangedEvent](/auto-docs/fixed-layout-editor/interfaces/EntityDataChangedEvent.md) - [Interface: EntityDataRegistry](/auto-docs/fixed-layout-editor/interfaces/EntityDataRegistry.md) - [Interface: EntityJSON](/auto-docs/fixed-layout-editor/interfaces/EntityJSON.md): 持久化数据 - [Interface: EntityManagerContribution](/auto-docs/fixed-layout-editor/interfaces/EntityManagerContribution.md) - [Interface: EntityOpts](/auto-docs/fixed-layout-editor/interfaces/EntityOpts.md) - [Interface: EntityRegistry](/auto-docs/fixed-layout-editor/interfaces/EntityRegistry.md): 注册类 - [Interface: EnumerateExpressionJSON](/auto-docs/fixed-layout-editor/interfaces/EnumerateExpressionJSON.md): ASTNodeJSON representation of EnumerateExpression - [Interface: Event](/auto-docs/fixed-layout-editor/interfaces/Event-1.md) - [Interface: EventListener](/auto-docs/fixed-layout-editor/interfaces/EventListener.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FieldArrayRenderProps](/auto-docs/fixed-layout-editor/interfaces/FieldArrayRenderProps.md) - [Interface: FieldRenderProps](/auto-docs/fixed-layout-editor/interfaces/FieldRenderProps.md) - [Interface: FieldState](/auto-docs/fixed-layout-editor/interfaces/FieldState.md) - [Interface: FixedHistoryPluginOptions](/auto-docs/fixed-layout-editor/interfaces/FixedHistoryPluginOptions.md): 插件配置 - [Interface: FixedLayoutPluginContext](/auto-docs/fixed-layout-editor/interfaces/FixedLayoutPluginContext.md) - [Interface: FixedLayoutPluginTools](/auto-docs/fixed-layout-editor/interfaces/FixedLayoutPluginTools.md) - [Interface: FixedLayoutProps](/auto-docs/fixed-layout-editor/interfaces/FixedLayoutProps-1.md): 固定布局配置 - [Interface: FlipSchema](/auto-docs/fixed-layout-editor/interfaces/FlipSchema.md) - [Interface: Flow](/auto-docs/fixed-layout-editor/interfaces/Flow.md) - [Interface: FlowDocumentContribution](/auto-docs/fixed-layout-editor/interfaces/FlowDocumentContribution.md) - [Interface: FlowDocumentOptions](/auto-docs/fixed-layout-editor/interfaces/FlowDocumentOptions.md): 流程画布配置 - [Interface: FlowDragOptions](/auto-docs/fixed-layout-editor/interfaces/FlowDragOptions.md) - [Interface: FlowGroupJSON](/auto-docs/fixed-layout-editor/interfaces/FlowGroupJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowLayout](/auto-docs/fixed-layout-editor/interfaces/FlowLayout.md): 流程布局算法 - [Interface: FlowLayoutContribution](/auto-docs/fixed-layout-editor/interfaces/FlowLayoutContribution.md) - [Interface: FlowNodeEntityConfig](/auto-docs/fixed-layout-editor/interfaces/FlowNodeEntityConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowNodeInitData](/auto-docs/fixed-layout-editor/interfaces/FlowNodeInitData.md) - [Interface: FlowNodeJSON](/auto-docs/fixed-layout-editor/interfaces/FlowNodeJSON.md): Flow node json data - [Interface: FlowNodeMeta](/auto-docs/fixed-layout-editor/interfaces/FlowNodeMeta.md): 节点渲染相关配置信息，可扩展 - [Interface: FlowNodeRegistry](/auto-docs/fixed-layout-editor/interfaces/FlowNodeRegistry-1.md): 节点注册 - [Interface: FlowNodeRenderSchema](/auto-docs/fixed-layout-editor/interfaces/FlowNodeRenderSchema.md) - [Interface: FlowNodeScope](/auto-docs/fixed-layout-editor/interfaces/FlowNodeScope.md): Represents a scope associated with a flow node. - [Interface: FlowNodeScopeMeta](/auto-docs/fixed-layout-editor/interfaces/FlowNodeScopeMeta.md): Metadata for a flow node scope. - [Interface: FlowNodeTransformSchema](/auto-docs/fixed-layout-editor/interfaces/FlowNodeTransformSchema.md) - [Interface: FlowNodeTransitionSchema](/auto-docs/fixed-layout-editor/interfaces/FlowNodeTransitionSchema.md) - [Interface: FlowNodesTransformLayerOptions](/auto-docs/fixed-layout-editor/interfaces/FlowNodesTransformLayerOptions.md) - [Interface: FlowOperationBaseService](/auto-docs/fixed-layout-editor/interfaces/FlowOperationBaseService.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: FlowOperationService](/auto-docs/fixed-layout-editor/interfaces/FlowOperationService.md) - [Interface: FlowRendererComponent](/auto-docs/fixed-layout-editor/interfaces/FlowRendererComponent.md) - [Interface: FlowRendererContribution](/auto-docs/fixed-layout-editor/interfaces/FlowRendererContribution.md) - [Interface: FlowSelectorBoundsLayerOptions](/auto-docs/fixed-layout-editor/interfaces/FlowSelectorBoundsLayerOptions.md) - [Interface: FlowSelectorBoxOptions](/auto-docs/fixed-layout-editor/interfaces/FlowSelectorBoxOptions.md) - [Interface: FlowTransitionLabel](/auto-docs/fixed-layout-editor/interfaces/FlowTransitionLabel.md) - [Interface: FlowTransitionLine](/auto-docs/fixed-layout-editor/interfaces/FlowTransitionLine.md) - [Interface: NodeInfo](/auto-docs/fixed-layout-editor/interfaces/FlowVirtualTree.NodeInfo.md): FlowVirtualTree.NodeInfo - [Interface: FocusNodeFormItemOptions](/auto-docs/fixed-layout-editor/interfaces/FocusNodeFormItemOptions.md) - [Interface: FormControl](/auto-docs/fixed-layout-editor/interfaces/FormControl.md) - [Interface: FormMeta](/auto-docs/fixed-layout-editor/interfaces/FormMeta.md) - [Interface: FormPluginConfig](/auto-docs/fixed-layout-editor/interfaces/FormPluginConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FormRenderProps](/auto-docs/fixed-layout-editor/interfaces/FormRenderProps.md) - [Interface: FormState](/auto-docs/fixed-layout-editor/interfaces/FormState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: GlobalEventActionType](/auto-docs/fixed-layout-editor/interfaces/GlobalEventActionType.md): Global event action type. Global event might be dispatched from ASTNode or Scope. - [Interface: HighLightOptions](/auto-docs/fixed-layout-editor/interfaces/HighLightOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryItem](/auto-docs/fixed-layout-editor/interfaces/HistoryItem.md) - [Interface: HistoryOperation](/auto-docs/fixed-layout-editor/interfaces/HistoryOperation.md): 操作历史 - [Interface: HistoryPluginOptions](/auto-docs/fixed-layout-editor/interfaces/HistoryPluginOptions.md) - [Interface: HistoryRecord](/auto-docs/fixed-layout-editor/interfaces/HistoryRecord.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryStackAddEvent](/auto-docs/fixed-layout-editor/interfaces/HistoryStackAddEvent.md): 添加历史事件 - [Interface: HistoryStackAddOperationEvent](/auto-docs/fixed-layout-editor/interfaces/HistoryStackAddOperationEvent.md): 添加操作事件 - [Interface: HistoryStackBaseEvent](/auto-docs/fixed-layout-editor/interfaces/HistoryStackBaseEvent.md): 历史栈变化事件基础 - [Interface: HistoryStackItem](/auto-docs/fixed-layout-editor/interfaces/HistoryStackItem.md) - [Interface: HistoryStackUpdateEvent](/auto-docs/fixed-layout-editor/interfaces/HistoryStackUpdateEvent.md): 更新历史事件 - [Interface: HistoryStackUpdateOperationEvent](/auto-docs/fixed-layout-editor/interfaces/HistoryStackUpdateOperationEvent.md): 更新操作事件 - [Interface: I18nLanguage](/auto-docs/fixed-layout-editor/interfaces/I18nLanguage.md) - [Interface: I18nPluginOptions](/auto-docs/fixed-layout-editor/interfaces/I18nPluginOptions.md) - [Interface: IField](/auto-docs/fixed-layout-editor/interfaces/IField.md): Field render model, it's only available when Field is rendered - [Interface: IFieldArray](/auto-docs/fixed-layout-editor/interfaces/IFieldArray.md): FieldArray render model, it's only available when FieldArray is rendered - [Interface: IForm](/auto-docs/fixed-layout-editor/interfaces/IForm.md) - [Interface: IHistoryDocument](/auto-docs/fixed-layout-editor/interfaces/IHistoryDocument.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: IHistoryManager](/auto-docs/fixed-layout-editor/interfaces/IHistoryManager.md): 历史服务管理 - [Interface: IHistoryService](/auto-docs/fixed-layout-editor/interfaces/IHistoryService.md): 历史服务 - [Interface: IOperationRegistry](/auto-docs/fixed-layout-editor/interfaces/IOperationRegistry.md): 操作注册 - [Interface: IOperationService](/auto-docs/fixed-layout-editor/interfaces/IOperationService.md) - [Interface: IPoint](/auto-docs/fixed-layout-editor/interfaces/IPoint.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: IUndoRedoElement](/auto-docs/fixed-layout-editor/interfaces/IUndoRedoElement.md): UndoRedo元素 - [Interface: IUndoRedoService](/auto-docs/fixed-layout-editor/interfaces/IUndoRedoService.md): UndoRedo服务 - [Interface: IVariableTable](/auto-docs/fixed-layout-editor/interfaces/IVariableTable.md): Interface for a variable table. - [Interface: KeyPathExpressionJSON](/auto-docs/fixed-layout-editor/interfaces/KeyPathExpressionJSON.md): ASTNodeJSON representation of KeyPathExpression - [Interface: LayerEntitiesSelector](/auto-docs/fixed-layout-editor/interfaces/LayerEntitiesSelector.md) - [Interface: LayerOptions](/auto-docs/fixed-layout-editor/interfaces/LayerOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: LayerRegistry

](/auto-docs/fixed-layout-editor/interfaces/LayerRegistry.md) - [Interface: ListNodeJSON](/auto-docs/fixed-layout-editor/interfaces/ListNodeJSON.md): ASTNodeJSON representation of ListNode - [Interface: LoggerProps](/auto-docs/fixed-layout-editor/interfaces/LoggerProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: MapNodeJSON](/auto-docs/fixed-layout-editor/interfaces/MapNodeJSON.md): ASTNodeJSON representation of MapNode - [Interface: MoveBlockOperation](/auto-docs/fixed-layout-editor/interfaces/MoveBlockOperation.md) - [Interface: MoveChildNodesOperation](/auto-docs/fixed-layout-editor/interfaces/MoveChildNodesOperation.md) - [Interface: MoveChildNodesOperationValue](/auto-docs/fixed-layout-editor/interfaces/MoveChildNodesOperationValue.md) - [Interface: MoveNodeConfig](/auto-docs/fixed-layout-editor/interfaces/MoveNodeConfig.md): 移动节点时的配置 - [Interface: MoveNodesOperation](/auto-docs/fixed-layout-editor/interfaces/MoveNodesOperation.md) - [Interface: MoveNodesOperationValue](/auto-docs/fixed-layout-editor/interfaces/MoveNodesOperationValue.md) - [Interface: Node](/auto-docs/fixed-layout-editor/interfaces/Node.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeCorePluginOptions](/auto-docs/fixed-layout-editor/interfaces/NodeCorePluginOptions.md) - [Interface: NodeEngineMaterialOptions](/auto-docs/fixed-layout-editor/interfaces/NodeEngineMaterialOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeFormProps](/auto-docs/fixed-layout-editor/interfaces/NodeFormProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeRenderProps](/auto-docs/fixed-layout-editor/interfaces/NodeRenderProps.md) - [Interface: NodeRenderReturnType](/auto-docs/fixed-layout-editor/interfaces/NodeRenderReturnType.md) - [Interface: NodeSchema](/auto-docs/fixed-layout-editor/interfaces/NodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ObjectJSON](/auto-docs/fixed-layout-editor/interfaces/ObjectJSON.md): ASTNodeJSON representation of ObjectType - [Interface: Observer](/auto-docs/fixed-layout-editor/interfaces/Observer.md): An object interface that defines a set of callback functions a user can use to get notified of any set of Observable guide/glossary-and-semantics#notification notification events. For more info, please refer to guide/observer this guide. - [Interface: OnNodeAddEvent](/auto-docs/fixed-layout-editor/interfaces/OnNodeAddEvent.md): 节点添加事件 - [Interface: OnNodeMoveEvent](/auto-docs/fixed-layout-editor/interfaces/OnNodeMoveEvent.md): 节点移动事件 - [Interface: Operation](/auto-docs/fixed-layout-editor/interfaces/Operation.md): 操作 - [Interface: OperationContribution](/auto-docs/fixed-layout-editor/interfaces/OperationContribution.md) - [Interface: OperationMeta](/auto-docs/fixed-layout-editor/interfaces/OperationMeta.md): 操作元数据 - [Interface: OriginSchema](/auto-docs/fixed-layout-editor/interfaces/OriginSchema.md) - [Interface: PaddingSchema](/auto-docs/fixed-layout-editor/interfaces/PaddingSchema-1.md) - [Interface: PipelineDimension](/auto-docs/fixed-layout-editor/interfaces/PipelineDimension.md) - [Interface: PipelineEntities](/auto-docs/fixed-layout-editor/interfaces/PipelineEntities.md): 注入到 Layer 中的实体选择器 - [Interface: PipelineEventRegsiter](/auto-docs/fixed-layout-editor/interfaces/PipelineEventRegsiter.md) - [Interface: PlaygroundConfig](/auto-docs/fixed-layout-editor/interfaces/PlaygroundConfig.md): 画布配置 - [Interface: PlaygroundConfigEntityData](/auto-docs/fixed-layout-editor/interfaces/PlaygroundConfigEntityData.md) - [Interface: PlaygroundConfigRevealOpts](/auto-docs/fixed-layout-editor/interfaces/PlaygroundConfigRevealOpts.md) - [Interface: PlaygroundContainerFactory](/auto-docs/fixed-layout-editor/interfaces/PlaygroundContainerFactory.md) - [Interface: PlaygroundContribution](/auto-docs/fixed-layout-editor/interfaces/PlaygroundContribution.md) - [Interface: PlaygroundDragEntitiesOpts](/auto-docs/fixed-layout-editor/interfaces/PlaygroundDragEntitiesOpts.md) - [Interface: PlaygroundDragEvent](/auto-docs/fixed-layout-editor/interfaces/PlaygroundDragEvent.md) - [Interface: PlaygroundDragOptions](/auto-docs/fixed-layout-editor/interfaces/PlaygroundDragOptions.md) - [Interface: PlaygroundLayerOptions](/auto-docs/fixed-layout-editor/interfaces/PlaygroundLayerOptions.md) - [Interface: PlaygroundReactProviderProps](/auto-docs/fixed-layout-editor/interfaces/PlaygroundReactProviderProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PlaygroundReactRendererProps](/auto-docs/fixed-layout-editor/interfaces/PlaygroundReactRendererProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PlaygroundTools](/auto-docs/fixed-layout-editor/interfaces/PlaygroundTools.md) - [Interface: PlaygroundToolsPropsType](/auto-docs/fixed-layout-editor/interfaces/PlaygroundToolsPropsType.md) - [Interface: PluginBindConfig](/auto-docs/fixed-layout-editor/interfaces/PluginBindConfig.md) - [Interface: PluginConfig](/auto-docs/fixed-layout-editor/interfaces/PluginConfig.md) - [Interface: PluginContext](/auto-docs/fixed-layout-editor/interfaces/PluginContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PluginsProvider](/auto-docs/fixed-layout-editor/interfaces/PluginsProvider.md) - [Interface: PositionSchema](/auto-docs/fixed-layout-editor/interfaces/PositionSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PromisePoolOpts](/auto-docs/fixed-layout-editor/interfaces/PromisePoolOpts.md) - [Interface: PromiseTask](/auto-docs/fixed-layout-editor/interfaces/PromiseTask.md) - [Interface: PushOperationOptions](/auto-docs/fixed-layout-editor/interfaces/PushOperationOptions.md): push操作配置 - [Interface: RegistryInit](/auto-docs/fixed-layout-editor/interfaces/RegistryInit.md) - [Interface: RegistryValueGetter](/auto-docs/fixed-layout-editor/interfaces/RegistryValueGetter.md) - [Interface: ScaleSchema](/auto-docs/fixed-layout-editor/interfaces/ScaleSchema.md) - [Interface: SchemaDecoration](/auto-docs/fixed-layout-editor/interfaces/SchemaDecoration-1.md) - [Interface: ScrollBarEvents](/auto-docs/fixed-layout-editor/interfaces/ScrollBarEvents.md) - [Interface: ScrollBarOptions](/auto-docs/fixed-layout-editor/interfaces/ScrollBarOptions.md) - [Interface: ScrollIntoViewOpts](/auto-docs/fixed-layout-editor/interfaces/ScrollIntoViewOpts.md) - [Interface: ScrollSchema](/auto-docs/fixed-layout-editor/interfaces/ScrollSchema.md) - [Interface: SelectorBoxConfigData](/auto-docs/fixed-layout-editor/interfaces/SelectorBoxConfigData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: SelectorBoxPopoverProps](/auto-docs/fixed-layout-editor/interfaces/SelectorBoxPopoverProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ShadowSchema](/auto-docs/fixed-layout-editor/interfaces/ShadowSchema.md) - [Interface: ShortCache](/auto-docs/fixed-layout-editor/interfaces/ShortCache.md) - [Interface: ShortcutsContribution](/auto-docs/fixed-layout-editor/interfaces/ShortcutsContribution.md) - [Interface: ShortcutsHandler](/auto-docs/fixed-layout-editor/interfaces/ShortcutsHandler.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: SizeSchema](/auto-docs/fixed-layout-editor/interfaces/SizeSchema-1.md) - [Interface: SkewSchema](/auto-docs/fixed-layout-editor/interfaces/SkewSchema.md) - [Interface: StorageService](/auto-docs/fixed-layout-editor/interfaces/StorageService.md): 存储数据到缓存 - [Interface: TintSchema](/auto-docs/fixed-layout-editor/interfaces/TintSchema-1.md) - [Interface: FlushOptions](/auto-docs/fixed-layout-editor/interfaces/Tracker.FlushOptions.md): Tracker.FlushOptions - [Interface: TransformNodeSchema](/auto-docs/fixed-layout-editor/interfaces/TransformNodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: TransformSchema](/auto-docs/fixed-layout-editor/interfaces/TransformSchema-1.md) - [Interface: TweenOpts](/auto-docs/fixed-layout-editor/interfaces/TweenOpts.md) - [Interface: UndoRedoChangeElementEvent](/auto-docs/fixed-layout-editor/interfaces/UndoRedoChangeElementEvent.md): 带element的事件 - [Interface: UndoRedoClearEvent](/auto-docs/fixed-layout-editor/interfaces/UndoRedoClearEvent.md): 清空事件 - [Interface: UngroupOperation](/auto-docs/fixed-layout-editor/interfaces/UngroupOperation.md) - [Interface: UnionJSON](/auto-docs/fixed-layout-editor/interfaces/UnionJSON.md): ASTNodeJSON representation of UnionType, which union multiple BaseType. - [Interface: VariableAbilityParseContext](/auto-docs/fixed-layout-editor/interfaces/VariableAbilityParseContext.md) - [Interface: VariableConsumerAbilityOptions](/auto-docs/fixed-layout-editor/interfaces/VariableConsumerAbilityOptions.md) - [Interface: VariableDeclarationListJSON](/auto-docs/fixed-layout-editor/interfaces/VariableDeclarationListJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: VariablePluginOptions](/auto-docs/fixed-layout-editor/interfaces/VariablePluginOptions.md) - [Interface: VariableProviderAbilityOptions](/auto-docs/fixed-layout-editor/interfaces/VariableProviderAbilityOptions.md) - [Interface: Vertex](/auto-docs/fixed-layout-editor/interfaces/Vertex.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: WeakCache](/auto-docs/fixed-layout-editor/interfaces/WeakCache.md) - [Interface: WrapArrayExpressionJSON](/auto-docs/fixed-layout-editor/interfaces/WrapArrayExpressionJSON.md): ASTNodeJSON representation of WrapArrayExpression - [Interface: createOrUngroupValue](/auto-docs/fixed-layout-editor/interfaces/createOrUngroupValue.md) - [Interface: Abstract](/auto-docs/fixed-layout-editor/interfaces/interfaces.Abstract.md): interfaces.Abstract - [Interface: AsyncContainerModule](/auto-docs/fixed-layout-editor/interfaces/interfaces.AsyncContainerModule.md): interfaces.AsyncContainerModule - [Interface: Binding](/auto-docs/fixed-layout-editor/interfaces/interfaces.Binding.md): interfaces.Binding - [Interface: BindingInSyntax](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingInSyntax.md): interfaces.BindingInSyntax - [Interface: BindingInWhenOnSyntax](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingInWhenOnSyntax.md): interfaces.BindingInWhenOnSyntax - [Interface: BindingOnSyntax](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingOnSyntax.md): interfaces.BindingOnSyntax - [Interface: BindingScopeEnum](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingScopeEnum.md): interfaces.BindingScopeEnum - [Interface: BindingToSyntax](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingToSyntax.md): interfaces.BindingToSyntax - [Interface: BindingTypeEnum](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingTypeEnum.md): interfaces.BindingTypeEnum - [Interface: BindingWhenOnSyntax](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingWhenOnSyntax.md): interfaces.BindingWhenOnSyntax - [Interface: BindingWhenSyntax](/auto-docs/fixed-layout-editor/interfaces/interfaces.BindingWhenSyntax.md): interfaces.BindingWhenSyntax - [Interface: Clonable](/auto-docs/fixed-layout-editor/interfaces/interfaces.Clonable.md): interfaces.Clonable - [Interface: ConstraintFunction](/auto-docs/fixed-layout-editor/interfaces/interfaces.ConstraintFunction.md): interfaces.ConstraintFunction - [Interface: ConstructorMetadata](/auto-docs/fixed-layout-editor/interfaces/interfaces.ConstructorMetadata.md): interfaces.ConstructorMetadata - [Interface: Container](/auto-docs/fixed-layout-editor/interfaces/interfaces.Container.md): interfaces.Container - [Interface: ContainerModule](/auto-docs/fixed-layout-editor/interfaces/interfaces.ContainerModule.md): interfaces.ContainerModule - [Interface: ContainerModuleBase](/auto-docs/fixed-layout-editor/interfaces/interfaces.ContainerModuleBase.md): interfaces.ContainerModuleBase - [Interface: ContainerOptions](/auto-docs/fixed-layout-editor/interfaces/interfaces.ContainerOptions.md): interfaces.ContainerOptions - [Interface: ContainerSnapshot](/auto-docs/fixed-layout-editor/interfaces/interfaces.ContainerSnapshot.md): interfaces.ContainerSnapshot - [Interface: Context](/auto-docs/fixed-layout-editor/interfaces/interfaces.Context.md): interfaces.Context - [Interface: FactoryDetails](/auto-docs/fixed-layout-editor/interfaces/interfaces.FactoryDetails.md): interfaces.FactoryDetails - [Interface: GetAllOptions](/auto-docs/fixed-layout-editor/interfaces/interfaces.GetAllOptions.md): interfaces.GetAllOptions - [Interface: Lookup](/auto-docs/fixed-layout-editor/interfaces/interfaces.Lookup.md): interfaces.Lookup - [Interface: Metadata](/auto-docs/fixed-layout-editor/interfaces/interfaces.Metadata.md): interfaces.Metadata - [Interface: MetadataMap](/auto-docs/fixed-layout-editor/interfaces/interfaces.MetadataMap.md): interfaces.MetadataMap - [Interface: MetadataReader](/auto-docs/fixed-layout-editor/interfaces/interfaces.MetadataReader.md): interfaces.MetadataReader - [Interface: ModuleActivationHandlers](/auto-docs/fixed-layout-editor/interfaces/interfaces.ModuleActivationHandlers.md): interfaces.ModuleActivationHandlers - [Interface: ModuleActivationStore](/auto-docs/fixed-layout-editor/interfaces/interfaces.ModuleActivationStore.md): interfaces.ModuleActivationStore - [Interface: NextArgs](/auto-docs/fixed-layout-editor/interfaces/interfaces.NextArgs.md): interfaces.NextArgs - [Interface: Plan](/auto-docs/fixed-layout-editor/interfaces/interfaces.Plan.md): interfaces.Plan - [Interface: QueryableString](/auto-docs/fixed-layout-editor/interfaces/interfaces.QueryableString.md): interfaces.QueryableString - [Interface: Request](/auto-docs/fixed-layout-editor/interfaces/interfaces.Request.md): interfaces.Request - [Interface: TargetTypeEnum](/auto-docs/fixed-layout-editor/interfaces/interfaces.TargetTypeEnum.md): interfaces.TargetTypeEnum - [Interface: onFormValueChangeInPayload](/auto-docs/fixed-layout-editor/interfaces/onFormValueChangeInPayload.md) - [Namespace: ASTFactory](/auto-docs/fixed-layout-editor/modules/ASTFactory.md): Variable-core ASTNode factories. - [Namespace: ASTMatch](/auto-docs/fixed-layout-editor/modules/ASTMatch.md): Variable-core ASTNode matchers. Typescript code inside if statement will be type guarded. - [Namespace: Angle](/auto-docs/fixed-layout-editor/modules/Angle.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Bounds](/auto-docs/fixed-layout-editor/modules/Bounds.md) - [Namespace: Cache](/auto-docs/fixed-layout-editor/modules/Cache.md): 缓存工具： 可延迟按需创建，提升性能可支持多个或单个，有些动态创建多个的场景可以共享已有的实例，提升性能自动删除，超过一定的数目会自动做清空回收 Example - [Namespace: CancellationToken](/auto-docs/fixed-layout-editor/modules/CancellationToken.md) - [Namespace: Command](/auto-docs/fixed-layout-editor/modules/Command.md) - [Namespace: Compare](/auto-docs/fixed-layout-editor/modules/Compare.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Disposable](/auto-docs/fixed-layout-editor/modules/Disposable.md) - [Namespace: EditorProps](/auto-docs/fixed-layout-editor/modules/EditorProps.md) - [Namespace: EditorState](/auto-docs/fixed-layout-editor/modules/EditorState.md) - [Namespace: Entity](/auto-docs/fixed-layout-editor/modules/Entity.md) - [Namespace: Event](/auto-docs/fixed-layout-editor/modules/Event.md) - [Namespace: FixedLayoutProps](/auto-docs/fixed-layout-editor/modules/FixedLayoutProps.md) - [Namespace: FlowLayoutDefault](/auto-docs/fixed-layout-editor/modules/FlowLayoutDefault.md) - [Namespace: FlowNodeEntity](/auto-docs/fixed-layout-editor/modules/FlowNodeEntity.md) - [Namespace: FlowNodeRegistry](/auto-docs/fixed-layout-editor/modules/FlowNodeRegistry.md) - [Namespace: FlowVirtualTree](/auto-docs/fixed-layout-editor/modules/FlowVirtualTree.md) - [Namespace: MouseTouchEvent](/auto-docs/fixed-layout-editor/modules/MouseTouchEvent.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: PaddingSchema](/auto-docs/fixed-layout-editor/modules/PaddingSchema.md) - [Namespace: PlaygroundDrag](/auto-docs/fixed-layout-editor/modules/PlaygroundDrag.md) - [Namespace: PlaygroundMockTools](/auto-docs/fixed-layout-editor/modules/PlaygroundMockTools.md): 画布测试工具 Example - [Namespace: Point](/auto-docs/fixed-layout-editor/modules/Point.md) - [Namespace: Rectangle](/auto-docs/fixed-layout-editor/modules/Rectangle.md) - [Namespace: Schema](/auto-docs/fixed-layout-editor/modules/Schema.md) - [Namespace: SchemaDecoration](/auto-docs/fixed-layout-editor/modules/SchemaDecoration.md) - [Namespace: SizeSchema](/auto-docs/fixed-layout-editor/modules/SizeSchema.md) - [Namespace: TintSchema](/auto-docs/fixed-layout-editor/modules/TintSchema.md) - [Namespace: Tracker](/auto-docs/fixed-layout-editor/modules/Tracker.md): Tracker 是一套 响应式依赖追踪 库，来源于 Meteor.Tracker https://docs.meteor.com/api/Tracker.html#tracker-autorun-and-async-callbacks https://github.com/meteor/meteor/blob/devel/packages/tracker/tracker.js 相关论文：https://dl.acm.org/doi/fullHtml/10.1145/3184558.3185978 - [Namespace: TransformData](/auto-docs/fixed-layout-editor/modules/TransformData.md) - [Namespace: TransformSchema](/auto-docs/fixed-layout-editor/modules/TransformSchema.md) - [Namespace: domUtils](/auto-docs/fixed-layout-editor/modules/domUtils.md) - [Namespace: interfaces](/auto-docs/fixed-layout-editor/modules/interfaces.md) - [Type alias: AddNodeConfig](/auto-docs/fixed-layout-editor/types/AddNodeConfig.md): AddNodeConfig: Object Type declaration - [Type alias: AddNodeData](/auto-docs/fixed-layout-editor/types/AddNodeData.md): AddNodeData: FlowNodeJSON & { hidden?: boolean ; index?: number ; originParent?: FlowNodeEntity ; parent?: FlowNodeEntity } - [Type alias: ArrayAppendEffect](/auto-docs/fixed-layout-editor/types/ArrayAppendEffect.md): ArrayAppendEffect: (props: { arrayValues: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number ; value: TFieldValue }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: ArrayDeleteEffect](/auto-docs/fixed-layout-editor/types/ArrayDeleteEffect.md): ArrayDeleteEffect: (props: { arrayValue: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: CSSStyle](/auto-docs/fixed-layout-editor/types/CSSStyle.md): CSSStyle: { [P in keyof CSSStyleDeclaration]?: string | number } Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: Cache](/auto-docs/fixed-layout-editor/types/Cache-1.md): Cache: { [P in keyof T]: T[P] } & { dispose?: () => void ; key?: any } Type parameters - [Type alias: Cursors](/auto-docs/fixed-layout-editor/types/Cursors.md): Cursors: Record - [Type alias: Effect](/auto-docs/fixed-layout-editor/types/Effect.md): Effect: (props: EffectFuncProps) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: EffectOptions](/auto-docs/fixed-layout-editor/types/EffectOptions.md): EffectOptions: { effect: Effect ; event: DataEvent } | { effect: ArrayAppendEffect ; event: DataEvent } | { effect: ArrayDeleteEffect ; event: DataEvent } - [Type alias: EffectReturn](/auto-docs/fixed-layout-editor/types/EffectReturn.md): EffectReturn: () => void Type declaration (): void Returns void - [Type alias: EntityDataInjector](/auto-docs/fixed-layout-editor/types/EntityDataInjector.md): EntityDataInjector: () => OPTS Type declaration (): OPTS Type parameters Returns OPTS - [Type alias: EntityDataProps](/auto-docs/fixed-layout-editor/types/EntityDataProps.md): EntityDataProps: E["data"] Type parameters - [Type alias: Errors](/auto-docs/fixed-layout-editor/types/Errors.md): Errors: Record - [Type alias: FieldError](/auto-docs/fixed-layout-editor/types/FieldError.md): FieldError: Feedback - [Type alias: FieldName](/auto-docs/fixed-layout-editor/types/FieldName.md): FieldName: string - [Type alias: FieldWarning](/auto-docs/fixed-layout-editor/types/FieldWarning.md): FieldWarning: Feedback - [Type alias: FlowDocumentJSON](/auto-docs/fixed-layout-editor/types/FlowDocumentJSON.md): FlowDocumentJSON: Object Type declaration - [Type alias: FlowDocumentProvider](/auto-docs/fixed-layout-editor/types/FlowDocumentProvider.md): FlowDocumentProvider: () => FlowDocument Type declaration (): FlowDocument Returns FlowDocument - [Type alias: FlowNodeEntityOrId](/auto-docs/fixed-layout-editor/types/FlowNodeEntityOrId.md): FlowNodeEntityOrId: string | FlowNodeEntity - [Type alias: FlowNodeType](/auto-docs/fixed-layout-editor/types/FlowNodeType.md): FlowNodeType: string | number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: FlowOperation](/auto-docs/fixed-layout-editor/types/FlowOperation.md): FlowOperation: AddFromNodeOperation | DeleteFromNodeOperation | AddBlockOperation | DeleteBlockOperation | CreateGroupOperation | UngroupOperation | MoveNodesOperation | AddNodesOperation | DeleteNodesOperation | MoveBlockOperation | AddChildNodeOperation | DeleteChildNodeOperation | MoveChildNodesOperation | AddNodeOperation | DeleteNodeOperation - [Type alias: FocusNodeCanvasOptions](/auto-docs/fixed-layout-editor/types/FocusNodeCanvasOptions.md): FocusNodeCanvasOptions: PlaygroundConfigRevealOpts Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: FormPluginCreator](/auto-docs/fixed-layout-editor/types/FormPluginCreator.md): FormPluginCreator: (opts: Opts) => FormPlugin Type parameters Type declaration (opts): FormPlugin Parameters Returns FormPlugin - [Type alias: FormPluginCtx](/auto-docs/fixed-layout-editor/types/FormPluginCtx.md): FormPluginCtx: { formModel: FormModel } & NodeContext - [Type alias: FormPluginSetupMetaCtx](/auto-docs/fixed-layout-editor/types/FormPluginSetupMetaCtx.md): FormPluginSetupMetaCtx: { addFormatOnInit: (formatOnInit: FormMeta["formatOnInit"]) => void ; addFormatOnSubmit: (formatOnSubmit: FormMeta["formatOnSubmit"]) => void ; mergeEffect: (effect: Record) => void ; mergeValidate: (validate: Record) => void } & NodeContext - [Type alias: GetBlockLabel](/auto-docs/fixed-layout-editor/types/GetBlockLabel.md): GetBlockLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据分支获取label Parameters Returns string - [Type alias: GetDocumentJSON](/auto-docs/fixed-layout-editor/types/GetDocumentJSON.md): GetDocumentJSON: () => unknown Type declaration (): unknown 获取文档JSON Returns unknown - [Type alias: GetKindJSON](/auto-docs/fixed-layout-editor/types/GetKindJSON.md): GetKindJSON: { key?: Identifier ; kind: KindType } & JSON TypeUtils to get the JSON representation of an AST node with a specific kind. Type parameters - [Type alias: GetKindJSONOrKind](/auto-docs/fixed-layout-editor/types/GetKindJSONOrKind.md): GetKindJSONOrKind: { key?: Identifier ; kind: KindType } & JSON | KindType TypeUtils to get the JSON representation of an AST node with a specific kind or just the kind string. Type parameters - [Type alias: GetNodeLabel](/auto-docs/fixed-layout-editor/types/GetNodeLabel.md): GetNodeLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据节点获取label Parameters Returns string - [Type alias: GetNodeLabelById](/auto-docs/fixed-layout-editor/types/GetNodeLabelById.md): GetNodeLabelById: (id: string) => string Type declaration (id): string 根据节点id获取label Parameters Returns string - [Type alias: GetNodeURI](/auto-docs/fixed-layout-editor/types/GetNodeURI.md): GetNodeURI: (id: string) => string | any Type declaration (id): string | any 根据节点获取URI Parameters Returns string | any - [Type alias: HistoryMergeEvent](/auto-docs/fixed-layout-editor/types/HistoryMergeEvent.md): HistoryMergeEvent: { type: ADD ; value: { element: IUndoRedoElement ; operation: Operation } } | { type: UPDATE ; value: { element: IUndoRedoElement ; operation: Operation ; value: any } } 历史合并事件 - [Type alias: HistoryStackChangeEvent](/auto-docs/fixed-layout-editor/types/HistoryStackChangeEvent.md): HistoryStackChangeEvent: HistoryStackAddEvent | HistoryStackUpdateEvent | HistoryStackAddOperationEvent | HistoryStackUpdateOperationEvent 历史记录变化事件 - [Type alias: ISize](/auto-docs/fixed-layout-editor/types/ISize.md): ISize: Object Size object, contains width and height Type declaration - [Type alias: IUndoRedoElementFactory](/auto-docs/fixed-layout-editor/types/IUndoRedoElementFactory.md): IUndoRedoElementFactory: (operation: Operation) => IUndoRedoElement Type parameters Type declaration (operation): IUndoRedoElement 操作工厂 Parameters Returns IUndoRedoElement - [Type alias: LocalId](/auto-docs/fixed-layout-editor/types/LocalId.md): LocalId: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: MarginSchema](/auto-docs/fixed-layout-editor/types/MarginSchema.md): MarginSchema: PaddingSchema - [Type alias: MaybeArray](/auto-docs/fixed-layout-editor/types/MaybeArray.md): MaybeArray: T | T[] Type parameters - [Type alias: MaybePromise](/auto-docs/fixed-layout-editor/types/MaybePromise.md): MaybePromise: T | PromiseLike Type parameters - [Type alias: MoveBlockOperationValue](/auto-docs/fixed-layout-editor/types/MoveBlockOperationValue.md): MoveBlockOperationValue: Object Type declaration - [Type alias: NodeToJson](/auto-docs/fixed-layout-editor/types/NodeToJson.md): NodeToJson: (node: FlowNodeEntity) => FlowNodeJSON Type declaration (node): FlowNodeJSON 将node转成json Parameters Returns FlowNodeJSON - [Type alias: ObjectPropertiesChangeAction](/auto-docs/fixed-layout-editor/types/ObjectPropertiesChangeAction.md): ObjectPropertiesChangeAction: GlobalEventActionType<"ObjectPropertiesChange", { next: Property[] ; prev: Property[] }, ObjectType> Action type for object properties change. - [Type alias: OpacitySchema](/auto-docs/fixed-layout-editor/types/OpacitySchema.md): OpacitySchema: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: OperationWithId](/auto-docs/fixed-layout-editor/types/OperationWithId.md): OperationWithId: Operation & { id: string } - [Type alias: PipeEventName](/auto-docs/fixed-layout-editor/types/PipeEventName.md): PipeEventName: string - [Type alias: PipeSupportEvent](/auto-docs/fixed-layout-editor/types/PipeSupportEvent.md): PipeSupportEvent: MouseEvent | DragEvent | KeyboardEvent | UIEvent | TouchEvent | any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipelineEventHandler](/auto-docs/fixed-layout-editor/types/PipelineEventHandler.md): PipelineEventHandler: (event: PipeSupportEvent) => boolean | undefined Type declaration (event): boolean | undefined Parameters Returns boolean | undefined - [Type alias: PipelineLayerFactory](/auto-docs/fixed-layout-editor/types/PipelineLayerFactory.md): PipelineLayerFactory: (layerRegistry: LayerRegistry, layerOptions?: any) => Layer Type declaration (layerRegistry, layerOptions?): Layer Parameters Returns Layer - [Type alias: PlaygroundContext](/auto-docs/fixed-layout-editor/types/PlaygroundContext.md): PlaygroundContext: any - [Type alias: PlaygroundContextProvider](/auto-docs/fixed-layout-editor/types/PlaygroundContextProvider.md): PlaygroundContextProvider: () => any Type declaration (): any Returns any - [Type alias: PlaygroundInteractiveType](/auto-docs/fixed-layout-editor/types/PlaygroundInteractiveType.md): PlaygroundInteractiveType: "MOUSE" | "PAD" MOUSE: 鼠标友好模式，鼠标左键拖动画布，滚动缩放 (适合 windows ) PAD: 双指同向移动拖动，双指张开捏合缩放 (适合 mac) - [Type alias: PlaygroundScrollLimitFn](/auto-docs/fixed-layout-editor/types/PlaygroundScrollLimitFn.md): PlaygroundScrollLimitFn: (scroll: { scrollX: number ; scrollY: number }) => { scrollX: number ; scrollY: number } Type declaration (scroll): Object Parameters Returns Object - [Type alias: Plugin](/auto-docs/fixed-layout-editor/types/Plugin.md): Plugin: Object Type parameters Type declaration - [Type alias: PluginCreator](/auto-docs/fixed-layout-editor/types/PluginCreator.md): PluginCreator: (opts: Options) => Plugin Type parameters Type declaration (opts): Plugin Parameters Returns Plugin - [Type alias: PropertyJSON](/auto-docs/fixed-layout-editor/types/PropertyJSON.md): PropertyJSON: BaseVariableFieldJSON ASTNodeJSON representation of the Property. Type parameters - [Type alias: ProtectWheelArea](/auto-docs/fixed-layout-editor/types/ProtectWheelArea.md): ProtectWheelArea: (dom: Element) => boolean Type declaration (dom): boolean Parameters Returns boolean - [Type alias: RecursivePartial](/auto-docs/fixed-layout-editor/types/RecursivePartial.md): RecursivePartial: { [P in keyof T]?: T[P] extends (infer I)[] ? RecursivePartial[] : RecursivePartial } Type parameters - [Type alias: RotationSchema](/auto-docs/fixed-layout-editor/types/RotationSchema.md): RotationSchema: number - [Type alias: SchemaType](/auto-docs/fixed-layout-editor/types/SchemaType.md): SchemaType: "string" | "integer" | "float" | "boolean" | "enum" | "object" | "range" | "color" | "array" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: IComputationCallback](/auto-docs/fixed-layout-editor/types/Tracker.IComputationCallback.md): Tracker.IComputationCallback IComputationCallback: ICallback Type parameters - [Type alias: UndoRedoChangeEvent](/auto-docs/fixed-layout-editor/types/UndoRedoChangeEvent.md): UndoRedoChangeEvent: UndoRedoChangeElementEvent | UndoRedoClearEvent undo redo变化事件 - [Type alias: Validate](/auto-docs/fixed-layout-editor/types/Validate.md): Validate: (props: { context: Context ; formValues: TFormValues ; name: FieldName ; value: TFieldValue }) => MaybePromise | MaybePromise | MaybePromise | MaybePromise Type parameters Type declaration (props): MaybePromise | MaybePromise | MaybePromise | MaybePromise Parameters Returns MaybePromise | MaybePromise | MaybePromise | MaybePromise - [Type alias: VariableDeclarationJSON](/auto-docs/fixed-layout-editor/types/VariableDeclarationJSON.md): VariableDeclarationJSON: BaseVariableFieldJSON & { order?: number } ASTNodeJSON representation of the VariableDeclaration. Type parameters - [Type alias: VariableDeclarationListChangeAction](/auto-docs/fixed-layout-editor/types/VariableDeclarationListChangeAction.md): VariableDeclarationListChangeAction: GlobalEventActionType<"VariableListChange", { next: VariableDeclaration[] ; prev: VariableDeclaration[] }, VariableDeclarationList> - [Type alias: VariableEngineProvider](/auto-docs/fixed-layout-editor/types/VariableEngineProvider.md): VariableEngineProvider: () => VariableEngine Type declaration (): VariableEngine Returns VariableEngine - [Type alias: Warnings](/auto-docs/fixed-layout-editor/types/Warnings.md): Warnings: Record - [Type alias: Xor](/auto-docs/fixed-layout-editor/types/Xor.md): Xor: T | U extends object ? Without & U | Without & T : T | U Type parameters - [Type alias: AsyncContainerModuleCallBack](/auto-docs/fixed-layout-editor/types/interfaces.AsyncContainerModuleCallBack.md): interfaces.AsyncContainerModuleCallBack AsyncContainerModuleCallBack: AsyncCallback - [Type alias: AutoFactory](/auto-docs/fixed-layout-editor/types/interfaces.AutoFactory.md): interfaces.AutoFactory AutoFactory: SimpleFactory Type parameters - [Type alias: AutoNamedFactory](/auto-docs/fixed-layout-editor/types/interfaces.AutoNamedFactory.md): interfaces.AutoNamedFactory AutoNamedFactory: SimpleFactory Type parameters - [Type alias: Bind](/auto-docs/fixed-layout-editor/types/interfaces.Bind.md): interfaces.Bind Bind: (serviceIdentifier: ServiceIdentifier) => BindingToSyntax Type declaration (serviceIdentifier): BindingToSyntax Type parameters Parameters Returns BindingToSyntax - [Type alias: BindingActivation](/auto-docs/fixed-layout-editor/types/interfaces.BindingActivation.md): interfaces.BindingActivation BindingActivation: (context: Context, injectable: T) => T | Promise Type parameters Type declaration (context, injectable): T | Promise Parameters Returns T | Promise - [Type alias: BindingDeactivation](/auto-docs/fixed-layout-editor/types/interfaces.BindingDeactivation.md): interfaces.BindingDeactivation BindingDeactivation: (injectable: T) => void | Promise Type parameters Type declaration (injectable): void | Promise Parameters Returns void | Promise - [Type alias: BindingScope](/auto-docs/fixed-layout-editor/types/interfaces.BindingScope.md): interfaces.BindingScope BindingScope: "Singleton" | "Transient" | "Request" - [Type alias: BindingType](/auto-docs/fixed-layout-editor/types/interfaces.BindingType.md): interfaces.BindingType BindingType: "ConstantValue" | "Constructor" | "DynamicValue" | "Factory" | "Function" | "Instance" | "Invalid" | "Provider" - [Type alias: ContainerModuleCallBack](/auto-docs/fixed-layout-editor/types/interfaces.ContainerModuleCallBack.md): interfaces.ContainerModuleCallBack ContainerModuleCallBack: (bind: Bind, unbind: Unbind, isBound: IsBound, rebind: Rebind, unbindAsync: UnbindAsync, onActivation: Container["onActivation"], onDeactivation: Container["onDeactivation"]) => void Type declaration (bind, unbind, isBound, rebind, unbindAsync, onActivation, onDeactivation): void Parameters Returns void - [Type alias: ContainerResolution](/auto-docs/fixed-layout-editor/types/interfaces.ContainerResolution.md): interfaces.ContainerResolution ContainerResolution: undefined | T | Promise | (T | Promise)[] Type parameters - [Type alias: ContextInterceptor](/auto-docs/fixed-layout-editor/types/interfaces.ContextInterceptor.md): interfaces.ContextInterceptor ContextInterceptor: (context: Context) => Context Type declaration (context): Context Parameters Returns Context - [Type alias: DynamicValue](/auto-docs/fixed-layout-editor/types/interfaces.DynamicValue.md): interfaces.DynamicValue DynamicValue: (context: Context) => T | Promise Type parameters Type declaration (context): T | Promise Parameters Returns T | Promise - [Type alias: Factory](/auto-docs/fixed-layout-editor/types/interfaces.Factory.md): interfaces.Factory Factory: SimpleFactory | MultiFactory Type parameters - [Type alias: FactoryCreator](/auto-docs/fixed-layout-editor/types/interfaces.FactoryCreator.md): interfaces.FactoryCreator FactoryCreator: (context: Context) => Factory Type parameters Type declaration (context): Factory Parameters Returns Factory - [Type alias: FactoryTypeFunction](/auto-docs/fixed-layout-editor/types/interfaces.FactoryTypeFunction.md): interfaces.FactoryTypeFunction FactoryTypeFunction: (context: Context) => T | Promise Type parameters Type declaration (context): T | Promise Parameters Returns T | Promise - [Type alias: Instance](/auto-docs/fixed-layout-editor/types/interfaces.Instance.md): interfaces.Instance Instance: T & Record void> Type parameters - [Type alias: IsBound](/auto-docs/fixed-layout-editor/types/interfaces.IsBound.md): interfaces.IsBound IsBound: (serviceIdentifier: ServiceIdentifier) => boolean Type declaration (serviceIdentifier): boolean Type parameters Parameters Returns boolean - [Type alias: MetadataOrMetadataArray](/auto-docs/fixed-layout-editor/types/interfaces.MetadataOrMetadataArray.md): interfaces.MetadataOrMetadataArray MetadataOrMetadataArray: Metadata | Metadata[] - [Type alias: Middleware](/auto-docs/fixed-layout-editor/types/interfaces.Middleware.md): interfaces.Middleware Middleware: (next: Next) => Next Type declaration (next): Next Parameters Returns Next - [Type alias: MultiFactory](/auto-docs/fixed-layout-editor/types/interfaces.MultiFactory.md): interfaces.MultiFactory MultiFactory: (...args: U) => SimpleFactory Type parameters Type declaration (...args): SimpleFactory Parameters Returns SimpleFactory - [Type alias: Newable](/auto-docs/fixed-layout-editor/types/interfaces.Newable.md): interfaces.Newable Newable: CommonNewable Type parameters - [Type alias: Next](/auto-docs/fixed-layout-editor/types/interfaces.Next.md): interfaces.Next Next: (args: NextArgs) => unknown | unknown[] Type declaration (args): unknown | unknown[] Parameters Returns unknown | unknown[] - [Type alias: Provider](/auto-docs/fixed-layout-editor/types/interfaces.Provider.md): interfaces.Provider Provider: (...args: any[]) => (...args: any[]) => Promise | Promise Type parameters Type declaration (...args): (...args: any[]) => Promise | Promise Parameters Returns (...args: any[]) => Promise | Promise - [Type alias: ProviderCreator](/auto-docs/fixed-layout-editor/types/interfaces.ProviderCreator.md): interfaces.ProviderCreator ProviderCreator: (context: Context) => Provider Type parameters Type declaration (context): Provider Parameters Returns Provider - [Type alias: Rebind](/auto-docs/fixed-layout-editor/types/interfaces.Rebind.md): interfaces.Rebind Rebind: (serviceIdentifier: ServiceIdentifier) => BindingToSyntax Type declaration (serviceIdentifier): BindingToSyntax Type parameters Parameters Returns BindingToSyntax - [Type alias: RequestScope](/auto-docs/fixed-layout-editor/types/interfaces.RequestScope.md): interfaces.RequestScope RequestScope: Map - [Type alias: ResolveRequestHandler](/auto-docs/fixed-layout-editor/types/interfaces.ResolveRequestHandler.md): interfaces.ResolveRequestHandler ResolveRequestHandler: (request: Request) => unknown Type declaration (request): unknown Parameters Returns unknown - [Type alias: ServiceIdentifier](/auto-docs/fixed-layout-editor/types/interfaces.ServiceIdentifier.md): interfaces.ServiceIdentifier ServiceIdentifier: CommonServiceIdentifier Type parameters - [Type alias: SimpleFactory](/auto-docs/fixed-layout-editor/types/interfaces.SimpleFactory.md): interfaces.SimpleFactory SimpleFactory: (...args: U) => T Type parameters Type declaration (...args): T Parameters Returns T - [Type alias: Target](/auto-docs/fixed-layout-editor/types/interfaces.Target.md): interfaces.Target Target: LegacyTarget - [Type alias: TargetType](/auto-docs/fixed-layout-editor/types/interfaces.TargetType.md): interfaces.TargetType TargetType: "ConstructorArgument" | "ClassProperty" | "Variable" - [Type alias: Unbind](/auto-docs/fixed-layout-editor/types/interfaces.Unbind.md): interfaces.Unbind Unbind: (serviceIdentifier: ServiceIdentifier) => void Type declaration (serviceIdentifier): void Type parameters Parameters Returns void - [Type alias: UnbindAsync](/auto-docs/fixed-layout-editor/types/interfaces.UnbindAsync.md): interfaces.UnbindAsync UnbindAsync: (serviceIdentifier: ServiceIdentifier) => Promise Type declaration (serviceIdentifier): Promise Type parameters Parameters Returns Promise - [Variable: Cancelled](/auto-docs/fixed-layout-editor/variables/CancellationToken.Cancelled.md): CancellationToken.Cancelled Const Cancelled: Readonly - [Variable: None](/auto-docs/fixed-layout-editor/variables/CancellationToken.None.md): CancellationToken.None Const None: Readonly - [Variable: ClipboardService](/auto-docs/fixed-layout-editor/variables/ClipboardService-1.md): Const ClipboardService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CommandService](/auto-docs/fixed-layout-editor/variables/CommandService-1.md): Const CommandService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: ConstantKeys](/auto-docs/fixed-layout-editor/variables/ConstantKeys.md): Const ConstantKeys: Object 支持外部 constants 自定义的 key 枚举 Type declaration - [Variable: ContributionProvider](/auto-docs/fixed-layout-editor/variables/ContributionProvider-1.md): Const ContributionProvider: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CropSchemaDecoration](/auto-docs/fixed-layout-editor/variables/CropSchemaDecoration.md): Const CropSchemaDecoration: SchemaDecoration - [Variable: DEFAULT_SIZE](/auto-docs/fixed-layout-editor/variables/DEFAULT_SIZE.md): Const DEFAULT_SIZE: Object 默认节点大小 Type declaration - [Variable: DEFAULT_SPACING](/auto-docs/fixed-layout-editor/variables/DEFAULT_SPACING.md): Const DEFAULT_SPACING: Object 默认一些间隔参数 Type declaration - [Variable: DEG_TO_RAD](/auto-docs/fixed-layout-editor/variables/DEG_TO_RAD.md): Const DEG_TO_RAD: number Conversion factor for converting degrees to radians. - [Variable: DecorationStyle](/auto-docs/fixed-layout-editor/variables/DecorationStyle.md): Const DecorationStyle: Object Type declaration - [Variable: DefaultSpacingKey](/auto-docs/fixed-layout-editor/variables/DefaultSpacingKey.md): Const DefaultSpacingKey: Object spacing default key 值 Type declaration - [Variable: Deferred](/auto-docs/fixed-layout-editor/variables/Deferred.md): Const Deferred: typeof PromiseDeferred - [Variable: NULL](/auto-docs/fixed-layout-editor/variables/Disposable.NULL.md): Disposable.NULL Const NULL: Readonly - [Variable: EDITOR_STATE_DEFAULTS](/auto-docs/fixed-layout-editor/variables/EDITOR_STATE_DEFAULTS.md): Const EDITOR_STATE_DEFAULTS: EditorState[] - [Variable: ENTITIES_BY_DATA_DECO_KEY](/auto-docs/fixed-layout-editor/variables/ENTITIES_BY_DATA_DECO_KEY.md): Const ENTITIES_BY_DATA_DECO_KEY: unique symbol - [Variable: ENTITIES_DECO_KEY](/auto-docs/fixed-layout-editor/variables/ENTITIES_DECO_KEY.md): Const ENTITIES_DECO_KEY: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: DEFAULT](/auto-docs/fixed-layout-editor/variables/EditorProps.DEFAULT.md): EditorProps.DEFAULT Const DEFAULT: EditorProps 默认配置 - [Variable: STATE_GRAB](/auto-docs/fixed-layout-editor/variables/EditorState.STATE_GRAB.md): EditorState.STATE_GRAB Const STATE_GRAB: EditorState - [Variable: STATE_MOUSE_FRIENDLY_SELECT](/auto-docs/fixed-layout-editor/variables/EditorState.STATE_MOUSE_FRIENDLY_SELECT.md): EditorState.STATE_MOUSE_FRIENDLY_SELECT Const STATE_MOUSE_FRIENDLY_SELECT: EditorState 鼠标友好模式状态 - [Variable: STATE_SELECT](/auto-docs/fixed-layout-editor/variables/EditorState.STATE_SELECT.md): EditorState.STATE_SELECT Const STATE_SELECT: EditorState - [Variable: EntityManagerContribution](/auto-docs/fixed-layout-editor/variables/EntityManagerContribution-1.md): Const EntityManagerContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FLOW_DEFAULT_HIDDEN_TYPES](/auto-docs/fixed-layout-editor/variables/FLOW_DEFAULT_HIDDEN_TYPES.md): Const FLOW_DEFAULT_HIDDEN_TYPES: FlowNodeType[] - [Variable: FLUSH_LAYER_REQUEST](/auto-docs/fixed-layout-editor/variables/FLUSH_LAYER_REQUEST.md): Const FLUSH_LAYER_REQUEST: "flush-layer-request" - [Variable: FixedLayoutContainerModule](/auto-docs/fixed-layout-editor/variables/FixedLayoutContainerModule.md): Const FixedLayoutContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FixedLayoutPluginContext](/auto-docs/fixed-layout-editor/variables/FixedLayoutPluginContext-1.md): Const FixedLayoutPluginContext: symbol = PluginContext - [Variable: DEFAULT](/auto-docs/fixed-layout-editor/variables/FixedLayoutProps.DEFAULT.md): FixedLayoutProps.DEFAULT Const DEFAULT: FixedLayoutProps 默认配置 - [Variable: FixedLayoutRegistries](/auto-docs/fixed-layout-editor/variables/FixedLayoutRegistries.md): Const FixedLayoutRegistries: Object Type declaration - [Variable: FlipSchemaDecoration](/auto-docs/fixed-layout-editor/variables/FlipSchemaDecoration.md): Const FlipSchemaDecoration: SchemaDecoration - [Variable: FlowDocumentConfigDefaultData](/auto-docs/fixed-layout-editor/variables/FlowDocumentConfigDefaultData.md): Const FlowDocumentConfigDefaultData: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentContainerModule](/auto-docs/fixed-layout-editor/variables/FlowDocumentContainerModule.md): Const FlowDocumentContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentContribution](/auto-docs/fixed-layout-editor/variables/FlowDocumentContribution-1.md): Const FlowDocumentContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentOptions](/auto-docs/fixed-layout-editor/variables/FlowDocumentOptions-1.md): Const FlowDocumentOptions: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentOptionsDefault](/auto-docs/fixed-layout-editor/variables/FlowDocumentOptionsDefault.md): Const FlowDocumentOptionsDefault: FlowDocumentOptions - [Variable: FlowDocumentProvider](/auto-docs/fixed-layout-editor/variables/FlowDocumentProvider-1.md): FlowDocumentProvider: typeof FlowDocumentProvider - [Variable: FlowLayout](/auto-docs/fixed-layout-editor/variables/FlowLayout-1.md): Const FlowLayout: unique symbol - [Variable: FlowLayoutContribution](/auto-docs/fixed-layout-editor/variables/FlowLayoutContribution-1.md): Const FlowLayoutContribution: unique symbol - [Variable: FlowOperationBaseService](/auto-docs/fixed-layout-editor/variables/FlowOperationBaseService-1.md): FlowOperationBaseService: typeof FlowOperationBaseService - [Variable: FlowOperationService](/auto-docs/fixed-layout-editor/variables/FlowOperationService-1.md): FlowOperationService: typeof FlowOperationService - [Variable: FlowRendererContainerModule](/auto-docs/fixed-layout-editor/variables/FlowRendererContainerModule.md): Const FlowRendererContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowRendererContribution](/auto-docs/fixed-layout-editor/variables/FlowRendererContribution-1.md): Const FlowRendererContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: HistoryContainerModule](/auto-docs/fixed-layout-editor/variables/HistoryContainerModule.md): Const HistoryContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: I18n](/auto-docs/fixed-layout-editor/variables/I18n.md): Const I18n: I18nImpl - [Variable: LayerOptions](/auto-docs/fixed-layout-editor/variables/LayerOptions-1.md): LayerOptions: typeof LayerOptions - [Variable: LazyInjectContext](/auto-docs/fixed-layout-editor/variables/LazyInjectContext.md): Const LazyInjectContext: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: MARK_ACTIVATED_ARROW_ID](/auto-docs/fixed-layout-editor/variables/MARK_ACTIVATED_ARROW_ID.md): Const MARK_ACTIVATED_ARROW_ID: "$marker_arrow_activated$" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: MARK_ARROW_ID](/auto-docs/fixed-layout-editor/variables/MARK_ARROW_ID.md): Const MARK_ARROW_ID: "$marker_arrow$" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OpacitySchemaDecoration](/auto-docs/fixed-layout-editor/variables/OpacitySchemaDecoration.md): Const OpacitySchemaDecoration: SchemaDecoration - [Variable: OperationContribution](/auto-docs/fixed-layout-editor/variables/OperationContribution-1.md): Const OperationContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OriginSchemaDecoration](/auto-docs/fixed-layout-editor/variables/OriginSchemaDecoration.md): Const OriginSchemaDecoration: SchemaDecoration - [Variable: PI](/auto-docs/fixed-layout-editor/variables/PI.md): Const PI: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PI_2](/auto-docs/fixed-layout-editor/variables/PI_2.md): Const PI_2: number Two Pi. - [Variable: PaddingSchemaDecoration](/auto-docs/fixed-layout-editor/variables/PaddingSchemaDecoration.md): Const PaddingSchemaDecoration: SchemaDecoration - [Variable: PipelineLayerFactory](/auto-docs/fixed-layout-editor/variables/PipelineLayerFactory-1.md): Const PipelineLayerFactory: unique symbol - [Variable: PlaygroundConfig](/auto-docs/fixed-layout-editor/variables/PlaygroundConfig-1.md): Const PlaygroundConfig: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundContainerFactory](/auto-docs/fixed-layout-editor/variables/PlaygroundContainerFactory-1.md): Const PlaygroundContainerFactory: unique symbol - [Variable: PlaygroundContainerModule](/auto-docs/fixed-layout-editor/variables/PlaygroundContainerModule.md): Const PlaygroundContainerModule: ContainerModule - [Variable: PlaygroundContext](/auto-docs/fixed-layout-editor/variables/PlaygroundContext-1.md): Const PlaygroundContext: unique symbol 会被注入到 layer 层，可以在使用的时候替换它 - [Variable: PlaygroundContextProvider](/auto-docs/fixed-layout-editor/variables/PlaygroundContextProvider-1.md): Const PlaygroundContextProvider: unique symbol - [Variable: PlaygroundContribution](/auto-docs/fixed-layout-editor/variables/PlaygroundContribution-1.md): Const PlaygroundContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundEntityContext](/auto-docs/fixed-layout-editor/variables/PlaygroundEntityContext.md): Const PlaygroundEntityContext: React$1.Context 当前 entity - [Variable: PlaygroundReactContainerContext](/auto-docs/fixed-layout-editor/variables/PlaygroundReactContainerContext.md): Const PlaygroundReactContainerContext: React$1.Context - [Variable: PlaygroundReactContext](/auto-docs/fixed-layout-editor/variables/PlaygroundReactContext.md): Const PlaygroundReactContext: React$1.Context Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundReactRefContext](/auto-docs/fixed-layout-editor/variables/PlaygroundReactRefContext.md): Const PlaygroundReactRefContext: React$1.Context - [Variable: Plugin](/auto-docs/fixed-layout-editor/variables/Plugin-1.md): Const Plugin: unique symbol - [Variable: PluginContext](/auto-docs/fixed-layout-editor/variables/PluginContext-1.md): PluginContext: typeof PluginContext - [Variable: EMPTY](/auto-docs/fixed-layout-editor/variables/Point.EMPTY.md): Point.EMPTY Const EMPTY: IPoint - [Variable: PositionSchemaDecoration](/auto-docs/fixed-layout-editor/variables/PositionSchemaDecoration.md): Const PositionSchemaDecoration: SchemaDecoration - [Variable: ProtectWheelArea](/auto-docs/fixed-layout-editor/variables/ProtectWheelArea-1.md): Const ProtectWheelArea: unique symbol 保护区域不被画布劫持滚动事件 - [Variable: RAD_TO_DEG](/auto-docs/fixed-layout-editor/variables/RAD_TO_DEG.md): Const RAD_TO_DEG: number Conversion factor for converting radians to degrees. - [Variable: RequestCache](/auto-docs/fixed-layout-editor/variables/RequestCache.md): Const RequestCache: Map> 请求缓存 Param - [Variable: RotationSchemaDecoration](/auto-docs/fixed-layout-editor/variables/RotationSchemaDecoration.md): Const RotationSchemaDecoration: SchemaDecoration - [Variable: SCALE_WIDTH](/auto-docs/fixed-layout-editor/variables/SCALE_WIDTH.md): Const SCALE_WIDTH: 0 - [Variable: ScaleSchemaDecoration](/auto-docs/fixed-layout-editor/variables/ScaleSchemaDecoration.md): Const ScaleSchemaDecoration: SchemaDecoration - [Variable: ScrollBarEvents](/auto-docs/fixed-layout-editor/variables/ScrollBarEvents-1.md): Const ScrollBarEvents: unique symbol 滚动条点击事件监听 - [Variable: ShadowSchemaDecoration](/auto-docs/fixed-layout-editor/variables/ShadowSchemaDecoration.md): Const ShadowSchemaDecoration: SchemaDecoration - [Variable: ShortcutsContribution](/auto-docs/fixed-layout-editor/variables/ShortcutsContribution-1.md): Const ShortcutsContribution: unique symbol - [Variable: SizeSchemaDecoration](/auto-docs/fixed-layout-editor/variables/SizeSchemaDecoration.md): Const SizeSchemaDecoration: SchemaDecoration - [Variable: SkewSchemaDecoration](/auto-docs/fixed-layout-editor/variables/SkewSchemaDecoration.md): Const SkewSchemaDecoration: SchemaDecoration - [Variable: SlotSpacingKey](/auto-docs/fixed-layout-editor/variables/SlotSpacingKey.md): Const SlotSpacingKey: Object Type declaration - [Variable: StorageService](/auto-docs/fixed-layout-editor/variables/StorageService-1.md): Const StorageService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: TintSchemaDecoration](/auto-docs/fixed-layout-editor/variables/TintSchemaDecoration.md): Const TintSchemaDecoration: SchemaDecoration - [Variable: TransformSchemaDecoration](/auto-docs/fixed-layout-editor/variables/TransformSchemaDecoration.md): Const TransformSchemaDecoration: SchemaDecoration - [Variable: VariableContainerModule](/auto-docs/fixed-layout-editor/variables/VariableContainerModule.md): Const VariableContainerModule: ContainerModule An InversifyJS container module that binds all the necessary services for the variable engine. This module sets up the dependency injection for the core components of the variable engine. - [Variable: VariableEngineProvider](/auto-docs/fixed-layout-editor/variables/VariableEngineProvider-1.md): Const VariableEngineProvider: unique symbol A provider for dynamically obtaining the VariableEngine instance. This is used to prevent circular dependencies when injecting VariableEngine. - [Variable: logger](/auto-docs/fixed-layout-editor/variables/logger.md): Const logger: Logger - [Class: ASTNode](/auto-docs/free-layout-editor/classes/ASTNode.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: ASTRegisters](/auto-docs/free-layout-editor/classes/ASTRegisters.md): Register the AST node to the engine. - [Class: ArrayType](/auto-docs/free-layout-editor/classes/ArrayType.md): Represents an array type. - [Class: AsyncContainerModule](/auto-docs/free-layout-editor/classes/AsyncContainerModule.md) - [Class: BaseExpression](/auto-docs/free-layout-editor/classes/BaseExpression.md): Base class for all expressions. All other expressions should extend this class. - [Class: BaseType](/auto-docs/free-layout-editor/classes/BaseType.md): Base class for all types. All other types should extend this class. - [Class: BaseVariableField](/auto-docs/free-layout-editor/classes/BaseVariableField.md): Variable Field abstract class, which is the base class for VariableDeclaration and Property VariableDeclaration is used to declare a variable in a block scope.Property is used to declare a property in an object. - [Class: BooleanType](/auto-docs/free-layout-editor/classes/BooleanType.md): Represents a boolean type. - [Class: CancellationTokenSource](/auto-docs/free-layout-editor/classes/CancellationTokenSource.md) - [Class: Circle](/auto-docs/free-layout-editor/classes/Circle.md): The Circle object is used to help draw graphics and can also be used to specify a hit area for displayObjects. - [Class: CommandRegistry](/auto-docs/free-layout-editor/classes/CommandRegistry.md) - [Class: ConfigEntity](/auto-docs/free-layout-editor/classes/ConfigEntity.md): 用于专门的数据配置，且是单例 - [Class: Container](/auto-docs/free-layout-editor/classes/Container.md) - [Class: ContainerModule](/auto-docs/free-layout-editor/classes/ContainerModule.md) - [Class: ContextMenuService](/auto-docs/free-layout-editor/classes/ContextMenuService.md): 圈选右键菜单相关 service - [Class: CustomType](/auto-docs/free-layout-editor/classes/CustomType.md): Represents a custom type. - [Class: DataNode](/auto-docs/free-layout-editor/classes/DataNode.md): Represents a general data node with no child nodes. - [Class: DefaultClipboardService](/auto-docs/free-layout-editor/classes/DefaultClipboardService.md): 剪贴板服务，一般用于管理临时的复制黏贴数据 TODO: 后续可以支持调用浏览器 - [Class: DisposableCollection](/auto-docs/free-layout-editor/classes/DisposableCollection.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: DisposableImpl](/auto-docs/free-layout-editor/classes/DisposableImpl.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: EditorStateConfigEntity](/auto-docs/free-layout-editor/classes/EditorStateConfigEntity.md): 编辑状态管理 - [Class: Emitter](/auto-docs/free-layout-editor/classes/Emitter.md) - [Class: Entity](/auto-docs/free-layout-editor/classes/Entity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: EntityData](/auto-docs/free-layout-editor/classes/EntityData.md): 实体的数据块 - [Class: EntityManager](/auto-docs/free-layout-editor/classes/EntityManager.md): TODO registry 改成 decorator Entity 管理器，全局唯一 - [Class: EnumerateExpression](/auto-docs/free-layout-editor/classes/EnumerateExpression.md): Represents an enumeration expression, which iterates over a list and returns the type of the enumerated variable. - [Class: FlowContextMenuLayer](/auto-docs/free-layout-editor/classes/FlowContextMenuLayer.md): 流程右键菜单 - [Class: FlowDebugLayer](/auto-docs/free-layout-editor/classes/FlowDebugLayer.md): 调试用，会绘出所有节点的边界 - [Class: FlowDocument](/auto-docs/free-layout-editor/classes/FlowDocument.md): 流程整个文档数据 - [Class: FlowDocumentConfig](/auto-docs/free-layout-editor/classes/FlowDocumentConfig.md): 用于文档扩展配置 - [Class: FlowDocumentTransformerEntity](/auto-docs/free-layout-editor/classes/FlowDocumentTransformerEntity.md): 用于通知所有 layer 更新 - [Class: FlowDragEntity](/auto-docs/free-layout-editor/classes/FlowDragEntity.md): 用于专门的数据配置，且是单例 - [Class: FlowDragLayer](/auto-docs/free-layout-editor/classes/FlowDragLayer.md): 监听节点的激活状态 - [Class: FlowDragService](/auto-docs/free-layout-editor/classes/FlowDragService.md): 拖拽相关操作 外部实现抽象类 - [Class: FlowEditorClient](/auto-docs/free-layout-editor/classes/FlowEditorClient.md) - [Class: FlowGroupController](/auto-docs/free-layout-editor/classes/FlowGroupController.md): 分组控制器 - [Class: FlowGroupService](/auto-docs/free-layout-editor/classes/FlowGroupService.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowLabelsLayer](/auto-docs/free-layout-editor/classes/FlowLabelsLayer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowLinesLayer](/auto-docs/free-layout-editor/classes/FlowLinesLayer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowNodeEntity](/auto-docs/free-layout-editor/classes/FlowNodeEntity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FlowNodeFormData](/auto-docs/free-layout-editor/classes/FlowNodeFormData.md): 实体的数据块 - [Class: FlowNodeRenderData](/auto-docs/free-layout-editor/classes/FlowNodeRenderData.md): 节点渲染状态相关数据 - [Class: FlowNodeTransformData](/auto-docs/free-layout-editor/classes/FlowNodeTransformData.md): 实体的数据块 - [Class: FlowNodeTransitionData](/auto-docs/free-layout-editor/classes/FlowNodeTransitionData.md): 实体的数据块 - [Class: FlowNodeVariableData](/auto-docs/free-layout-editor/classes/FlowNodeVariableData.md): Manages variable data for a flow node, including public and private scopes. - [Class: FlowNodesContentLayer](/auto-docs/free-layout-editor/classes/FlowNodesContentLayer.md): 渲染节点内容 - [Class: FlowNodesTransformLayer](/auto-docs/free-layout-editor/classes/FlowNodesTransformLayer.md): 渲染节点位置 - [Class: FlowOperationBaseServiceImpl](/auto-docs/free-layout-editor/classes/FlowOperationBaseServiceImpl.md): 操作服务 - [Class: FlowRendererRegistry](/auto-docs/free-layout-editor/classes/FlowRendererRegistry.md) - [Class: FlowRendererStateEntity](/auto-docs/free-layout-editor/classes/FlowRendererStateEntity.md): 渲染相关的全局状态管理 - [Class: FlowScrollBarLayer](/auto-docs/free-layout-editor/classes/FlowScrollBarLayer.md): 渲染滚动条 layer - [Class: FlowScrollLimitLayer](/auto-docs/free-layout-editor/classes/FlowScrollLimitLayer.md): 控制滚动边界 - [Class: FlowSelectConfigEntity](/auto-docs/free-layout-editor/classes/FlowSelectConfigEntity.md): 圈选节点相关数据存储 - [Class: FlowSelectorBoundsLayer](/auto-docs/free-layout-editor/classes/FlowSelectorBoundsLayer.md): 流程节点被框选后的边界区域渲染 - [Class: FlowSelectorBoxLayer](/auto-docs/free-layout-editor/classes/FlowSelectorBoxLayer.md): 流程选择框 - [Class: FlowVirtualTree](/auto-docs/free-layout-editor/classes/FlowVirtualTree-1.md): 存储节点的 tree 结构信息 策略是 "重修改轻查询"，即修改时候做的事情更多，查询都通过指针来操作 - [Class: FlushLayerMessage](/auto-docs/free-layout-editor/classes/FlushLayerMessage.md) - [Class: FormModel](/auto-docs/free-layout-editor/classes/FormModel.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FormPlugin](/auto-docs/free-layout-editor/classes/FormPlugin.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: FreeHistoryConfig](/auto-docs/free-layout-editor/classes/FreeHistoryConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FreeHistoryRegisters](/auto-docs/free-layout-editor/classes/FreeHistoryRegisters.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: GlobalScope](/auto-docs/free-layout-editor/classes/GlobalScope.md): Global Scope stores all variables that are not scoped to any node. Variables in Global Scope can be accessed by any node.Any other scope's variables can not be accessed by Global Scope. - [Class: HistoryConfig](/auto-docs/free-layout-editor/classes/HistoryConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryContext](/auto-docs/free-layout-editor/classes/HistoryContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryManager](/auto-docs/free-layout-editor/classes/HistoryManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryService](/auto-docs/free-layout-editor/classes/HistoryService.md): 历史服务 - [Class: HistoryStack](/auto-docs/free-layout-editor/classes/HistoryStack.md): 历史栈，聚合所有历史操作 - [Class: IntegerType](/auto-docs/free-layout-editor/classes/IntegerType.md): Represents an integer type. - [Class: KeyPathExpression](/auto-docs/free-layout-editor/classes/KeyPathExpression.md): Represents a key path expression, which is used to reference a variable by its key path. This is the V2 of KeyPathExpression, with the following improvements: returnType is copied to a new instance to avoid reference issues.Circular reference detection is introduced. - [Class: Layer](/auto-docs/free-layout-editor/classes/Layer.md): 基础 layer - [Class: LegacyKeyPathExpression](/auto-docs/free-layout-editor/classes/LegacyKeyPathExpression.md): Deprecated Use KeyPathExpression instead. Represents a key path expression, which is used to reference a variable by its key path. - [Class: ListNode](/auto-docs/free-layout-editor/classes/ListNode.md): Represents a list of nodes. - [Class: LocalStorageService](/auto-docs/free-layout-editor/classes/LocalStorageService.md) - [Class: LoggerService](/auto-docs/free-layout-editor/classes/LoggerService.md): 画布全局的选择器，可以放任何东西 - [Class: MapNode](/auto-docs/free-layout-editor/classes/MapNode.md): Represents a map of nodes. - [Class: MapType](/auto-docs/free-layout-editor/classes/MapType.md): Represents a map type. - [Class: Matrix](/auto-docs/free-layout-editor/classes/Matrix.md): The PIXIJS Matrix as a class makes it a lot faster. Here is a representation of it: - [Class: MutableToken](/auto-docs/free-layout-editor/classes/MutableToken.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: NodeClient](/auto-docs/free-layout-editor/classes/NodeClient.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: NodeFocusService](/auto-docs/free-layout-editor/classes/NodeFocusService.md) - [Class: NumberType](/auto-docs/free-layout-editor/classes/NumberType.md): Represents a number type. - [Class: OBBRect](/auto-docs/free-layout-editor/classes/OBBRect.md): Oriented Bounding Box (OBB) See https://en.wikipedia.org/wiki/Bounding_volume - [Class: ObjectType](/auto-docs/free-layout-editor/classes/ObjectType.md): Represents an object type. - [Class: OpacityData](/auto-docs/free-layout-editor/classes/OpacityData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OperationRegistry](/auto-docs/free-layout-editor/classes/OperationRegistry.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OperationService](/auto-docs/free-layout-editor/classes/OperationService.md) - [Class: OriginData](/auto-docs/free-layout-editor/classes/OriginData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PipelineEntitiesImpl](/auto-docs/free-layout-editor/classes/PipelineEntitiesImpl.md): 注入到 Layer 中的实体选择器 - [Class: PipelineEntitiesSelector](/auto-docs/free-layout-editor/classes/PipelineEntitiesSelector.md): 选择器用来在 pipeline 绘制之前，筛选并注入 entities - [Class: PipelineRegistry](/auto-docs/free-layout-editor/classes/PipelineRegistry.md): pipeline 注册器，用于注册一些事件 - [Class: PipelineRenderer](/auto-docs/free-layout-editor/classes/PipelineRenderer.md): pipeline 渲染器 - [Class: Playground](/auto-docs/free-layout-editor/classes/Playground.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundConfigEntity](/auto-docs/free-layout-editor/classes/PlaygroundConfigEntity.md): 全局画布的配置信息 - [Class: PlaygroundDrag](/auto-docs/free-layout-editor/classes/PlaygroundDrag-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: PlaygroundGesture](/auto-docs/free-layout-editor/classes/PlaygroundGesture.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundLayer](/auto-docs/free-layout-editor/classes/PlaygroundLayer.md): 基础层，控制画布缩放/滚动等操作 - [Class: LayerTestState](/auto-docs/free-layout-editor/classes/PlaygroundMockTools.LayerTestState.md): PlaygroundMockTools.LayerTestState - [Class: PlaygroundRegistry](/auto-docs/free-layout-editor/classes/PlaygroundRegistry.md) - [Class: PlaygroundSchedule](/auto-docs/free-layout-editor/classes/PlaygroundSchedule.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Point](/auto-docs/free-layout-editor/classes/Point-1.md): The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis. Memberof PIXI Implements IPoint - [Class: PositionData](/auto-docs/free-layout-editor/classes/PositionData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PromiseDeferred](/auto-docs/free-layout-editor/classes/PromiseDeferred.md): Simple implementation of the deferred pattern. An object that exposes a promise and functions to resolve and reject it. - [Class: PromisePool](/auto-docs/free-layout-editor/classes/PromisePool.md) - [Class: Property](/auto-docs/free-layout-editor/classes/Property.md): Property is a variable field that represents a property of a ObjectType. - [Class: ReactiveBaseState](/auto-docs/free-layout-editor/classes/ReactiveBaseState.md) - [Class: ReactiveState](/auto-docs/free-layout-editor/classes/ReactiveState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Rectangle](/auto-docs/free-layout-editor/classes/Rectangle-1.md): Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. - [Class: RotationData](/auto-docs/free-layout-editor/classes/RotationData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: ScaleData](/auto-docs/free-layout-editor/classes/ScaleData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: Scope](/auto-docs/free-layout-editor/classes/Scope.md): Represents a variable scope, which manages its own set of variables and their lifecycle. scope.output represents the variables declared within this scope.scope.available represents all variables accessible from this scope, including those from parent scopes. - [Class: ScopeChain](/auto-docs/free-layout-editor/classes/ScopeChain.md): Manages the dependency relationships between scopes. This is an abstract class, and specific implementations determine how the scope order is managed. - [Class: ScopeChainTransformService](/auto-docs/free-layout-editor/classes/ScopeChainTransformService.md): A service for transforming scope chains. - [Class: ScopeOutputData](/auto-docs/free-layout-editor/classes/ScopeOutputData.md): Manages the output variables of a scope. - [Class: SelectionService](/auto-docs/free-layout-editor/classes/SelectionService.md): 画布全局的选择器，可以放任何东西 - [Class: SelectorBoxConfigEntity](/auto-docs/free-layout-editor/classes/SelectorBoxConfigEntity.md): 选择框配置 - [Class: ShortcutsRegistry](/auto-docs/free-layout-editor/classes/ShortcutsRegistry.md) - [Class: SizeData](/auto-docs/free-layout-editor/classes/SizeData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: SkewData](/auto-docs/free-layout-editor/classes/SkewData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StackOperation](/auto-docs/free-layout-editor/classes/StackOperation.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StackingComputing](/auto-docs/free-layout-editor/classes/StackingComputing.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StackingContextManager](/auto-docs/free-layout-editor/classes/StackingContextManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: StringType](/auto-docs/free-layout-editor/classes/StringType.md): Base class for all types. All other types should extend this class. - [Class: Computation](/auto-docs/free-layout-editor/classes/Tracker.Computation.md): Tracker.Computation A Computation object represents code that is repeatedly rerun in response to reactive data changes. Computations don't have return values; they just perform actions, such as rerendering a template on the screen. Computations are created using Tracker.autorun. Use stop to prevent further rerunning of a computation. - [Class: Dependency](/auto-docs/free-layout-editor/classes/Tracker.Dependency.md): Tracker.Dependency A Dependency represents an atomic unit of reactive data that a computation might depend on. Reactive data sources such as Session or Minimongo internally create different Dependency objects for different pieces of data, each of which may be depended on by multiple computations. When the data changes, the computations are invalidated. - [Class: Transform](/auto-docs/free-layout-editor/classes/Transform.md): Transform that takes care about its versions Memberof PIXI - [Class: TransformData](/auto-docs/free-layout-editor/classes/TransformData-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: UndoRedoService](/auto-docs/free-layout-editor/classes/UndoRedoService.md): UndoRedo服务 - [Class: VariableDeclaration](/auto-docs/free-layout-editor/classes/VariableDeclaration.md): VariableDeclaration is a variable field that represents a variable declaration. - [Class: VariableDeclarationList](/auto-docs/free-layout-editor/classes/VariableDeclarationList.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: VariableEngine](/auto-docs/free-layout-editor/classes/VariableEngine.md): The core of the variable engine system. It manages scopes, variables, and events within the system. - [Class: VariableFieldKeyRenameService](/auto-docs/free-layout-editor/classes/VariableFieldKeyRenameService.md): This service is responsible for detecting when a variable field's key is renamed. It listens for changes in variable declaration lists and object properties, and determines if a change constitutes a rename operation. - [Class: WorkflowAutoLayoutTool](/auto-docs/free-layout-editor/classes/WorkflowAutoLayoutTool.md): Auto layout tool - 自动布局工具 https://flowgram.ai/guide/plugin/free-auto-layout-plugin.html - [Class: WorkflowDocument](/auto-docs/free-layout-editor/classes/WorkflowDocument.md): 流程整个文档数据 - [Class: WorkflowDragService](/auto-docs/free-layout-editor/classes/WorkflowDragService.md) - [Class: WorkflowHoverService](/auto-docs/free-layout-editor/classes/WorkflowHoverService.md): hover 状态管理 - [Class: WorkflowLineEntity](/auto-docs/free-layout-editor/classes/WorkflowLineEntity.md): 线条 - [Class: WorkflowLineRenderData](/auto-docs/free-layout-editor/classes/WorkflowLineRenderData.md): 实体的数据块 - [Class: WorkflowLinesManager](/auto-docs/free-layout-editor/classes/WorkflowLinesManager.md): 线条管理 - [Class: WorkflowNodeLinesData](/auto-docs/free-layout-editor/classes/WorkflowNodeLinesData.md): 节点的关联的线条 - [Class: WorkflowNodePortsData](/auto-docs/free-layout-editor/classes/WorkflowNodePortsData.md): 节点的点位信息 portsData 只监听点位的数目和类型，不监听点位的 position 变化 - [Class: WorkflowOperationBaseServiceImpl](/auto-docs/free-layout-editor/classes/WorkflowOperationBaseServiceImpl.md): 操作服务 - [Class: WorkflowPortEntity](/auto-docs/free-layout-editor/classes/WorkflowPortEntity.md): Port 抽象的 Entity - [Class: WorkflowResetLayoutService](/auto-docs/free-layout-editor/classes/WorkflowResetLayoutService.md): 重置布局服务 - [Class: WorkflowSelectService](/auto-docs/free-layout-editor/classes/WorkflowSelectService.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: WrapArrayExpression](/auto-docs/free-layout-editor/classes/WrapArrayExpression.md): Represents a wrap expression, which wraps an expression with an array. - [Enumeration: ASTKind](/auto-docs/free-layout-editor/enums/ASTKind.md): Core AST node types. - [Enumeration: ASTNodeFlags](/auto-docs/free-layout-editor/enums/ASTNodeFlags.md): ASTNode flags. Stored in the flags property of the ASTNode. - [Enumeration: Default](/auto-docs/free-layout-editor/enums/Command.Default.md): Command.Default - [Enumeration: DRAGGING_TYPE](/auto-docs/free-layout-editor/enums/DRAGGING_TYPE.md): 拖拽种类枚举 节点拖拽分支拖拽 - [Enumeration: DataEvent](/auto-docs/free-layout-editor/enums/DataEvent.md) - [Enumeration: EditorCursorState](/auto-docs/free-layout-editor/enums/EditorCursorState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FeedbackLevel](/auto-docs/free-layout-editor/enums/FeedbackLevel.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowDocumentConfigEnum](/auto-docs/free-layout-editor/enums/FlowDocumentConfigEnum.md) - [Enumeration: FlowLayoutDefault](/auto-docs/free-layout-editor/enums/FlowLayoutDefault-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowNodeBaseType](/auto-docs/free-layout-editor/enums/FlowNodeBaseType.md) - [Enumeration: FlowNodeScopeType](/auto-docs/free-layout-editor/enums/FlowNodeScopeType.md): Enum for flow node scope types. - [Enumeration: FlowNodeSplitType](/auto-docs/free-layout-editor/enums/FlowNodeSplitType.md) - [Enumeration: FlowRendererCommandCategory](/auto-docs/free-layout-editor/enums/FlowRendererCommandCategory.md): 命令分类 - [Enumeration: FlowRendererComponentType](/auto-docs/free-layout-editor/enums/FlowRendererComponentType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowRendererKey](/auto-docs/free-layout-editor/enums/FlowRendererKey.md) - [Enumeration: FlowTextKey](/auto-docs/free-layout-editor/enums/FlowTextKey.md) - [Enumeration: FlowTransitionLabelEnum](/auto-docs/free-layout-editor/enums/FlowTransitionLabelEnum.md) - [Enumeration: FlowTransitionLineEnum](/auto-docs/free-layout-editor/enums/FlowTransitionLineEnum.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FreeOperationType](/auto-docs/free-layout-editor/enums/FreeOperationType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: HistoryMergeEventType](/auto-docs/free-layout-editor/enums/HistoryMergeEventType.md) - [Enumeration: HistoryStackChangeType](/auto-docs/free-layout-editor/enums/HistoryStackChangeType.md): 历史栈变化类型 - [Enumeration: InteractiveType](/auto-docs/free-layout-editor/enums/InteractiveType.md) - [Enumeration: LABEL_SIDE_TYPE](/auto-docs/free-layout-editor/enums/LABEL_SIDE_TYPE.md): 拖拽分支 Adder、Line 类型 - [Enumeration: LineColors](/auto-docs/free-layout-editor/enums/LineColors.md) - [Enumeration: LineType](/auto-docs/free-layout-editor/enums/LineType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: LoggerEvent](/auto-docs/free-layout-editor/enums/LoggerEvent.md) - [Enumeration: OperationType](/auto-docs/free-layout-editor/enums/OperationType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: PipelineLayerPriority](/auto-docs/free-layout-editor/enums/PipelineLayerPriority.md) - [Enumeration: PipelineMessage](/auto-docs/free-layout-editor/enums/PipelineMessage.md) - [Enumeration: RectangleAlignTitle](/auto-docs/free-layout-editor/enums/RectangleAlignTitle.md) - [Enumeration: RectangleAlignType](/auto-docs/free-layout-editor/enums/RectangleAlignType.md) - [Enumeration: SHAPES](/auto-docs/free-layout-editor/enums/SHAPES.md): Constants that identify shapes. - [Enumeration: UndoRedoChangeType](/auto-docs/free-layout-editor/enums/UndoRedoChangeType.md): undo redo 类型 - [Enumeration: ValidateTrigger](/auto-docs/free-layout-editor/enums/ValidateTrigger.md) - [Enumeration: WorkflowCommands](/auto-docs/free-layout-editor/enums/WorkflowCommands.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: WorkflowContentChangeType](/auto-docs/free-layout-editor/enums/WorkflowContentChangeType.md) - [Function: create](/auto-docs/free-layout-editor/functions/ASTFactory.create.md): ASTFactory.create create(targetType, json): { kind: string } & JSON Creates Type-Safe ASTNodeJSON object based on the provided AST class. Type parameters Parameters Returns { kind: string } & JSON The ASTNode JSON object. - [Function: createArray](/auto-docs/free-layout-editor/functions/ASTFactory.createArray.md): ASTFactory.createArray createArray(json): Object Creates an Array type node. Parameters Returns Object - [Function: createBoolean](/auto-docs/free-layout-editor/functions/ASTFactory.createBoolean.md): ASTFactory.createBoolean createBoolean(): Object Creates a Boolean type node. Returns Object - [Function: createCustomType](/auto-docs/free-layout-editor/functions/ASTFactory.createCustomType.md): ASTFactory.createCustomType createCustomType(json): Object Creates a CustomType node. Parameters Returns Object - [Function: createEnumerateExpression](/auto-docs/free-layout-editor/functions/ASTFactory.createEnumerateExpression.md): ASTFactory.createEnumerateExpression createEnumerateExpression(json): Object Creates an EnumerateExpression node. Parameters Returns Object - [Function: createInteger](/auto-docs/free-layout-editor/functions/ASTFactory.createInteger.md): ASTFactory.createInteger createInteger(): Object Creates an Integer type node. Returns Object - [Function: createKeyPathExpression](/auto-docs/free-layout-editor/functions/ASTFactory.createKeyPathExpression.md): ASTFactory.createKeyPathExpression createKeyPathExpression(json): Object Creates a KeyPathExpression node. Parameters Returns Object - [Function: createMap](/auto-docs/free-layout-editor/functions/ASTFactory.createMap.md): ASTFactory.createMap createMap(json): Object Creates a Map type node. Parameters Returns Object - [Function: createNumber](/auto-docs/free-layout-editor/functions/ASTFactory.createNumber.md): ASTFactory.createNumber createNumber(): Object Creates a Number type node. Returns Object - [Function: createObject](/auto-docs/free-layout-editor/functions/ASTFactory.createObject.md): ASTFactory.createObject createObject(json): Object Creates an Object type node. Parameters Returns Object - [Function: createProperty](/auto-docs/free-layout-editor/functions/ASTFactory.createProperty.md): ASTFactory.createProperty createProperty(json): Object Creates a Property node. Type parameters Parameters Returns Object - [Function: createString](/auto-docs/free-layout-editor/functions/ASTFactory.createString.md): ASTFactory.createString createString(json?): Object Creates a String type node. Parameters Returns Object - [Function: createUnion](/auto-docs/free-layout-editor/functions/ASTFactory.createUnion.md): ASTFactory.createUnion createUnion(json): Object Creates a Union type node. Parameters Returns Object - [Function: createVariableDeclaration](/auto-docs/free-layout-editor/functions/ASTFactory.createVariableDeclaration.md): ASTFactory.createVariableDeclaration createVariableDeclaration(json): Object Creates a VariableDeclaration node. Type parameters Parameters Returns Object - [Function: createVariableDeclarationList](/auto-docs/free-layout-editor/functions/ASTFactory.createVariableDeclarationList.md): ASTFactory.createVariableDeclarationList createVariableDeclarationList(json): Object Creates a VariableDeclarationList node. Parameters Returns Object - [Function: createWrapArrayExpression](/auto-docs/free-layout-editor/functions/ASTFactory.createWrapArrayExpression.md): ASTFactory.createWrapArrayExpression createWrapArrayExpression(json): Object Creates a WrapArrayExpression node. Parameters Returns Object - [Function: is](/auto-docs/free-layout-editor/functions/ASTMatch.is.md): ASTMatch.is is(node?, targetType?): node is TargetASTNode Check ASTNode Match by ASTClass Type parameters Parameters Returns node is TargetASTNode Whether the node is of the target type. - [Function: isArray](/auto-docs/free-layout-editor/functions/ASTMatch.isArray.md): ASTMatch.isArray isArray(node?): node is ArrayType Check if the node is a ArrayType. Parameters Returns node is ArrayType - [Function: isBaseVariableField](/auto-docs/free-layout-editor/functions/ASTMatch.isBaseVariableField.md): ASTMatch.isBaseVariableField isBaseVariableField(node?): node is BaseVariableField Check if the node is a BaseVariableField. Parameters Returns node is BaseVariableField - [Function: isBoolean](/auto-docs/free-layout-editor/functions/ASTMatch.isBoolean.md): ASTMatch.isBoolean isBoolean(node?): node is BooleanType Check if the node is a BooleanType. Parameters Returns node is BooleanType - [Function: isCustomType](/auto-docs/free-layout-editor/functions/ASTMatch.isCustomType.md): ASTMatch.isCustomType isCustomType(node?): node is CustomType Check if the node is a CustomType. Parameters Returns node is CustomType - [Function: isEnumerateExpression](/auto-docs/free-layout-editor/functions/ASTMatch.isEnumerateExpression.md): ASTMatch.isEnumerateExpression isEnumerateExpression(node?): node is EnumerateExpression Check if the node is a EnumerateExpression. Parameters Returns node is EnumerateExpression - [Function: isInteger](/auto-docs/free-layout-editor/functions/ASTMatch.isInteger.md): ASTMatch.isInteger isInteger(node?): node is IntegerType Check if the node is a IntegerType. Parameters Returns node is IntegerType - [Function: isKeyPathExpression](/auto-docs/free-layout-editor/functions/ASTMatch.isKeyPathExpression.md): ASTMatch.isKeyPathExpression isKeyPathExpression(node?): node is KeyPathExpression Check if the node is a KeyPathExpression. Parameters Returns node is KeyPathExpression - [Function: isMap](/auto-docs/free-layout-editor/functions/ASTMatch.isMap.md): ASTMatch.isMap isMap(node?): node is MapType Check if the node is a MapType. Parameters Returns node is MapType - [Function: isNumber](/auto-docs/free-layout-editor/functions/ASTMatch.isNumber.md): ASTMatch.isNumber isNumber(node?): node is NumberType Check if the node is a NumberType. Parameters Returns node is NumberType - [Function: isObject](/auto-docs/free-layout-editor/functions/ASTMatch.isObject.md): ASTMatch.isObject isObject(node?): node is ObjectType Check if the node is a ObjectType. Parameters Returns node is ObjectType - [Function: isProperty](/auto-docs/free-layout-editor/functions/ASTMatch.isProperty.md): ASTMatch.isProperty isProperty(node?): node is Property Check if the node is a Property. Type parameters Parameters Returns node is Property - [Function: isString](/auto-docs/free-layout-editor/functions/ASTMatch.isString.md): ASTMatch.isString isString(node?): node is StringType Check if the node is a StringType. Parameters Returns node is StringType - [Function: isVariableDeclaration](/auto-docs/free-layout-editor/functions/ASTMatch.isVariableDeclaration.md): ASTMatch.isVariableDeclaration isVariableDeclaration(node?): node is VariableDeclaration Check if the node is a VariableDeclaration. Type parameters Parameters Returns node is VariableDeclaration - [Function: isVariableDeclarationList](/auto-docs/free-layout-editor/functions/ASTMatch.isVariableDeclarationList.md): ASTMatch.isVariableDeclarationList isVariableDeclarationList(node?): node is VariableDeclarationList Check if the node is a VariableDeclarationList. Parameters Returns node is VariableDeclarationList - [Function: isWrapArrayExpression](/auto-docs/free-layout-editor/functions/ASTMatch.isWrapArrayExpression.md): ASTMatch.isWrapArrayExpression isWrapArrayExpression(node?): node is WrapArrayExpression Check if the node is a WrapArrayExpression. Parameters Returns node is WrapArrayExpression - [Function: betweenPoints](/auto-docs/free-layout-editor/functions/Angle.betweenPoints.md): Angle.betweenPoints betweenPoints(point1, point2, originPoint?): number 计算两个点的夹角 Parameters Returns number The angle in radians. - [Function: wrap](/auto-docs/free-layout-editor/functions/Angle.wrap.md): Angle.wrap wrap(angle): number Wrap an angle. Wraps the angle to a value in the range of -PI to PI. Parameters Returns number The wrapped angle, in radians. - [Function: wrapDegrees](/auto-docs/free-layout-editor/functions/Angle.wrapDegrees.md): Angle.wrapDegrees wrapDegrees(angle): number Wrap an angle in degrees. Wraps the angle to a value in the range of -180 to 180. Parameters Returns number The wrapped angle, in degrees. - [Function: applyMatrix](/auto-docs/free-layout-editor/functions/Bounds.applyMatrix.md): Bounds.applyMatrix applyMatrix(bounds, matrix): Rectangle Parameters Returns Rectangle - [Function: getBottomCenter](/auto-docs/free-layout-editor/functions/Bounds.getBottomCenter.md): Bounds.getBottomCenter getBottomCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomLeft](/auto-docs/free-layout-editor/functions/Bounds.getBottomLeft.md): Bounds.getBottomLeft getBottomLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomRight](/auto-docs/free-layout-editor/functions/Bounds.getBottomRight.md): Bounds.getBottomRight getBottomRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBounds](/auto-docs/free-layout-editor/functions/Bounds.getBounds.md): Bounds.getBounds getBounds(target, matrix?): Rectangle 获取外围边界矩形 Parameters Returns Rectangle - [Function: getCenter](/auto-docs/free-layout-editor/functions/Bounds.getCenter.md): Bounds.getCenter getCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftCenter](/auto-docs/free-layout-editor/functions/Bounds.getLeftCenter.md): Bounds.getLeftCenter getLeftCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftPointFromBounds](/auto-docs/free-layout-editor/functions/Bounds.getLeftPointFromBounds.md): Bounds.getLeftPointFromBounds getLeftPointFromBounds(target, matrix?): PositionSchema 找到边框中最左边的点 Parameters Returns PositionSchema - [Function: getPointWithMatrix](/auto-docs/free-layout-editor/functions/Bounds.getPointWithMatrix.md): Bounds.getPointWithMatrix getPointWithMatrix(output, matrix?): PositionSchema 位置做矩阵偏移 Parameters Returns PositionSchema - [Function: getRightCenter](/auto-docs/free-layout-editor/functions/Bounds.getRightCenter.md): Bounds.getRightCenter getRightCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopCenter](/auto-docs/free-layout-editor/functions/Bounds.getTopCenter.md): Bounds.getTopCenter getTopCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopLeft](/auto-docs/free-layout-editor/functions/Bounds.getTopLeft.md): Bounds.getTopLeft getTopLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopPointFromBounds](/auto-docs/free-layout-editor/functions/Bounds.getTopPointFromBounds.md): Bounds.getTopPointFromBounds getTopPointFromBounds(target, matrix?): PositionSchema 找到边框中最上边的点 Parameters Returns PositionSchema - [Function: getTopRight](/auto-docs/free-layout-editor/functions/Bounds.getTopRight.md): Bounds.getTopRight getTopRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: assign](/auto-docs/free-layout-editor/functions/Cache.assign.md): Cache.assign assign(target, fn): Cache Type parameters Parameters Returns Cache - [Function: create](/auto-docs/free-layout-editor/functions/Cache.create.md): Cache.create create(cacheFactory, opts?): CacheManager Type parameters Parameters Returns CacheManager - [Function: createShortCache](/auto-docs/free-layout-editor/functions/Cache.createShortCache.md): Cache.createShortCache createShortCache(timeout?): ShortCache 短存储 Type parameters Parameters Returns ShortCache - [Function: createWeakCache](/auto-docs/free-layout-editor/functions/Cache.createWeakCache.md): Cache.createWeakCache createWeakCache(): WeakCache Returns WeakCache - [Function: isCancellationToken](/auto-docs/free-layout-editor/functions/CancellationToken.isCancellationToken.md): CancellationToken.isCancellationToken isCancellationToken(thing): thing is CancellationToken Parameters Returns thing is CancellationToken - [Function: is](/auto-docs/free-layout-editor/functions/Command.is.md): Command.is is(arg): arg is Command 判断是否是 command Parameters Returns arg is Command - [Function: isArrayShallowChanged](/auto-docs/free-layout-editor/functions/Compare.isArrayShallowChanged.md): Compare.isArrayShallowChanged isArrayShallowChanged(arr1, arr2): boolean Parameters Returns boolean - [Function: isChanged](/auto-docs/free-layout-editor/functions/Compare.isChanged.md): Compare.isChanged isChanged(oldProps, newProps, depth?, partial?): boolean 比较，默认浅比较 Parameters Returns boolean - [Function: isDeepChanged](/auto-docs/free-layout-editor/functions/Compare.isDeepChanged.md): Compare.isDeepChanged isDeepChanged(oldProps, newProps, partial?): boolean 深度比较 Parameters Returns boolean - [Function: DEFAULT_FLOW_NODE_META](/auto-docs/free-layout-editor/functions/DEFAULT_FLOW_NODE_META.md): DEFAULT_FLOW_NODE_META(nodeType, document): FlowNodeMeta 默认 meta 配置 Parameters Returns FlowNodeMeta - [Function: create](/auto-docs/free-layout-editor/functions/Disposable.create.md): Disposable.create create(func): Disposable Parameters Returns Disposable - [Function: is](/auto-docs/free-layout-editor/functions/Disposable.is.md): Disposable.is is(thing): thing is Disposable Parameters Returns thing is Disposable - [Function: Editor](/auto-docs/free-layout-editor/functions/Editor.md): Editor(props, deprecatedLegacyContext?): null | ReactElement 画布编辑器 Parameters Returns null | ReactElement - [Function: EditorProvider](/auto-docs/free-layout-editor/functions/EditorProvider.md): EditorProvider(props, deprecatedLegacyContext?): null | ReactElement Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns null | ReactElement - [Function: EditorRenderer](/auto-docs/free-layout-editor/functions/EditorRenderer.md): EditorRenderer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: checkDataChanged](/auto-docs/free-layout-editor/functions/Entity.checkDataChanged.md): Entity.checkDataChanged checkDataChanged(oldProps, newProps): boolean 默认数据比较，采用浅比较 Parameters Returns boolean - [Function: getType](/auto-docs/free-layout-editor/functions/Entity.getType.md): Entity.getType getType(registry): string Parameters Returns string - [Function: isRegistryOf](/auto-docs/free-layout-editor/functions/Entity.isRegistryOf.md): Entity.isRegistryOf isRegistryOf(target, Registry): boolean Parameters Returns boolean - [Function: None](/auto-docs/free-layout-editor/functions/Event.None.md): Event.None None(listener, thisArgs?): Disposable Parameters Returns Disposable - [Function: Field](/auto-docs/free-layout-editor/functions/Field.md): Field(«destructured»): React$1.ReactElement HOC That declare a field, an Field model will be created it's rendered. Multiple Field rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React$1.ReactElement - [Function: FieldArray](/auto-docs/free-layout-editor/functions/FieldArray.md): FieldArray(«destructured»): React$1.ReactElement HOC That declare an array field, an FieldArray model will be created when it's rendered. Multiple FieldArray rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React$1.ReactElement - [Function: isVertical](/auto-docs/free-layout-editor/functions/FlowLayoutDefault.isVertical.md): FlowLayoutDefault.isVertical isVertical(layout): boolean Parameters Returns boolean - [Function: is](/auto-docs/free-layout-editor/functions/FlowNodeEntity.is.md): FlowNodeEntity.is is(obj): obj is FlowNodeEntity Parameters Returns obj is FlowNodeEntity - [Function: extend](/auto-docs/free-layout-editor/functions/FlowNodeRegistry.extend.md): FlowNodeRegistry.extend extend(registry, extendRegistries): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: merge](/auto-docs/free-layout-editor/functions/FlowNodeRegistry.merge.md): FlowNodeRegistry.merge merge(registry1, registry2, finalType): FlowNodeRegistry Parameters Returns FlowNodeRegistry - [Function: mergeChildRegistries](/auto-docs/free-layout-editor/functions/FlowNodeRegistry.mergeChildRegistries.md): FlowNodeRegistry.mergeChildRegistries mergeChildRegistries(r1?, r2?): FlowNodeRegistry[] Parameters Returns FlowNodeRegistry[] - [Function: Form](/auto-docs/free-layout-editor/functions/Form.md): Form(props): React__default.JSX.Element Hoc That init and provide Form instance. You can also provide form instance from outside by using control prop Type parameters Parameters Returns React__default.JSX.Element - [Function: FreeLayoutEditor](/auto-docs/free-layout-editor/functions/FreeLayoutEditor.md): FreeLayoutEditor(props): null | ReactElement> 自由布局编辑器 Parameters Returns null | ReactElement> - [Function: FreeLayoutEditorProvider](/auto-docs/free-layout-editor/functions/FreeLayoutEditorProvider.md): FreeLayoutEditorProvider(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: MOUSE_SCROLL_DELTA](/auto-docs/free-layout-editor/functions/MOUSE_SCROLL_DELTA.md): MOUSE_SCROLL_DELTA(zoom): number 鼠标缩放 delta Parameters Returns number - [Function: getEventCoord](/auto-docs/free-layout-editor/functions/MouseTouchEvent.getEventCoord.md): MouseTouchEvent.getEventCoord getEventCoord(e): Object Parameters Returns Object - [Function: isTouchEvent](/auto-docs/free-layout-editor/functions/MouseTouchEvent.isTouchEvent.md): MouseTouchEvent.isTouchEvent isTouchEvent(event): event is TouchEvent Parameters Returns event is TouchEvent - [Function: onTouched](/auto-docs/free-layout-editor/functions/MouseTouchEvent.onTouched.md): MouseTouchEvent.onTouched onTouched(touchStartEvent, callback): void Parameters Returns void - [Function: preventDefault](/auto-docs/free-layout-editor/functions/MouseTouchEvent.preventDefault.md): MouseTouchEvent.preventDefault preventDefault(e): void Parameters Returns void - [Function: touchToMouseEvent](/auto-docs/free-layout-editor/functions/MouseTouchEvent.touchToMouseEvent.md): MouseTouchEvent.touchToMouseEvent touchToMouseEvent(event): Event | MouseEvent Parameters Returns Event | MouseEvent - [Function: NOOP](/auto-docs/free-layout-editor/functions/NOOP.md): NOOP(): void Returns void - [Function: NodeRender](/auto-docs/free-layout-editor/functions/NodeRender.md): NodeRender(props): null | ReactElement> Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns null | ReactElement> - [Function: empty](/auto-docs/free-layout-editor/functions/PaddingSchema.empty.md): PaddingSchema.empty empty(): Object Returns Object - [Function: startDrag](/auto-docs/free-layout-editor/functions/PlaygroundDrag.startDrag.md): PlaygroundDrag.startDrag startDrag(clientX, clientY, opts?): Disposable 拖拽实体 Type parameters Parameters Returns Disposable - [Function: createContainer](/auto-docs/free-layout-editor/functions/PlaygroundMockTools.createContainer.md): PlaygroundMockTools.createContainer createContainer(modules?): Container Parameters Returns Container - [Function: createLayerTestState](/auto-docs/free-layout-editor/functions/PlaygroundMockTools.createLayerTestState.md): PlaygroundMockTools.createLayerTestState createLayerTestState(layerRegistry, opts?, modules?): LayerTestState 创建layer, 并记录layer的回调数据 Type parameters Parameters Returns LayerTestState - [Function: createPlayground](/auto-docs/free-layout-editor/functions/PlaygroundMockTools.createPlayground.md): PlaygroundMockTools.createPlayground createPlayground(modules?): Playground Parameters Returns Playground - [Function: getLayerTestState](/auto-docs/free-layout-editor/functions/PlaygroundMockTools.getLayerTestState.md): PlaygroundMockTools.getLayerTestState getLayerTestState(container, layerRegistry): LayerTestState Type parameters Parameters Returns LayerTestState - [Function: PlaygroundReactProvider](/auto-docs/free-layout-editor/functions/PlaygroundReactProvider.md): PlaygroundReactProvider(props): null | ReactElement> Playground react 组件 Parameters Returns null | ReactElement> - [Function: fixZero](/auto-docs/free-layout-editor/functions/Point.fixZero.md): Point.fixZero fixZero(output): IPoint Parameters Returns IPoint - [Function: getDistance](/auto-docs/free-layout-editor/functions/Point.getDistance.md): Point.getDistance getDistance(p1, p2): number 获取两点间的距离 Parameters Returns number - [Function: getMiddlePoint](/auto-docs/free-layout-editor/functions/Point.getMiddlePoint.md): Point.getMiddlePoint getMiddlePoint(p1, p2): IPoint 获取两点间的中间点 Parameters Returns IPoint - [Function: getRatioPoint](/auto-docs/free-layout-editor/functions/Point.getRatioPoint.md): Point.getRatioPoint getRatioPoint(p1, p2, ratio): IPoint 按一定比例，获取两点间的中间点 Parameters Returns IPoint - [Function: move](/auto-docs/free-layout-editor/functions/Point.move.md): Point.move move(current, m): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: moveDistanceToDirection](/auto-docs/free-layout-editor/functions/Point.moveDistanceToDirection.md): Point.moveDistanceToDirection moveDistanceToDirection(current, direction, distance): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: PrivateScopeProvider](/auto-docs/free-layout-editor/functions/PrivateScopeProvider.md): PrivateScopeProvider(«destructured»): Element PrivateScopeProvider provides the private scope to its children via context. Parameters Returns Element - [Function: PublicScopeProvider](/auto-docs/free-layout-editor/functions/PublicScopeProvider.md): PublicScopeProvider(«destructured»): Element PublicScopeProvider provides the public scope to its children via context. Parameters Returns Element - [Function: align](/auto-docs/free-layout-editor/functions/Rectangle.align.md): Rectangle.align align(rectangles, type): Rectangle[] 矩形对齐 Parameters Returns Rectangle[] - [Function: createRectangleWithTwoPoints](/auto-docs/free-layout-editor/functions/Rectangle.createRectangleWithTwoPoints.md): Rectangle.createRectangleWithTwoPoints createRectangleWithTwoPoints(point1, point2): Rectangle 根据两点创建矩形 Parameters Returns Rectangle - [Function: enlarge](/auto-docs/free-layout-editor/functions/Rectangle.enlarge.md): Rectangle.enlarge enlarge(rectangles): Rectangle 获取所有矩形的外围最大边框 Parameters Returns Rectangle - [Function: intersects](/auto-docs/free-layout-editor/functions/Rectangle.intersects.md): Rectangle.intersects intersects(target1, target2, direction?): boolean 判断矩形相交 Parameters Returns boolean - [Function: intersectsWithRotation](/auto-docs/free-layout-editor/functions/Rectangle.intersectsWithRotation.md): Rectangle.intersectsWithRotation intersectsWithRotation(rect1, rotate1, rect2, rotate2): boolean 使用 OBB 算法判断两个旋转矩形是否相交 Parameters Returns boolean - [Function: isViewportVisible](/auto-docs/free-layout-editor/functions/Rectangle.isViewportVisible.md): Rectangle.isViewportVisible isViewportVisible(rect, viewport, rotation?, isContains?): boolean 判断指定 rect 是否在 viewport 可见 Parameters Returns boolean - [Function: setViewportVisible](/auto-docs/free-layout-editor/functions/Rectangle.setViewportVisible.md): Rectangle.setViewportVisible setViewportVisible(bounds, viewport, padding?): Rectangle 保证bounds 永远在 viewport 里边 Parameters Returns Rectangle - [Function: createDefault](/auto-docs/free-layout-editor/functions/Schema.createDefault.md): Schema.createDefault createDefault(decoration, mixinDefaults?, _key?): T Type parameters Parameters Returns T - [Function: isBaseType](/auto-docs/free-layout-editor/functions/Schema.isBaseType.md): Schema.isBaseType isBaseType(decoration): boolean 非 object 类 Parameters Returns boolean - [Function: create](/auto-docs/free-layout-editor/functions/SchemaDecoration.create.md): SchemaDecoration.create create(properties, baseDecoration?, mixinDefaults?): SchemaDecoration 扩展 SchemaDecoration Type parameters Parameters Returns SchemaDecoration Example - [Function: ScopeProvider](/auto-docs/free-layout-editor/functions/ScopeProvider.md): ScopeProvider(props): Element ScopeProvider provides the scope to its children via context. Parameters Returns Element - [Function: coverSize](/auto-docs/free-layout-editor/functions/SizeSchema.coverSize.md): SizeSchema.coverSize coverSize(currentSize, parentSize): number 填充父节点的宽高 Parameters Returns number 返回放大的比例 - [Function: empty](/auto-docs/free-layout-editor/functions/SizeSchema.empty.md): SizeSchema.empty empty(): SizeSchema Returns SizeSchema - [Function: fixSize](/auto-docs/free-layout-editor/functions/SizeSchema.fixSize.md): SizeSchema.fixSize fixSize(currentSize, parentSize): number 适配父节点宽高 Parameters Returns number 返回需要缩放的比例，为 1 则不缩放 - [Function: isEmpty](/auto-docs/free-layout-editor/functions/TintSchema.isEmpty.md): TintSchema.isEmpty isEmpty(tint): boolean Parameters Returns boolean - [Function: afterFlush](/auto-docs/free-layout-editor/functions/Tracker.afterFlush.md): Tracker.afterFlush afterFlush(f): void Schedules a function to be called during the next flush, or later in the current flush if one is in progress, after all invalidated computations have been rerun. The function will be run once and not on subsequent flushes unless afterFlush is called again. Parameters Returns void - [Function: autorun](/auto-docs/free-layout-editor/functions/Tracker.autorun.md): Tracker.autorun autorun(f, options?): Computation Run a function now and rerun it later whenever its dependencies change. Returns a Computation object that can be used to stop or observe the rerunning. Type parameters Parameters Returns Computation - [Function: flush](/auto-docs/free-layout-editor/functions/Tracker.flush.md): Tracker.flush flush(options?): void Process all reactive updates immediately and ensure that all invalidated computations are rerun. Parameters Returns void - [Function: getCurrentComputation](/auto-docs/free-layout-editor/functions/Tracker.getCurrentComputation.md): Tracker.getCurrentComputation getCurrentComputation(): Computation | undefined Returns Computation | undefined - [Function: inFlush](/auto-docs/free-layout-editor/functions/Tracker.inFlush.md): Tracker.inFlush inFlush(): boolean True if we are computing a computation now, either first time or recompute. This matches Tracker.active unless we are inside Tracker.nonreactive, which nullfies currentComputation even though an enclosing computation may still be running. Returns boolean - [Function: isActive](/auto-docs/free-layout-editor/functions/Tracker.isActive.md): Tracker.isActive isActive(): boolean Returns boolean - [Function: onInvalidate](/auto-docs/free-layout-editor/functions/Tracker.onInvalidate.md): Tracker.onInvalidate onInvalidate(f): void Parameters Returns void - [Function: withComputation](/auto-docs/free-layout-editor/functions/Tracker.withComputation.md): Tracker.withComputation withComputation(computation, f): T 函数在响应式模块中执行 Type parameters Parameters Returns T - [Function: withoutComputation](/auto-docs/free-layout-editor/functions/Tracker.withoutComputation.md): Tracker.withoutComputation withoutComputation(f): T 函数在非响应式模块中执行 Type parameters Parameters Returns T - [Function: isParentOrChildrenTransform](/auto-docs/free-layout-editor/functions/TransformData.isParentOrChildrenTransform.md): TransformData.isParentOrChildrenTransform isParentOrChildrenTransform(dragableEntities, target): boolean Parameters Returns boolean - [Function: createDefault](/auto-docs/free-layout-editor/functions/TransformSchema.createDefault.md): TransformSchema.createDefault createDefault(): TransformSchema Returns TransformSchema - [Function: getDelta](/auto-docs/free-layout-editor/functions/TransformSchema.getDelta.md): TransformSchema.getDelta getDelta(oldTransform, newTransform): TransformSchema Parameters Returns TransformSchema - [Function: is](/auto-docs/free-layout-editor/functions/TransformSchema.is.md): TransformSchema.is is(obj): obj is TransformSchema Parameters Returns obj is TransformSchema - [Function: mergeDelta](/auto-docs/free-layout-editor/functions/TransformSchema.mergeDelta.md): TransformSchema.mergeDelta mergeDelta(oldTransform, newTransformDelta, toFixedNum?): TransformSchema Parameters Returns TransformSchema - [Function: toJSON](/auto-docs/free-layout-editor/functions/TransformSchema.toJSON.md): TransformSchema.toJSON toJSON(obj): TransformSchema Parameters Returns TransformSchema - [Function: WorkflowNodeRenderer](/auto-docs/free-layout-editor/functions/WorkflowNodeRenderer.md): WorkflowNodeRenderer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: WorkflowPortRender](/auto-docs/free-layout-editor/functions/WorkflowPortRender.md): WorkflowPortRender(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: addEventListener](/auto-docs/free-layout-editor/functions/addEventListener.md): addEventListener(element, type, listener, useCapture?): Disposable Type parameters Parameters Returns Disposable - [Function: arrayToSet](/auto-docs/free-layout-editor/functions/arrayToSet.md): arrayToSet(arr): Set Parameters Returns Set - [Function: arrayUnion](/auto-docs/free-layout-editor/functions/arrayUnion.md): arrayUnion(arr): any[] Parameters Returns any[] See https://stackoverflow.com/a/9229821 export function arrayUnion(arr: any[]): any[] { return [...new Set(arr)] } - [Function: bindConfigEntity](/auto-docs/free-layout-editor/functions/bindConfigEntity.md): bindConfigEntity(bind, entityRegistry): void 让 entity 可以注入到类中 Parameters Returns void Example - [Function: bindContributionProvider](/auto-docs/free-layout-editor/functions/bindContributionProvider.md): bindContributionProvider(bind, id): void Parameters Returns void - [Function: bindContributions](/auto-docs/free-layout-editor/functions/bindContributions.md): bindContributions(bind, target, contribs): void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns void - [Function: bindPlaygroundContextProvider](/auto-docs/free-layout-editor/functions/bindPlaygroundContextProvider.md): bindPlaygroundContextProvider(bind): void Parameters Returns void - [Function: buildGroupJSON](/auto-docs/free-layout-editor/functions/buildGroupJSON.md): buildGroupJSON(json): WorkflowJSON Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns WorkflowJSON - [Function: cancelled](/auto-docs/free-layout-editor/functions/cancelled.md): cancelled(): Error Returns Error - [Function: checkCancelled](/auto-docs/free-layout-editor/functions/checkCancelled.md): checkCancelled(token?): void Parameters Returns void - [Function: clearRequestCache](/auto-docs/free-layout-editor/functions/clearRequestCache.md): clearRequestCache(): void Returns void - [Function: compose](/auto-docs/free-layout-editor/functions/compose.md): compose(...fns): Func Type parameters Parameters Returns Func - [Function: composeAsync](/auto-docs/free-layout-editor/functions/composeAsync.md): composeAsync(...fns): FuncPromise Type parameters Parameters Returns FuncPromise - [Function: createConfigDataRegistry](/auto-docs/free-layout-editor/functions/createConfigDataRegistry.md): createConfigDataRegistry

(entity): EntityDataRegistry Type parameters Parameters Returns EntityDataRegistry - [Function: createDefaultPlaygroundConfig](/auto-docs/free-layout-editor/functions/createDefaultPlaygroundConfig.md): createDefaultPlaygroundConfig(): PlaygroundConfig 默认配置 Returns PlaygroundConfig - [Function: createDefaultPreset](/auto-docs/free-layout-editor/functions/createDefaultPreset.md): createDefaultPreset(opts, plugins?): PluginsProvider Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns PluginsProvider - [Function: createEffectFromVariableProvider](/auto-docs/free-layout-editor/functions/createEffectFromVariableProvider.md): createEffectFromVariableProvider(options): EffectOptions[] 根据 VariableProvider 生成 FormV2 的 Effect Parameters Returns EffectOptions[] - [Function: createEffectOptions](/auto-docs/free-layout-editor/functions/createEffectOptions.md): createEffectOptions(event, effect): Object Type parameters Parameters Returns Object - [Function: createFlowEditorClientPlugin](/auto-docs/free-layout-editor/functions/createFlowEditorClientPlugin.md): createFlowEditorClientPlugin(opts): Plugin<{}> Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Plugin<{}> - [Function: createFlowEditorClientPlugins](/auto-docs/free-layout-editor/functions/createFlowEditorClientPlugins.md): createFlowEditorClientPlugins(): Plugin<{}>[] Returns Plugin<{}>[] - [Function: createFreeHistoryPlugin](/auto-docs/free-layout-editor/functions/createFreeHistoryPlugin.md): createFreeHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: createFreeLayoutPreset](/auto-docs/free-layout-editor/functions/createFreeLayoutPreset.md): createFreeLayoutPreset(opts): PluginsProvider Parameters Returns PluginsProvider - [Function: createFreeStackPlugin](/auto-docs/free-layout-editor/functions/createFreeStackPlugin.md): createFreeStackPlugin(opts): Plugin> Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Plugin> - [Function: createHistoryPlugin](/auto-docs/free-layout-editor/functions/createHistoryPlugin.md): createHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: createI18nPlugin](/auto-docs/free-layout-editor/functions/createI18nPlugin.md): createI18nPlugin(opts): Plugin I18n Plugin Parameters Returns Plugin - [Function: createLines](/auto-docs/free-layout-editor/functions/createLines.md): createLines(props): void Parameters Returns void - [Function: createNodeCorePlugin](/auto-docs/free-layout-editor/functions/createNodeCorePlugin.md): createNodeCorePlugin(opts): Plugin Parameters Returns Plugin - [Function: createNodeVariablePlugin](/auto-docs/free-layout-editor/functions/createNodeVariablePlugin.md): createNodeVariablePlugin(opts): Plugin Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Plugin - [Function: createPlaygroundContainer](/auto-docs/free-layout-editor/functions/createPlaygroundContainer.md): createPlaygroundContainer(config?, parent?, container?): Container Parameters Returns Container - [Function: createPlaygroundLayerDefault](/auto-docs/free-layout-editor/functions/createPlaygroundLayerDefault.md): createPlaygroundLayerDefault(container, layerRegistry, options?): Layer Parameters Returns Layer - [Function: createPlaygroundPlugin](/auto-docs/free-layout-editor/functions/createPlaygroundPlugin.md): createPlaygroundPlugin(options): Plugin Type parameters Parameters Returns Plugin Example - [Function: createPlaygroundReactPreset](/auto-docs/free-layout-editor/functions/createPlaygroundReactPreset.md): createPlaygroundReactPreset(opts, plugins?): PluginsProvider Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns PluginsProvider - [Function: createPluginContextDefault](/auto-docs/free-layout-editor/functions/createPluginContextDefault.md): createPluginContextDefault(container): PluginContext Parameters Returns PluginContext - [Function: createRegistryDecorator](/auto-docs/free-layout-editor/functions/createRegistryDecorator.md): createRegistryDecorator(key, data, getValue?, init?): any Parameters Returns any - [Function: createShortcutsPlugin](/auto-docs/free-layout-editor/functions/createShortcutsPlugin.md): createShortcutsPlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariablePlugin](/auto-docs/free-layout-editor/functions/createVariablePlugin.md): createVariablePlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariableProviderPlugin](/auto-docs/free-layout-editor/functions/createVariableProviderPlugin.md): createVariableProviderPlugin(opts): FormPlugin Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns FormPlugin - [Function: deepFreeze](/auto-docs/free-layout-editor/functions/deepFreeze.md): deepFreeze(obj): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: defineFormPluginCreator](/auto-docs/free-layout-editor/functions/defineFormPluginCreator.md): defineFormPluginCreator(config): FormPluginCreator Type parameters Parameters Returns FormPluginCreator - [Function: definePluginCreator](/auto-docs/free-layout-editor/functions/definePluginCreator.md): definePluginCreator(config): PluginCreator Type parameters Parameters Returns PluginCreator - [Function: delay](/auto-docs/free-layout-editor/functions/delay.md): delay(ms, token?): Promise Parameters Returns Promise resolves after a specified number of milliseconds Throws cancelled if a given token is cancelled before a specified number of milliseconds - [Function: domReactToBounds](/auto-docs/free-layout-editor/functions/domReactToBounds.md): domReactToBounds(react): Rectangle Parameters Returns Rectangle - [Function: addClass](/auto-docs/free-layout-editor/functions/domUtils.addClass.md): domUtils.addClass addClass(element, ...classNames): void Parameters Returns void - [Function: addStandardDisposableListener](/auto-docs/free-layout-editor/functions/domUtils.addStandardDisposableListener.md): domUtils.addStandardDisposableListener addStandardDisposableListener(dom, type, listener, options?): Disposable Parameters Returns Disposable - [Function: classNameWithPrefix](/auto-docs/free-layout-editor/functions/domUtils.classNameWithPrefix.md): domUtils.classNameWithPrefix classNameWithPrefix(prefix): (key: string, opts?: any) => string Parameters Returns fn (key, opts?): string Parameters Returns string - [Function: clearChildren](/auto-docs/free-layout-editor/functions/domUtils.clearChildren.md): domUtils.clearChildren clearChildren(container): void Parameters Returns void - [Function: coverClass](/auto-docs/free-layout-editor/functions/domUtils.coverClass.md): domUtils.coverClass coverClass(element, ...classNames): void Parameters Returns void - [Function: createDOMCache](/auto-docs/free-layout-editor/functions/domUtils.createDOMCache.md): domUtils.createDOMCache createDOMCache(parent, className, children?): CacheManager dom 缓存 Type parameters Parameters Returns CacheManager - [Function: createDivWithClass](/auto-docs/free-layout-editor/functions/domUtils.createDivWithClass.md): domUtils.createDivWithClass createDivWithClass(...classNames): HTMLDivElement Parameters Returns HTMLDivElement - [Function: createElement](/auto-docs/free-layout-editor/functions/domUtils.createElement.md): domUtils.createElement createElement(ele, ...classNames): T Type parameters Parameters Returns T - [Function: delClass](/auto-docs/free-layout-editor/functions/domUtils.delClass.md): domUtils.delClass delClass(element, ...classNames): void Parameters Returns void - [Function: disableEvent](/auto-docs/free-layout-editor/functions/domUtils.disableEvent.md): domUtils.disableEvent disableEvent(element): void Parameters Returns void - [Function: enableEvent](/auto-docs/free-layout-editor/functions/domUtils.enableEvent.md): domUtils.enableEvent enableEvent(element): void Parameters Returns void - [Function: fromPercent](/auto-docs/free-layout-editor/functions/domUtils.fromPercent.md): domUtils.fromPercent fromPercent(percent): number Parameters Returns number - [Function: setStyle](/auto-docs/free-layout-editor/functions/domUtils.setStyle.md): domUtils.setStyle setStyle(node, styles): void Parameters Returns void - [Function: toPercent](/auto-docs/free-layout-editor/functions/domUtils.toPercent.md): domUtils.toPercent toPercent(percent): string Parameters Returns string - [Function: toPixel](/auto-docs/free-layout-editor/functions/domUtils.toPixel.md): domUtils.toPixel toPixel(num): string Parameters Returns string - [Function: translatePercent](/auto-docs/free-layout-editor/functions/domUtils.translatePercent.md): domUtils.translatePercent translatePercent(node, x, y): void Parameters Returns void - [Function: translateXPercent](/auto-docs/free-layout-editor/functions/domUtils.translateXPercent.md): domUtils.translateXPercent translateXPercent(node, x): void Parameters Returns void - [Function: translateYPercent](/auto-docs/free-layout-editor/functions/domUtils.translateYPercent.md): domUtils.translateYPercent translateYPercent(node, y): void Parameters Returns void - [Function: drawLineToBottom](/auto-docs/free-layout-editor/functions/drawLineToBottom.md): drawLineToBottom(transition): { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] Parameters Returns { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] - [Function: drawLineToNext](/auto-docs/free-layout-editor/functions/drawLineToNext.md): drawLineToNext(transition): { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] Parameters Returns { from: IPoint ; to: IPoint ; type: FlowTransitionLineEnum }[] - [Function: each](/auto-docs/free-layout-editor/functions/each.md): each(obj, fn): void Type parameters Parameters Returns void - [Function: filter](/auto-docs/free-layout-editor/functions/filter.md): filter(obj, fn, dest?): any Parameters Returns any - [Function: fitView](/auto-docs/free-layout-editor/functions/fitView.md): fitView(doc, playgroundConfig, easing?): Promise Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns Promise - [Function: generateLocalId](/auto-docs/free-layout-editor/functions/generateLocalId.md): generateLocalId(): LocalId Returns LocalId - [Function: getAntiOverlapPosition](/auto-docs/free-layout-editor/functions/getAntiOverlapPosition.md): getAntiOverlapPosition(doc, position, containerNode?): IPoint 获取没有碰撞的位置 距离很小时，xy 各偏移 30 Parameters Returns IPoint - [Function: getByKey](/auto-docs/free-layout-editor/functions/getByKey.md): getByKey(target, key): any | undefined Parameters Returns any | undefined Example - [Function: getDefaultSpacing](/auto-docs/free-layout-editor/functions/getDefaultSpacing.md): getDefaultSpacing(node, key, defaultSpacing?): any Parameters Returns any - [Function: getEntityDatasMetadata](/auto-docs/free-layout-editor/functions/getEntityDatasMetadata.md): getEntityDatasMetadata(layer): { data: EntityDataRegistry ; entity: EntityRegistry }[] Parameters Returns { data: EntityDataRegistry ; entity: EntityRegistry }[] - [Function: getEntityMetadata](/auto-docs/free-layout-editor/functions/getEntityMetadata.md): getEntityMetadata(layer): EntityRegistry[] Parameters Returns EntityRegistry[] - [Function: getLineCenter](/auto-docs/free-layout-editor/functions/getLineCenter.md): getLineCenter(from, to, bbox, linePadding): LineCenterPoint Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns LineCenterPoint - [Function: getNodeForm](/auto-docs/free-layout-editor/functions/getNodeForm.md): getNodeForm(node): NodeFormProps | undefined Use node.form instead Type parameters Parameters Returns NodeFormProps | undefined Deprecated - [Function: getNodePrivateScope](/auto-docs/free-layout-editor/functions/getNodePrivateScope.md): getNodePrivateScope(node): FlowNodeScope Use node.privateScope instead. Parameters Returns FlowNodeScope The private scope of the node. Deprecated - [Function: getNodeScope](/auto-docs/free-layout-editor/functions/getNodeScope.md): getNodeScope(node): FlowNodeScope Use node.scope instead. Parameters Returns FlowNodeScope The public scope of the node. Deprecated - [Function: getPortEntityId](/auto-docs/free-layout-editor/functions/getPortEntityId.md): getPortEntityId(node, portType, portID?): string Parameters Returns string - [Function: getPortEntityIdByNodeId](/auto-docs/free-layout-editor/functions/getPortEntityIdByNodeId.md): getPortEntityIdByNodeId(nodeId, portType, portID?): string Parameters Returns string - [Function: getRegistryMetadata](/auto-docs/free-layout-editor/functions/getRegistryMetadata.md): getRegistryMetadata(target, key): any[] Parameters Returns any[] - [Function: getTag](/auto-docs/free-layout-editor/functions/getTag.md): getTag(v): string Parameters Returns string - [Function: highlightFormItem](/auto-docs/free-layout-editor/functions/highlightFormItem.md): highlightFormItem(formItem, options?): HTMLDivElement | undefined Parameters Returns HTMLDivElement | undefined - [Function: inject](/auto-docs/free-layout-editor/functions/inject.md): inject(serviceIdentifier): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Type parameters Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Parameters Returns void - [Function: injectByProvider](/auto-docs/free-layout-editor/functions/injectByProvider.md): injectByProvider(provider): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectPlaygroundContext](/auto-docs/free-layout-editor/functions/injectPlaygroundContext.md): injectPlaygroundContext(): (target: any, propertyKey: string) => any Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectToAST](/auto-docs/free-layout-editor/functions/injectToAST.md): injectToAST(serviceIdentifier): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectable](/auto-docs/free-layout-editor/functions/injectable.md): injectable(): (target: T) => T Returns fn (target): T Type parameters Parameters Returns T - [Function: isCancelled](/auto-docs/free-layout-editor/functions/isCancelled.md): isCancelled(err): boolean Parameters Returns boolean - [Function: isEmpty](/auto-docs/free-layout-editor/functions/isEmpty.md): isEmpty(arg): boolean true if the argument is an empty object. Otherwise, false. Parameters Returns boolean - [Function: isFormMetaV2](/auto-docs/free-layout-editor/functions/isFormMetaV2.md): isFormMetaV2(formMeta): formMeta is FormMeta Parameters Returns formMeta is FormMeta - [Function: isFormModelV2](/auto-docs/free-layout-editor/functions/isFormModelV2.md): isFormModelV2(fm): fm is FormModel Parameters Returns fm is FormModel - [Function: isFormV2](/auto-docs/free-layout-editor/functions/isFormV2.md): isFormV2(node): boolean Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns boolean - [Function: isFunction](/auto-docs/free-layout-editor/functions/isFunction.md): isFunction(v): v is T Type parameters Parameters Returns v is T - [Function: isMatchAST](/auto-docs/free-layout-editor/functions/isMatchAST.md): isMatchAST(node?, targetType?): node is TargetASTNode isMatchAST is same as ASTMatch.is Type parameters Parameters Returns node is TargetASTNode - [Function: isNumber](/auto-docs/free-layout-editor/functions/isNumber.md): isNumber(v): v is number Parameters Returns v is number - [Function: isObject](/auto-docs/free-layout-editor/functions/isObject.md): isObject(v): v is UnknownObject Type parameters Parameters Returns v is UnknownObject - [Function: isPlainObject](/auto-docs/free-layout-editor/functions/isPlainObject.md): isPlainObject(obj): boolean Parameters Returns boolean True if the argument appears to be a plain object. - [Function: isString](/auto-docs/free-layout-editor/functions/isString.md): isString(v): v is string Parameters Returns v is string - [Function: iterToArray](/auto-docs/free-layout-editor/functions/iterToArray.md): iterToArray(iter): T[] Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T[] - [Function: lazyInject](/auto-docs/free-layout-editor/functions/lazyInject.md): lazyInject(serviceIdentifier): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: loadPlugins](/auto-docs/free-layout-editor/functions/loadPlugins.md): loadPlugins(plugins, container): void Parameters Returns void - [Function: mapKeys](/auto-docs/free-layout-editor/functions/mapKeys.md): mapKeys(obj, fn): any Type parameters Parameters Returns any - [Function: mapValues](/auto-docs/free-layout-editor/functions/mapValues.md): mapValues(obj, fn): any Type parameters Parameters Returns any - [Function: multiInject](/auto-docs/free-layout-editor/functions/multiInject.md): multiInject(serviceIdentifier): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Type parameters Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Parameters Returns void - [Function: named](/auto-docs/free-layout-editor/functions/named.md): named(name): (target: DecoratorTarget, targetKey?: string | symbol, indexOrPropertyDescriptor?: number | TypedPropertyDescriptor) => void Parameters Returns fn (target, targetKey?, indexOrPropertyDescriptor?): void Type parameters Parameters Returns void - [Function: nanoid](/auto-docs/free-layout-editor/functions/nanoid.md): nanoid(n?): string Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns string - [Function: notEmpty](/auto-docs/free-layout-editor/functions/notEmpty.md): notEmpty(arg): arg is T Type parameters Parameters Returns arg is T - [Function: observe](/auto-docs/free-layout-editor/functions/observe.md): observe(fc): React.FC Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns React.FC - [Function: observeEntities](/auto-docs/free-layout-editor/functions/observeEntities.md): observeEntities(registry): any 监听 entity 变化 Parameters Returns any - [Function: observeEntity](/auto-docs/free-layout-editor/functions/observeEntity.md): observeEntity(registry): any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns any - [Function: observeEntityDatas](/auto-docs/free-layout-editor/functions/observeEntityDatas.md): observeEntityDatas(entityRegistry, dataRegistry): any 监听 entity 对应的 data 数据变化 Parameters Returns any - [Function: omit](/auto-docs/free-layout-editor/functions/omit.md): omit(obj, fields, dest?): any Parameters Returns any - [Function: pick](/auto-docs/free-layout-editor/functions/pick.md): pick(obj, fields, dest?): any Parameters Returns any - [Function: postConstruct](/auto-docs/free-layout-editor/functions/postConstruct.md): postConstruct(): (target: { constructor: NewableFunction }, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: postConstructAST](/auto-docs/free-layout-editor/functions/postConstructAST.md): postConstructAST(): (target: any, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: reduce](/auto-docs/free-layout-editor/functions/reduce.md): reduce(obj, fn, res?): R Type parameters Parameters Returns R - [Function: registerNodeMaterial](/auto-docs/free-layout-editor/functions/registerNodeMaterial.md): registerNodeMaterial(«destructured»): void Parameters Returns void - [Function: removeInjectedProperties](/auto-docs/free-layout-editor/functions/removeInjectedProperties.md): removeInjectedProperties(instance): void 在 rspack 场景编译ts文件时候 decorator 注入的 property 会被当成 this 的属性, 导致 Reflect.metadata 失效 Parameters Returns void - [Function: requestWithMemo](/auto-docs/free-layout-editor/functions/requestWithMemo.md): requestWithMemo(req, cacheTime?, createCacheKey?): RequestFn Parameters Returns RequestFn - [Function: retry](/auto-docs/free-layout-editor/functions/retry.md): retry(task, delayTime, retries, shouldRetry?): Promise Type parameters Parameters Returns Promise - [Function: safeKey](/auto-docs/free-layout-editor/functions/safeKey.md): safeKey(key): string filter dangerous key, prevent prototype pollution injection Parameters Returns string filtered key - [Function: scrollIntoViewWithTween](/auto-docs/free-layout-editor/functions/scrollIntoViewWithTween.md): scrollIntoViewWithTween(opts): Disposable 滚动到可视区域 Parameters Returns Disposable - [Function: setByKey](/auto-docs/free-layout-editor/functions/setByKey.md): setByKey(target, key, newValue, autoCreateObject?, clone?): any Parameters Returns any Example - [Function: _setIdx](/auto-docs/free-layout-editor/functions/setIdx.md): _setIdx(idx): void Parameters Returns void - [Function: startTween](/auto-docs/free-layout-editor/functions/startTween.md): startTween(opts): Disposable Type parameters Parameters Returns Disposable - [Function: useAutoLayout](/auto-docs/free-layout-editor/functions/useAutoLayout.md): useAutoLayout(): (options: LayoutOptions) => Promise Returns fn (options?): Promise Parameters Returns Promise - [Function: useAvailableVariables](/auto-docs/free-layout-editor/functions/useAvailableVariables.md): useAvailableVariables(): VariableDeclaration[] Get available variable list in the current scope. If no scope, return global variable list.The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useBaseColor](/auto-docs/free-layout-editor/functions/useBaseColor.md): useBaseColor(): Object Returns Object - [Function: useClientContext](/auto-docs/free-layout-editor/functions/useClientContext.md): useClientContext(): FreeLayoutPluginContext Returns FreeLayoutPluginContext - [Function: useConfigEntity](/auto-docs/free-layout-editor/functions/useConfigEntity.md): useConfigEntity(entityRegistry, listenChange?): T 获取 config entity Type parameters Parameters Returns T - [Function: useCurrentDomNode](/auto-docs/free-layout-editor/functions/useCurrentDomNode.md): useCurrentDomNode(): HTMLDivElement 获取当前渲染的 dom 节点 Returns HTMLDivElement - [Function: useCurrentEntity](/auto-docs/free-layout-editor/functions/useCurrentEntity.md): useCurrentEntity(): WorkflowNodeEntity 获取当前节点 Returns WorkflowNodeEntity - [Function: useCurrentField](/auto-docs/free-layout-editor/functions/useCurrentField.md): useCurrentField(): IField | IFieldArray Get the current Field. It should be used in a child component of , otherwise it throws an error Type parameters Returns IField | IFieldArray - [Function: useCurrentFieldState](/auto-docs/free-layout-editor/functions/useCurrentFieldState.md): useCurrentFieldState(): FieldState Get the current field state. It should be used in a child component of , otherwise it throws an error Returns FieldState - [Function: useCurrentScope](/auto-docs/free-layout-editor/functions/useCurrentScope.md): useCurrentScope(params?): Strict extends true ? Scope> : undefined | Scope> useCurrentScope returns the scope provided by ScopeProvider. Type parameters Parameters Returns Strict extends true ? Scope> : undefined | Scope> - [Function: useEntities](/auto-docs/free-layout-editor/functions/useEntities.md): useEntities(entityRegistry): T[] 获取 entities 并监听变化 Type parameters Parameters Returns T[] Deprecated - [Function: useEntityDataFromContext](/auto-docs/free-layout-editor/functions/useEntityDataFromContext.md): useEntityDataFromContext(dataRegistry, listenChange?): T 从上下 PlaygroundEntityContext 获取 entity data 并监听变化 (默认不监听) Type parameters Parameters Returns T - [Function: useEntityFromContext](/auto-docs/free-layout-editor/functions/useEntityFromContext.md): useEntityFromContext(listenChange?): T 从上下 PlaygroundEntityContext 获取 entity 并监听变化(默认不监听) Type parameters Parameters Returns T - [Function: useField](/auto-docs/free-layout-editor/functions/useField.md): useField(name?): TField | undefined Type parameters Parameters Returns TField | undefined Deprecated useField is deprecated because its return relies on React render. if the Field is not rendered, the return would be undefined. If you simply want to monitor the change of the value of a certain path, please use useWatch(fieldName) - [Function: useFieldValidate](/auto-docs/free-layout-editor/functions/useFieldValidate.md): useFieldValidate(name?): () => void Get validate method of a field with given name. the returned function could possibly do nothing if the field is not found. The reason could be that the field is not rendered yet or the name given is wrong. Parameters Returns fn (): void Returns void - [Function: useFlowEditor](/auto-docs/free-layout-editor/functions/useFlowEditor.md): useFlowEditor(): FlowEditorClient Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Returns FlowEditorClient - [Function: useForm](/auto-docs/free-layout-editor/functions/useForm.md): useForm(): IForm Get Form instance. It should be use in a child component of Returns IForm - [Function: useHighlight](/auto-docs/free-layout-editor/functions/useHighlight.md): useHighlight(props): React.MutableRefObject | null Parameters Returns React.MutableRefObject | null - [Function: useInitializedFormModel](/auto-docs/free-layout-editor/functions/useInitializedFormModel.md): useInitializedFormModel(node): FormModel Listen to FormModel's initialization and refresh React component. By providing related node, you can use this hook outside the Form Component. Parameters Returns FormModel - [Function: useListenEvents](/auto-docs/free-layout-editor/functions/useListenEvents.md): useListenEvents(...events): void 监听 event 事件变化 Parameters Returns void - [Function: useNodeRender](/auto-docs/free-layout-editor/functions/useNodeRender.md): useNodeRender(nodeFromProps?): NodeRenderReturnType Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns NodeRenderReturnType - [Function: useObserve](/auto-docs/free-layout-editor/functions/useObserve.md): useObserve(value): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: useOutputVariables](/auto-docs/free-layout-editor/functions/useOutputVariables.md): useOutputVariables(): VariableDeclaration[] Get output variable list in the current scope. The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: usePlayground](/auto-docs/free-layout-editor/functions/usePlayground.md): usePlayground(): Playground 获取 playground Returns Playground - [Function: usePlaygroundContainer](/auto-docs/free-layout-editor/functions/usePlaygroundContainer.md): usePlaygroundContainer(): Container 获取 playground inversify container Returns Container - [Function: usePlaygroundContext](/auto-docs/free-layout-editor/functions/usePlaygroundContext.md): usePlaygroundContext(): T 获取 playground context 数据 Type parameters Returns T - [Function: usePlaygroundDrag](/auto-docs/free-layout-editor/functions/usePlaygroundDrag.md): usePlaygroundDrag(): UsePlaygroundDragReturn Returns UsePlaygroundDragReturn - [Function: usePlaygroundReadonlyState](/auto-docs/free-layout-editor/functions/usePlaygroundReadonlyState.md): usePlaygroundReadonlyState(listenChange?): boolean 获取 readonly 状态 Parameters Returns boolean - [Function: usePlaygroundTools](/auto-docs/free-layout-editor/functions/usePlaygroundTools.md): usePlaygroundTools(props?): PlaygroundTools Parameters Returns PlaygroundTools - [Function: useReactiveState](/auto-docs/free-layout-editor/functions/useReactiveState.md): useReactiveState(v): T Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T - [Function: useReadonlyReactiveState](/auto-docs/free-layout-editor/functions/useReadonlyReactiveState.md): useReadonlyReactiveState(state): Readonly Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns Readonly - [Function: useRefresh](/auto-docs/free-layout-editor/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (v?): void Parameters Returns void - [Function: useScopeAvailable](/auto-docs/free-layout-editor/functions/useScopeAvailable.md): useScopeAvailable(params?): ScopeAvailableData Get the available variables in the current scope. 获取作用域的可访问变量 Parameters Returns ScopeAvailableData the available variables in the current scope - [Function: useService](/auto-docs/free-layout-editor/functions/useService.md): useService(identifier): T 获取画布的 IOC 模块 Type parameters Parameters Returns T - [Function: useUndoRedo](/auto-docs/free-layout-editor/functions/useUndoRedo.md): useUndoRedo(): UndoRedo Returns UndoRedo - [Function: useWatch](/auto-docs/free-layout-editor/functions/useWatch.md): useWatch(name): TValue Listen to the field data change and refresh the React component. Type parameters Parameters Returns TValue - [Function: useWatchFormErrors](/auto-docs/free-layout-editor/functions/useWatchFormErrors.md): useWatchFormErrors(node): Errors | undefined Get Form's errors, Form errors is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Errors | undefined - [Function: useWatchFormState](/auto-docs/free-layout-editor/functions/useWatchFormState.md): useWatchFormState(node): FormState | undefined Get Form's state, Form State is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns FormState | undefined - [Function: useWatchFormValueIn](/auto-docs/free-layout-editor/functions/useWatchFormValueIn.md): useWatchFormValueIn(node, name): T | undefined Listen to Form's value in a certain path and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormValues](/auto-docs/free-layout-editor/functions/useWatchFormValues.md): useWatchFormValues(node): T | undefined Listen to Form's values and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormWarnings](/auto-docs/free-layout-editor/functions/useWatchFormWarnings.md): useWatchFormWarnings(node): Warnings | undefined Get Form's warnings, Form warnings is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Warnings | undefined - [Function: useWorkflowDocument](/auto-docs/free-layout-editor/functions/useWorkflowDocument.md): useWorkflowDocument(): WorkflowDocument Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Returns WorkflowDocument - [Function: values](/auto-docs/free-layout-editor/functions/values.md): values(obj): any[] Parameters Returns any[] - [Interface: ASTNodeJSON](/auto-docs/free-layout-editor/interfaces/ASTNodeJSON.md): ASTNodeJSON is the JSON representation of an ASTNode. - [Interface: ASTNodeRegistry](/auto-docs/free-layout-editor/interfaces/ASTNodeRegistry.md) - [Interface: AddBlockConfig](/auto-docs/free-layout-editor/interfaces/AddBlockConfig.md): 添加block时的配置 - [Interface: AddBlockOperation](/auto-docs/free-layout-editor/interfaces/AddBlockOperation.md) - [Interface: AddChildNodeOperation](/auto-docs/free-layout-editor/interfaces/AddChildNodeOperation.md) - [Interface: AddFromNodeOperation](/auto-docs/free-layout-editor/interfaces/AddFromNodeOperation.md) - [Interface: AddLineOperation](/auto-docs/free-layout-editor/interfaces/AddLineOperation.md): 操作 - [Interface: AddNodeOperation](/auto-docs/free-layout-editor/interfaces/AddNodeOperation.md) - [Interface: AddNodesOperation](/auto-docs/free-layout-editor/interfaces/AddNodesOperation.md) - [Interface: AddOrDeleteBlockValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteBlockValue.md) - [Interface: AddOrDeleteChildNodeValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteChildNodeValue.md) - [Interface: AddOrDeleteFromNodeOperationValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteFromNodeOperationValue.md) - [Interface: AddOrDeleteLineOperationValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteLineOperationValue.md) - [Interface: AddOrDeleteNodeOperationValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteNodeOperationValue.md) - [Interface: AddOrDeleteNodeValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteNodeValue.md) - [Interface: AddOrDeleteNodesOperationValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteNodesOperationValue.md) - [Interface: AddOrDeleteWorkflowNodeOperationValue](/auto-docs/free-layout-editor/interfaces/AddOrDeleteWorkflowNodeOperationValue.md) - [Interface: AddWorkflowNodeOperation](/auto-docs/free-layout-editor/interfaces/AddWorkflowNodeOperation.md): 操作 - [Interface: AdderProps](/auto-docs/free-layout-editor/interfaces/AdderProps.md) - [Interface: AsClass](/auto-docs/free-layout-editor/interfaces/AsClass.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheManager](/auto-docs/free-layout-editor/interfaces/CacheManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheOpts](/auto-docs/free-layout-editor/interfaces/CacheOpts.md) - [Interface: CacheOriginItem](/auto-docs/free-layout-editor/interfaces/CacheOriginItem.md) - [Interface: CancellationToken](/auto-docs/free-layout-editor/interfaces/CancellationToken-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ChangeLineDataOperation](/auto-docs/free-layout-editor/interfaces/ChangeLineDataOperation.md): 操作 - [Interface: ChangeLineDataValue](/auto-docs/free-layout-editor/interfaces/ChangeLineDataValue.md) - [Interface: ChangeNodeDataValue](/auto-docs/free-layout-editor/interfaces/ChangeNodeDataValue.md) - [Interface: ClipboardService](/auto-docs/free-layout-editor/interfaces/ClipboardService.md) - [Interface: CollapseAdderProps](/auto-docs/free-layout-editor/interfaces/CollapseAdderProps.md) - [Interface: CollapseProps](/auto-docs/free-layout-editor/interfaces/CollapseProps.md) - [Interface: CollisionRetType](/auto-docs/free-layout-editor/interfaces/CollisionRetType.md) - [Interface: Command](/auto-docs/free-layout-editor/interfaces/Command-1.md) - [Interface: CommandService](/auto-docs/free-layout-editor/interfaces/CommandService.md): command service 执行接口 - [Interface: ConfigEntityProps](/auto-docs/free-layout-editor/interfaces/ConfigEntityProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ContentChangeTypeToOperation](/auto-docs/free-layout-editor/interfaces/ContentChangeTypeToOperation.md) - [Interface: ContributionProvider](/auto-docs/free-layout-editor/interfaces/ContributionProvider.md) - [Interface: CreateASTParams](/auto-docs/free-layout-editor/interfaces/CreateASTParams.md) - [Interface: CreateGroupOperation](/auto-docs/free-layout-editor/interfaces/CreateGroupOperation.md) - [Interface: CustomLabelProps](/auto-docs/free-layout-editor/interfaces/CustomLabelProps.md) - [Interface: CustomTypeJSON](/auto-docs/free-layout-editor/interfaces/CustomTypeJSON.md): ASTNodeJSON representation of CustomType - [Interface: DOMCache](/auto-docs/free-layout-editor/interfaces/DOMCache.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: DeleteBlockOperation](/auto-docs/free-layout-editor/interfaces/DeleteBlockOperation.md) - [Interface: DeleteChildNodeOperation](/auto-docs/free-layout-editor/interfaces/DeleteChildNodeOperation.md) - [Interface: DeleteFromNodeOperation](/auto-docs/free-layout-editor/interfaces/DeleteFromNodeOperation.md) - [Interface: DeleteLineOperation](/auto-docs/free-layout-editor/interfaces/DeleteLineOperation.md): 操作 - [Interface: DeleteNodeOperation](/auto-docs/free-layout-editor/interfaces/DeleteNodeOperation.md) - [Interface: DeleteNodesOperation](/auto-docs/free-layout-editor/interfaces/DeleteNodesOperation.md) - [Interface: DeleteWorkflowNodeOperation](/auto-docs/free-layout-editor/interfaces/DeleteWorkflowNodeOperation.md): 操作 - [Interface: Disposable](/auto-docs/free-layout-editor/interfaces/Disposable-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: DragNodeOperationValue](/auto-docs/free-layout-editor/interfaces/DragNodeOperationValue.md) - [Interface: DragNodeProps](/auto-docs/free-layout-editor/interfaces/DragNodeProps.md) - [Interface: EditorPluginContext](/auto-docs/free-layout-editor/interfaces/EditorPluginContext.md) - [Interface: EditorProps](/auto-docs/free-layout-editor/interfaces/EditorProps-1.md) - [Interface: EditorState](/auto-docs/free-layout-editor/interfaces/EditorState-1.md): 编辑态 - [Interface: EditorStateChangeEvent](/auto-docs/free-layout-editor/interfaces/EditorStateChangeEvent.md) - [Interface: EffectFuncProps](/auto-docs/free-layout-editor/interfaces/EffectFuncProps.md) - [Interface: EntityDataChangedEvent](/auto-docs/free-layout-editor/interfaces/EntityDataChangedEvent.md) - [Interface: EntityDataRegistry](/auto-docs/free-layout-editor/interfaces/EntityDataRegistry.md) - [Interface: EntityDataType](/auto-docs/free-layout-editor/interfaces/EntityDataType.md) - [Interface: EntityJSON](/auto-docs/free-layout-editor/interfaces/EntityJSON.md): 持久化数据 - [Interface: EntityManagerContribution](/auto-docs/free-layout-editor/interfaces/EntityManagerContribution.md) - [Interface: EntityOpts](/auto-docs/free-layout-editor/interfaces/EntityOpts.md) - [Interface: EntityRegistry](/auto-docs/free-layout-editor/interfaces/EntityRegistry.md): 注册类 - [Interface: EnumerateExpressionJSON](/auto-docs/free-layout-editor/interfaces/EnumerateExpressionJSON.md): ASTNodeJSON representation of EnumerateExpression - [Interface: Event](/auto-docs/free-layout-editor/interfaces/Event-1.md) - [Interface: EventListener](/auto-docs/free-layout-editor/interfaces/EventListener.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FieldArrayRenderProps](/auto-docs/free-layout-editor/interfaces/FieldArrayRenderProps.md) - [Interface: FieldRenderProps](/auto-docs/free-layout-editor/interfaces/FieldRenderProps.md) - [Interface: FieldState](/auto-docs/free-layout-editor/interfaces/FieldState.md) - [Interface: FlipSchema](/auto-docs/free-layout-editor/interfaces/FlipSchema.md) - [Interface: Flow](/auto-docs/free-layout-editor/interfaces/Flow.md) - [Interface: FlowDocumentContribution](/auto-docs/free-layout-editor/interfaces/FlowDocumentContribution.md) - [Interface: FlowDocumentOptions](/auto-docs/free-layout-editor/interfaces/FlowDocumentOptions.md): 流程画布配置 - [Interface: FlowDragOptions](/auto-docs/free-layout-editor/interfaces/FlowDragOptions.md) - [Interface: FlowGroupJSON](/auto-docs/free-layout-editor/interfaces/FlowGroupJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowLayout](/auto-docs/free-layout-editor/interfaces/FlowLayout.md): 流程布局算法 - [Interface: FlowLayoutContribution](/auto-docs/free-layout-editor/interfaces/FlowLayoutContribution.md) - [Interface: FlowNodeEntityConfig](/auto-docs/free-layout-editor/interfaces/FlowNodeEntityConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FlowNodeInitData](/auto-docs/free-layout-editor/interfaces/FlowNodeInitData.md) - [Interface: FlowNodeJSON](/auto-docs/free-layout-editor/interfaces/FlowNodeJSON.md): Flow node json data - [Interface: FlowNodeMeta](/auto-docs/free-layout-editor/interfaces/FlowNodeMeta.md): 节点渲染相关配置信息，可扩展 - [Interface: FlowNodeRegistry](/auto-docs/free-layout-editor/interfaces/FlowNodeRegistry-1.md): 节点注册 - [Interface: FlowNodeRenderSchema](/auto-docs/free-layout-editor/interfaces/FlowNodeRenderSchema.md) - [Interface: FlowNodeScope](/auto-docs/free-layout-editor/interfaces/FlowNodeScope.md): Represents a scope associated with a flow node. - [Interface: FlowNodeScopeMeta](/auto-docs/free-layout-editor/interfaces/FlowNodeScopeMeta.md): Metadata for a flow node scope. - [Interface: FlowNodeTransformSchema](/auto-docs/free-layout-editor/interfaces/FlowNodeTransformSchema.md) - [Interface: FlowNodeTransitionSchema](/auto-docs/free-layout-editor/interfaces/FlowNodeTransitionSchema.md) - [Interface: FlowNodesTransformLayerOptions](/auto-docs/free-layout-editor/interfaces/FlowNodesTransformLayerOptions.md) - [Interface: FlowOperationBaseService](/auto-docs/free-layout-editor/interfaces/FlowOperationBaseService.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: FlowRendererComponent](/auto-docs/free-layout-editor/interfaces/FlowRendererComponent.md) - [Interface: FlowRendererContribution](/auto-docs/free-layout-editor/interfaces/FlowRendererContribution.md) - [Interface: FlowSelectorBoundsLayerOptions](/auto-docs/free-layout-editor/interfaces/FlowSelectorBoundsLayerOptions.md) - [Interface: FlowSelectorBoxOptions](/auto-docs/free-layout-editor/interfaces/FlowSelectorBoxOptions.md) - [Interface: FlowTransitionLabel](/auto-docs/free-layout-editor/interfaces/FlowTransitionLabel.md) - [Interface: FlowTransitionLine](/auto-docs/free-layout-editor/interfaces/FlowTransitionLine.md) - [Interface: NodeInfo](/auto-docs/free-layout-editor/interfaces/FlowVirtualTree.NodeInfo.md): FlowVirtualTree.NodeInfo - [Interface: FocusNodeFormItemOptions](/auto-docs/free-layout-editor/interfaces/FocusNodeFormItemOptions.md) - [Interface: FormControl](/auto-docs/free-layout-editor/interfaces/FormControl.md) - [Interface: FormMeta](/auto-docs/free-layout-editor/interfaces/FormMeta.md) - [Interface: FormPluginConfig](/auto-docs/free-layout-editor/interfaces/FormPluginConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FormRenderProps](/auto-docs/free-layout-editor/interfaces/FormRenderProps.md) - [Interface: FormState](/auto-docs/free-layout-editor/interfaces/FormState.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FreeHistoryPluginOptions](/auto-docs/free-layout-editor/interfaces/FreeHistoryPluginOptions.md): 插件配置 - [Interface: FreeLayoutPluginContext](/auto-docs/free-layout-editor/interfaces/FreeLayoutPluginContext.md) - [Interface: FreeLayoutPluginTools](/auto-docs/free-layout-editor/interfaces/FreeLayoutPluginTools.md) - [Interface: FreeLayoutProps](/auto-docs/free-layout-editor/interfaces/FreeLayoutProps-1.md): Free layout configuration 自由布局配置 - [Interface: GlobalEventActionType](/auto-docs/free-layout-editor/interfaces/GlobalEventActionType.md): Global event action type. Global event might be dispatched from ASTNode or Scope. - [Interface: HighLightOptions](/auto-docs/free-layout-editor/interfaces/HighLightOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryItem](/auto-docs/free-layout-editor/interfaces/HistoryItem.md) - [Interface: HistoryOperation](/auto-docs/free-layout-editor/interfaces/HistoryOperation.md): 操作历史 - [Interface: HistoryPluginOptions](/auto-docs/free-layout-editor/interfaces/HistoryPluginOptions.md) - [Interface: HistoryRecord](/auto-docs/free-layout-editor/interfaces/HistoryRecord.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryStackAddEvent](/auto-docs/free-layout-editor/interfaces/HistoryStackAddEvent.md): 添加历史事件 - [Interface: HistoryStackAddOperationEvent](/auto-docs/free-layout-editor/interfaces/HistoryStackAddOperationEvent.md): 添加操作事件 - [Interface: HistoryStackBaseEvent](/auto-docs/free-layout-editor/interfaces/HistoryStackBaseEvent.md): 历史栈变化事件基础 - [Interface: HistoryStackItem](/auto-docs/free-layout-editor/interfaces/HistoryStackItem.md) - [Interface: HistoryStackUpdateEvent](/auto-docs/free-layout-editor/interfaces/HistoryStackUpdateEvent.md): 更新历史事件 - [Interface: HistoryStackUpdateOperationEvent](/auto-docs/free-layout-editor/interfaces/HistoryStackUpdateOperationEvent.md): 更新操作事件 - [Interface: HoverPosition](/auto-docs/free-layout-editor/interfaces/HoverPosition.md) - [Interface: I18nLanguage](/auto-docs/free-layout-editor/interfaces/I18nLanguage.md) - [Interface: I18nPluginOptions](/auto-docs/free-layout-editor/interfaces/I18nPluginOptions.md) - [Interface: IField](/auto-docs/free-layout-editor/interfaces/IField.md): Field render model, it's only available when Field is rendered - [Interface: IFieldArray](/auto-docs/free-layout-editor/interfaces/IFieldArray.md): FieldArray render model, it's only available when FieldArray is rendered - [Interface: IForm](/auto-docs/free-layout-editor/interfaces/IForm.md) - [Interface: IHandler](/auto-docs/free-layout-editor/interfaces/IHandler.md) - [Interface: IHistoryManager](/auto-docs/free-layout-editor/interfaces/IHistoryManager.md): 历史服务管理 - [Interface: IHistoryService](/auto-docs/free-layout-editor/interfaces/IHistoryService.md): 历史服务 - [Interface: IOperationRegistry](/auto-docs/free-layout-editor/interfaces/IOperationRegistry.md): 操作注册 - [Interface: IOperationService](/auto-docs/free-layout-editor/interfaces/IOperationService.md) - [Interface: IPoint](/auto-docs/free-layout-editor/interfaces/IPoint.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: IUndoRedoElement](/auto-docs/free-layout-editor/interfaces/IUndoRedoElement.md): UndoRedo元素 - [Interface: IUndoRedoService](/auto-docs/free-layout-editor/interfaces/IUndoRedoService.md): UndoRedo服务 - [Interface: IVariableTable](/auto-docs/free-layout-editor/interfaces/IVariableTable.md): Interface for a variable table. - [Interface: KeyPathExpressionJSON](/auto-docs/free-layout-editor/interfaces/KeyPathExpressionJSON.md): ASTNodeJSON representation of KeyPathExpression - [Interface: LayerEntitiesSelector](/auto-docs/free-layout-editor/interfaces/LayerEntitiesSelector.md) - [Interface: LayerOptions](/auto-docs/free-layout-editor/interfaces/LayerOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: LayerRegistry

](/auto-docs/free-layout-editor/interfaces/LayerRegistry.md) - [Interface: LineCenterPoint](/auto-docs/free-layout-editor/interfaces/LineCenterPoint.md) - [Interface: LineColor](/auto-docs/free-layout-editor/interfaces/LineColor.md) - [Interface: LineEventProps](/auto-docs/free-layout-editor/interfaces/LineEventProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: LinePoint](/auto-docs/free-layout-editor/interfaces/LinePoint.md) - [Interface: LinePosition](/auto-docs/free-layout-editor/interfaces/LinePosition.md) - [Interface: ListNodeJSON](/auto-docs/free-layout-editor/interfaces/ListNodeJSON.md): ASTNodeJSON representation of ListNode - [Interface: LoggerProps](/auto-docs/free-layout-editor/interfaces/LoggerProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: MapNodeJSON](/auto-docs/free-layout-editor/interfaces/MapNodeJSON.md): ASTNodeJSON representation of MapNode - [Interface: MoveBlockOperation](/auto-docs/free-layout-editor/interfaces/MoveBlockOperation.md) - [Interface: MoveChildNodesOperation](/auto-docs/free-layout-editor/interfaces/MoveChildNodesOperation.md) - [Interface: MoveChildNodesOperationValue](/auto-docs/free-layout-editor/interfaces/MoveChildNodesOperationValue.md) - [Interface: MoveNodeConfig](/auto-docs/free-layout-editor/interfaces/MoveNodeConfig.md): 移动节点时的配置 - [Interface: MoveNodeOperation](/auto-docs/free-layout-editor/interfaces/MoveNodeOperation.md): 操作 - [Interface: MoveNodeOperationValue](/auto-docs/free-layout-editor/interfaces/MoveNodeOperationValue.md) - [Interface: MoveNodesOperation](/auto-docs/free-layout-editor/interfaces/MoveNodesOperation.md) - [Interface: MoveNodesOperationValue](/auto-docs/free-layout-editor/interfaces/MoveNodesOperationValue.md) - [Interface: Node](/auto-docs/free-layout-editor/interfaces/Node.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeCorePluginOptions](/auto-docs/free-layout-editor/interfaces/NodeCorePluginOptions.md) - [Interface: NodeEngineMaterialOptions](/auto-docs/free-layout-editor/interfaces/NodeEngineMaterialOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeFormProps](/auto-docs/free-layout-editor/interfaces/NodeFormProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodePostionUpdateEvent](/auto-docs/free-layout-editor/interfaces/NodePostionUpdateEvent.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeRenderProps](/auto-docs/free-layout-editor/interfaces/NodeRenderProps.md) - [Interface: NodeRenderReturnType](/auto-docs/free-layout-editor/interfaces/NodeRenderReturnType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeSchema](/auto-docs/free-layout-editor/interfaces/NodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodesDragEndEvent](/auto-docs/free-layout-editor/interfaces/NodesDragEndEvent.md) - [Interface: NodesDragStartEvent](/auto-docs/free-layout-editor/interfaces/NodesDragStartEvent.md) - [Interface: NodesDraggingEvent](/auto-docs/free-layout-editor/interfaces/NodesDraggingEvent.md) - [Interface: ObjectJSON](/auto-docs/free-layout-editor/interfaces/ObjectJSON.md): ASTNodeJSON representation of ObjectType - [Interface: Observer](/auto-docs/free-layout-editor/interfaces/Observer.md): An object interface that defines a set of callback functions a user can use to get notified of any set of Observable guide/glossary-and-semantics#notification notification events. For more info, please refer to guide/observer this guide. - [Interface: OnNodeAddEvent](/auto-docs/free-layout-editor/interfaces/OnNodeAddEvent.md): 节点添加事件 - [Interface: OnNodeMoveEvent](/auto-docs/free-layout-editor/interfaces/OnNodeMoveEvent.md): 节点移动事件 - [Interface: Operation](/auto-docs/free-layout-editor/interfaces/Operation.md): 操作 - [Interface: OperationContribution](/auto-docs/free-layout-editor/interfaces/OperationContribution.md) - [Interface: OperationMeta](/auto-docs/free-layout-editor/interfaces/OperationMeta.md): 操作元数据 - [Interface: OriginSchema](/auto-docs/free-layout-editor/interfaces/OriginSchema.md) - [Interface: PaddingSchema](/auto-docs/free-layout-editor/interfaces/PaddingSchema-1.md) - [Interface: PipelineDimension](/auto-docs/free-layout-editor/interfaces/PipelineDimension.md) - [Interface: PipelineEntities](/auto-docs/free-layout-editor/interfaces/PipelineEntities.md): 注入到 Layer 中的实体选择器 - [Interface: PipelineEventRegsiter](/auto-docs/free-layout-editor/interfaces/PipelineEventRegsiter.md) - [Interface: PlaygroundConfig](/auto-docs/free-layout-editor/interfaces/PlaygroundConfig.md): 画布配置 - [Interface: PlaygroundConfigEntityData](/auto-docs/free-layout-editor/interfaces/PlaygroundConfigEntityData.md) - [Interface: PlaygroundConfigRevealOpts](/auto-docs/free-layout-editor/interfaces/PlaygroundConfigRevealOpts.md) - [Interface: PlaygroundContainerFactory](/auto-docs/free-layout-editor/interfaces/PlaygroundContainerFactory.md) - [Interface: PlaygroundContribution](/auto-docs/free-layout-editor/interfaces/PlaygroundContribution.md) - [Interface: PlaygroundDragEntitiesOpts](/auto-docs/free-layout-editor/interfaces/PlaygroundDragEntitiesOpts.md) - [Interface: PlaygroundDragEvent](/auto-docs/free-layout-editor/interfaces/PlaygroundDragEvent.md) - [Interface: PlaygroundDragOptions](/auto-docs/free-layout-editor/interfaces/PlaygroundDragOptions.md) - [Interface: PlaygroundLayerOptions](/auto-docs/free-layout-editor/interfaces/PlaygroundLayerOptions.md) - [Interface: PlaygroundReactProviderProps](/auto-docs/free-layout-editor/interfaces/PlaygroundReactProviderProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PlaygroundReactRendererProps](/auto-docs/free-layout-editor/interfaces/PlaygroundReactRendererProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PlaygroundTools](/auto-docs/free-layout-editor/interfaces/PlaygroundTools.md) - [Interface: PluginBindConfig](/auto-docs/free-layout-editor/interfaces/PluginBindConfig.md) - [Interface: PluginConfig](/auto-docs/free-layout-editor/interfaces/PluginConfig.md) - [Interface: PluginContext](/auto-docs/free-layout-editor/interfaces/PluginContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PluginsProvider](/auto-docs/free-layout-editor/interfaces/PluginsProvider.md) - [Interface: PositionSchema](/auto-docs/free-layout-editor/interfaces/PositionSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PromisePoolOpts](/auto-docs/free-layout-editor/interfaces/PromisePoolOpts.md) - [Interface: PromiseTask](/auto-docs/free-layout-editor/interfaces/PromiseTask.md) - [Interface: PushOperationOptions](/auto-docs/free-layout-editor/interfaces/PushOperationOptions.md): push操作配置 - [Interface: RegistryInit](/auto-docs/free-layout-editor/interfaces/RegistryInit.md) - [Interface: RegistryValueGetter](/auto-docs/free-layout-editor/interfaces/RegistryValueGetter.md) - [Interface: ResetLayoutOperationValue](/auto-docs/free-layout-editor/interfaces/ResetLayoutOperationValue.md) - [Interface: ScaleSchema](/auto-docs/free-layout-editor/interfaces/ScaleSchema.md) - [Interface: SchemaDecoration](/auto-docs/free-layout-editor/interfaces/SchemaDecoration-1.md) - [Interface: ScrollBarEvents](/auto-docs/free-layout-editor/interfaces/ScrollBarEvents.md) - [Interface: ScrollBarOptions](/auto-docs/free-layout-editor/interfaces/ScrollBarOptions.md) - [Interface: ScrollIntoViewOpts](/auto-docs/free-layout-editor/interfaces/ScrollIntoViewOpts.md) - [Interface: ScrollSchema](/auto-docs/free-layout-editor/interfaces/ScrollSchema.md) - [Interface: SelectorBoxConfigData](/auto-docs/free-layout-editor/interfaces/SelectorBoxConfigData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: SelectorBoxPopoverProps](/auto-docs/free-layout-editor/interfaces/SelectorBoxPopoverProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ShadowSchema](/auto-docs/free-layout-editor/interfaces/ShadowSchema.md) - [Interface: ShortCache](/auto-docs/free-layout-editor/interfaces/ShortCache.md) - [Interface: ShortcutsContribution](/auto-docs/free-layout-editor/interfaces/ShortcutsContribution.md) - [Interface: ShortcutsHandler](/auto-docs/free-layout-editor/interfaces/ShortcutsHandler.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: SizeSchema](/auto-docs/free-layout-editor/interfaces/SizeSchema-1.md) - [Interface: SkewSchema](/auto-docs/free-layout-editor/interfaces/SkewSchema.md) - [Interface: StackContextManagerOptions](/auto-docs/free-layout-editor/interfaces/StackContextManagerOptions.md) - [Interface: StackingContext](/auto-docs/free-layout-editor/interfaces/StackingContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: StorageService](/auto-docs/free-layout-editor/interfaces/StorageService.md): 存储数据到缓存 - [Interface: TintSchema](/auto-docs/free-layout-editor/interfaces/TintSchema-1.md) - [Interface: FlushOptions](/auto-docs/free-layout-editor/interfaces/Tracker.FlushOptions.md): Tracker.FlushOptions - [Interface: TransformNodeSchema](/auto-docs/free-layout-editor/interfaces/TransformNodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: TransformSchema](/auto-docs/free-layout-editor/interfaces/TransformSchema-1.md) - [Interface: TweenOpts](/auto-docs/free-layout-editor/interfaces/TweenOpts.md) - [Interface: URLParams](/auto-docs/free-layout-editor/interfaces/URLParams.md) - [Interface: UndoRedoChangeElementEvent](/auto-docs/free-layout-editor/interfaces/UndoRedoChangeElementEvent.md): 带element的事件 - [Interface: UndoRedoClearEvent](/auto-docs/free-layout-editor/interfaces/UndoRedoClearEvent.md): 清空事件 - [Interface: UngroupOperation](/auto-docs/free-layout-editor/interfaces/UngroupOperation.md) - [Interface: UnionJSON](/auto-docs/free-layout-editor/interfaces/UnionJSON.md): ASTNodeJSON representation of UnionType, which union multiple BaseType. - [Interface: VariableAbilityParseContext](/auto-docs/free-layout-editor/interfaces/VariableAbilityParseContext.md) - [Interface: VariableConsumerAbilityOptions](/auto-docs/free-layout-editor/interfaces/VariableConsumerAbilityOptions.md) - [Interface: VariableDeclarationListJSON](/auto-docs/free-layout-editor/interfaces/VariableDeclarationListJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: VariablePluginOptions](/auto-docs/free-layout-editor/interfaces/VariablePluginOptions.md) - [Interface: VariableProviderAbilityOptions](/auto-docs/free-layout-editor/interfaces/VariableProviderAbilityOptions.md) - [Interface: Vertex](/auto-docs/free-layout-editor/interfaces/Vertex.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: WeakCache](/auto-docs/free-layout-editor/interfaces/WeakCache.md) - [Interface: WorkflowContentChangeEvent](/auto-docs/free-layout-editor/interfaces/WorkflowContentChangeEvent.md) - [Interface: WorkflowDocumentOptions](/auto-docs/free-layout-editor/interfaces/WorkflowDocumentOptions.md): 线条配置 - [Interface: WorkflowEdgeJSON](/auto-docs/free-layout-editor/interfaces/WorkflowEdgeJSON.md): 边数据 - [Interface: WorkflowJSON](/auto-docs/free-layout-editor/interfaces/WorkflowJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: WorkflowLineEntityOpts](/auto-docs/free-layout-editor/interfaces/WorkflowLineEntityOpts.md) - [Interface: WorkflowLineInfo](/auto-docs/free-layout-editor/interfaces/WorkflowLineInfo.md) - [Interface: WorkflowLinePortInfo](/auto-docs/free-layout-editor/interfaces/WorkflowLinePortInfo.md) - [Interface: WorkflowLineRenderContribution](/auto-docs/free-layout-editor/interfaces/WorkflowLineRenderContribution.md) - [Interface: WorkflowLineRenderDataSchema](/auto-docs/free-layout-editor/interfaces/WorkflowLineRenderDataSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: WorkflowLineUIState](/auto-docs/free-layout-editor/interfaces/WorkflowLineUIState.md) - [Interface: WorkflowNodeJSON](/auto-docs/free-layout-editor/interfaces/WorkflowNodeJSON.md): 节点数据 - [Interface: WorkflowNodeLines](/auto-docs/free-layout-editor/interfaces/WorkflowNodeLines.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: WorkflowNodeMeta](/auto-docs/free-layout-editor/interfaces/WorkflowNodeMeta.md): 节点 meta 信息 - [Interface: WorkflowNodeProps](/auto-docs/free-layout-editor/interfaces/WorkflowNodeProps.md) - [Interface: WorkflowNodeRegistry](/auto-docs/free-layout-editor/interfaces/WorkflowNodeRegistry.md): 节点注册 - [Interface: WorkflowNodeRenderProps](/auto-docs/free-layout-editor/interfaces/WorkflowNodeRenderProps.md) - [Interface: WorkflowOperationBaseService](/auto-docs/free-layout-editor/interfaces/WorkflowOperationBaseService.md) - [Interface: WorkflowPort](/auto-docs/free-layout-editor/interfaces/WorkflowPort.md) - [Interface: WorkflowPortEntityOpts](/auto-docs/free-layout-editor/interfaces/WorkflowPortEntityOpts.md) - [Interface: WorkflowPortRenderProps](/auto-docs/free-layout-editor/interfaces/WorkflowPortRenderProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: WrapArrayExpressionJSON](/auto-docs/free-layout-editor/interfaces/WrapArrayExpressionJSON.md): ASTNodeJSON representation of WrapArrayExpression - [Interface: createOrUngroupValue](/auto-docs/free-layout-editor/interfaces/createOrUngroupValue.md) - [Interface: Abstract](/auto-docs/free-layout-editor/interfaces/interfaces.Abstract.md): interfaces.Abstract - [Interface: AsyncContainerModule](/auto-docs/free-layout-editor/interfaces/interfaces.AsyncContainerModule.md): interfaces.AsyncContainerModule - [Interface: Binding](/auto-docs/free-layout-editor/interfaces/interfaces.Binding.md): interfaces.Binding - [Interface: BindingInSyntax](/auto-docs/free-layout-editor/interfaces/interfaces.BindingInSyntax.md): interfaces.BindingInSyntax - [Interface: BindingInWhenOnSyntax](/auto-docs/free-layout-editor/interfaces/interfaces.BindingInWhenOnSyntax.md): interfaces.BindingInWhenOnSyntax - [Interface: BindingOnSyntax](/auto-docs/free-layout-editor/interfaces/interfaces.BindingOnSyntax.md): interfaces.BindingOnSyntax - [Interface: BindingScopeEnum](/auto-docs/free-layout-editor/interfaces/interfaces.BindingScopeEnum.md): interfaces.BindingScopeEnum - [Interface: BindingToSyntax](/auto-docs/free-layout-editor/interfaces/interfaces.BindingToSyntax.md): interfaces.BindingToSyntax - [Interface: BindingTypeEnum](/auto-docs/free-layout-editor/interfaces/interfaces.BindingTypeEnum.md): interfaces.BindingTypeEnum - [Interface: BindingWhenOnSyntax](/auto-docs/free-layout-editor/interfaces/interfaces.BindingWhenOnSyntax.md): interfaces.BindingWhenOnSyntax - [Interface: BindingWhenSyntax](/auto-docs/free-layout-editor/interfaces/interfaces.BindingWhenSyntax.md): interfaces.BindingWhenSyntax - [Interface: Clonable](/auto-docs/free-layout-editor/interfaces/interfaces.Clonable.md): interfaces.Clonable - [Interface: ConstraintFunction](/auto-docs/free-layout-editor/interfaces/interfaces.ConstraintFunction.md): interfaces.ConstraintFunction - [Interface: ConstructorMetadata](/auto-docs/free-layout-editor/interfaces/interfaces.ConstructorMetadata.md): interfaces.ConstructorMetadata - [Interface: Container](/auto-docs/free-layout-editor/interfaces/interfaces.Container.md): interfaces.Container - [Interface: ContainerModule](/auto-docs/free-layout-editor/interfaces/interfaces.ContainerModule.md): interfaces.ContainerModule - [Interface: ContainerModuleBase](/auto-docs/free-layout-editor/interfaces/interfaces.ContainerModuleBase.md): interfaces.ContainerModuleBase - [Interface: ContainerOptions](/auto-docs/free-layout-editor/interfaces/interfaces.ContainerOptions.md): interfaces.ContainerOptions - [Interface: ContainerSnapshot](/auto-docs/free-layout-editor/interfaces/interfaces.ContainerSnapshot.md): interfaces.ContainerSnapshot - [Interface: Context](/auto-docs/free-layout-editor/interfaces/interfaces.Context.md): interfaces.Context - [Interface: FactoryDetails](/auto-docs/free-layout-editor/interfaces/interfaces.FactoryDetails.md): interfaces.FactoryDetails - [Interface: GetAllOptions](/auto-docs/free-layout-editor/interfaces/interfaces.GetAllOptions.md): interfaces.GetAllOptions - [Interface: Lookup](/auto-docs/free-layout-editor/interfaces/interfaces.Lookup.md): interfaces.Lookup - [Interface: Metadata](/auto-docs/free-layout-editor/interfaces/interfaces.Metadata.md): interfaces.Metadata - [Interface: MetadataMap](/auto-docs/free-layout-editor/interfaces/interfaces.MetadataMap.md): interfaces.MetadataMap - [Interface: MetadataReader](/auto-docs/free-layout-editor/interfaces/interfaces.MetadataReader.md): interfaces.MetadataReader - [Interface: ModuleActivationHandlers](/auto-docs/free-layout-editor/interfaces/interfaces.ModuleActivationHandlers.md): interfaces.ModuleActivationHandlers - [Interface: ModuleActivationStore](/auto-docs/free-layout-editor/interfaces/interfaces.ModuleActivationStore.md): interfaces.ModuleActivationStore - [Interface: NextArgs](/auto-docs/free-layout-editor/interfaces/interfaces.NextArgs.md): interfaces.NextArgs - [Interface: Plan](/auto-docs/free-layout-editor/interfaces/interfaces.Plan.md): interfaces.Plan - [Interface: QueryableString](/auto-docs/free-layout-editor/interfaces/interfaces.QueryableString.md): interfaces.QueryableString - [Interface: Request](/auto-docs/free-layout-editor/interfaces/interfaces.Request.md): interfaces.Request - [Interface: TargetTypeEnum](/auto-docs/free-layout-editor/interfaces/interfaces.TargetTypeEnum.md): interfaces.TargetTypeEnum - [Interface: onFormValueChangeInPayload](/auto-docs/free-layout-editor/interfaces/onFormValueChangeInPayload.md) - [Namespace: ASTFactory](/auto-docs/free-layout-editor/modules/ASTFactory.md): Variable-core ASTNode factories. - [Namespace: ASTMatch](/auto-docs/free-layout-editor/modules/ASTMatch.md): Variable-core ASTNode matchers. Typescript code inside if statement will be type guarded. - [Namespace: Angle](/auto-docs/free-layout-editor/modules/Angle.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Bounds](/auto-docs/free-layout-editor/modules/Bounds.md) - [Namespace: Cache](/auto-docs/free-layout-editor/modules/Cache.md): 缓存工具： 可延迟按需创建，提升性能可支持多个或单个，有些动态创建多个的场景可以共享已有的实例，提升性能自动删除，超过一定的数目会自动做清空回收 Example - [Namespace: CancellationToken](/auto-docs/free-layout-editor/modules/CancellationToken.md) - [Namespace: Command](/auto-docs/free-layout-editor/modules/Command.md) - [Namespace: Compare](/auto-docs/free-layout-editor/modules/Compare.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Disposable](/auto-docs/free-layout-editor/modules/Disposable.md) - [Namespace: EditorProps](/auto-docs/free-layout-editor/modules/EditorProps.md) - [Namespace: EditorState](/auto-docs/free-layout-editor/modules/EditorState.md) - [Namespace: Entity](/auto-docs/free-layout-editor/modules/Entity.md) - [Namespace: Event](/auto-docs/free-layout-editor/modules/Event.md) - [Namespace: FlowLayoutDefault](/auto-docs/free-layout-editor/modules/FlowLayoutDefault.md) - [Namespace: FlowNodeEntity](/auto-docs/free-layout-editor/modules/FlowNodeEntity.md) - [Namespace: FlowNodeRegistry](/auto-docs/free-layout-editor/modules/FlowNodeRegistry.md) - [Namespace: FlowVirtualTree](/auto-docs/free-layout-editor/modules/FlowVirtualTree.md) - [Namespace: FreeLayoutProps](/auto-docs/free-layout-editor/modules/FreeLayoutProps.md) - [Namespace: MouseTouchEvent](/auto-docs/free-layout-editor/modules/MouseTouchEvent.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: PaddingSchema](/auto-docs/free-layout-editor/modules/PaddingSchema.md) - [Namespace: PlaygroundDrag](/auto-docs/free-layout-editor/modules/PlaygroundDrag.md) - [Namespace: PlaygroundMockTools](/auto-docs/free-layout-editor/modules/PlaygroundMockTools.md): 画布测试工具 Example - [Namespace: Point](/auto-docs/free-layout-editor/modules/Point.md) - [Namespace: Rectangle](/auto-docs/free-layout-editor/modules/Rectangle.md) - [Namespace: Schema](/auto-docs/free-layout-editor/modules/Schema.md) - [Namespace: SchemaDecoration](/auto-docs/free-layout-editor/modules/SchemaDecoration.md) - [Namespace: SizeSchema](/auto-docs/free-layout-editor/modules/SizeSchema.md) - [Namespace: TintSchema](/auto-docs/free-layout-editor/modules/TintSchema.md) - [Namespace: Tracker](/auto-docs/free-layout-editor/modules/Tracker.md): Tracker 是一套 响应式依赖追踪 库，来源于 Meteor.Tracker https://docs.meteor.com/api/Tracker.html#tracker-autorun-and-async-callbacks https://github.com/meteor/meteor/blob/devel/packages/tracker/tracker.js 相关论文：https://dl.acm.org/doi/fullHtml/10.1145/3184558.3185978 - [Namespace: TransformData](/auto-docs/free-layout-editor/modules/TransformData.md) - [Namespace: TransformSchema](/auto-docs/free-layout-editor/modules/TransformSchema.md) - [Namespace: domUtils](/auto-docs/free-layout-editor/modules/domUtils.md) - [Namespace: interfaces](/auto-docs/free-layout-editor/modules/interfaces.md) - [Type alias: AddNodeConfig](/auto-docs/free-layout-editor/types/AddNodeConfig.md): AddNodeConfig: Object Type declaration - [Type alias: AddNodeData](/auto-docs/free-layout-editor/types/AddNodeData.md): AddNodeData: FlowNodeJSON & { hidden?: boolean ; index?: number ; originParent?: FlowNodeEntity ; parent?: FlowNodeEntity } - [Type alias: ArrayAppendEffect](/auto-docs/free-layout-editor/types/ArrayAppendEffect.md): ArrayAppendEffect: (props: { arrayValues: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number ; value: TFieldValue }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: ArrayDeleteEffect](/auto-docs/free-layout-editor/types/ArrayDeleteEffect.md): ArrayDeleteEffect: (props: { arrayValue: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: AutoLayoutResetFn](/auto-docs/free-layout-editor/types/AutoLayoutResetFn.md): AutoLayoutResetFn: () => void Type declaration (): void Returns void - [Type alias: AutoLayoutToolOptions](/auto-docs/free-layout-editor/types/AutoLayoutToolOptions.md): AutoLayoutToolOptions: LayoutOptions - [Type alias: CSSStyle](/auto-docs/free-layout-editor/types/CSSStyle.md): CSSStyle: { [P in keyof CSSStyleDeclaration]?: string | number } Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: Cache](/auto-docs/free-layout-editor/types/Cache-1.md): Cache: { [P in keyof T]: T[P] } & { dispose?: () => void ; key?: any } Type parameters - [Type alias: Cursors](/auto-docs/free-layout-editor/types/Cursors.md): Cursors: Record - [Type alias: Effect](/auto-docs/free-layout-editor/types/Effect.md): Effect: (props: EffectFuncProps) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: EffectOptions](/auto-docs/free-layout-editor/types/EffectOptions.md): EffectOptions: { effect: Effect ; event: DataEvent } | { effect: ArrayAppendEffect ; event: DataEvent } | { effect: ArrayDeleteEffect ; event: DataEvent } - [Type alias: EffectReturn](/auto-docs/free-layout-editor/types/EffectReturn.md): EffectReturn: () => void Type declaration (): void Returns void - [Type alias: EntityDataInjector](/auto-docs/free-layout-editor/types/EntityDataInjector.md): EntityDataInjector: () => OPTS Type declaration (): OPTS Type parameters Returns OPTS - [Type alias: EntityDataProps](/auto-docs/free-layout-editor/types/EntityDataProps.md): EntityDataProps: E["data"] Type parameters - [Type alias: Errors](/auto-docs/free-layout-editor/types/Errors.md): Errors: Record - [Type alias: FieldError](/auto-docs/free-layout-editor/types/FieldError.md): FieldError: Feedback - [Type alias: FieldName](/auto-docs/free-layout-editor/types/FieldName.md): FieldName: string - [Type alias: FieldWarning](/auto-docs/free-layout-editor/types/FieldWarning.md): FieldWarning: Feedback - [Type alias: FlowDocumentJSON](/auto-docs/free-layout-editor/types/FlowDocumentJSON.md): FlowDocumentJSON: Object Type declaration - [Type alias: FlowDocumentProvider](/auto-docs/free-layout-editor/types/FlowDocumentProvider.md): FlowDocumentProvider: () => FlowDocument Type declaration (): FlowDocument Returns FlowDocument - [Type alias: FlowNodeEntityOrId](/auto-docs/free-layout-editor/types/FlowNodeEntityOrId.md): FlowNodeEntityOrId: string | FlowNodeEntity - [Type alias: FlowNodeType](/auto-docs/free-layout-editor/types/FlowNodeType.md): FlowNodeType: string | number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: FlowOperation](/auto-docs/free-layout-editor/types/FlowOperation.md): FlowOperation: AddFromNodeOperation | DeleteFromNodeOperation | AddBlockOperation | DeleteBlockOperation | CreateGroupOperation | UngroupOperation | MoveNodesOperation | AddNodesOperation | DeleteNodesOperation | MoveBlockOperation | AddChildNodeOperation | DeleteChildNodeOperation | MoveChildNodesOperation | AddNodeOperation | DeleteNodeOperation - [Type alias: FocusNodeCanvasOptions](/auto-docs/free-layout-editor/types/FocusNodeCanvasOptions.md): FocusNodeCanvasOptions: PlaygroundConfigRevealOpts Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: FormPluginCreator](/auto-docs/free-layout-editor/types/FormPluginCreator.md): FormPluginCreator: (opts: Opts) => FormPlugin Type parameters Type declaration (opts): FormPlugin Parameters Returns FormPlugin - [Type alias: FormPluginCtx](/auto-docs/free-layout-editor/types/FormPluginCtx.md): FormPluginCtx: { formModel: FormModel } & NodeContext - [Type alias: FormPluginSetupMetaCtx](/auto-docs/free-layout-editor/types/FormPluginSetupMetaCtx.md): FormPluginSetupMetaCtx: { addFormatOnInit: (formatOnInit: FormMeta["formatOnInit"]) => void ; addFormatOnSubmit: (formatOnSubmit: FormMeta["formatOnSubmit"]) => void ; mergeEffect: (effect: Record) => void ; mergeValidate: (validate: Record) => void } & NodeContext - [Type alias: FreeStackPluginOptions](/auto-docs/free-layout-editor/types/FreeStackPluginOptions.md): FreeStackPluginOptions: Partial - [Type alias: GetBlockLabel](/auto-docs/free-layout-editor/types/GetBlockLabel.md): GetBlockLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据分支获取label Parameters Returns string - [Type alias: GetKindJSON](/auto-docs/free-layout-editor/types/GetKindJSON.md): GetKindJSON: { key?: Identifier ; kind: KindType } & JSON TypeUtils to get the JSON representation of an AST node with a specific kind. Type parameters - [Type alias: GetKindJSONOrKind](/auto-docs/free-layout-editor/types/GetKindJSONOrKind.md): GetKindJSONOrKind: { key?: Identifier ; kind: KindType } & JSON | KindType TypeUtils to get the JSON representation of an AST node with a specific kind or just the kind string. Type parameters - [Type alias: GetLineURI](/auto-docs/free-layout-editor/types/GetLineURI.md): GetLineURI: (id: string) => string | any Type declaration (id): string | any 根据连线获取URI Parameters Returns string | any - [Type alias: GetNodeLabel](/auto-docs/free-layout-editor/types/GetNodeLabel.md): GetNodeLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据节点获取label Parameters Returns string - [Type alias: GetNodeLabelById](/auto-docs/free-layout-editor/types/GetNodeLabelById.md): GetNodeLabelById: (id: string) => string Type declaration (id): string 根据节点id获取label Parameters Returns string - [Type alias: GetNodeURI](/auto-docs/free-layout-editor/types/GetNodeURI.md): GetNodeURI: (id: string) => string | any Type declaration (id): string | any 根据节点获取URI Parameters Returns string | any - [Type alias: HistoryMergeEvent](/auto-docs/free-layout-editor/types/HistoryMergeEvent.md): HistoryMergeEvent: { type: ADD ; value: { element: IUndoRedoElement ; operation: Operation } } | { type: UPDATE ; value: { element: IUndoRedoElement ; operation: Operation ; value: any } } 历史合并事件 - [Type alias: HistoryStackChangeEvent](/auto-docs/free-layout-editor/types/HistoryStackChangeEvent.md): HistoryStackChangeEvent: HistoryStackAddEvent | HistoryStackUpdateEvent | HistoryStackAddOperationEvent | HistoryStackUpdateOperationEvent 历史记录变化事件 - [Type alias: ISize](/auto-docs/free-layout-editor/types/ISize.md): ISize: Object Size object, contains width and height Type declaration - [Type alias: IUndoRedoElementFactory](/auto-docs/free-layout-editor/types/IUndoRedoElementFactory.md): IUndoRedoElementFactory: (operation: Operation) => IUndoRedoElement Type parameters Type declaration (operation): IUndoRedoElement 操作工厂 Parameters Returns IUndoRedoElement - [Type alias: LinePointLocation](/auto-docs/free-layout-editor/types/LinePointLocation.md): LinePointLocation: "left" | "top" | "right" | "bottom" - [Type alias: LineRenderType](/auto-docs/free-layout-editor/types/LineRenderType.md): LineRenderType: LineType | string - [Type alias: LineToJson](/auto-docs/free-layout-editor/types/LineToJson.md): LineToJson: (node: WorkflowLineEntity) => FlowNodeJSON Type declaration (node): FlowNodeJSON 将line转成json Parameters Returns FlowNodeJSON - [Type alias: LocalId](/auto-docs/free-layout-editor/types/LocalId.md): LocalId: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: MarginSchema](/auto-docs/free-layout-editor/types/MarginSchema.md): MarginSchema: PaddingSchema - [Type alias: MaybeArray](/auto-docs/free-layout-editor/types/MaybeArray.md): MaybeArray: T | T[] Type parameters - [Type alias: MaybePromise](/auto-docs/free-layout-editor/types/MaybePromise.md): MaybePromise: T | PromiseLike Type parameters - [Type alias: MoveBlockOperationValue](/auto-docs/free-layout-editor/types/MoveBlockOperationValue.md): MoveBlockOperationValue: Object Type declaration - [Type alias: NodeToJson](/auto-docs/free-layout-editor/types/NodeToJson.md): NodeToJson: (node: FlowNodeEntity) => FlowNodeJSON Type declaration (node): FlowNodeJSON 将node转成json Parameters Returns FlowNodeJSON - [Type alias: NodesDragEvent](/auto-docs/free-layout-editor/types/NodesDragEvent.md): NodesDragEvent: NodesDragStartEvent | NodesDraggingEvent | NodesDragEndEvent - [Type alias: ObjectPropertiesChangeAction](/auto-docs/free-layout-editor/types/ObjectPropertiesChangeAction.md): ObjectPropertiesChangeAction: GlobalEventActionType<"ObjectPropertiesChange", { next: Property[] ; prev: Property[] }, ObjectType> Action type for object properties change. - [Type alias: OnDragLineEnd](/auto-docs/free-layout-editor/types/OnDragLineEnd.md): OnDragLineEnd: (params: onDragLineEndParams) => Promise Type declaration (params): Promise Parameters Returns Promise - [Type alias: OpacitySchema](/auto-docs/free-layout-editor/types/OpacitySchema.md): OpacitySchema: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: OperationWithId](/auto-docs/free-layout-editor/types/OperationWithId.md): OperationWithId: Operation & { id: string } - [Type alias: PipeEventName](/auto-docs/free-layout-editor/types/PipeEventName.md): PipeEventName: string - [Type alias: PipeSupportEvent](/auto-docs/free-layout-editor/types/PipeSupportEvent.md): PipeSupportEvent: MouseEvent | DragEvent | KeyboardEvent | UIEvent | TouchEvent | any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipelineEventHandler](/auto-docs/free-layout-editor/types/PipelineEventHandler.md): PipelineEventHandler: (event: PipeSupportEvent) => boolean | undefined Type declaration (event): boolean | undefined Parameters Returns boolean | undefined - [Type alias: PipelineLayerFactory](/auto-docs/free-layout-editor/types/PipelineLayerFactory.md): PipelineLayerFactory: (layerRegistry: LayerRegistry, layerOptions?: any) => Layer Type declaration (layerRegistry, layerOptions?): Layer Parameters Returns Layer - [Type alias: PlaygroundContext](/auto-docs/free-layout-editor/types/PlaygroundContext.md): PlaygroundContext: any - [Type alias: PlaygroundContextProvider](/auto-docs/free-layout-editor/types/PlaygroundContextProvider.md): PlaygroundContextProvider: () => any Type declaration (): any Returns any - [Type alias: PlaygroundInteractiveType](/auto-docs/free-layout-editor/types/PlaygroundInteractiveType.md): PlaygroundInteractiveType: "MOUSE" | "PAD" MOUSE: 鼠标友好模式，鼠标左键拖动画布，滚动缩放 (适合 windows ) PAD: 双指同向移动拖动，双指张开捏合缩放 (适合 mac) - [Type alias: PlaygroundScrollLimitFn](/auto-docs/free-layout-editor/types/PlaygroundScrollLimitFn.md): PlaygroundScrollLimitFn: (scroll: { scrollX: number ; scrollY: number }) => { scrollX: number ; scrollY: number } Type declaration (scroll): Object Parameters Returns Object - [Type alias: Plugin](/auto-docs/free-layout-editor/types/Plugin.md): Plugin: Object Type parameters Type declaration - [Type alias: PluginCreator](/auto-docs/free-layout-editor/types/PluginCreator.md): PluginCreator: (opts: Options) => Plugin Type parameters Type declaration (opts): Plugin Parameters Returns Plugin - [Type alias: PositionMap](/auto-docs/free-layout-editor/types/PositionMap.md): PositionMap: Record - [Type alias: PropertyJSON](/auto-docs/free-layout-editor/types/PropertyJSON.md): PropertyJSON: BaseVariableFieldJSON ASTNodeJSON representation of the Property. Type parameters - [Type alias: ProtectWheelArea](/auto-docs/free-layout-editor/types/ProtectWheelArea.md): ProtectWheelArea: (dom: Element) => boolean Type declaration (dom): boolean Parameters Returns boolean - [Type alias: RecursivePartial](/auto-docs/free-layout-editor/types/RecursivePartial.md): RecursivePartial: { [P in keyof T]?: T[P] extends (infer I)[] ? RecursivePartial[] : RecursivePartial } Type parameters - [Type alias: RotationSchema](/auto-docs/free-layout-editor/types/RotationSchema.md): RotationSchema: number - [Type alias: SchemaType](/auto-docs/free-layout-editor/types/SchemaType.md): SchemaType: "string" | "integer" | "float" | "boolean" | "enum" | "object" | "range" | "color" | "array" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: IComputationCallback](/auto-docs/free-layout-editor/types/Tracker.IComputationCallback.md): Tracker.IComputationCallback IComputationCallback: ICallback Type parameters - [Type alias: UndoRedoChangeEvent](/auto-docs/free-layout-editor/types/UndoRedoChangeEvent.md): UndoRedoChangeEvent: UndoRedoChangeElementEvent | UndoRedoClearEvent undo redo变化事件 - [Type alias: Validate](/auto-docs/free-layout-editor/types/Validate.md): Validate: (props: { context: Context ; formValues: TFormValues ; name: FieldName ; value: TFieldValue }) => MaybePromise | MaybePromise | MaybePromise | MaybePromise Type parameters Type declaration (props): MaybePromise | MaybePromise | MaybePromise | MaybePromise Parameters Returns MaybePromise | MaybePromise | MaybePromise | MaybePromise - [Type alias: VariableDeclarationJSON](/auto-docs/free-layout-editor/types/VariableDeclarationJSON.md): VariableDeclarationJSON: BaseVariableFieldJSON & { order?: number } ASTNodeJSON representation of the VariableDeclaration. Type parameters - [Type alias: VariableDeclarationListChangeAction](/auto-docs/free-layout-editor/types/VariableDeclarationListChangeAction.md): VariableDeclarationListChangeAction: GlobalEventActionType<"VariableListChange", { next: VariableDeclaration[] ; prev: VariableDeclaration[] }, VariableDeclarationList> - [Type alias: VariableEngineProvider](/auto-docs/free-layout-editor/types/VariableEngineProvider.md): VariableEngineProvider: () => VariableEngine Type declaration (): VariableEngine Returns VariableEngine - [Type alias: Warnings](/auto-docs/free-layout-editor/types/Warnings.md): Warnings: Record - [Type alias: WorkfloEntityHoverable](/auto-docs/free-layout-editor/types/WorkfloEntityHoverable.md): WorkfloEntityHoverable: WorkflowEntityHoverable Deprecated - [Type alias: WorkflowDocumentProvider](/auto-docs/free-layout-editor/types/WorkflowDocumentProvider.md): WorkflowDocumentProvider: () => WorkflowDocument Type declaration (): WorkflowDocument Returns WorkflowDocument - [Type alias: WorkflowEntityHoverable](/auto-docs/free-layout-editor/types/WorkflowEntityHoverable.md): WorkflowEntityHoverable: WorkflowNodeEntity | WorkflowLineEntity | WorkflowPortEntity 可 Hover 的节点 类型 - [Type alias: WorkflowLineRenderContributionFactory](/auto-docs/free-layout-editor/types/WorkflowLineRenderContributionFactory.md): WorkflowLineRenderContributionFactory: (entity: WorkflowLineEntity) => WorkflowLineRenderContribution & { type: LineRenderType } - [Type alias: WorkflowNodeEntity](/auto-docs/free-layout-editor/types/WorkflowNodeEntity.md): WorkflowNodeEntity: FlowNodeEntity - [Type alias: WorkflowNodeFormMeta](/auto-docs/free-layout-editor/types/WorkflowNodeFormMeta.md): WorkflowNodeFormMeta: FormMetaOrFormMetaGenerator | FormMeta 节点表单引擎配置 - [Type alias: WorkflowPortType](/auto-docs/free-layout-editor/types/WorkflowPortType.md): WorkflowPortType: "input" | "output" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: WorkflowPorts](/auto-docs/free-layout-editor/types/WorkflowPorts.md): WorkflowPorts: WorkflowPort[] - [Type alias: WorkflowSubCanvas](/auto-docs/free-layout-editor/types/WorkflowSubCanvas.md): WorkflowSubCanvas: Object 子画布配置 Type declaration - [Type alias: Xor](/auto-docs/free-layout-editor/types/Xor.md): Xor: T | U extends object ? Without & U | Without & T : T | U Type parameters - [Type alias: AsyncContainerModuleCallBack](/auto-docs/free-layout-editor/types/interfaces.AsyncContainerModuleCallBack.md): interfaces.AsyncContainerModuleCallBack AsyncContainerModuleCallBack: AsyncCallback - [Type alias: AutoFactory](/auto-docs/free-layout-editor/types/interfaces.AutoFactory.md): interfaces.AutoFactory AutoFactory: SimpleFactory Type parameters - [Type alias: AutoNamedFactory](/auto-docs/free-layout-editor/types/interfaces.AutoNamedFactory.md): interfaces.AutoNamedFactory AutoNamedFactory: SimpleFactory Type parameters - [Type alias: Bind](/auto-docs/free-layout-editor/types/interfaces.Bind.md): interfaces.Bind Bind: (serviceIdentifier: ServiceIdentifier) => BindingToSyntax Type declaration (serviceIdentifier): BindingToSyntax Type parameters Parameters Returns BindingToSyntax - [Type alias: BindingActivation](/auto-docs/free-layout-editor/types/interfaces.BindingActivation.md): interfaces.BindingActivation BindingActivation: (context: Context, injectable: T) => T | Promise Type parameters Type declaration (context, injectable): T | Promise Parameters Returns T | Promise - [Type alias: BindingDeactivation](/auto-docs/free-layout-editor/types/interfaces.BindingDeactivation.md): interfaces.BindingDeactivation BindingDeactivation: (injectable: T) => void | Promise Type parameters Type declaration (injectable): void | Promise Parameters Returns void | Promise - [Type alias: BindingScope](/auto-docs/free-layout-editor/types/interfaces.BindingScope.md): interfaces.BindingScope BindingScope: "Singleton" | "Transient" | "Request" - [Type alias: BindingType](/auto-docs/free-layout-editor/types/interfaces.BindingType.md): interfaces.BindingType BindingType: "ConstantValue" | "Constructor" | "DynamicValue" | "Factory" | "Function" | "Instance" | "Invalid" | "Provider" - [Type alias: ContainerModuleCallBack](/auto-docs/free-layout-editor/types/interfaces.ContainerModuleCallBack.md): interfaces.ContainerModuleCallBack ContainerModuleCallBack: (bind: Bind, unbind: Unbind, isBound: IsBound, rebind: Rebind, unbindAsync: UnbindAsync, onActivation: Container["onActivation"], onDeactivation: Container["onDeactivation"]) => void Type declaration (bind, unbind, isBound, rebind, unbindAsync, onActivation, onDeactivation): void Parameters Returns void - [Type alias: ContainerResolution](/auto-docs/free-layout-editor/types/interfaces.ContainerResolution.md): interfaces.ContainerResolution ContainerResolution: undefined | T | Promise | (T | Promise)[] Type parameters - [Type alias: ContextInterceptor](/auto-docs/free-layout-editor/types/interfaces.ContextInterceptor.md): interfaces.ContextInterceptor ContextInterceptor: (context: Context) => Context Type declaration (context): Context Parameters Returns Context - [Type alias: DynamicValue](/auto-docs/free-layout-editor/types/interfaces.DynamicValue.md): interfaces.DynamicValue DynamicValue: (context: Context) => T | Promise Type parameters Type declaration (context): T | Promise Parameters Returns T | Promise - [Type alias: Factory](/auto-docs/free-layout-editor/types/interfaces.Factory.md): interfaces.Factory Factory: SimpleFactory | MultiFactory Type parameters - [Type alias: FactoryCreator](/auto-docs/free-layout-editor/types/interfaces.FactoryCreator.md): interfaces.FactoryCreator FactoryCreator: (context: Context) => Factory Type parameters Type declaration (context): Factory Parameters Returns Factory - [Type alias: FactoryTypeFunction](/auto-docs/free-layout-editor/types/interfaces.FactoryTypeFunction.md): interfaces.FactoryTypeFunction FactoryTypeFunction: (context: Context) => T | Promise Type parameters Type declaration (context): T | Promise Parameters Returns T | Promise - [Type alias: Instance](/auto-docs/free-layout-editor/types/interfaces.Instance.md): interfaces.Instance Instance: T & Record void> Type parameters - [Type alias: IsBound](/auto-docs/free-layout-editor/types/interfaces.IsBound.md): interfaces.IsBound IsBound: (serviceIdentifier: ServiceIdentifier) => boolean Type declaration (serviceIdentifier): boolean Type parameters Parameters Returns boolean - [Type alias: MetadataOrMetadataArray](/auto-docs/free-layout-editor/types/interfaces.MetadataOrMetadataArray.md): interfaces.MetadataOrMetadataArray MetadataOrMetadataArray: Metadata | Metadata[] - [Type alias: Middleware](/auto-docs/free-layout-editor/types/interfaces.Middleware.md): interfaces.Middleware Middleware: (next: Next) => Next Type declaration (next): Next Parameters Returns Next - [Type alias: MultiFactory](/auto-docs/free-layout-editor/types/interfaces.MultiFactory.md): interfaces.MultiFactory MultiFactory: (...args: U) => SimpleFactory Type parameters Type declaration (...args): SimpleFactory Parameters Returns SimpleFactory - [Type alias: Newable](/auto-docs/free-layout-editor/types/interfaces.Newable.md): interfaces.Newable Newable: CommonNewable Type parameters - [Type alias: Next](/auto-docs/free-layout-editor/types/interfaces.Next.md): interfaces.Next Next: (args: NextArgs) => unknown | unknown[] Type declaration (args): unknown | unknown[] Parameters Returns unknown | unknown[] - [Type alias: Provider](/auto-docs/free-layout-editor/types/interfaces.Provider.md): interfaces.Provider Provider: (...args: any[]) => (...args: any[]) => Promise | Promise Type parameters Type declaration (...args): (...args: any[]) => Promise | Promise Parameters Returns (...args: any[]) => Promise | Promise - [Type alias: ProviderCreator](/auto-docs/free-layout-editor/types/interfaces.ProviderCreator.md): interfaces.ProviderCreator ProviderCreator: (context: Context) => Provider Type parameters Type declaration (context): Provider Parameters Returns Provider - [Type alias: Rebind](/auto-docs/free-layout-editor/types/interfaces.Rebind.md): interfaces.Rebind Rebind: (serviceIdentifier: ServiceIdentifier) => BindingToSyntax Type declaration (serviceIdentifier): BindingToSyntax Type parameters Parameters Returns BindingToSyntax - [Type alias: RequestScope](/auto-docs/free-layout-editor/types/interfaces.RequestScope.md): interfaces.RequestScope RequestScope: Map - [Type alias: ResolveRequestHandler](/auto-docs/free-layout-editor/types/interfaces.ResolveRequestHandler.md): interfaces.ResolveRequestHandler ResolveRequestHandler: (request: Request) => unknown Type declaration (request): unknown Parameters Returns unknown - [Type alias: ServiceIdentifier](/auto-docs/free-layout-editor/types/interfaces.ServiceIdentifier.md): interfaces.ServiceIdentifier ServiceIdentifier: CommonServiceIdentifier Type parameters - [Type alias: SimpleFactory](/auto-docs/free-layout-editor/types/interfaces.SimpleFactory.md): interfaces.SimpleFactory SimpleFactory: (...args: U) => T Type parameters Type declaration (...args): T Parameters Returns T - [Type alias: Target](/auto-docs/free-layout-editor/types/interfaces.Target.md): interfaces.Target Target: LegacyTarget - [Type alias: TargetType](/auto-docs/free-layout-editor/types/interfaces.TargetType.md): interfaces.TargetType TargetType: "ConstructorArgument" | "ClassProperty" | "Variable" - [Type alias: Unbind](/auto-docs/free-layout-editor/types/interfaces.Unbind.md): interfaces.Unbind Unbind: (serviceIdentifier: ServiceIdentifier) => void Type declaration (serviceIdentifier): void Type parameters Parameters Returns void - [Type alias: UnbindAsync](/auto-docs/free-layout-editor/types/interfaces.UnbindAsync.md): interfaces.UnbindAsync UnbindAsync: (serviceIdentifier: ServiceIdentifier) => Promise Type declaration (serviceIdentifier): Promise Type parameters Parameters Returns Promise - [Type alias: onDragLineEndParams](/auto-docs/free-layout-editor/types/onDragLineEndParams.md): onDragLineEndParams: Object Type declaration - [Variable: BASE_Z_INDEX](/auto-docs/free-layout-editor/variables/BASE_Z_INDEX.md): Const BASE_Z_INDEX: 8 Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: Cancelled](/auto-docs/free-layout-editor/variables/CancellationToken.Cancelled.md): CancellationToken.Cancelled Const Cancelled: Readonly - [Variable: None](/auto-docs/free-layout-editor/variables/CancellationToken.None.md): CancellationToken.None Const None: Readonly - [Variable: ClipboardService](/auto-docs/free-layout-editor/variables/ClipboardService-1.md): Const ClipboardService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CommandService](/auto-docs/free-layout-editor/variables/CommandService-1.md): Const CommandService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: ConstantKeys](/auto-docs/free-layout-editor/variables/ConstantKeys.md): Const ConstantKeys: Object 支持外部 constants 自定义的 key 枚举 Type declaration - [Variable: ContributionProvider](/auto-docs/free-layout-editor/variables/ContributionProvider-1.md): Const ContributionProvider: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CropSchemaDecoration](/auto-docs/free-layout-editor/variables/CropSchemaDecoration.md): Const CropSchemaDecoration: SchemaDecoration - [Variable: DEFAULT_SIZE](/auto-docs/free-layout-editor/variables/DEFAULT_SIZE.md): Const DEFAULT_SIZE: Object 默认节点大小 Type declaration - [Variable: DEFAULT_SPACING](/auto-docs/free-layout-editor/variables/DEFAULT_SPACING.md): Const DEFAULT_SPACING: Object 默认一些间隔参数 Type declaration - [Variable: DEG_TO_RAD](/auto-docs/free-layout-editor/variables/DEG_TO_RAD.md): Const DEG_TO_RAD: number Conversion factor for converting degrees to radians. - [Variable: DecorationStyle](/auto-docs/free-layout-editor/variables/DecorationStyle.md): Const DecorationStyle: Object Type declaration - [Variable: DefaultSpacingKey](/auto-docs/free-layout-editor/variables/DefaultSpacingKey.md): Const DefaultSpacingKey: Object spacing default key 值 Type declaration - [Variable: Deferred](/auto-docs/free-layout-editor/variables/Deferred.md): Const Deferred: typeof PromiseDeferred - [Variable: NULL](/auto-docs/free-layout-editor/variables/Disposable.NULL.md): Disposable.NULL Const NULL: Readonly - [Variable: EDITOR_STATE_DEFAULTS](/auto-docs/free-layout-editor/variables/EDITOR_STATE_DEFAULTS.md): Const EDITOR_STATE_DEFAULTS: EditorState[] - [Variable: ENTITIES_BY_DATA_DECO_KEY](/auto-docs/free-layout-editor/variables/ENTITIES_BY_DATA_DECO_KEY.md): Const ENTITIES_BY_DATA_DECO_KEY: unique symbol - [Variable: ENTITIES_DECO_KEY](/auto-docs/free-layout-editor/variables/ENTITIES_DECO_KEY.md): Const ENTITIES_DECO_KEY: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: DEFAULT](/auto-docs/free-layout-editor/variables/EditorProps.DEFAULT.md): EditorProps.DEFAULT Const DEFAULT: EditorProps 默认配置 - [Variable: STATE_GRAB](/auto-docs/free-layout-editor/variables/EditorState.STATE_GRAB.md): EditorState.STATE_GRAB Const STATE_GRAB: EditorState - [Variable: STATE_MOUSE_FRIENDLY_SELECT](/auto-docs/free-layout-editor/variables/EditorState.STATE_MOUSE_FRIENDLY_SELECT.md): EditorState.STATE_MOUSE_FRIENDLY_SELECT Const STATE_MOUSE_FRIENDLY_SELECT: EditorState 鼠标友好模式状态 - [Variable: STATE_SELECT](/auto-docs/free-layout-editor/variables/EditorState.STATE_SELECT.md): EditorState.STATE_SELECT Const STATE_SELECT: EditorState - [Variable: EntityManagerContribution](/auto-docs/free-layout-editor/variables/EntityManagerContribution-1.md): Const EntityManagerContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FLOW_DEFAULT_HIDDEN_TYPES](/auto-docs/free-layout-editor/variables/FLOW_DEFAULT_HIDDEN_TYPES.md): Const FLOW_DEFAULT_HIDDEN_TYPES: FlowNodeType[] - [Variable: FLUSH_LAYER_REQUEST](/auto-docs/free-layout-editor/variables/FLUSH_LAYER_REQUEST.md): Const FLUSH_LAYER_REQUEST: "flush-layer-request" - [Variable: FlipSchemaDecoration](/auto-docs/free-layout-editor/variables/FlipSchemaDecoration.md): Const FlipSchemaDecoration: SchemaDecoration - [Variable: FlowDocumentConfigDefaultData](/auto-docs/free-layout-editor/variables/FlowDocumentConfigDefaultData.md): Const FlowDocumentConfigDefaultData: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentContainerModule](/auto-docs/free-layout-editor/variables/FlowDocumentContainerModule.md): Const FlowDocumentContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentContribution](/auto-docs/free-layout-editor/variables/FlowDocumentContribution-1.md): Const FlowDocumentContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentOptions](/auto-docs/free-layout-editor/variables/FlowDocumentOptions-1.md): Const FlowDocumentOptions: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowDocumentOptionsDefault](/auto-docs/free-layout-editor/variables/FlowDocumentOptionsDefault.md): Const FlowDocumentOptionsDefault: FlowDocumentOptions - [Variable: FlowDocumentProvider](/auto-docs/free-layout-editor/variables/FlowDocumentProvider-1.md): FlowDocumentProvider: typeof FlowDocumentProvider - [Variable: FlowLayout](/auto-docs/free-layout-editor/variables/FlowLayout-1.md): Const FlowLayout: unique symbol - [Variable: FlowLayoutContribution](/auto-docs/free-layout-editor/variables/FlowLayoutContribution-1.md): Const FlowLayoutContribution: unique symbol - [Variable: FlowOperationBaseService](/auto-docs/free-layout-editor/variables/FlowOperationBaseService-1.md): FlowOperationBaseService: typeof FlowOperationBaseService - [Variable: FlowRendererContainerModule](/auto-docs/free-layout-editor/variables/FlowRendererContainerModule.md): Const FlowRendererContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FlowRendererContribution](/auto-docs/free-layout-editor/variables/FlowRendererContribution-1.md): Const FlowRendererContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FreeLayoutPluginContext](/auto-docs/free-layout-editor/variables/FreeLayoutPluginContext-1.md): Const FreeLayoutPluginContext: symbol = PluginContext - [Variable: DEFAULT](/auto-docs/free-layout-editor/variables/FreeLayoutProps.DEFAULT.md): FreeLayoutProps.DEFAULT Const DEFAULT: FreeLayoutProps 默认配置 - [Variable: HistoryContainerModule](/auto-docs/free-layout-editor/variables/HistoryContainerModule.md): Const HistoryContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: I18n](/auto-docs/free-layout-editor/variables/I18n.md): Const I18n: I18nImpl - [Variable: LINE_HOVER_DISTANCE](/auto-docs/free-layout-editor/variables/LINE_HOVER_DISTANCE.md): Const LINE_HOVER_DISTANCE: 8 - [Variable: LayerOptions](/auto-docs/free-layout-editor/variables/LayerOptions-1.md): LayerOptions: typeof LayerOptions - [Variable: LazyInjectContext](/auto-docs/free-layout-editor/variables/LazyInjectContext.md): Const LazyInjectContext: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: MARK_ACTIVATED_ARROW_ID](/auto-docs/free-layout-editor/variables/MARK_ACTIVATED_ARROW_ID.md): Const MARK_ACTIVATED_ARROW_ID: "$marker_arrow_activated$" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: MARK_ARROW_ID](/auto-docs/free-layout-editor/variables/MARK_ARROW_ID.md): Const MARK_ARROW_ID: "$marker_arrow$" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OpacitySchemaDecoration](/auto-docs/free-layout-editor/variables/OpacitySchemaDecoration.md): Const OpacitySchemaDecoration: SchemaDecoration - [Variable: OperationContribution](/auto-docs/free-layout-editor/variables/OperationContribution-1.md): Const OperationContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OriginSchemaDecoration](/auto-docs/free-layout-editor/variables/OriginSchemaDecoration.md): Const OriginSchemaDecoration: SchemaDecoration - [Variable: PI](/auto-docs/free-layout-editor/variables/PI.md): Const PI: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PI_2](/auto-docs/free-layout-editor/variables/PI_2.md): Const PI_2: number Two Pi. - [Variable: POINT_RADIUS](/auto-docs/free-layout-editor/variables/POINT_RADIUS.md): Const POINT_RADIUS: 10 - [Variable: PORT_SIZE](/auto-docs/free-layout-editor/variables/PORT_SIZE.md): Const PORT_SIZE: 24 - [Variable: PaddingSchemaDecoration](/auto-docs/free-layout-editor/variables/PaddingSchemaDecoration.md): Const PaddingSchemaDecoration: SchemaDecoration - [Variable: PipelineLayerFactory](/auto-docs/free-layout-editor/variables/PipelineLayerFactory-1.md): Const PipelineLayerFactory: unique symbol - [Variable: PlaygroundConfig](/auto-docs/free-layout-editor/variables/PlaygroundConfig-1.md): Const PlaygroundConfig: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundContainerFactory](/auto-docs/free-layout-editor/variables/PlaygroundContainerFactory-1.md): Const PlaygroundContainerFactory: unique symbol - [Variable: PlaygroundContainerModule](/auto-docs/free-layout-editor/variables/PlaygroundContainerModule.md): Const PlaygroundContainerModule: ContainerModule - [Variable: PlaygroundContext](/auto-docs/free-layout-editor/variables/PlaygroundContext-1.md): Const PlaygroundContext: unique symbol 会被注入到 layer 层，可以在使用的时候替换它 - [Variable: PlaygroundContextProvider](/auto-docs/free-layout-editor/variables/PlaygroundContextProvider-1.md): Const PlaygroundContextProvider: unique symbol - [Variable: PlaygroundContribution](/auto-docs/free-layout-editor/variables/PlaygroundContribution-1.md): Const PlaygroundContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundEntityContext](/auto-docs/free-layout-editor/variables/PlaygroundEntityContext.md): Const PlaygroundEntityContext: React$1.Context 当前 entity - [Variable: PlaygroundReactContainerContext](/auto-docs/free-layout-editor/variables/PlaygroundReactContainerContext.md): Const PlaygroundReactContainerContext: React$1.Context - [Variable: PlaygroundReactContext](/auto-docs/free-layout-editor/variables/PlaygroundReactContext.md): Const PlaygroundReactContext: React$1.Context Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundReactRefContext](/auto-docs/free-layout-editor/variables/PlaygroundReactRefContext.md): Const PlaygroundReactRefContext: React$1.Context - [Variable: Plugin](/auto-docs/free-layout-editor/variables/Plugin-1.md): Const Plugin: unique symbol - [Variable: PluginContext](/auto-docs/free-layout-editor/variables/PluginContext-1.md): PluginContext: typeof PluginContext - [Variable: EMPTY](/auto-docs/free-layout-editor/variables/Point.EMPTY.md): Point.EMPTY Const EMPTY: IPoint - [Variable: PositionSchemaDecoration](/auto-docs/free-layout-editor/variables/PositionSchemaDecoration.md): Const PositionSchemaDecoration: SchemaDecoration - [Variable: ProtectWheelArea](/auto-docs/free-layout-editor/variables/ProtectWheelArea-1.md): Const ProtectWheelArea: unique symbol 保护区域不被画布劫持滚动事件 - [Variable: RAD_TO_DEG](/auto-docs/free-layout-editor/variables/RAD_TO_DEG.md): Const RAD_TO_DEG: number Conversion factor for converting radians to degrees. - [Variable: RequestCache](/auto-docs/free-layout-editor/variables/RequestCache.md): Const RequestCache: Map> 请求缓存 Param - [Variable: RotationSchemaDecoration](/auto-docs/free-layout-editor/variables/RotationSchemaDecoration.md): Const RotationSchemaDecoration: SchemaDecoration - [Variable: SCALE_WIDTH](/auto-docs/free-layout-editor/variables/SCALE_WIDTH.md): Const SCALE_WIDTH: 0 - [Variable: ScaleSchemaDecoration](/auto-docs/free-layout-editor/variables/ScaleSchemaDecoration.md): Const ScaleSchemaDecoration: SchemaDecoration - [Variable: ScrollBarEvents](/auto-docs/free-layout-editor/variables/ScrollBarEvents-1.md): Const ScrollBarEvents: unique symbol 滚动条点击事件监听 - [Variable: ShadowSchemaDecoration](/auto-docs/free-layout-editor/variables/ShadowSchemaDecoration.md): Const ShadowSchemaDecoration: SchemaDecoration - [Variable: ShortcutsContribution](/auto-docs/free-layout-editor/variables/ShortcutsContribution-1.md): Const ShortcutsContribution: unique symbol - [Variable: SizeSchemaDecoration](/auto-docs/free-layout-editor/variables/SizeSchemaDecoration.md): Const SizeSchemaDecoration: SchemaDecoration - [Variable: SkewSchemaDecoration](/auto-docs/free-layout-editor/variables/SkewSchemaDecoration.md): Const SkewSchemaDecoration: SchemaDecoration - [Variable: StorageService](/auto-docs/free-layout-editor/variables/StorageService-1.md): Const StorageService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: TintSchemaDecoration](/auto-docs/free-layout-editor/variables/TintSchemaDecoration.md): Const TintSchemaDecoration: SchemaDecoration - [Variable: TransformSchemaDecoration](/auto-docs/free-layout-editor/variables/TransformSchemaDecoration.md): Const TransformSchemaDecoration: SchemaDecoration - [Variable: URLParams](/auto-docs/free-layout-editor/variables/URLParams-1.md): Const URLParams: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: VariableContainerModule](/auto-docs/free-layout-editor/variables/VariableContainerModule.md): Const VariableContainerModule: ContainerModule An InversifyJS container module that binds all the necessary services for the variable engine. This module sets up the dependency injection for the core components of the variable engine. - [Variable: VariableEngineProvider](/auto-docs/free-layout-editor/variables/VariableEngineProvider-1.md): Const VariableEngineProvider: unique symbol A provider for dynamically obtaining the VariableEngine instance. This is used to prevent circular dependencies when injecting VariableEngine. - [Variable: WORKFLOW_LINE_ENTITY](/auto-docs/free-layout-editor/variables/WORKFLOW_LINE_ENTITY.md): Const WORKFLOW_LINE_ENTITY: "WorkflowLineEntity" - [Variable: WorkflowDocumentContainerModule](/auto-docs/free-layout-editor/variables/WorkflowDocumentContainerModule.md): Const WorkflowDocumentContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: WorkflowDocumentOptions](/auto-docs/free-layout-editor/variables/WorkflowDocumentOptions-1.md): Const WorkflowDocumentOptions: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: WorkflowDocumentOptionsDefault](/auto-docs/free-layout-editor/variables/WorkflowDocumentOptionsDefault.md): Const WorkflowDocumentOptionsDefault: WorkflowDocumentOptions - [Variable: WorkflowDocumentProvider](/auto-docs/free-layout-editor/variables/WorkflowDocumentProvider-1.md): Const WorkflowDocumentProvider: unique symbol - [Variable: WorkflowNodeEntity](/auto-docs/free-layout-editor/variables/WorkflowNodeEntity-1.md): WorkflowNodeEntity: typeof FlowNodeEntity - [Variable: WorkflowOperationBaseService](/auto-docs/free-layout-editor/variables/WorkflowOperationBaseService-1.md): WorkflowOperationBaseService: typeof WorkflowOperationBaseService - [Variable: logger](/auto-docs/free-layout-editor/variables/logger.md): Const logger: Logger - [Class: CommandRegistry](/auto-docs/playground-react/classes/CommandRegistry.md) - [Class: ConfigEntity](/auto-docs/playground-react/classes/ConfigEntity.md): 用于专门的数据配置，且是单例 - [Class: ContextMenuService](/auto-docs/playground-react/classes/ContextMenuService.md): 圈选右键菜单相关 service - [Class: DefaultClipboardService](/auto-docs/playground-react/classes/DefaultClipboardService.md): 剪贴板服务，一般用于管理临时的复制黏贴数据 TODO: 后续可以支持调用浏览器 - [Class: EditorStateConfigEntity](/auto-docs/playground-react/classes/EditorStateConfigEntity.md): 编辑状态管理 - [Class: Emitter](/auto-docs/playground-react/classes/Emitter.md) - [Class: Entity](/auto-docs/playground-react/classes/Entity-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: EntityData](/auto-docs/playground-react/classes/EntityData.md): 实体的数据块 - [Class: EntityManager](/auto-docs/playground-react/classes/EntityManager.md): TODO registry 改成 decorator Entity 管理器，全局唯一 - [Class: FlushLayerMessage](/auto-docs/playground-react/classes/FlushLayerMessage.md) - [Class: Layer](/auto-docs/playground-react/classes/Layer.md): 基础 layer - [Class: LocalStorageService](/auto-docs/playground-react/classes/LocalStorageService.md) - [Class: LoggerService](/auto-docs/playground-react/classes/LoggerService.md): 画布全局的选择器，可以放任何东西 - [Class: OpacityData](/auto-docs/playground-react/classes/OpacityData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OriginData](/auto-docs/playground-react/classes/OriginData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PipelineEntitiesImpl](/auto-docs/playground-react/classes/PipelineEntitiesImpl.md): 注入到 Layer 中的实体选择器 - [Class: PipelineEntitiesSelector](/auto-docs/playground-react/classes/PipelineEntitiesSelector.md): 选择器用来在 pipeline 绘制之前，筛选并注入 entities - [Class: PipelineRegistry](/auto-docs/playground-react/classes/PipelineRegistry.md): pipeline 注册器，用于注册一些事件 - [Class: PipelineRenderer](/auto-docs/playground-react/classes/PipelineRenderer.md): pipeline 渲染器 - [Class: Playground](/auto-docs/playground-react/classes/Playground.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundConfigEntity](/auto-docs/playground-react/classes/PlaygroundConfigEntity.md): 全局画布的配置信息 - [Class: PlaygroundDrag](/auto-docs/playground-react/classes/PlaygroundDrag-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: PlaygroundGesture](/auto-docs/playground-react/classes/PlaygroundGesture.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PlaygroundLayer](/auto-docs/playground-react/classes/PlaygroundLayer.md): 基础层，控制画布缩放/滚动等操作 - [Class: LayerTestState](/auto-docs/playground-react/classes/PlaygroundMockTools.LayerTestState.md): PlaygroundMockTools.LayerTestState - [Class: PlaygroundRegistry](/auto-docs/playground-react/classes/PlaygroundRegistry.md) - [Class: PlaygroundSchedule](/auto-docs/playground-react/classes/PlaygroundSchedule.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: PositionData](/auto-docs/playground-react/classes/PositionData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: RotationData](/auto-docs/playground-react/classes/RotationData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: ScaleData](/auto-docs/playground-react/classes/ScaleData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: SelectionService](/auto-docs/playground-react/classes/SelectionService.md): 画布全局的选择器，可以放任何东西 - [Class: SizeData](/auto-docs/playground-react/classes/SizeData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: SkewData](/auto-docs/playground-react/classes/SkewData.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: TransformData](/auto-docs/playground-react/classes/TransformData-1.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: Default](/auto-docs/playground-react/enums/Command.Default.md): Command.Default - [Enumeration: LoggerEvent](/auto-docs/playground-react/enums/LoggerEvent.md) - [Enumeration: PipelineLayerPriority](/auto-docs/playground-react/enums/PipelineLayerPriority.md) - [Enumeration: PipelineMessage](/auto-docs/playground-react/enums/PipelineMessage.md) - [Function: applyMatrix](/auto-docs/playground-react/functions/Bounds.applyMatrix.md): Bounds.applyMatrix applyMatrix(bounds, matrix): Rectangle Parameters Returns Rectangle - [Function: getBottomCenter](/auto-docs/playground-react/functions/Bounds.getBottomCenter.md): Bounds.getBottomCenter getBottomCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomLeft](/auto-docs/playground-react/functions/Bounds.getBottomLeft.md): Bounds.getBottomLeft getBottomLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBottomRight](/auto-docs/playground-react/functions/Bounds.getBottomRight.md): Bounds.getBottomRight getBottomRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getBounds](/auto-docs/playground-react/functions/Bounds.getBounds.md): Bounds.getBounds getBounds(target, matrix?): Rectangle 获取外围边界矩形 Parameters Returns Rectangle - [Function: getCenter](/auto-docs/playground-react/functions/Bounds.getCenter.md): Bounds.getCenter getCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftCenter](/auto-docs/playground-react/functions/Bounds.getLeftCenter.md): Bounds.getLeftCenter getLeftCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getLeftPointFromBounds](/auto-docs/playground-react/functions/Bounds.getLeftPointFromBounds.md): Bounds.getLeftPointFromBounds getLeftPointFromBounds(target, matrix?): PositionSchema 找到边框中最左边的点 Parameters Returns PositionSchema - [Function: getPointWithMatrix](/auto-docs/playground-react/functions/Bounds.getPointWithMatrix.md): Bounds.getPointWithMatrix getPointWithMatrix(output, matrix?): PositionSchema 位置做矩阵偏移 Parameters Returns PositionSchema - [Function: getRightCenter](/auto-docs/playground-react/functions/Bounds.getRightCenter.md): Bounds.getRightCenter getRightCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopCenter](/auto-docs/playground-react/functions/Bounds.getTopCenter.md): Bounds.getTopCenter getTopCenter(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopLeft](/auto-docs/playground-react/functions/Bounds.getTopLeft.md): Bounds.getTopLeft getTopLeft(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: getTopPointFromBounds](/auto-docs/playground-react/functions/Bounds.getTopPointFromBounds.md): Bounds.getTopPointFromBounds getTopPointFromBounds(target, matrix?): PositionSchema 找到边框中最上边的点 Parameters Returns PositionSchema - [Function: getTopRight](/auto-docs/playground-react/functions/Bounds.getTopRight.md): Bounds.getTopRight getTopRight(target, matrix?): PositionSchema Parameters Returns PositionSchema - [Function: is](/auto-docs/playground-react/functions/Command.is.md): Command.is is(arg): arg is Command 判断是否是 command Parameters Returns arg is Command - [Function: create](/auto-docs/playground-react/functions/Disposable.create.md): Disposable.create create(func): Disposable Parameters Returns Disposable - [Function: is](/auto-docs/playground-react/functions/Disposable.is.md): Disposable.is is(thing): thing is Disposable Parameters Returns thing is Disposable - [Function: checkDataChanged](/auto-docs/playground-react/functions/Entity.checkDataChanged.md): Entity.checkDataChanged checkDataChanged(oldProps, newProps): boolean 默认数据比较，采用浅比较 Parameters Returns boolean - [Function: getType](/auto-docs/playground-react/functions/Entity.getType.md): Entity.getType getType(registry): string Parameters Returns string - [Function: isRegistryOf](/auto-docs/playground-react/functions/Entity.isRegistryOf.md): Entity.isRegistryOf isRegistryOf(target, Registry): boolean Parameters Returns boolean - [Function: None](/auto-docs/playground-react/functions/Event.None.md): Event.None None(listener, thisArgs?): Disposable Parameters Returns Disposable - [Function: MOUSE_SCROLL_DELTA](/auto-docs/playground-react/functions/MOUSE_SCROLL_DELTA.md): MOUSE_SCROLL_DELTA(zoom): number 鼠标缩放 delta Parameters Returns number - [Function: getEventCoord](/auto-docs/playground-react/functions/MouseTouchEvent.getEventCoord.md): MouseTouchEvent.getEventCoord getEventCoord(e): Object Parameters Returns Object - [Function: isTouchEvent](/auto-docs/playground-react/functions/MouseTouchEvent.isTouchEvent.md): MouseTouchEvent.isTouchEvent isTouchEvent(event): event is TouchEvent Parameters Returns event is TouchEvent - [Function: onTouched](/auto-docs/playground-react/functions/MouseTouchEvent.onTouched.md): MouseTouchEvent.onTouched onTouched(touchStartEvent, callback): void Parameters Returns void - [Function: preventDefault](/auto-docs/playground-react/functions/MouseTouchEvent.preventDefault.md): MouseTouchEvent.preventDefault preventDefault(e): void Parameters Returns void - [Function: touchToMouseEvent](/auto-docs/playground-react/functions/MouseTouchEvent.touchToMouseEvent.md): MouseTouchEvent.touchToMouseEvent touchToMouseEvent(event): Event | MouseEvent Parameters Returns Event | MouseEvent - [Function: startDrag](/auto-docs/playground-react/functions/PlaygroundDrag.startDrag.md): PlaygroundDrag.startDrag startDrag(clientX, clientY, opts?): Disposable 拖拽实体 Type parameters Parameters Returns Disposable - [Function: createContainer](/auto-docs/playground-react/functions/PlaygroundMockTools.createContainer.md): PlaygroundMockTools.createContainer createContainer(modules?): interfaces.Container Parameters Returns interfaces.Container - [Function: createLayerTestState](/auto-docs/playground-react/functions/PlaygroundMockTools.createLayerTestState.md): PlaygroundMockTools.createLayerTestState createLayerTestState(layerRegistry, opts?, modules?): LayerTestState 创建layer, 并记录layer的回调数据 Type parameters Parameters Returns LayerTestState - [Function: createPlayground](/auto-docs/playground-react/functions/PlaygroundMockTools.createPlayground.md): PlaygroundMockTools.createPlayground createPlayground(modules?): Playground Parameters Returns Playground - [Function: getLayerTestState](/auto-docs/playground-react/functions/PlaygroundMockTools.getLayerTestState.md): PlaygroundMockTools.getLayerTestState getLayerTestState(container, layerRegistry): LayerTestState Type parameters Parameters Returns LayerTestState - [Function: PlaygroundReact](/auto-docs/playground-react/functions/PlaygroundReact.md): PlaygroundReact(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: PlaygroundReactContent](/auto-docs/playground-react/functions/PlaygroundReactContent.md): PlaygroundReactContent(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: PlaygroundReactProvider](/auto-docs/playground-react/functions/PlaygroundReactProvider.md): PlaygroundReactProvider(props): null | ReactElement> Playground react 组件 Parameters Returns null | ReactElement> - [Function: PlaygroundReactRenderer](/auto-docs/playground-react/functions/PlaygroundReactRenderer.md): PlaygroundReactRenderer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: coverSize](/auto-docs/playground-react/functions/SizeSchema.coverSize.md): SizeSchema.coverSize coverSize(currentSize, parentSize): number 填充父节点的宽高 Parameters Returns number 返回放大的比例 - [Function: empty](/auto-docs/playground-react/functions/SizeSchema.empty.md): SizeSchema.empty empty(): SizeSchema Returns SizeSchema - [Function: fixSize](/auto-docs/playground-react/functions/SizeSchema.fixSize.md): SizeSchema.fixSize fixSize(currentSize, parentSize): number 适配父节点宽高 Parameters Returns number 返回需要缩放的比例，为 1 则不缩放 - [Function: isParentOrChildrenTransform](/auto-docs/playground-react/functions/TransformData.isParentOrChildrenTransform.md): TransformData.isParentOrChildrenTransform isParentOrChildrenTransform(dragableEntities, target): boolean Parameters Returns boolean - [Function: createDefault](/auto-docs/playground-react/functions/TransformSchema.createDefault.md): TransformSchema.createDefault createDefault(): TransformSchema Returns TransformSchema - [Function: getDelta](/auto-docs/playground-react/functions/TransformSchema.getDelta.md): TransformSchema.getDelta getDelta(oldTransform, newTransform): TransformSchema Parameters Returns TransformSchema - [Function: is](/auto-docs/playground-react/functions/TransformSchema.is.md): TransformSchema.is is(obj): obj is TransformSchema Parameters Returns obj is TransformSchema - [Function: mergeDelta](/auto-docs/playground-react/functions/TransformSchema.mergeDelta.md): TransformSchema.mergeDelta mergeDelta(oldTransform, newTransformDelta, toFixedNum?): TransformSchema Parameters Returns TransformSchema - [Function: toJSON](/auto-docs/playground-react/functions/TransformSchema.toJSON.md): TransformSchema.toJSON toJSON(obj): TransformSchema Parameters Returns TransformSchema - [Function: bindConfigEntity](/auto-docs/playground-react/functions/bindConfigEntity.md): bindConfigEntity(bind, entityRegistry): void 让 entity 可以注入到类中 Parameters Returns void Example - [Function: bindContributionProvider](/auto-docs/playground-react/functions/bindContributionProvider.md): bindContributionProvider(bind, id): void Parameters Returns void - [Function: bindContributions](/auto-docs/playground-react/functions/bindContributions.md): bindContributions(bind, target, contribs): void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns void - [Function: bindPlaygroundContextProvider](/auto-docs/playground-react/functions/bindPlaygroundContextProvider.md): bindPlaygroundContextProvider(bind): void Parameters Returns void - [Function: createConfigDataRegistry](/auto-docs/playground-react/functions/createConfigDataRegistry.md): createConfigDataRegistry

(entity): EntityDataRegistry Type parameters Parameters Returns EntityDataRegistry - [Function: createDefaultPlaygroundConfig](/auto-docs/playground-react/functions/createDefaultPlaygroundConfig.md): createDefaultPlaygroundConfig(): PlaygroundConfig 默认配置 Returns PlaygroundConfig - [Function: createPlaygroundContainer](/auto-docs/playground-react/functions/createPlaygroundContainer.md): createPlaygroundContainer(config?, parent?, container?): interfaces.Container Parameters Returns interfaces.Container - [Function: createPlaygroundLayerDefault](/auto-docs/playground-react/functions/createPlaygroundLayerDefault.md): createPlaygroundLayerDefault(container, layerRegistry, options?): Layer Parameters Returns Layer - [Function: createPlaygroundPlugin](/auto-docs/playground-react/functions/createPlaygroundPlugin.md): createPlaygroundPlugin(options): Plugin Type parameters Parameters Returns Plugin Example - [Function: createPlaygroundReactPreset](/auto-docs/playground-react/functions/createPlaygroundReactPreset.md): createPlaygroundReactPreset(opts, plugins?): PluginsProvider Type parameters Parameters Returns PluginsProvider - [Function: createPluginContextDefault](/auto-docs/playground-react/functions/createPluginContextDefault.md): createPluginContextDefault(container): PluginContext Parameters Returns PluginContext - [Function: createRegistryDecorator](/auto-docs/playground-react/functions/createRegistryDecorator.md): createRegistryDecorator(key, data, getValue?, init?): any Parameters Returns any - [Function: definePluginCreator](/auto-docs/playground-react/functions/definePluginCreator.md): definePluginCreator(config): PluginCreator Type parameters Parameters Returns PluginCreator - [Function: getEntityDatasMetadata](/auto-docs/playground-react/functions/getEntityDatasMetadata.md): getEntityDatasMetadata(layer): { data: EntityDataRegistry ; entity: EntityRegistry }[] Parameters Returns { data: EntityDataRegistry ; entity: EntityRegistry }[] - [Function: getEntityMetadata](/auto-docs/playground-react/functions/getEntityMetadata.md): getEntityMetadata(layer): EntityRegistry[] Parameters Returns EntityRegistry[] - [Function: getRegistryMetadata](/auto-docs/playground-react/functions/getRegistryMetadata.md): getRegistryMetadata(target, key): any[] Parameters Returns any[] - [Function: injectByProvider](/auto-docs/playground-react/functions/injectByProvider.md): injectByProvider(provider): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: injectPlaygroundContext](/auto-docs/playground-react/functions/injectPlaygroundContext.md): injectPlaygroundContext(): (target: any, propertyKey: string) => any Returns fn (target, propertyKey): any Parameters Returns any - [Function: lazyInject](/auto-docs/playground-react/functions/lazyInject.md): lazyInject(serviceIdentifier): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: loadPlugins](/auto-docs/playground-react/functions/loadPlugins.md): loadPlugins(plugins, container): void Parameters Returns void - [Function: observeEntities](/auto-docs/playground-react/functions/observeEntities.md): observeEntities(registry): any 监听 entity 变化 Parameters Returns any - [Function: observeEntity](/auto-docs/playground-react/functions/observeEntity.md): observeEntity(registry): any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns any - [Function: observeEntityDatas](/auto-docs/playground-react/functions/observeEntityDatas.md): observeEntityDatas(entityRegistry, dataRegistry): any 监听 entity 对应的 data 数据变化 Parameters Returns any - [Function: removeInjectedProperties](/auto-docs/playground-react/functions/removeInjectedProperties.md): removeInjectedProperties(instance): void 在 rspack 场景编译ts文件时候 decorator 注入的 property 会被当成 this 的属性, 导致 Reflect.metadata 失效 Parameters Returns void - [Function: scrollIntoViewWithTween](/auto-docs/playground-react/functions/scrollIntoViewWithTween.md): scrollIntoViewWithTween(opts): Disposable 滚动到可视区域 Parameters Returns Disposable - [Function: startTween](/auto-docs/playground-react/functions/startTween.md): startTween(opts): Disposable Type parameters Parameters Returns Disposable - [Function: useConfigEntity](/auto-docs/playground-react/functions/useConfigEntity.md): useConfigEntity(entityRegistry, listenChange?): T 获取 config entity Type parameters Parameters Returns T - [Function: useEntities](/auto-docs/playground-react/functions/useEntities.md): useEntities(entityRegistry): T[] 获取 entities 并监听变化 Type parameters Parameters Returns T[] Deprecated - [Function: useEntityDataFromContext](/auto-docs/playground-react/functions/useEntityDataFromContext.md): useEntityDataFromContext(dataRegistry, listenChange?): T 从上下 PlaygroundEntityContext 获取 entity data 并监听变化 (默认不监听) Type parameters Parameters Returns T - [Function: useEntityFromContext](/auto-docs/playground-react/functions/useEntityFromContext.md): useEntityFromContext(listenChange?): T 从上下 PlaygroundEntityContext 获取 entity 并监听变化(默认不监听) Type parameters Parameters Returns T - [Function: useListenEvents](/auto-docs/playground-react/functions/useListenEvents.md): useListenEvents(...events): void 监听 event 事件变化 Parameters Returns void - [Function: usePlayground](/auto-docs/playground-react/functions/usePlayground.md): usePlayground(): Playground 获取 playground Returns Playground - [Function: usePlaygroundContainer](/auto-docs/playground-react/functions/usePlaygroundContainer.md): usePlaygroundContainer(): interfaces.Container 获取 playground inversify container Returns interfaces.Container - [Function: usePlaygroundContext](/auto-docs/playground-react/functions/usePlaygroundContext.md): usePlaygroundContext(): T 获取 playground context 数据 Type parameters Returns T - [Function: usePlaygroundDrag](/auto-docs/playground-react/functions/usePlaygroundDrag.md): usePlaygroundDrag(): UsePlaygroundDragReturn Returns UsePlaygroundDragReturn - [Function: usePlaygroundTools](/auto-docs/playground-react/functions/usePlaygroundTools.md): usePlaygroundTools(props?): PlaygroundTools Parameters Returns PlaygroundTools - [Function: useRefresh](/auto-docs/playground-react/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (v?): void Parameters Returns void - [Function: useService](/auto-docs/playground-react/functions/useService.md): useService(identifier): T 获取画布的 IOC 模块 Type parameters Parameters Returns T - [Interface: ClipboardService](/auto-docs/playground-react/interfaces/ClipboardService.md) - [Interface: Command](/auto-docs/playground-react/interfaces/Command-1.md) - [Interface: CommandService](/auto-docs/playground-react/interfaces/CommandService.md): command service 执行接口 - [Interface: ConfigEntityProps](/auto-docs/playground-react/interfaces/ConfigEntityProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: ContributionProvider](/auto-docs/playground-react/interfaces/ContributionProvider.md) - [Interface: Disposable](/auto-docs/playground-react/interfaces/Disposable-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: EditorState](/auto-docs/playground-react/interfaces/EditorState-1.md): 编辑态 - [Interface: EditorStateChangeEvent](/auto-docs/playground-react/interfaces/EditorStateChangeEvent.md) - [Interface: EntityDataChangedEvent](/auto-docs/playground-react/interfaces/EntityDataChangedEvent.md) - [Interface: EntityDataRegistry](/auto-docs/playground-react/interfaces/EntityDataRegistry.md) - [Interface: EntityJSON](/auto-docs/playground-react/interfaces/EntityJSON.md): 持久化数据 - [Interface: EntityManagerContribution](/auto-docs/playground-react/interfaces/EntityManagerContribution.md) - [Interface: EntityOpts](/auto-docs/playground-react/interfaces/EntityOpts.md) - [Interface: EntityRegistry](/auto-docs/playground-react/interfaces/EntityRegistry.md): 注册类 - [Interface: Event](/auto-docs/playground-react/interfaces/Event-1.md) - [Interface: LayerEntitiesSelector](/auto-docs/playground-react/interfaces/LayerEntitiesSelector.md) - [Interface: LayerOptions](/auto-docs/playground-react/interfaces/LayerOptions.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: LayerRegistry

](/auto-docs/playground-react/interfaces/LayerRegistry.md) - [Interface: LoggerProps](/auto-docs/playground-react/interfaces/LoggerProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: NodeSchema](/auto-docs/playground-react/interfaces/NodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: OriginSchema](/auto-docs/playground-react/interfaces/OriginSchema.md) - [Interface: PipelineDimension](/auto-docs/playground-react/interfaces/PipelineDimension.md) - [Interface: PipelineEntities](/auto-docs/playground-react/interfaces/PipelineEntities.md): 注入到 Layer 中的实体选择器 - [Interface: PipelineEventRegsiter](/auto-docs/playground-react/interfaces/PipelineEventRegsiter.md) - [Interface: PlaygroundConfig](/auto-docs/playground-react/interfaces/PlaygroundConfig.md): 画布配置 - [Interface: PlaygroundConfigEntityData](/auto-docs/playground-react/interfaces/PlaygroundConfigEntityData.md) - [Interface: PlaygroundConfigRevealOpts](/auto-docs/playground-react/interfaces/PlaygroundConfigRevealOpts.md) - [Interface: PlaygroundContainerFactory](/auto-docs/playground-react/interfaces/PlaygroundContainerFactory.md) - [Interface: PlaygroundContribution](/auto-docs/playground-react/interfaces/PlaygroundContribution.md) - [Interface: PlaygroundDragEntitiesOpts](/auto-docs/playground-react/interfaces/PlaygroundDragEntitiesOpts.md) - [Interface: PlaygroundDragEvent](/auto-docs/playground-react/interfaces/PlaygroundDragEvent.md) - [Interface: PlaygroundDragOptions](/auto-docs/playground-react/interfaces/PlaygroundDragOptions.md) - [Interface: PlaygroundLayerOptions](/auto-docs/playground-react/interfaces/PlaygroundLayerOptions.md) - [Interface: PlaygroundReactContentProps](/auto-docs/playground-react/interfaces/PlaygroundReactContentProps.md) - [Interface: PlaygroundReactProps](/auto-docs/playground-react/interfaces/PlaygroundReactProps.md): 画布配置配置 - [Interface: PlaygroundReactProviderProps](/auto-docs/playground-react/interfaces/PlaygroundReactProviderProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PlaygroundReactRendererProps](/auto-docs/playground-react/interfaces/PlaygroundReactRendererProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PluginBindConfig](/auto-docs/playground-react/interfaces/PluginBindConfig.md) - [Interface: PluginConfig](/auto-docs/playground-react/interfaces/PluginConfig.md) - [Interface: PluginContext](/auto-docs/playground-react/interfaces/PluginContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: PluginsProvider](/auto-docs/playground-react/interfaces/PluginsProvider.md) - [Interface: PositionSchema](/auto-docs/playground-react/interfaces/PositionSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: RegistryInit](/auto-docs/playground-react/interfaces/RegistryInit.md) - [Interface: RegistryValueGetter](/auto-docs/playground-react/interfaces/RegistryValueGetter.md) - [Interface: ScaleSchema](/auto-docs/playground-react/interfaces/ScaleSchema.md) - [Interface: ScrollIntoViewOpts](/auto-docs/playground-react/interfaces/ScrollIntoViewOpts.md) - [Interface: SizeSchema](/auto-docs/playground-react/interfaces/SizeSchema-1.md) - [Interface: SkewSchema](/auto-docs/playground-react/interfaces/SkewSchema.md) - [Interface: StorageService](/auto-docs/playground-react/interfaces/StorageService.md): 存储数据到缓存 - [Interface: TransformNodeSchema](/auto-docs/playground-react/interfaces/TransformNodeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: TransformSchema](/auto-docs/playground-react/interfaces/TransformSchema-1.md) - [Interface: TweenOpts](/auto-docs/playground-react/interfaces/TweenOpts.md) - [Namespace: Bounds](/auto-docs/playground-react/modules/Bounds.md) - [Namespace: Command](/auto-docs/playground-react/modules/Command.md) - [Namespace: Disposable](/auto-docs/playground-react/modules/Disposable.md) - [Namespace: EditorState](/auto-docs/playground-react/modules/EditorState.md) - [Namespace: Entity](/auto-docs/playground-react/modules/Entity.md) - [Namespace: Event](/auto-docs/playground-react/modules/Event.md) - [Namespace: MouseTouchEvent](/auto-docs/playground-react/modules/MouseTouchEvent.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: PlaygroundDrag](/auto-docs/playground-react/modules/PlaygroundDrag.md) - [Namespace: PlaygroundMockTools](/auto-docs/playground-react/modules/PlaygroundMockTools.md): 画布测试工具 Example - [Namespace: SizeSchema](/auto-docs/playground-react/modules/SizeSchema.md) - [Namespace: TransformData](/auto-docs/playground-react/modules/TransformData.md) - [Namespace: TransformSchema](/auto-docs/playground-react/modules/TransformSchema.md) - [Type alias: Cursors](/auto-docs/playground-react/types/Cursors.md): Cursors: Record - [Type alias: EntityDataInjector](/auto-docs/playground-react/types/EntityDataInjector.md): EntityDataInjector: () => OPTS Type declaration (): OPTS Type parameters Returns OPTS - [Type alias: EntityDataProps](/auto-docs/playground-react/types/EntityDataProps.md): EntityDataProps: E["data"] Type parameters - [Type alias: OpacitySchema](/auto-docs/playground-react/types/OpacitySchema.md): OpacitySchema: number Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipeEventName](/auto-docs/playground-react/types/PipeEventName.md): PipeEventName: string - [Type alias: PipeSupportEvent](/auto-docs/playground-react/types/PipeSupportEvent.md): PipeSupportEvent: MouseEvent | DragEvent | KeyboardEvent | UIEvent | TouchEvent | any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: PipelineEventHandler](/auto-docs/playground-react/types/PipelineEventHandler.md): PipelineEventHandler: (event: PipeSupportEvent) => boolean | undefined Type declaration (event): boolean | undefined Parameters Returns boolean | undefined - [Type alias: PipelineLayerFactory](/auto-docs/playground-react/types/PipelineLayerFactory.md): PipelineLayerFactory: (layerRegistry: LayerRegistry, layerOptions?: any) => Layer Type declaration (layerRegistry, layerOptions?): Layer Parameters Returns Layer - [Type alias: PlaygroundContext](/auto-docs/playground-react/types/PlaygroundContext.md): PlaygroundContext: any - [Type alias: PlaygroundContextProvider](/auto-docs/playground-react/types/PlaygroundContextProvider.md): PlaygroundContextProvider: () => any Type declaration (): any Returns any - [Type alias: PlaygroundInteractiveType](/auto-docs/playground-react/types/PlaygroundInteractiveType.md): PlaygroundInteractiveType: "MOUSE" | "PAD" MOUSE: 鼠标友好模式，鼠标左键拖动画布，滚动缩放 (适合 windows ) PAD: 双指同向移动拖动，双指张开捏合缩放 (适合 mac) - [Type alias: PlaygroundRef](/auto-docs/playground-react/types/PlaygroundRef.md): PlaygroundRef: PluginContext - [Type alias: PlaygroundScrollLimitFn](/auto-docs/playground-react/types/PlaygroundScrollLimitFn.md): PlaygroundScrollLimitFn: (scroll: { scrollX: number ; scrollY: number }) => { scrollX: number ; scrollY: number } Type declaration (scroll): Object Parameters Returns Object - [Type alias: Plugin](/auto-docs/playground-react/types/Plugin.md): Plugin: Object Type parameters Type declaration - [Type alias: PluginCreator](/auto-docs/playground-react/types/PluginCreator.md): PluginCreator: (opts: Options) => Plugin Type parameters Type declaration (opts): Plugin Parameters Returns Plugin - [Type alias: ProtectWheelArea](/auto-docs/playground-react/types/ProtectWheelArea.md): ProtectWheelArea: (dom: Element) => boolean Type declaration (dom): boolean Parameters Returns boolean - [Type alias: RotationSchema](/auto-docs/playground-react/types/RotationSchema.md): RotationSchema: number - [Variable: ClipboardService](/auto-docs/playground-react/variables/ClipboardService-1.md): Const ClipboardService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CommandService](/auto-docs/playground-react/variables/CommandService-1.md): Const CommandService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: ContributionProvider](/auto-docs/playground-react/variables/ContributionProvider-1.md): Const ContributionProvider: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: NULL](/auto-docs/playground-react/variables/Disposable.NULL.md): Disposable.NULL Const NULL: Readonly - [Variable: EDITOR_STATE_DEFAULTS](/auto-docs/playground-react/variables/EDITOR_STATE_DEFAULTS.md): Const EDITOR_STATE_DEFAULTS: EditorState[] - [Variable: ENTITIES_BY_DATA_DECO_KEY](/auto-docs/playground-react/variables/ENTITIES_BY_DATA_DECO_KEY.md): Const ENTITIES_BY_DATA_DECO_KEY: unique symbol - [Variable: ENTITIES_DECO_KEY](/auto-docs/playground-react/variables/ENTITIES_DECO_KEY.md): Const ENTITIES_DECO_KEY: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: STATE_GRAB](/auto-docs/playground-react/variables/EditorState.STATE_GRAB.md): EditorState.STATE_GRAB Const STATE_GRAB: EditorState - [Variable: STATE_MOUSE_FRIENDLY_SELECT](/auto-docs/playground-react/variables/EditorState.STATE_MOUSE_FRIENDLY_SELECT.md): EditorState.STATE_MOUSE_FRIENDLY_SELECT Const STATE_MOUSE_FRIENDLY_SELECT: EditorState 鼠标友好模式状态 - [Variable: STATE_SELECT](/auto-docs/playground-react/variables/EditorState.STATE_SELECT.md): EditorState.STATE_SELECT Const STATE_SELECT: EditorState - [Variable: EntityManagerContribution](/auto-docs/playground-react/variables/EntityManagerContribution-1.md): Const EntityManagerContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: FLUSH_LAYER_REQUEST](/auto-docs/playground-react/variables/FLUSH_LAYER_REQUEST.md): Const FLUSH_LAYER_REQUEST: "flush-layer-request" - [Variable: LayerOptions](/auto-docs/playground-react/variables/LayerOptions-1.md): LayerOptions: typeof LayerOptions - [Variable: LazyInjectContext](/auto-docs/playground-react/variables/LazyInjectContext.md): Const LazyInjectContext: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OpacitySchemaDecoration](/auto-docs/playground-react/variables/OpacitySchemaDecoration.md): Const OpacitySchemaDecoration: SchemaDecoration - [Variable: OriginSchemaDecoration](/auto-docs/playground-react/variables/OriginSchemaDecoration.md): Const OriginSchemaDecoration: SchemaDecoration - [Variable: PipelineLayerFactory](/auto-docs/playground-react/variables/PipelineLayerFactory-1.md): Const PipelineLayerFactory: unique symbol - [Variable: PlaygroundConfig](/auto-docs/playground-react/variables/PlaygroundConfig-1.md): Const PlaygroundConfig: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundContainerFactory](/auto-docs/playground-react/variables/PlaygroundContainerFactory-1.md): Const PlaygroundContainerFactory: unique symbol - [Variable: PlaygroundContainerModule](/auto-docs/playground-react/variables/PlaygroundContainerModule.md): Const PlaygroundContainerModule: ContainerModule - [Variable: PlaygroundContext](/auto-docs/playground-react/variables/PlaygroundContext-1.md): Const PlaygroundContext: unique symbol 会被注入到 layer 层，可以在使用的时候替换它 - [Variable: PlaygroundContextProvider](/auto-docs/playground-react/variables/PlaygroundContextProvider-1.md): Const PlaygroundContextProvider: unique symbol - [Variable: PlaygroundContribution](/auto-docs/playground-react/variables/PlaygroundContribution-1.md): Const PlaygroundContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundEntityContext](/auto-docs/playground-react/variables/PlaygroundEntityContext.md): Const PlaygroundEntityContext: React$1.Context 当前 entity - [Variable: PlaygroundReactContainerContext](/auto-docs/playground-react/variables/PlaygroundReactContainerContext.md): Const PlaygroundReactContainerContext: React$1.Context - [Variable: PlaygroundReactContext](/auto-docs/playground-react/variables/PlaygroundReactContext.md): Const PlaygroundReactContext: React$1.Context Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: PlaygroundReactRefContext](/auto-docs/playground-react/variables/PlaygroundReactRefContext.md): Const PlaygroundReactRefContext: React$1.Context - [Variable: Plugin](/auto-docs/playground-react/variables/Plugin-1.md): Const Plugin: unique symbol - [Variable: PluginContext](/auto-docs/playground-react/variables/PluginContext-1.md): PluginContext: typeof PluginContext - [Variable: PositionSchemaDecoration](/auto-docs/playground-react/variables/PositionSchemaDecoration.md): Const PositionSchemaDecoration: SchemaDecoration - [Variable: ProtectWheelArea](/auto-docs/playground-react/variables/ProtectWheelArea-1.md): Const ProtectWheelArea: unique symbol 保护区域不被画布劫持滚动事件 - [Variable: RotationSchemaDecoration](/auto-docs/playground-react/variables/RotationSchemaDecoration.md): Const RotationSchemaDecoration: SchemaDecoration - [Variable: SCALE_WIDTH](/auto-docs/playground-react/variables/SCALE_WIDTH.md): Const SCALE_WIDTH: 0 - [Variable: ScaleSchemaDecoration](/auto-docs/playground-react/variables/ScaleSchemaDecoration.md): Const ScaleSchemaDecoration: SchemaDecoration - [Variable: SizeSchemaDecoration](/auto-docs/playground-react/variables/SizeSchemaDecoration.md): Const SizeSchemaDecoration: SchemaDecoration - [Variable: SkewSchemaDecoration](/auto-docs/playground-react/variables/SkewSchemaDecoration.md): Const SkewSchemaDecoration: SchemaDecoration - [Variable: StorageService](/auto-docs/playground-react/variables/StorageService-1.md): Const StorageService: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: TransformSchemaDecoration](/auto-docs/playground-react/variables/TransformSchemaDecoration.md): Const TransformSchemaDecoration: SchemaDecoration - [Class: CommandRegistry](/auto-docs/command/classes/CommandRegistry.md) - [Enumeration: Default](/auto-docs/command/enums/Command.Default.md): Command.Default - [Function: is](/auto-docs/command/functions/Command.is.md): Command.is is(arg): arg is Command 判断是否是 command Parameters Returns arg is Command - [Interface: Command](/auto-docs/command/interfaces/Command-1.md) - [Interface: CommandContribution](/auto-docs/command/interfaces/CommandContribution.md) - [Interface: CommandHandler](/auto-docs/command/interfaces/CommandHandler.md) - [Interface: CommandService](/auto-docs/command/interfaces/CommandService.md): command service 执行接口 - [Namespace: Command](/auto-docs/command/modules/Command.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: CommandContainerModule](/auto-docs/command/variables/CommandContainerModule.md): Const CommandContainerModule: ContainerModule - [Variable: CommandContribution](/auto-docs/command/variables/CommandContribution-1.md): Const CommandContribution: typeof CommandContribution - [Variable: CommandRegistryFactory](/auto-docs/command/variables/CommandRegistryFactory.md): Const CommandRegistryFactory: "CommandRegistryFactory" - [Variable: CommandService](/auto-docs/command/variables/CommandService-1.md): Const CommandService: typeof CommandService - [Class: HistoryConfig](/auto-docs/history/classes/HistoryConfig.md) - [Class: HistoryContext](/auto-docs/history/classes/HistoryContext.md) - [Class: HistoryManager](/auto-docs/history/classes/HistoryManager.md): 历史服务管理 - [Class: HistoryService](/auto-docs/history/classes/HistoryService.md): 历史服务 - [Class: HistoryStack](/auto-docs/history/classes/HistoryStack.md): 历史栈，聚合所有历史操作 - [Class: OperationRegistry](/auto-docs/history/classes/OperationRegistry.md) - [Class: OperationService](/auto-docs/history/classes/OperationService.md) - [Class: StackOperation](/auto-docs/history/classes/StackOperation.md): UndoRedo元素 - [Class: UndoRedoService](/auto-docs/history/classes/UndoRedoService.md): UndoRedo服务 - [Enumeration: HistoryMergeEventType](/auto-docs/history/enums/HistoryMergeEventType.md) - [Enumeration: HistoryStackChangeType](/auto-docs/history/enums/HistoryStackChangeType.md): 历史栈变化类型 - [Enumeration: UndoRedoChangeType](/auto-docs/history/enums/UndoRedoChangeType.md): undo redo 类型 - [Function: createHistoryPlugin](/auto-docs/history/functions/createHistoryPlugin.md): createHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Interface: HistoryItem](/auto-docs/history/interfaces/HistoryItem.md) - [Interface: HistoryOperation](/auto-docs/history/interfaces/HistoryOperation.md): 操作历史 - [Interface: HistoryPluginOptions](/auto-docs/history/interfaces/HistoryPluginOptions.md) - [Interface: HistoryRecord](/auto-docs/history/interfaces/HistoryRecord.md) - [Interface: HistoryStackAddEvent](/auto-docs/history/interfaces/HistoryStackAddEvent.md): 添加历史事件 - [Interface: HistoryStackAddOperationEvent](/auto-docs/history/interfaces/HistoryStackAddOperationEvent.md): 添加操作事件 - [Interface: HistoryStackBaseEvent](/auto-docs/history/interfaces/HistoryStackBaseEvent.md): 历史栈变化事件基础 - [Interface: HistoryStackItem](/auto-docs/history/interfaces/HistoryStackItem.md) - [Interface: HistoryStackUpdateEvent](/auto-docs/history/interfaces/HistoryStackUpdateEvent.md): 更新历史事件 - [Interface: HistoryStackUpdateOperationEvent](/auto-docs/history/interfaces/HistoryStackUpdateOperationEvent.md): 更新操作事件 - [Interface: IHistoryManager](/auto-docs/history/interfaces/IHistoryManager.md): 历史服务管理 - [Interface: IHistoryService](/auto-docs/history/interfaces/IHistoryService.md): 历史服务 - [Interface: IOperationRegistry](/auto-docs/history/interfaces/IOperationRegistry.md): 操作注册 - [Interface: IOperationService](/auto-docs/history/interfaces/IOperationService.md) - [Interface: IUndoRedoElement](/auto-docs/history/interfaces/IUndoRedoElement.md): UndoRedo元素 - [Interface: IUndoRedoService](/auto-docs/history/interfaces/IUndoRedoService.md): UndoRedo服务 - [Interface: Operation](/auto-docs/history/interfaces/Operation.md): 操作 - [Interface: OperationContribution](/auto-docs/history/interfaces/OperationContribution.md) - [Interface: OperationMeta](/auto-docs/history/interfaces/OperationMeta.md): 操作元数据 - [Interface: PushOperationOptions](/auto-docs/history/interfaces/PushOperationOptions.md): push操作配置 - [Interface: UndoRedoChangeElementEvent](/auto-docs/history/interfaces/UndoRedoChangeElementEvent.md): 带element的事件 - [Interface: UndoRedoClearEvent](/auto-docs/history/interfaces/UndoRedoClearEvent.md): 清空事件 - [Type alias: HistoryMergeEvent](/auto-docs/history/types/HistoryMergeEvent.md): HistoryMergeEvent: { type: ADD ; value: { element: IUndoRedoElement ; operation: Operation } } | { type: UPDATE ; value: { element: IUndoRedoElement ; operation: Operation ; value: any } } 历史合并事件 - [Type alias: HistoryStackChangeEvent](/auto-docs/history/types/HistoryStackChangeEvent.md): HistoryStackChangeEvent: HistoryStackAddEvent | HistoryStackUpdateEvent | HistoryStackAddOperationEvent | HistoryStackUpdateOperationEvent 历史记录变化事件 - [Type alias: IUndoRedoElementFactory](/auto-docs/history/types/IUndoRedoElementFactory.md): IUndoRedoElementFactory: (operation: Operation) => IUndoRedoElement Type parameters Type declaration (operation): IUndoRedoElement 操作工厂 Parameters Returns IUndoRedoElement - [Type alias: OperationWithId](/auto-docs/history/types/OperationWithId.md): OperationWithId: Operation & { id: string } - [Type alias: UndoRedoChangeEvent](/auto-docs/history/types/UndoRedoChangeEvent.md): UndoRedoChangeEvent: UndoRedoChangeElementEvent | UndoRedoClearEvent undo redo变化事件 - [Variable: HistoryContainerModule](/auto-docs/history/variables/HistoryContainerModule.md): Const HistoryContainerModule: ContainerModule - [Variable: OperationContribution](/auto-docs/history/variables/OperationContribution-1.md): Const OperationContribution: typeof OperationContribution - [Class: HistoryDatabase](/auto-docs/history-storage/classes/HistoryDatabase.md): 历史数据库 - [Class: HistoryStorageManager](/auto-docs/history-storage/classes/HistoryStorageManager.md): 历史存储管理 - [Function: useStorageHistoryItems](/auto-docs/history-storage/functions/useStorageHistoryItems.md): useStorageHistoryItems(historyStorageManager, resourceURI): Object Parameters Returns Object - [Interface: HistoryOperationRecord](/auto-docs/history-storage/interfaces/HistoryOperationRecord.md) - [Interface: HistoryRecord](/auto-docs/history-storage/interfaces/HistoryRecord.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryStoragePluginOptions](/auto-docs/history-storage/interfaces/HistoryStoragePluginOptions.md): 插件配置 - [Variable: HistoryStorageContainerModule](/auto-docs/history-storage/variables/HistoryStorageContainerModule.md): Const HistoryStorageContainerModule: any - [Variable: createHistoryStoragePlugin](/auto-docs/history-storage/variables/createHistoryStoragePlugin.md): Const createHistoryStoragePlugin: any - [Interface: I18nLanguage](/auto-docs/i18n/interfaces/I18nLanguage.md) - [Variable: I18n](/auto-docs/i18n/variables/I18n.md): Const I18n: I18nImpl - [Class: ReactiveBaseState](/auto-docs/reactive/classes/ReactiveBaseState.md) - [Class: ReactiveState](/auto-docs/reactive/classes/ReactiveState.md) - [Class: Computation](/auto-docs/reactive/classes/Tracker.Computation.md): Tracker.Computation A Computation object represents code that is repeatedly rerun in response to reactive data changes. Computations don't have return values; they just perform actions, such as rerendering a template on the screen. Computations are created using Tracker.autorun. Use stop to prevent further rerunning of a computation. - [Class: Dependency](/auto-docs/reactive/classes/Tracker.Dependency.md): Tracker.Dependency A Dependency represents an atomic unit of reactive data that a computation might depend on. Reactive data sources such as Session or Minimongo internally create different Dependency objects for different pieces of data, each of which may be depended on by multiple computations. When the data changes, the computations are invalidated. - [Function: afterFlush](/auto-docs/reactive/functions/Tracker.afterFlush.md): Tracker.afterFlush afterFlush(f): void Schedules a function to be called during the next flush, or later in the current flush if one is in progress, after all invalidated computations have been rerun. The function will be run once and not on subsequent flushes unless afterFlush is called again. Parameters Returns void - [Function: autorun](/auto-docs/reactive/functions/Tracker.autorun.md): Tracker.autorun autorun(f, options?): Computation Run a function now and rerun it later whenever its dependencies change. Returns a Computation object that can be used to stop or observe the rerunning. Type parameters Parameters Returns Computation - [Function: flush](/auto-docs/reactive/functions/Tracker.flush.md): Tracker.flush flush(options?): void Process all reactive updates immediately and ensure that all invalidated computations are rerun. Parameters Returns void - [Function: getCurrentComputation](/auto-docs/reactive/functions/Tracker.getCurrentComputation.md): Tracker.getCurrentComputation getCurrentComputation(): Computation | undefined Returns Computation | undefined - [Function: inFlush](/auto-docs/reactive/functions/Tracker.inFlush.md): Tracker.inFlush inFlush(): boolean True if we are computing a computation now, either first time or recompute. This matches Tracker.active unless we are inside Tracker.nonreactive, which nullfies currentComputation even though an enclosing computation may still be running. Returns boolean - [Function: isActive](/auto-docs/reactive/functions/Tracker.isActive.md): Tracker.isActive isActive(): boolean Returns boolean - [Function: onInvalidate](/auto-docs/reactive/functions/Tracker.onInvalidate.md): Tracker.onInvalidate onInvalidate(f): void Parameters Returns void - [Function: withComputation](/auto-docs/reactive/functions/Tracker.withComputation.md): Tracker.withComputation withComputation(computation, f): T 函数在响应式模块中执行 Type parameters Parameters Returns T - [Function: withoutComputation](/auto-docs/reactive/functions/Tracker.withoutComputation.md): Tracker.withoutComputation withoutComputation(f): T 函数在非响应式模块中执行 Type parameters Parameters Returns T - [Function: observe](/auto-docs/reactive/functions/observe.md): observe(fc): React.FC Type parameters Parameters Returns React.FC - [Function: useObserve](/auto-docs/reactive/functions/useObserve.md): useObserve(value): T Type parameters Parameters Returns T - [Function: useReactiveState](/auto-docs/reactive/functions/useReactiveState.md): useReactiveState(v): T Type parameters Parameters Returns T - [Function: useReadonlyReactiveState](/auto-docs/reactive/functions/useReadonlyReactiveState.md): useReadonlyReactiveState(state): Readonly Type parameters Parameters Returns Readonly - [Interface: FlushOptions](/auto-docs/reactive/interfaces/Tracker.FlushOptions.md): Tracker.FlushOptions - [Namespace: Tracker](/auto-docs/reactive/modules/Tracker.md): Tracker 是一套 响应式依赖追踪 库，来源于 Meteor.Tracker https://docs.meteor.com/api/Tracker.html#tracker-autorun-and-async-callbacks https://github.com/meteor/meteor/blob/devel/packages/tracker/tracker.js 相关论文：https://dl.acm.org/doi/fullHtml/10.1145/3184558.3185978 - [Type alias: IComputationCallback](/auto-docs/reactive/types/Tracker.IComputationCallback.md): Tracker.IComputationCallback IComputationCallback: ICallback Type parameters - [Variable: Computation](/auto-docs/reactive/variables/Computation.md): Computation: typeof Computation - [Variable: Dependency](/auto-docs/reactive/variables/Dependency.md): Dependency: typeof Dependency - [Class: CancellationTokenSource](/auto-docs/utils/classes/CancellationTokenSource.md) - [Class: Circle](/auto-docs/utils/classes/Circle.md): The Circle object is used to help draw graphics and can also be used to specify a hit area for displayObjects. - [Class: DisposableCollection](/auto-docs/utils/classes/DisposableCollection.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: DisposableImpl](/auto-docs/utils/classes/DisposableImpl.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Class: Emitter](/auto-docs/utils/classes/Emitter.md) - [Class: Matrix](/auto-docs/utils/classes/Matrix.md): The PIXIJS Matrix as a class makes it a lot faster. Here is a representation of it: - [Class: MutableToken](/auto-docs/utils/classes/MutableToken.md) - [Class: OBBRect](/auto-docs/utils/classes/OBBRect.md): Oriented Bounding Box (OBB) See https://en.wikipedia.org/wiki/Bounding_volume - [Class: Point](/auto-docs/utils/classes/Point-1.md): The Point object represents a location in a two-dimensional coordinate system, where x represents the horizontal axis and y represents the vertical axis. Memberof PIXI Implements IPoint - [Class: PromiseDeferred](/auto-docs/utils/classes/PromiseDeferred.md): Simple implementation of the deferred pattern. An object that exposes a promise and functions to resolve and reject it. - [Class: PromisePool](/auto-docs/utils/classes/PromisePool.md) - [Class: Rectangle](/auto-docs/utils/classes/Rectangle-1.md): Rectangle object is an area defined by its position, as indicated by its top-left corner point (x, y) and by its width and its height. - [Class: Transform](/auto-docs/utils/classes/Transform.md): Transform that takes care about its versions Memberof PIXI - [Enumeration: RectangleAlignTitle](/auto-docs/utils/enums/RectangleAlignTitle.md) - [Enumeration: RectangleAlignType](/auto-docs/utils/enums/RectangleAlignType.md) - [Enumeration: SHAPES](/auto-docs/utils/enums/SHAPES.md): Constants that identify shapes. - [Function: betweenPoints](/auto-docs/utils/functions/Angle.betweenPoints.md): Angle.betweenPoints betweenPoints(point1, point2, originPoint?): number 计算两个点的夹角 Parameters Returns number The angle in radians. - [Function: wrap](/auto-docs/utils/functions/Angle.wrap.md): Angle.wrap wrap(angle): number Wrap an angle. Wraps the angle to a value in the range of -PI to PI. Parameters Returns number The wrapped angle, in radians. - [Function: wrapDegrees](/auto-docs/utils/functions/Angle.wrapDegrees.md): Angle.wrapDegrees wrapDegrees(angle): number Wrap an angle in degrees. Wraps the angle to a value in the range of -180 to 180. Parameters Returns number The wrapped angle, in degrees. - [Function: assign](/auto-docs/utils/functions/Cache.assign.md): Cache.assign assign(target, fn): Cache Type parameters Parameters Returns Cache - [Function: create](/auto-docs/utils/functions/Cache.create.md): Cache.create create(cacheFactory, opts?): CacheManager Type parameters Parameters Returns CacheManager - [Function: createShortCache](/auto-docs/utils/functions/Cache.createShortCache.md): Cache.createShortCache createShortCache(timeout?): ShortCache 短存储 Type parameters Parameters Returns ShortCache - [Function: createWeakCache](/auto-docs/utils/functions/Cache.createWeakCache.md): Cache.createWeakCache createWeakCache(): WeakCache Returns WeakCache - [Function: isCancellationToken](/auto-docs/utils/functions/CancellationToken.isCancellationToken.md): CancellationToken.isCancellationToken isCancellationToken(thing): thing is CancellationToken Parameters Returns thing is CancellationToken - [Function: isArrayShallowChanged](/auto-docs/utils/functions/Compare.isArrayShallowChanged.md): Compare.isArrayShallowChanged isArrayShallowChanged(arr1, arr2): boolean Parameters Returns boolean - [Function: isChanged](/auto-docs/utils/functions/Compare.isChanged.md): Compare.isChanged isChanged(oldProps, newProps, depth?, partial?): boolean 比较，默认浅比较 Parameters Returns boolean - [Function: isDeepChanged](/auto-docs/utils/functions/Compare.isDeepChanged.md): Compare.isDeepChanged isDeepChanged(oldProps, newProps, partial?): boolean 深度比较 Parameters Returns boolean - [Function: create](/auto-docs/utils/functions/Disposable.create.md): Disposable.create create(func): Disposable Parameters Returns Disposable - [Function: is](/auto-docs/utils/functions/Disposable.is.md): Disposable.is is(thing): thing is Disposable Parameters Returns thing is Disposable - [Function: None](/auto-docs/utils/functions/Event.None.md): Event.None None(listener, thisArgs?): Disposable Parameters Returns Disposable - [Function: NOOP](/auto-docs/utils/functions/NOOP.md): NOOP(): void Returns void - [Function: empty](/auto-docs/utils/functions/PaddingSchema.empty.md): PaddingSchema.empty empty(): Object Returns Object - [Function: fixZero](/auto-docs/utils/functions/Point.fixZero.md): Point.fixZero fixZero(output): IPoint Parameters Returns IPoint - [Function: getDistance](/auto-docs/utils/functions/Point.getDistance.md): Point.getDistance getDistance(p1, p2): number 获取两点间的距离 Parameters Returns number - [Function: getMiddlePoint](/auto-docs/utils/functions/Point.getMiddlePoint.md): Point.getMiddlePoint getMiddlePoint(p1, p2): IPoint 获取两点间的中间点 Parameters Returns IPoint - [Function: getRatioPoint](/auto-docs/utils/functions/Point.getRatioPoint.md): Point.getRatioPoint getRatioPoint(p1, p2, ratio): IPoint 按一定比例，获取两点间的中间点 Parameters Returns IPoint - [Function: move](/auto-docs/utils/functions/Point.move.md): Point.move move(current, m): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: moveDistanceToDirection](/auto-docs/utils/functions/Point.moveDistanceToDirection.md): Point.moveDistanceToDirection moveDistanceToDirection(current, direction, distance): IPoint 往目标点移动 distance 距离 Parameters Returns IPoint - [Function: align](/auto-docs/utils/functions/Rectangle.align.md): Rectangle.align align(rectangles, type): Rectangle[] 矩形对齐 Parameters Returns Rectangle[] - [Function: createRectangleWithTwoPoints](/auto-docs/utils/functions/Rectangle.createRectangleWithTwoPoints.md): Rectangle.createRectangleWithTwoPoints createRectangleWithTwoPoints(point1, point2): Rectangle 根据两点创建矩形 Parameters Returns Rectangle - [Function: enlarge](/auto-docs/utils/functions/Rectangle.enlarge.md): Rectangle.enlarge enlarge(rectangles): Rectangle 获取所有矩形的外围最大边框 Parameters Returns Rectangle - [Function: intersects](/auto-docs/utils/functions/Rectangle.intersects.md): Rectangle.intersects intersects(target1, target2, direction?): boolean 判断矩形相交 Parameters Returns boolean - [Function: intersectsWithRotation](/auto-docs/utils/functions/Rectangle.intersectsWithRotation.md): Rectangle.intersectsWithRotation intersectsWithRotation(rect1, rotate1, rect2, rotate2): boolean 使用 OBB 算法判断两个旋转矩形是否相交 Parameters Returns boolean - [Function: isViewportVisible](/auto-docs/utils/functions/Rectangle.isViewportVisible.md): Rectangle.isViewportVisible isViewportVisible(rect, viewport, rotation?, isContains?): boolean 判断指定 rect 是否在 viewport 可见 Parameters Returns boolean - [Function: setViewportVisible](/auto-docs/utils/functions/Rectangle.setViewportVisible.md): Rectangle.setViewportVisible setViewportVisible(bounds, viewport, padding?): Rectangle 保证bounds 永远在 viewport 里边 Parameters Returns Rectangle - [Function: createDefault](/auto-docs/utils/functions/Schema.createDefault.md): Schema.createDefault createDefault(decoration, mixinDefaults?, _key?): T Type parameters Parameters Returns T - [Function: isBaseType](/auto-docs/utils/functions/Schema.isBaseType.md): Schema.isBaseType isBaseType(decoration): boolean 非 object 类 Parameters Returns boolean - [Function: create](/auto-docs/utils/functions/SchemaDecoration.create.md): SchemaDecoration.create create(properties, baseDecoration?, mixinDefaults?): SchemaDecoration 扩展 SchemaDecoration Type parameters Parameters Returns SchemaDecoration Example - [Function: coverSize](/auto-docs/utils/functions/SizeSchema.coverSize.md): SizeSchema.coverSize coverSize(currentSize, parentSize): number 填充父节点的宽高 Parameters Returns number 返回放大的比例 - [Function: empty](/auto-docs/utils/functions/SizeSchema.empty.md): SizeSchema.empty empty(): SizeSchema Returns SizeSchema - [Function: fixSize](/auto-docs/utils/functions/SizeSchema.fixSize.md): SizeSchema.fixSize fixSize(currentSize, parentSize): number 适配父节点宽高 Parameters Returns number 返回需要缩放的比例，为 1 则不缩放 - [Function: isEmpty](/auto-docs/utils/functions/TintSchema.isEmpty.md): TintSchema.isEmpty isEmpty(tint): boolean Parameters Returns boolean - [Function: createDefault](/auto-docs/utils/functions/TransformSchema.createDefault.md): TransformSchema.createDefault createDefault(): TransformSchema Returns TransformSchema - [Function: getDelta](/auto-docs/utils/functions/TransformSchema.getDelta.md): TransformSchema.getDelta getDelta(oldTransform, newTransform): TransformSchema Parameters Returns TransformSchema - [Function: is](/auto-docs/utils/functions/TransformSchema.is.md): TransformSchema.is is(obj): obj is TransformSchema Parameters Returns obj is TransformSchema - [Function: mergeDelta](/auto-docs/utils/functions/TransformSchema.mergeDelta.md): TransformSchema.mergeDelta mergeDelta(oldTransform, newTransformDelta, toFixedNum?): TransformSchema Parameters Returns TransformSchema - [Function: toJSON](/auto-docs/utils/functions/TransformSchema.toJSON.md): TransformSchema.toJSON toJSON(obj): TransformSchema Parameters Returns TransformSchema - [Function: addEventListener](/auto-docs/utils/functions/addEventListener.md): addEventListener(element, type, listener, useCapture?): Disposable Type parameters Parameters Returns Disposable - [Function: arrayToSet](/auto-docs/utils/functions/arrayToSet.md): arrayToSet(arr): Set Parameters Returns Set - [Function: arrayUnion](/auto-docs/utils/functions/arrayUnion.md): arrayUnion(arr): any[] Parameters Returns any[] See https://stackoverflow.com/a/9229821 export function arrayUnion(arr: any[]): any[] { return [...new Set(arr)] } - [Function: bindContributionProvider](/auto-docs/utils/functions/bindContributionProvider.md): bindContributionProvider(bind, id): void Parameters Returns void - [Function: bindContributions](/auto-docs/utils/functions/bindContributions.md): bindContributions(bind, target, contribs): void Parameters Returns void - [Function: cancelled](/auto-docs/utils/functions/cancelled.md): cancelled(): Error Returns Error - [Function: checkCancelled](/auto-docs/utils/functions/checkCancelled.md): checkCancelled(token?): void Parameters Returns void - [Function: clearRequestCache](/auto-docs/utils/functions/clearRequestCache.md): clearRequestCache(): void Returns void - [Function: compose](/auto-docs/utils/functions/compose.md): compose(...fns): Func Type parameters Parameters Returns Func - [Function: composeAsync](/auto-docs/utils/functions/composeAsync.md): composeAsync(...fns): FuncPromise Type parameters Parameters Returns FuncPromise - [Function: deepFreeze](/auto-docs/utils/functions/deepFreeze.md): deepFreeze(obj): T Type parameters Parameters Returns T - [Function: delay](/auto-docs/utils/functions/delay.md): delay(ms, token?): Promise Parameters Returns Promise resolves after a specified number of milliseconds Throws cancelled if a given token is cancelled before a specified number of milliseconds - [Function: addClass](/auto-docs/utils/functions/domUtils.addClass.md): domUtils.addClass addClass(element, ...classNames): void Parameters Returns void - [Function: addStandardDisposableListener](/auto-docs/utils/functions/domUtils.addStandardDisposableListener.md): domUtils.addStandardDisposableListener addStandardDisposableListener(dom, type, listener, options?): Disposable Parameters Returns Disposable - [Function: classNameWithPrefix](/auto-docs/utils/functions/domUtils.classNameWithPrefix.md): domUtils.classNameWithPrefix classNameWithPrefix(prefix): (key: string, opts?: any) => string Parameters Returns fn (key, opts?): string Parameters Returns string - [Function: clearChildren](/auto-docs/utils/functions/domUtils.clearChildren.md): domUtils.clearChildren clearChildren(container): void Parameters Returns void - [Function: coverClass](/auto-docs/utils/functions/domUtils.coverClass.md): domUtils.coverClass coverClass(element, ...classNames): void Parameters Returns void - [Function: createDOMCache](/auto-docs/utils/functions/domUtils.createDOMCache.md): domUtils.createDOMCache createDOMCache(parent, className, children?): CacheManager dom 缓存 Type parameters Parameters Returns CacheManager - [Function: createDivWithClass](/auto-docs/utils/functions/domUtils.createDivWithClass.md): domUtils.createDivWithClass createDivWithClass(...classNames): HTMLDivElement Parameters Returns HTMLDivElement - [Function: createElement](/auto-docs/utils/functions/domUtils.createElement.md): domUtils.createElement createElement(ele, ...classNames): T Type parameters Parameters Returns T - [Function: delClass](/auto-docs/utils/functions/domUtils.delClass.md): domUtils.delClass delClass(element, ...classNames): void Parameters Returns void - [Function: disableEvent](/auto-docs/utils/functions/domUtils.disableEvent.md): domUtils.disableEvent disableEvent(element): void Parameters Returns void - [Function: enableEvent](/auto-docs/utils/functions/domUtils.enableEvent.md): domUtils.enableEvent enableEvent(element): void Parameters Returns void - [Function: fromPercent](/auto-docs/utils/functions/domUtils.fromPercent.md): domUtils.fromPercent fromPercent(percent): number Parameters Returns number - [Function: setStyle](/auto-docs/utils/functions/domUtils.setStyle.md): domUtils.setStyle setStyle(node, styles): void Parameters Returns void - [Function: toPercent](/auto-docs/utils/functions/domUtils.toPercent.md): domUtils.toPercent toPercent(percent): string Parameters Returns string - [Function: toPixel](/auto-docs/utils/functions/domUtils.toPixel.md): domUtils.toPixel toPixel(num): string Parameters Returns string - [Function: translatePercent](/auto-docs/utils/functions/domUtils.translatePercent.md): domUtils.translatePercent translatePercent(node, x, y): void Parameters Returns void - [Function: translateXPercent](/auto-docs/utils/functions/domUtils.translateXPercent.md): domUtils.translateXPercent translateXPercent(node, x): void Parameters Returns void - [Function: translateYPercent](/auto-docs/utils/functions/domUtils.translateYPercent.md): domUtils.translateYPercent translateYPercent(node, y): void Parameters Returns void - [Function: each](/auto-docs/utils/functions/each.md): each(obj, fn): void Type parameters Parameters Returns void - [Function: filter](/auto-docs/utils/functions/filter.md): filter(obj, fn, dest?): any Parameters Returns any - [Function: generateLocalId](/auto-docs/utils/functions/generateLocalId.md): generateLocalId(): LocalId Returns LocalId - [Function: getByKey](/auto-docs/utils/functions/getByKey.md): getByKey(target, key): any | undefined Parameters Returns any | undefined Example - [Function: getTag](/auto-docs/utils/functions/getTag.md): getTag(v): string Parameters Returns string - [Function: isCancelled](/auto-docs/utils/functions/isCancelled.md): isCancelled(err): boolean Parameters Returns boolean - [Function: isEmpty](/auto-docs/utils/functions/isEmpty.md): isEmpty(arg): boolean true if the argument is an empty object. Otherwise, false. Parameters Returns boolean - [Function: isFunction](/auto-docs/utils/functions/isFunction.md): isFunction(v): v is T Type parameters Parameters Returns v is T - [Function: isNumber](/auto-docs/utils/functions/isNumber.md): isNumber(v): v is number Parameters Returns v is number - [Function: isObject](/auto-docs/utils/functions/isObject.md): isObject(v): v is UnknownObject Type parameters Parameters Returns v is UnknownObject - [Function: isPlainObject](/auto-docs/utils/functions/isPlainObject.md): isPlainObject(obj): boolean Parameters Returns boolean True if the argument appears to be a plain object. - [Function: isString](/auto-docs/utils/functions/isString.md): isString(v): v is string Parameters Returns v is string - [Function: iterToArray](/auto-docs/utils/functions/iterToArray.md): iterToArray(iter): T[] Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters Parameters Returns T[] - [Function: mapKeys](/auto-docs/utils/functions/mapKeys.md): mapKeys(obj, fn): any Type parameters Parameters Returns any - [Function: mapValues](/auto-docs/utils/functions/mapValues.md): mapValues(obj, fn): any Type parameters Parameters Returns any - [Function: notEmpty](/auto-docs/utils/functions/notEmpty.md): notEmpty(arg): arg is T Type parameters Parameters Returns arg is T - [Function: omit](/auto-docs/utils/functions/omit.md): omit(obj, fields, dest?): any Parameters Returns any - [Function: pick](/auto-docs/utils/functions/pick.md): pick(obj, fields, dest?): any Parameters Returns any - [Function: reduce](/auto-docs/utils/functions/reduce.md): reduce(obj, fn, res?): R Type parameters Parameters Returns R - [Function: requestWithMemo](/auto-docs/utils/functions/requestWithMemo.md): requestWithMemo(req, cacheTime?, createCacheKey?): RequestFn Parameters Returns RequestFn - [Function: retry](/auto-docs/utils/functions/retry.md): retry(task, delayTime, retries, shouldRetry?): Promise Type parameters Parameters Returns Promise - [Function: safeKey](/auto-docs/utils/functions/safeKey.md): safeKey(key): string filter dangerous key, prevent prototype pollution injection Parameters Returns string filtered key - [Function: setByKey](/auto-docs/utils/functions/setByKey.md): setByKey(target, key, newValue, autoCreateObject?, clone?): any Parameters Returns any Example - [Function: _setIdx](/auto-docs/utils/functions/setIdx.md): _setIdx(idx): void Parameters Returns void - [Function: useRefresh](/auto-docs/utils/functions/useRefresh.md): useRefresh(defaultValue?): (v?: any) => void Parameters Returns fn (v?): void Parameters Returns void - [Function: values](/auto-docs/utils/functions/values.md): values(obj): any[] Parameters Returns any[] - [Interface: AsClass](/auto-docs/utils/interfaces/AsClass.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: CacheManager](/auto-docs/utils/interfaces/CacheManager.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: CacheOpts](/auto-docs/utils/interfaces/CacheOpts.md) - [Interface: CacheOriginItem](/auto-docs/utils/interfaces/CacheOriginItem.md) - [Interface: CancellationToken](/auto-docs/utils/interfaces/CancellationToken-1.md) - [Interface: ContributionProvider](/auto-docs/utils/interfaces/ContributionProvider.md) - [Interface: DOMCache](/auto-docs/utils/interfaces/DOMCache.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: Disposable](/auto-docs/utils/interfaces/Disposable-1.md): An object that performs a cleanup operation when .dispose() is called. Some examples of how disposables are used: An event listener that removes itself when .dispose() is called.The return value from registering a provider. When .dispose() is called, the provider is unregistered. - [Interface: Event](/auto-docs/utils/interfaces/Event-1.md) - [Interface: EventListener](/auto-docs/utils/interfaces/EventListener.md) - [Interface: FlipSchema](/auto-docs/utils/interfaces/FlipSchema.md) - [Interface: IPoint](/auto-docs/utils/interfaces/IPoint.md): Common interface for points. Both Point and ObservablePoint implement it - [Interface: OriginSchema](/auto-docs/utils/interfaces/OriginSchema.md) - [Interface: PaddingSchema](/auto-docs/utils/interfaces/PaddingSchema-1.md) - [Interface: PositionSchema](/auto-docs/utils/interfaces/PositionSchema.md) - [Interface: PromisePoolOpts](/auto-docs/utils/interfaces/PromisePoolOpts.md) - [Interface: PromiseTask](/auto-docs/utils/interfaces/PromiseTask.md) - [Interface: ScaleSchema](/auto-docs/utils/interfaces/ScaleSchema.md) - [Interface: SchemaDecoration](/auto-docs/utils/interfaces/SchemaDecoration-1.md) - [Interface: ScrollSchema](/auto-docs/utils/interfaces/ScrollSchema.md) - [Interface: ShadowSchema](/auto-docs/utils/interfaces/ShadowSchema.md) - [Interface: ShortCache](/auto-docs/utils/interfaces/ShortCache.md) - [Interface: SizeSchema](/auto-docs/utils/interfaces/SizeSchema-1.md) - [Interface: SkewSchema](/auto-docs/utils/interfaces/SkewSchema.md) - [Interface: TintSchema](/auto-docs/utils/interfaces/TintSchema-1.md) - [Interface: TransformSchema](/auto-docs/utils/interfaces/TransformSchema-1.md) - [Interface: WeakCache](/auto-docs/utils/interfaces/WeakCache.md) - [Namespace: Angle](/auto-docs/utils/modules/Angle.md) - [Namespace: Cache](/auto-docs/utils/modules/Cache.md): 缓存工具： 可延迟按需创建，提升性能可支持多个或单个，有些动态创建多个的场景可以共享已有的实例，提升性能自动删除，超过一定的数目会自动做清空回收 Example - [Namespace: CancellationToken](/auto-docs/utils/modules/CancellationToken.md) - [Namespace: Compare](/auto-docs/utils/modules/Compare.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: Disposable](/auto-docs/utils/modules/Disposable.md) - [Namespace: Event](/auto-docs/utils/modules/Event.md) - [Namespace: PaddingSchema](/auto-docs/utils/modules/PaddingSchema.md) - [Namespace: Point](/auto-docs/utils/modules/Point.md) - [Namespace: Rectangle](/auto-docs/utils/modules/Rectangle.md) - [Namespace: Schema](/auto-docs/utils/modules/Schema.md) - [Namespace: SchemaDecoration](/auto-docs/utils/modules/SchemaDecoration.md) - [Namespace: SizeSchema](/auto-docs/utils/modules/SizeSchema.md) - [Namespace: TintSchema](/auto-docs/utils/modules/TintSchema.md) - [Namespace: TransformSchema](/auto-docs/utils/modules/TransformSchema.md) - [Namespace: domUtils](/auto-docs/utils/modules/domUtils.md) - [Type alias: CSSStyle](/auto-docs/utils/types/CSSStyle.md): CSSStyle: { [P in keyof CSSStyleDeclaration]?: string | number } - [Type alias: Cache](/auto-docs/utils/types/Cache-1.md): Cache: { [P in keyof T]: T[P] } & { dispose?: () => void ; key?: any } Type parameters - [Type alias: ISize](/auto-docs/utils/types/ISize.md): ISize: Object Size object, contains width and height Type declaration - [Type alias: LocalId](/auto-docs/utils/types/LocalId.md): LocalId: number - [Type alias: MarginSchema](/auto-docs/utils/types/MarginSchema.md): MarginSchema: PaddingSchema - [Type alias: MaybeArray](/auto-docs/utils/types/MaybeArray.md): MaybeArray: T | T[] Type parameters - [Type alias: MaybePromise](/auto-docs/utils/types/MaybePromise.md): MaybePromise: T | PromiseLike Type parameters - [Type alias: OpacitySchema](/auto-docs/utils/types/OpacitySchema.md): OpacitySchema: number - [Type alias: RecursivePartial](/auto-docs/utils/types/RecursivePartial.md): RecursivePartial: { [P in keyof T]?: T[P] extends (infer I)[] ? RecursivePartial[] : RecursivePartial } Type parameters - [Type alias: RotationSchema](/auto-docs/utils/types/RotationSchema.md): RotationSchema: number - [Type alias: SchemaType](/auto-docs/utils/types/SchemaType.md): SchemaType: "string" | "integer" | "float" | "boolean" | "enum" | "object" | "range" | "color" | "array" - [Type alias: Xor](/auto-docs/utils/types/Xor.md): Xor: T | U extends object ? Without & U | Without & T : T | U Type parameters - [Variable: Cancelled](/auto-docs/utils/variables/CancellationToken.Cancelled.md): CancellationToken.Cancelled Const Cancelled: Readonly - [Variable: None](/auto-docs/utils/variables/CancellationToken.None.md): CancellationToken.None Const None: Readonly - [Variable: ContributionProvider](/auto-docs/utils/variables/ContributionProvider-1.md): Const ContributionProvider: typeof ContributionProvider - [Variable: CropSchemaDecoration](/auto-docs/utils/variables/CropSchemaDecoration.md): Const CropSchemaDecoration: SchemaDecoration - [Variable: DEG_TO_RAD](/auto-docs/utils/variables/DEG_TO_RAD.md): Const DEG_TO_RAD: number Conversion factor for converting degrees to radians. - [Variable: DecorationStyle](/auto-docs/utils/variables/DecorationStyle.md): Const DecorationStyle: Object Type declaration - [Variable: Deferred](/auto-docs/utils/variables/Deferred.md): Const Deferred: typeof PromiseDeferred = PromiseDeferred - [Variable: NULL](/auto-docs/utils/variables/Disposable.NULL.md): Disposable.NULL Const NULL: Readonly - [Variable: FlipSchemaDecoration](/auto-docs/utils/variables/FlipSchemaDecoration.md): Const FlipSchemaDecoration: SchemaDecoration - [Variable: OpacitySchemaDecoration](/auto-docs/utils/variables/OpacitySchemaDecoration.md): Const OpacitySchemaDecoration: SchemaDecoration - [Variable: OriginSchemaDecoration](/auto-docs/utils/variables/OriginSchemaDecoration.md): Const OriginSchemaDecoration: SchemaDecoration - [Variable: PI](/auto-docs/utils/variables/PI.md): PI: number - [Variable: PI_2](/auto-docs/utils/variables/PI_2.md): Const PI_2: number Two Pi. - [Variable: PaddingSchemaDecoration](/auto-docs/utils/variables/PaddingSchemaDecoration.md): Const PaddingSchemaDecoration: SchemaDecoration - [Variable: EMPTY](/auto-docs/utils/variables/Point.EMPTY.md): Point.EMPTY Const EMPTY: IPoint - [Variable: PositionSchemaDecoration](/auto-docs/utils/variables/PositionSchemaDecoration.md): Const PositionSchemaDecoration: SchemaDecoration - [Variable: RAD_TO_DEG](/auto-docs/utils/variables/RAD_TO_DEG.md): Const RAD_TO_DEG: number Conversion factor for converting radians to degrees. - [Variable: RequestCache](/auto-docs/utils/variables/RequestCache.md): Const RequestCache: Map> 请求缓存 Param - [Variable: RotationSchemaDecoration](/auto-docs/utils/variables/RotationSchemaDecoration.md): Const RotationSchemaDecoration: SchemaDecoration - [Variable: ScaleSchemaDecoration](/auto-docs/utils/variables/ScaleSchemaDecoration.md): Const ScaleSchemaDecoration: SchemaDecoration - [Variable: ShadowSchemaDecoration](/auto-docs/utils/variables/ShadowSchemaDecoration.md): Const ShadowSchemaDecoration: SchemaDecoration - [Variable: SizeSchemaDecoration](/auto-docs/utils/variables/SizeSchemaDecoration.md): Const SizeSchemaDecoration: SchemaDecoration - [Variable: SkewSchemaDecoration](/auto-docs/utils/variables/SkewSchemaDecoration.md): Const SkewSchemaDecoration: SchemaDecoration - [Variable: TintSchemaDecoration](/auto-docs/utils/variables/TintSchemaDecoration.md): Const TintSchemaDecoration: SchemaDecoration - [Variable: TransformSchemaDecoration](/auto-docs/utils/variables/TransformSchemaDecoration.md): Const TransformSchemaDecoration: SchemaDecoration - [Variable: logger](/auto-docs/utils/variables/logger.md): Const logger: Logger - [Class: FocusableWidget](/auto-docs/coze-editor/classes/FocusableWidget.md) - [Class: SpanWidget](/auto-docs/coze-editor/classes/SpanWidget.md) - [Enumeration: SelectionSide](/auto-docs/coze-editor/enums/SelectionSide.md) - [Function: api](/auto-docs/coze-editor/functions/api.md): api(name, handler): APIPluginSpec Type parameters Parameters Returns APIPluginSpec - [Function: create](/auto-docs/coze-editor/functions/create.md): create(«destructured»): Object Type parameters Parameters Returns Object - [Function: event](/auto-docs/coze-editor/functions/event.md): event(name, handler): EventPluginSpec Type parameters Parameters Returns EventPluginSpec - [Function: extension](/auto-docs/coze-editor/functions/extension.md): extension(ext): ExtensionPluginSpec Parameters Returns ExtensionPluginSpec - [Function: indentGuides](/auto-docs/coze-editor/functions/indentGuides.md): indentGuides(): Extension[] Returns Extension[] - [Function: inputRules](/auto-docs/coze-editor/functions/inputRules.md): inputRules(rules?): Extension Parameters Returns Extension - [Function: mixLanguages](/auto-docs/coze-editor/functions/mixLanguages.md): mixLanguages(«destructured»): LRLanguage Parameters Returns LRLanguage - [Function: option](/auto-docs/coze-editor/functions/option.md): option(name, handler): OptionPluginSpec Type parameters Parameters Returns OptionPluginSpec - [Function: scrollBeyondLastLine](/auto-docs/coze-editor/functions/scrollBeyondLastLine.md): scrollBeyondLastLine(scrollHeight?): Extension[] Parameters Returns Extension[] - [Function: updateWholeDecorations](/auto-docs/coze-editor/functions/updateWholeDecorations.md): updateWholeDecorations(view): void Parameters Returns void - [Interface: DeletionEnlargerSpec](/auto-docs/coze-editor/interfaces/DeletionEnlargerSpec.md) - [Interface: InputRule](/auto-docs/coze-editor/interfaces/InputRule.md) - [Interface: SelectionEnlargerSpec](/auto-docs/coze-editor/interfaces/SelectionEnlargerSpec.md) - [Type alias: CursorASTDecorator](/auto-docs/coze-editor/types/CursorASTDecorator.md): CursorASTDecorator: (cursor: TreeCursor, state: EditorState) => ClassNameDecorationSpec | BackgroundDecorationSpec | undefined Type declaration (cursor, state): ClassNameDecorationSpec | BackgroundDecorationSpec | undefined Parameters Returns ClassNameDecorationSpec | BackgroundDecorationSpec | undefined - [Type alias: WholeASTDecorator](/auto-docs/coze-editor/types/WholeASTDecorator.md): WholeASTDecorator: (cursor: TreeCursor, state: EditorState) => DecorationSpec[] | DecorationSpec | undefined Type declaration (cursor, state): DecorationSpec[] | DecorationSpec | undefined Parameters Returns DecorationSpec[] | DecorationSpec | undefined - [Variable: EVENT_SILENT](/auto-docs/coze-editor/variables/EVENT_SILENT.md): Const EVENT_SILENT: unique symbol - [Variable: astDebugger](/auto-docs/coze-editor/variables/astDebugger.md): Const astDebugger: ViewPlugin<{ update: (update: ViewUpdate) => void }, undefined> - [Variable: astDecorator](/auto-docs/coze-editor/variables/astDecorator.md): Const astDecorator: Object Type declaration - [Variable: autoSelectRanges](/auto-docs/coze-editor/variables/autoSelectRanges.md): Const autoSelectRanges: Facet - [Variable: autoSelectUserEvent](/auto-docs/coze-editor/variables/autoSelectUserEvent.md): Const autoSelectUserEvent: Facet - [Variable: backgroundDecorations](/auto-docs/coze-editor/variables/backgroundDecorations.md): Const backgroundDecorations: Facet - [Variable: colorizationBrackets](/auto-docs/coze-editor/variables/colorizationBrackets.md): Const colorizationBrackets: _codemirror_state.Extension[] - [Variable: deletionEnlarger](/auto-docs/coze-editor/variables/deletionEnlarger.md): Const deletionEnlarger: Facet - [Variable: elementAtPosition](/auto-docs/coze-editor/variables/elementAtPosition.md): Const elementAtPosition: Facet - [Variable: focusableKeymap](/auto-docs/coze-editor/variables/focusableKeymap.md): Const focusableKeymap: _codemirror_state.Extension - [Variable: frozenRanges](/auto-docs/coze-editor/variables/frozenRanges.md): Const frozenRanges: Facet - [Variable: matchingBrackets](/auto-docs/coze-editor/variables/matchingBrackets.md): Const matchingBrackets: StateField[] - [Variable: mergeableMarkers](/auto-docs/coze-editor/variables/mergeableMarkers.md): Const mergeableMarkers: Facet> - [Variable: positionElementLayer](/auto-docs/coze-editor/variables/positionElementLayer.md): Const positionElementLayer: _codemirror_state.Extension - [Variable: selectionEnlarger](/auto-docs/coze-editor/variables/selectionEnlarger.md): Const selectionEnlarger: Facet - [Function: PlaygroundTools](/auto-docs/fixed-semi-materials/functions/PlaygroundTools.md): PlaygroundTools(«destructured»): Element Parameters Returns Element - [Variable: defaultFixedSemiMaterials](/auto-docs/fixed-semi-materials/variables/defaultFixedSemiMaterials.md): Const defaultFixedSemiMaterials: Object Type declaration - [Enumeration: Op](/auto-docs/form-antd-materials/enums/Op.md) - [Function: BatchVariableSelector](/auto-docs/form-antd-materials/functions/BatchVariableSelector.md): BatchVariableSelector(props): any Parameters Returns any - [Function: ConditionRow](/auto-docs/form-antd-materials/functions/ConditionRow.md): ConditionRow(«destructured»): any Parameters Returns any - [Function: ConstantInput](/auto-docs/form-antd-materials/functions/ConstantInput.md): ConstantInput(props): any Parameters Returns any - [Function: DynamicValueInput](/auto-docs/form-antd-materials/functions/DynamicValueInput.md): DynamicValueInput(«destructured»): any Parameters Returns any - [Function: JsonSchemaEditor](/auto-docs/form-antd-materials/functions/JsonSchemaEditor.md): JsonSchemaEditor(props): any Parameters Returns any - [Function: astToSchema](/auto-docs/form-antd-materials/functions/JsonSchemaUtils.astToSchema.md): JsonSchemaUtils.astToSchema astToSchema(typeAST, options?): IJsonSchema | undefined Convert AST To JSON Schema Parameters Returns IJsonSchema | undefined - [Function: isASTMatchSchema](/auto-docs/form-antd-materials/functions/JsonSchemaUtils.isASTMatchSchema.md): JsonSchemaUtils.isASTMatchSchema isASTMatchSchema(typeAST, schema): boolean Check if the AST type is match the JSON Schema Parameters Returns boolean - [Function: schemaToAST](/auto-docs/form-antd-materials/functions/JsonSchemaUtils.schemaToAST.md): JsonSchemaUtils.schemaToAST schemaToAST(jsonSchema): ASTNodeJSON | undefined Converts a JSON schema to an Abstract Syntax Tree (AST) representation. This function recursively processes the JSON schema and creates corresponding AST nodes. For more information on JSON Schema, refer to the official documentation: https://json-schema.org/ Parameters Returns ASTNodeJSON | undefined An AST node representing the JSON schema, or undefined if the schema type is not recognized. - [Function: SvgIcon](/auto-docs/form-antd-materials/functions/SvgIcon.md): SvgIcon(props): any Parameters Returns any - [Function: TypeSelector](/auto-docs/form-antd-materials/functions/TypeSelector.md): TypeSelector(props): any Parameters Returns any - [Function: VariableSelector](/auto-docs/form-antd-materials/functions/VariableSelector.md): VariableSelector(«destructured»): any Parameters Returns any - [Function: formatLegacyRefOnInit](/auto-docs/form-antd-materials/functions/formatLegacyRefOnInit.md): formatLegacyRefOnInit(value): any In flowgram 0.2.0, for introducing Loop variable functionality, the FlowRefValueSchema type definition is updated: interface LegacyFlowRefValueSchema { type: 'ref'; content: string; } interface NewFlowRefValueSchema { type: 'ref'; content: string[]; } For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData How to use: Call formatLegacyRefOnSubmit on the formData before submittingCall formatLegacyRefOnInit on the formData after submitting Example: formMeta: { formatOnSubmit: (data) => formatLegacyRefOnSubmit(data), formatOnInit: (data) => formatLegacyRefOnInit(data), } Parameters Returns any - [Function: formatLegacyRefOnSubmit](/auto-docs/form-antd-materials/functions/formatLegacyRefOnSubmit.md): formatLegacyRefOnSubmit(value): any In flowgram 0.2.0, for introducing Loop variable functionality, the FlowRefValueSchema type definition is updated: interface LegacyFlowRefValueSchema { type: 'ref'; content: string; } interface NewFlowRefValueSchema { type: 'ref'; content: string[]; } For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData How to use: Call formatLegacyRefOnSubmit on the formData before submittingCall formatLegacyRefOnInit on the formData after submitting Example: formMeta: { formatOnSubmit: (data) => formatLegacyRefOnSubmit(data), formatOnInit: (data) => formatLegacyRefOnInit(data), } Parameters Returns any - [Function: formatLegacyRefToNewRef](/auto-docs/form-antd-materials/functions/formatLegacyRefToNewRef.md): formatLegacyRefToNewRef(value): Object Parameters Returns Object - [Function: formatNewRefToLegacyRef](/auto-docs/form-antd-materials/functions/formatNewRefToLegacyRef.md): formatNewRefToLegacyRef(value): Object Parameters Returns Object - [Function: getSchemaIcon](/auto-docs/form-antd-materials/functions/getSchemaIcon.md): getSchemaIcon(value?): ReactNode Parameters Returns ReactNode - [Function: getTypeSelectValue](/auto-docs/form-antd-materials/functions/getTypeSelectValue.md): getTypeSelectValue(value?): string[] Parameters Returns string[] - [Function: isLegacyFlowRefValueSchema](/auto-docs/form-antd-materials/functions/isLegacyFlowRefValueSchema.md): isLegacyFlowRefValueSchema(value): value is LegacyFlowRefValueSchema Parameters Returns value is LegacyFlowRefValueSchema - [Function: isNewFlowRefValueSchema](/auto-docs/form-antd-materials/functions/isNewFlowRefValueSchema.md): isNewFlowRefValueSchema(value): value is NewFlowRefValueSchema Parameters Returns value is NewFlowRefValueSchema - [Function: parseTypeSelectValue](/auto-docs/form-antd-materials/functions/parseTypeSelectValue.md): parseTypeSelectValue(value?): Partial> Parameters Returns Partial> - [Interface: ConditionRowValueType](/auto-docs/form-antd-materials/interfaces/ConditionRowValueType.md) - [Interface: IFlowConstantValue](/auto-docs/form-antd-materials/interfaces/IFlowConstantValue.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: IFlowExpressionValue](/auto-docs/form-antd-materials/interfaces/IFlowExpressionValue.md) - [Interface: IFlowRefValue](/auto-docs/form-antd-materials/interfaces/IFlowRefValue.md) - [Interface: IFlowTemplateValue](/auto-docs/form-antd-materials/interfaces/IFlowTemplateValue.md) - [Interface: IJsonSchema](/auto-docs/form-antd-materials/interfaces/IJsonSchema.md) - [Namespace: JsonSchemaUtils](/auto-docs/form-antd-materials/modules/JsonSchemaUtils.md) - [Type alias: IBasicJsonSchema](/auto-docs/form-antd-materials/types/IBasicJsonSchema.md): IBasicJsonSchema: IJsonSchema - [Type alias: IFlowConstantRefValue](/auto-docs/form-antd-materials/types/IFlowConstantRefValue.md): IFlowConstantRefValue: IFlowConstantValue | IFlowRefValue - [Type alias: IFlowValue](/auto-docs/form-antd-materials/types/IFlowValue.md): IFlowValue: IFlowConstantValue | IFlowRefValue | IFlowExpressionValue | IFlowTemplateValue - [Type alias: JsonSchemaBasicType](/auto-docs/form-antd-materials/types/JsonSchemaBasicType.md): JsonSchemaBasicType: "boolean" | "string" | "integer" | "number" | "object" | "array" | "map" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: VariableSelectorProps](/auto-docs/form-antd-materials/types/VariableSelectorProps.md): VariableSelectorProps: PropTypes - [Variable: ArrayIcons](/auto-docs/form-antd-materials/variables/ArrayIcons.md): Const ArrayIcons: Object Index signature ▪ [key: string]: React.ReactNode - [Variable: VariableTypeIcons](/auto-docs/form-antd-materials/variables/VariableTypeIcons.md): Const VariableTypeIcons: Object Index signature ▪ [key: string]: React.ReactNode - [Variable: autoRenameRefEffect](/auto-docs/form-antd-materials/variables/autoRenameRefEffect.md): Const autoRenameRefEffect: EffectOptions[] Auto rename ref when form item's key is renamed Example: formMeta: { effects: { "inputsValues": autoRenameRefEffect, } } - [Variable: createBatchOutputsFormPlugin](/auto-docs/form-antd-materials/variables/createBatchOutputsFormPlugin.md): Const createBatchOutputsFormPlugin: FormPluginCreator<{ outputKey: string }> Free Layout only right now - [Variable: provideBatchInputEffect](/auto-docs/form-antd-materials/variables/provideBatchInputEffect.md): Const provideBatchInputEffect: EffectOptions[] - [Variable: provideBatchOutputsEffect](/auto-docs/form-antd-materials/variables/provideBatchOutputsEffect.md): Const provideBatchOutputsEffect: EffectOptions[] - [Variable: provideJsonSchemaOutputs](/auto-docs/form-antd-materials/variables/provideJsonSchemaOutputs.md): Const provideJsonSchemaOutputs: EffectOptions[] - [Variable: syncVariableTitle](/auto-docs/form-antd-materials/variables/syncVariableTitle.md): Const syncVariableTitle: EffectOptions[] - [Enumeration: ConditionPresetOp](/auto-docs/form-materials/enums/ConditionPresetOp.md) - [Function: AssignRow](/auto-docs/form-materials/functions/AssignRow.md): AssignRow(props): Element Parameters Returns Element - [Function: AssignRows](/auto-docs/form-materials/functions/AssignRows.md): AssignRows(props): Element Parameters Returns Element - [Function: BaseCodeEditor](/auto-docs/form-materials/functions/BaseCodeEditor.md): BaseCodeEditor(«destructured»): Element Parameters Returns Element - [Function: BatchOutputs](/auto-docs/form-materials/functions/BatchOutputs.md): BatchOutputs(props): Element Parameters Returns Element - [Function: BatchVariableSelector](/auto-docs/form-materials/functions/BatchVariableSelector.md): BatchVariableSelector(props): Element Parameters Returns Element - [Function: BlurInput](/auto-docs/form-materials/functions/BlurInput.md): BlurInput(props): Element Parameters Returns Element - [Function: CodeEditor](/auto-docs/form-materials/functions/CodeEditor.md): CodeEditor(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement Deprecated CodeEditor will bundle all languages features, use XXXCodeEditor instead for better bundle experience - [Function: CodeEditorMini](/auto-docs/form-materials/functions/CodeEditorMini.md): CodeEditorMini(props): Element Parameters Returns Element Deprecated use mini in CodeEditorPropsType instead - [Function: ConditionProvider](/auto-docs/form-materials/functions/ConditionProvider.md): ConditionProvider(props): Element Parameters Returns Element - [Function: ConditionRow](/auto-docs/form-materials/functions/ConditionRow.md): ConditionRow(«destructured»): Element Parameters Returns Element - [Function: ConstantInput](/auto-docs/form-materials/functions/ConstantInput.md): ConstantInput(props): Element Parameters Returns Element - [Function: DBConditionRow](/auto-docs/form-materials/functions/DBConditionRow.md): DBConditionRow(«destructured»): Element Parameters Returns Element - [Function: DisplayFlowValue](/auto-docs/form-materials/functions/DisplayFlowValue.md): DisplayFlowValue(«destructured»): Element Parameters Returns Element - [Function: DisplayInputsValueAllInTag](/auto-docs/form-materials/functions/DisplayInputsValueAllInTag.md): DisplayInputsValueAllInTag(«destructured»): Element Parameters Returns Element - [Function: DisplayInputsValues](/auto-docs/form-materials/functions/DisplayInputsValues.md): DisplayInputsValues(«destructured»): Element Parameters Returns Element - [Function: DisplayOutputs](/auto-docs/form-materials/functions/DisplayOutputs.md): DisplayOutputs(«destructured»): Element Parameters Returns Element - [Function: DisplaySchemaTag](/auto-docs/form-materials/functions/DisplaySchemaTag.md): DisplaySchemaTag(«destructured»): Element Parameters Returns Element - [Function: DisplaySchemaTree](/auto-docs/form-materials/functions/DisplaySchemaTree.md): DisplaySchemaTree(props): Element Parameters Returns Element - [Function: DynamicValueInput](/auto-docs/form-materials/functions/DynamicValueInput-1.md): DynamicValueInput(«destructured»): Element Parameters Returns Element - [Function: EditorInputsTree](/auto-docs/form-materials/functions/EditorInputsTree.md): EditorInputsTree(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: EditorVariableTagInject](/auto-docs/form-materials/functions/EditorVariableTagInject.md): EditorVariableTagInject(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: EditorVariableTree](/auto-docs/form-materials/functions/EditorVariableTree.md): EditorVariableTree(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: getTemplateKeyPaths](/auto-docs/form-materials/functions/FlowValueUtils.getTemplateKeyPaths.md): FlowValueUtils.getTemplateKeyPaths getTemplateKeyPaths(value): string[][] Get all key paths in the template value Parameters Returns string[][] A list of key paths - [Function: inferConstantJsonSchema](/auto-docs/form-materials/functions/FlowValueUtils.inferConstantJsonSchema.md): FlowValueUtils.inferConstantJsonSchema inferConstantJsonSchema(value): IJsonSchema | undefined Infer the schema of the constant value Parameters Returns IJsonSchema | undefined - [Function: inferJsonSchema](/auto-docs/form-materials/functions/FlowValueUtils.inferJsonSchema.md): FlowValueUtils.inferJsonSchema inferJsonSchema(values, scope): IJsonSchema | undefined Infer the schema of the flow value Parameters Returns IJsonSchema | undefined - [Function: isConstant](/auto-docs/form-materials/functions/FlowValueUtils.isConstant.md): FlowValueUtils.isConstant isConstant(value): value is IFlowConstantValue Check if the value is a constant type Parameters Returns value is IFlowConstantValue - [Function: isConstantOrRef](/auto-docs/form-materials/functions/FlowValueUtils.isConstantOrRef.md): FlowValueUtils.isConstantOrRef isConstantOrRef(value): value is IFlowConstantRefValue Check if the value is either a constant or reference type Parameters Returns value is IFlowConstantRefValue - [Function: isExpression](/auto-docs/form-materials/functions/FlowValueUtils.isExpression.md): FlowValueUtils.isExpression isExpression(value): value is IFlowExpressionValue Check if the value is an expression type Parameters Returns value is IFlowExpressionValue - [Function: isFlowValue](/auto-docs/form-materials/functions/FlowValueUtils.isFlowValue.md): FlowValueUtils.isFlowValue isFlowValue(value): value is IFlowValue Check if the value is a valid flow value type Parameters Returns value is IFlowValue - [Function: isRef](/auto-docs/form-materials/functions/FlowValueUtils.isRef.md): FlowValueUtils.isRef isRef(value): value is IFlowRefValue Check if the value is a reference type Parameters Returns value is IFlowRefValue - [Function: isTemplate](/auto-docs/form-materials/functions/FlowValueUtils.isTemplate.md): FlowValueUtils.isTemplate isTemplate(value): value is IFlowTemplateValue Check if the value is a template type Parameters Returns value is IFlowTemplateValue - [Function: traverse](/auto-docs/form-materials/functions/FlowValueUtils.traverse.md): FlowValueUtils.traverse traverse(value, options): Generator<{ path: string ; pathArr: string[] ; value: IFlowValue }> Traverse all flow values in the given value Parameters Returns Generator<{ path: string ; pathArr: string[] ; value: IFlowValue }> A generator of flow values - [Function: InjectDynamicValueInput](/auto-docs/form-materials/functions/InjectDynamicValueInput.md): InjectDynamicValueInput(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: InjectTypeSelector](/auto-docs/form-materials/functions/InjectTypeSelector.md): InjectTypeSelector(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: InjectVariableSelector](/auto-docs/form-materials/functions/InjectVariableSelector.md): InjectVariableSelector(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: InputsValues](/auto-docs/form-materials/functions/InputsValues.md): InputsValues(«destructured»): Element Parameters Returns Element - [Function: InputsValuesTree](/auto-docs/form-materials/functions/InputsValuesTree.md): InputsValuesTree(props): Element Parameters Returns Element - [Function: JsonCodeEditor](/auto-docs/form-materials/functions/JsonCodeEditor.md): JsonCodeEditor(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: JsonEditorWithVariables](/auto-docs/form-materials/functions/JsonEditorWithVariables.md): JsonEditorWithVariables(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: JsonSchemaCreator](/auto-docs/form-materials/functions/JsonSchemaCreator.md): JsonSchemaCreator(«destructured»): Element Parameters Returns Element - [Function: JsonSchemaEditor](/auto-docs/form-materials/functions/JsonSchemaEditor.md): JsonSchemaEditor(props): Element Parameters Returns Element - [Function: JsonSchemaTypePresetProvider](/auto-docs/form-materials/functions/JsonSchemaTypePresetProvider.md): JsonSchemaTypePresetProvider(«destructured»): Element Parameters Returns Element - [Function: astToSchema](/auto-docs/form-materials/functions/JsonSchemaUtils.astToSchema.md): JsonSchemaUtils.astToSchema astToSchema(typeAST?, options?): IJsonSchema | undefined Convert AST To JSON Schema Parameters Returns IJsonSchema | undefined - [Function: isASTMatchSchema](/auto-docs/form-materials/functions/JsonSchemaUtils.isASTMatchSchema.md): JsonSchemaUtils.isASTMatchSchema isASTMatchSchema(typeAST, schema): boolean Check if the AST type is match the JSON Schema Parameters Returns boolean - [Function: schemaToAST](/auto-docs/form-materials/functions/JsonSchemaUtils.schemaToAST.md): JsonSchemaUtils.schemaToAST schemaToAST(jsonSchema): ASTNodeJSON | undefined Converts a JSON schema to an Abstract Syntax Tree (AST) representation. This function recursively processes the JSON schema and creates corresponding AST nodes. For more information on JSON Schema, refer to the official documentation: https://json-schema.org/ Parameters Returns ASTNodeJSON | undefined An AST node representing the JSON schema, or undefined if the schema type is not recognized. - [Function: PromptEditor](/auto-docs/form-materials/functions/PromptEditor.md): PromptEditor(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: PromptEditorWithInputs](/auto-docs/form-materials/functions/PromptEditorWithInputs.md): PromptEditorWithInputs(«destructured»): Element Parameters Returns Element - [Function: PromptEditorWithVariables](/auto-docs/form-materials/functions/PromptEditorWithVariables.md): PromptEditorWithVariables(props): Element Parameters Returns Element - [Function: PythonCodeEditor](/auto-docs/form-materials/functions/PythonCodeEditor.md): PythonCodeEditor(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: SQLCodeEditor](/auto-docs/form-materials/functions/SQLCodeEditor.md): SQLCodeEditor(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: SQLEditorWithVariables](/auto-docs/form-materials/functions/SQLEditorWithVariables.md): SQLEditorWithVariables(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: ShellCodeEditor](/auto-docs/form-materials/functions/ShellCodeEditor.md): ShellCodeEditor(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: TypeScriptCodeEditor](/auto-docs/form-materials/functions/TypeScriptCodeEditor.md): TypeScriptCodeEditor(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: TypeSelector](/auto-docs/form-materials/functions/TypeSelector-1.md): TypeSelector(props): Element Parameters Returns Element - [Function: VariableSelector](/auto-docs/form-materials/functions/VariableSelector-1.md): VariableSelector(«destructured»): Element Parameters Returns Element - [Function: VariableSelectorProvider](/auto-docs/form-materials/functions/VariableSelectorProvider.md): VariableSelectorProvider(«destructured»): Element Parameters Returns Element - [Function: createBatchOutputsFormPlugin](/auto-docs/form-materials/functions/createBatchOutputsFormPlugin.md): createBatchOutputsFormPlugin(opts): FormPlugin<{ inferTargetKey?: string ; outputKey: string }> Free Layout only right now Parameters Returns FormPlugin<{ inferTargetKey?: string ; outputKey: string }> - [Function: createDisableDeclarationPlugin](/auto-docs/form-materials/functions/createDisableDeclarationPlugin.md): createDisableDeclarationPlugin(opts): Plugin Parameters Returns Plugin - [Function: createInferAssignPlugin](/auto-docs/form-materials/functions/createInferAssignPlugin.md): createInferAssignPlugin(opts): FormPlugin Parameters Returns FormPlugin - [Function: createInferInputsPlugin](/auto-docs/form-materials/functions/createInferInputsPlugin.md): createInferInputsPlugin(opts): FormPlugin Parameters Returns FormPlugin - [Function: createInjectMaterial](/auto-docs/form-materials/functions/createInjectMaterial.md): createInjectMaterial(Component, params?): WithRenderKey> Creates a material component wrapper with dependency injection support This Higher-Order Component (HOC) implements a dynamic component replacement mechanism for material components. It automatically checks if a custom renderer is registered in the editor context, using the injected component if available, otherwise falling back to the default component. Type parameters Parameters Returns WithRenderKey> Wrapper component with dependency injection support Example Description Data flow explanation: Register components to FlowRendererRegistry in use-editor-propsInjectMaterial reads renderers from FlowRendererRegistryIf registered renderer exists and type is REACT, use injected componentIf not exists or type mismatch, fallback to default component - [Function: createTypePresetPlugin](/auto-docs/form-materials/functions/createTypePresetPlugin.md): createTypePresetPlugin(opts): Plugin Parameters Returns Plugin - [Function: formatLegacyRefOnInit](/auto-docs/form-materials/functions/formatLegacyRefOnInit.md): formatLegacyRefOnInit(value): any In flowgram 0.2.0, for introducing Loop variable functionality, the FlowRefValueSchema type definition is updated: interface LegacyFlowRefValueSchema { type: 'ref'; content: string; } interface NewFlowRefValueSchema { type: 'ref'; content: string[]; } For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData How to use: Call formatLegacyRefOnSubmit on the formData before submittingCall formatLegacyRefOnInit on the formData after submitting Example: formMeta: { formatOnSubmit: (data) => formatLegacyRefOnSubmit(data), formatOnInit: (data) => formatLegacyRefOnInit(data), } Parameters Returns any - [Function: formatLegacyRefOnSubmit](/auto-docs/form-materials/functions/formatLegacyRefOnSubmit.md): formatLegacyRefOnSubmit(value): any In flowgram 0.2.0, for introducing Loop variable functionality, the FlowRefValueSchema type definition is updated: interface LegacyFlowRefValueSchema { type: 'ref'; content: string; } interface NewFlowRefValueSchema { type: 'ref'; content: string[]; } For making sure backend json will not be changed, we provide format legacy ref utils for updating the formData How to use: Call formatLegacyRefOnSubmit on the formData before submittingCall formatLegacyRefOnInit on the formData after submitting Example: formMeta: { formatOnSubmit: (data) => formatLegacyRefOnSubmit(data), formatOnInit: (data) => formatLegacyRefOnInit(data), } Parameters Returns any - [Function: formatLegacyRefToNewRef](/auto-docs/form-materials/functions/formatLegacyRefToNewRef.md): formatLegacyRefToNewRef(value): Object Parameters Returns Object - [Function: formatNewRefToLegacyRef](/auto-docs/form-materials/functions/formatNewRefToLegacyRef.md): formatNewRefToLegacyRef(value): Object Parameters Returns Object - [Function: getTypeSelectValue](/auto-docs/form-materials/functions/getTypeSelectValue.md): getTypeSelectValue(value?): undefined | string[] Parameters Returns undefined | string[] - [Function: isLegacyFlowRefValueSchema](/auto-docs/form-materials/functions/isLegacyFlowRefValueSchema.md): isLegacyFlowRefValueSchema(value): value is LegacyFlowRefValueSchema Parameters Returns value is LegacyFlowRefValueSchema - [Function: isNewFlowRefValueSchema](/auto-docs/form-materials/functions/isNewFlowRefValueSchema.md): isNewFlowRefValueSchema(value): value is NewFlowRefValueSchema Parameters Returns value is NewFlowRefValueSchema - [Function: lazySuspense](/auto-docs/form-materials/functions/lazySuspense.md): lazySuspense(params, fallback?): LazyExoticComponent Type parameters Parameters Returns LazyExoticComponent - [Function: listenRefSchemaChange](/auto-docs/form-materials/functions/listenRefSchemaChange.md): listenRefSchemaChange(cb): EffectOptions[] Example: const formMeta = { effect: { 'inputsValues.*': listenRefSchemaChange(({ name, schema, form }) => { form.setValueIn(${name}.schema, schema); }) } } Parameters Returns EffectOptions[] - [Function: listenRefValueChange](/auto-docs/form-materials/functions/listenRefValueChange.md): listenRefValueChange(cb): EffectOptions[] Example: const formMeta = { effect: { 'inputsValues.*': listenRefValueChange(({ name, variable, form }) => { const schema = JsonSchemaUtils.astToSchema(variable?.type); form.setValueIn(${name}.schema, schema); }) } } Parameters Returns EffectOptions[] - [Function: parseTypeSelectValue](/auto-docs/form-materials/functions/parseTypeSelectValue.md): parseTypeSelectValue(value?): undefined | Partial> Parameters Returns undefined | Partial> - [Function: polyfillCreateRoot](/auto-docs/form-materials/functions/polyfillCreateRoot.md): polyfillCreateRoot(dom): IPolyfillRoot Parameters Returns IPolyfillRoot - [Function: unstableSetCreateRoot](/auto-docs/form-materials/functions/unstableSetCreateRoot.md): unstableSetCreateRoot(createRoot): void Parameters Returns void - [Function: useCondition](/auto-docs/form-materials/functions/useCondition.md): useCondition(«destructured»): Object Parameters Returns Object - [Function: useConditionContext](/auto-docs/form-materials/functions/useConditionContext.md): useConditionContext(): ContextType Returns ContextType - [Function: useObjectList](/auto-docs/form-materials/functions/useObjectList.md): useObjectList(«destructured»): Object Type parameters Parameters Returns Object - [Function: useTypeManager](/auto-docs/form-materials/functions/useTypeManager.md): useTypeManager(): JsonSchemaTypeManager, JsonSchemaTypeRegistry> Returns JsonSchemaTypeManager, JsonSchemaTypeRegistry> - [Function: useVariableTree](/auto-docs/form-materials/functions/useVariableTree.md): useVariableTree(params): TreeNodeData[] Parameters Returns TreeNodeData[] - [Function: validateFlowValue](/auto-docs/form-materials/functions/validateFlowValue.md): validateFlowValue(value, ctx): undefined | { level: FeedbackLevel = FeedbackLevel.Error; message: string = requiredMessage } Parameters Returns undefined | { level: FeedbackLevel = FeedbackLevel.Error; message: string = requiredMessage } - [Function: validateWhenVariableSync](/auto-docs/form-materials/functions/validateWhenVariableSync.md): validateWhenVariableSync(«destructured»?): EffectOptions[] Parameters Returns EffectOptions[] - [Function: withSuspense](/auto-docs/form-materials/functions/withSuspense.md): withSuspense(Component, fallback?): T Type parameters Parameters Returns T - [Interface: CodeEditorPropsType](/auto-docs/form-materials/interfaces/CodeEditorPropsType.md) - [Interface: ConditionOpConfig](/auto-docs/form-materials/interfaces/ConditionOpConfig.md) - [Interface: ConditionRowValueType](/auto-docs/form-materials/interfaces/ConditionRowValueType.md) - [Interface: ConstantInputStrategy](/auto-docs/form-materials/interfaces/ConstantInputStrategy.md) - [Interface: ConstantRendererProps](/auto-docs/form-materials/interfaces/ConstantRendererProps.md) - [Interface: DBConditionOptionType](/auto-docs/form-materials/interfaces/DBConditionOptionType.md) - [Interface: DBConditionRowValueType](/auto-docs/form-materials/interfaces/DBConditionRowValueType.md) - [Interface: IFlowConstantValue](/auto-docs/form-materials/interfaces/IFlowConstantValue.md) - [Interface: IFlowExpressionValue](/auto-docs/form-materials/interfaces/IFlowExpressionValue.md) - [Interface: IFlowRefValue](/auto-docs/form-materials/interfaces/IFlowRefValue.md) - [Interface: IFlowTemplateValue](/auto-docs/form-materials/interfaces/IFlowTemplateValue.md) - [Interface: IFlowValueExtra](/auto-docs/form-materials/interfaces/IFlowValueExtra.md) - [Interface: IInputsValues](/auto-docs/form-materials/interfaces/IInputsValues.md) - [Interface: IJsonSchema](/auto-docs/form-materials/interfaces/IJsonSchema.md) - [Interface: IPolyfillRoot](/auto-docs/form-materials/interfaces/IPolyfillRoot.md) - [Interface: JsonEditorWithVariablesProps](/auto-docs/form-materials/interfaces/JsonEditorWithVariablesProps.md) - [Interface: JsonSchemaCreatorProps](/auto-docs/form-materials/interfaces/JsonSchemaCreatorProps.md) - [Interface: JsonSchemaTypeRegistry](/auto-docs/form-materials/interfaces/JsonSchemaTypeRegistry.md) - [Interface: PromptEditorPropsType](/auto-docs/form-materials/interfaces/PromptEditorPropsType.md) - [Interface: PromptEditorWithInputsProps](/auto-docs/form-materials/interfaces/PromptEditorWithInputsProps.md) - [Interface: PromptEditorWithVariablesProps](/auto-docs/form-materials/interfaces/PromptEditorWithVariablesProps.md) - [Interface: SQLEditorWithVariablesProps](/auto-docs/form-materials/interfaces/SQLEditorWithVariablesProps.md) - [Interface: TypeSelectorProps](/auto-docs/form-materials/interfaces/TypeSelectorProps.md) - [Interface: VariableSelectorProps](/auto-docs/form-materials/interfaces/VariableSelectorProps.md) - [Namespace: DynamicValueInput](/auto-docs/form-materials/modules/DynamicValueInput.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: FlowValueUtils](/auto-docs/form-materials/modules/FlowValueUtils.md) - [Namespace: JsonSchemaUtils](/auto-docs/form-materials/modules/JsonSchemaUtils.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: TypeSelector](/auto-docs/form-materials/modules/TypeSelector.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Namespace: VariableSelector](/auto-docs/form-materials/modules/VariableSelector.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: AssignValueType](/auto-docs/form-materials/types/AssignValueType.md): AssignValueType: { left?: IFlowRefValue ; operator: "assign" ; right?: IFlowValue } | { left?: string ; operator: "declare" ; right?: IFlowValue } - [Type alias: ConditionOpConfigs](/auto-docs/form-materials/types/ConditionOpConfigs.md): ConditionOpConfigs: Record - [Type alias: FlowValueType](/auto-docs/form-materials/types/FlowValueType.md): FlowValueType: "constant" | "ref" | "expression" | "template" - [Type alias: IConditionRule](/auto-docs/form-materials/types/IConditionRule.md): IConditionRule: Record - [Type alias: IConditionRuleFactory](/auto-docs/form-materials/types/IConditionRuleFactory.md): IConditionRuleFactory: (schema?: IJsonSchema) => Record Type declaration (schema?): Record Parameters Returns Record - [Type alias: IFlowConstantRefValue](/auto-docs/form-materials/types/IFlowConstantRefValue.md): IFlowConstantRefValue: IFlowConstantValue | IFlowRefValue - [Type alias: IFlowValue](/auto-docs/form-materials/types/IFlowValue.md): IFlowValue: IFlowConstantValue | IFlowRefValue | IFlowExpressionValue | IFlowTemplateValue - [Type alias: JsonSchemaBasicType](/auto-docs/form-materials/types/JsonSchemaBasicType.md): JsonSchemaBasicType: "boolean" | "string" | "integer" | "number" | "object" | "array" | "map" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: renderKey](/auto-docs/form-materials/variables/DynamicValueInput.renderKey.md): DynamicValueInput.renderKey renderKey: string - [Variable: renderKey](/auto-docs/form-materials/variables/TypeSelector.renderKey.md): TypeSelector.renderKey renderKey: string - [Variable: renderKey](/auto-docs/form-materials/variables/VariableSelector.renderKey.md): VariableSelector.renderKey renderKey: string - [Variable: autoRenameRefEffect](/auto-docs/form-materials/variables/autoRenameRefEffect.md): Const autoRenameRefEffect: EffectOptions[] Auto rename ref when form item's key is renamed Example: formMeta: { effects: { "inputsValues": autoRenameRefEffect, } } - [Variable: provideBatchInputEffect](/auto-docs/form-materials/variables/provideBatchInputEffect.md): Const provideBatchInputEffect: EffectOptions[] - [Variable: provideBatchOutputsEffect](/auto-docs/form-materials/variables/provideBatchOutputsEffect.md): Const provideBatchOutputsEffect: EffectOptions[] - [Variable: provideJsonSchemaOutputs](/auto-docs/form-materials/variables/provideJsonSchemaOutputs.md): Const provideJsonSchemaOutputs: EffectOptions[] - [Variable: syncVariableTitle](/auto-docs/form-materials/variables/syncVariableTitle.md): Const syncVariableTitle: EffectOptions[] - [Class: TypeEditorRegistryManager](/auto-docs/type-editor/classes/TypeEditorRegistryManager.md) - [Class: TypeEditorService](/auto-docs/type-editor/classes/TypeEditorService.md) - [Enumeration: ToolbarKey](/auto-docs/type-editor/enums/ToolbarKey.md) - [Enumeration: TypeEditorColumnType](/auto-docs/type-editor/enums/TypeEditorColumnType.md) - [Function: ObjectTypeEditor](/auto-docs/type-editor/functions/ObjectTypeEditor.md): ObjectTypeEditor(props): any Parameters Returns any - [Function: TypeEditor](/auto-docs/type-editor/functions/TypeEditor.md): TypeEditor(props): Element Type parameters Parameters Returns Element - [Function: TypeSelector](/auto-docs/type-editor/functions/TypeSelector.md): TypeSelector(props): any Type parameters Parameters Returns any - [Interface: DeclareAssignValueType](/auto-docs/type-editor/interfaces/DeclareAssignValueType.md) - [Interface: DisableTypeInfo](/auto-docs/type-editor/interfaces/DisableTypeInfo.md) - [Interface: EditorProps](/auto-docs/type-editor/interfaces/EditorProps.md) - [Interface: FlowSchemaInitCtx](/auto-docs/type-editor/interfaces/FlowSchemaInitCtx.md) - [Interface: InfoContext](/auto-docs/type-editor/interfaces/InfoContext.md) - [Interface: ModeValueConfig](/auto-docs/type-editor/interfaces/ModeValueConfig.md) - [Interface: RenderProps](/auto-docs/type-editor/interfaces/RenderProps.md) - [Interface: ShortcutContext](/auto-docs/type-editor/interfaces/ShortcutContext.md) - [Interface: TypeCascaderConfig](/auto-docs/type-editor/interfaces/TypeCascaderConfig.md) - [Interface: TypeChangeContext](/auto-docs/type-editor/interfaces/TypeChangeContext.md) - [Interface: TypeEditorColumnConfig](/auto-docs/type-editor/interfaces/TypeEditorColumnConfig.md) - [Interface: TypeEditorColumnViewConfig](/auto-docs/type-editor/interfaces/TypeEditorColumnViewConfig.md) - [Interface: TypeEditorDropInfo](/auto-docs/type-editor/interfaces/TypeEditorDropInfo.md) - [Interface: TypeEditorExtraInfo](/auto-docs/type-editor/interfaces/TypeEditorExtraInfo.md) - [Interface: TypeEditorPos](/auto-docs/type-editor/interfaces/TypeEditorPos.md) - [Interface: TypeEditorProp](/auto-docs/type-editor/interfaces/TypeEditorProp.md) - [Interface: TypeEditorRef](/auto-docs/type-editor/interfaces/TypeEditorRef.md) - [Interface: TypeEditorRegistry](/auto-docs/type-editor/interfaces/TypeEditorRegistry.md) - [Interface: TypeEditorSpecialConfig](/auto-docs/type-editor/interfaces/TypeEditorSpecialConfig.md) - [Interface: TypeInputConfig](/auto-docs/type-editor/interfaces/TypeInputConfig.md) - [Interface: TypeInputContext](/auto-docs/type-editor/interfaces/TypeInputContext.md) - [Type alias: ToolbarConfig](/auto-docs/type-editor/types/ToolbarConfig.md): ToolbarConfig: Object Type declaration - [Type alias: TypeEditorMode](/auto-docs/type-editor/types/TypeEditorMode.md): TypeEditorMode: "type-definition" | "declare-assign" - [Type alias: TypeEditorRowData](/auto-docs/type-editor/types/TypeEditorRowData.md): TypeEditorRowData: TypeSchema & { cannotDrag?: boolean ; childrenCount: number ; deepChildrenCount: number ; disableEditColumn?: { column: TypeEditorColumnType ; reason: string }[] ; extraConfig: TypeEditorSpecialConfig ; id: string ; index: number ; isRequired: boolean ; key: string ; level: number ; parent?: TypeEditorSchema ; parentId?: string ; path: string[] ; self: TypeEditorSchema } Type parameters - [Type alias: TypeEditorSchema](/auto-docs/type-editor/types/TypeEditorSchema.md): TypeEditorSchema: TypeSchema & { extra?: TypeEditorExtraInfo } Type parameters - [Type alias: TypeEditorValue](/auto-docs/type-editor/types/TypeEditorValue.md): TypeEditorValue: Mode extends "type-definition" ? TypeEditorSchema : DeclareAssignValueType Type parameters - [Variable: TypeEditorContext](/auto-docs/type-editor/variables/TypeEditorContext.md): Const TypeEditorContext: any - [Variable: typeEditorColumnConfigs](/auto-docs/type-editor/variables/typeEditorColumnConfigs.md): Const typeEditorColumnConfigs: TypeEditorColumnConfig[] - [Class: FieldArrayModel](/auto-docs/form/classes/FieldArrayModel.md) - [Class: FieldModel](/auto-docs/form/classes/FieldModel.md) - [Class: FormModel](/auto-docs/form/classes/FormModel.md) - [Class: Path](/auto-docs/form/classes/Path.md) - [Enumeration: FeedbackLevel](/auto-docs/form/enums/FeedbackLevel.md) - [Enumeration: ValidateTrigger](/auto-docs/form/enums/ValidateTrigger.md) - [Function: Field](/auto-docs/form/functions/Field.md): Field(«destructured»): React.ReactElement HOC That declare a field, an Field model will be created it's rendered. Multiple Field rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React.ReactElement - [Function: FieldArray](/auto-docs/form/functions/FieldArray.md): FieldArray(«destructured»): React.ReactElement HOC That declare an array field, an FieldArray model will be created when it's rendered. Multiple FieldArray rendering with a same name will link to the same model, which means they shared data、 status and methods Type parameters Parameters Returns React.ReactElement - [Function: Form](/auto-docs/form/functions/Form.md): Form(props): Element Hoc That init and provide Form instance. You can also provide form instance from outside by using control prop Type parameters Parameters Returns Element - [Function: findMatchPaths](/auto-docs/form/functions/Glob.findMatchPaths.md): Glob.findMatchPaths findMatchPaths(obj, pattern, withEmptyValue?): string[] Find all paths matched pattern in object. If withEmptyValue is true, it will include paths whoes value is undefined. Parameters Returns string[] - [Function: findMatchPathsWithEmptyValue](/auto-docs/form/functions/Glob.findMatchPathsWithEmptyValue.md): Glob.findMatchPathsWithEmptyValue findMatchPathsWithEmptyValue(obj, pattern): string[] Find all paths matched pattern in object, including paths whoes value is undefined. Parameters Returns string[] - [Function: getParentPathByPattern](/auto-docs/form/functions/Glob.getParentPathByPattern.md): Glob.getParentPathByPattern getParentPathByPattern(pattern, path): string 从 path 中提取出匹配pattern 的 parent path，包括是 path 自身 该方法默认 isMatchOrParent(pattern, path) 为 true, 不做为false 的错误处理。 Parameters Returns string - [Function: isMatch](/auto-docs/form/functions/Glob.isMatch.md): Glob.isMatch isMatch(pattern, path): boolean Parameters Returns boolean - [Function: isMatchOrParent](/auto-docs/form/functions/Glob.isMatchOrParent.md): Glob.isMatchOrParent isMatchOrParent(pattern, path): boolean 判断pattern 是否match pattern 或其parent Parameters Returns boolean - [Function: createForm](/auto-docs/form/functions/createForm.md): createForm(options?): CreateFormReturn Type parameters Parameters Returns CreateFormReturn - [Function: toField](/auto-docs/form/functions/toField.md): toField(model): IField Type parameters Parameters Returns IField - [Function: toFieldArray](/auto-docs/form/functions/toFieldArray.md): toFieldArray(model): IFieldArray Type parameters Parameters Returns IFieldArray - [Function: toFieldState](/auto-docs/form/functions/toFieldState.md): toFieldState(modelState): Object Parameters Returns Object - [Function: toForm](/auto-docs/form/functions/toForm.md): toForm(model): IForm Type parameters Parameters Returns IForm - [Function: toFormState](/auto-docs/form/functions/toFormState.md): toFormState(modelState): FormState Parameters Returns FormState - [Function: useCurrentField](/auto-docs/form/functions/useCurrentField.md): useCurrentField(): IField | IFieldArray Get the current Field. It should be used in a child component of , otherwise it throws an error Type parameters Returns IField | IFieldArray - [Function: useCurrentFieldState](/auto-docs/form/functions/useCurrentFieldState.md): useCurrentFieldState(): FieldState Get the current field state. It should be used in a child component of , otherwise it throws an error Returns FieldState - [Function: useField](/auto-docs/form/functions/useField.md): useField(name?): TField | undefined Type parameters Parameters Returns TField | undefined Deprecated useField is deprecated because its return relies on React render. if the Field is not rendered, the return would be undefined. If you simply want to monitor the change of the value of a certain path, please use useWatch(fieldName) - [Function: useFieldValidate](/auto-docs/form/functions/useFieldValidate.md): useFieldValidate(name?): () => void Get validate method of a field with given name. the returned function could possibly do nothing if the field is not found. The reason could be that the field is not rendered yet or the name given is wrong. Parameters Returns fn (): void Returns void - [Function: useForm](/auto-docs/form/functions/useForm.md): useForm(): IForm Get Form instance. It should be use in a child component of Returns IForm - [Function: useFormErrors](/auto-docs/form/functions/useFormErrors.md): useFormErrors(control?): undefined | Errors Parameters Returns undefined | Errors - [Function: useFormState](/auto-docs/form/functions/useFormState.md): useFormState(control?): FormState Parameters Returns FormState - [Function: useFormWarnings](/auto-docs/form/functions/useFormWarnings.md): useFormWarnings(control?): undefined | Warnings Parameters Returns undefined | Warnings - [Function: useWatch](/auto-docs/form/functions/useWatch.md): useWatch(name): TValue Listen to the field data change and refresh the React component. Type parameters Parameters Returns TValue - [Interface: FieldArrayRenderProps](/auto-docs/form/interfaces/FieldArrayRenderProps.md) - [Interface: FieldRenderProps](/auto-docs/form/interfaces/FieldRenderProps.md) - [Interface: FieldState](/auto-docs/form/interfaces/FieldState.md) - [Interface: FormControl](/auto-docs/form/interfaces/FormControl.md) - [Interface: FormRenderProps](/auto-docs/form/interfaces/FormRenderProps.md) - [Interface: FormState](/auto-docs/form/interfaces/FormState.md) - [Interface: IField](/auto-docs/form/interfaces/IField.md): Field render model, it's only available when Field is rendered - [Interface: IFieldArray](/auto-docs/form/interfaces/IFieldArray.md): FieldArray render model, it's only available when FieldArray is rendered - [Interface: IForm](/auto-docs/form/interfaces/IForm.md) - [Namespace: Glob](/auto-docs/form/modules/Glob.md) - [Type alias: CreateFormOptions](/auto-docs/form/types/CreateFormOptions.md): CreateFormOptions: FormOptions & { disableAutoInit?: boolean } Type parameters - [Type alias: Errors](/auto-docs/form/types/Errors.md): Errors: Record - [Type alias: FieldArrayProps](/auto-docs/form/types/FieldArrayProps.md): FieldArrayProps: FieldArrayOptions & { children?: (props: FieldArrayRenderProps) => React.ReactElement | React.ReactElement ; deps?: FieldName[] } Type parameters - [Type alias: FieldError](/auto-docs/form/types/FieldError.md): FieldError: Feedback - [Type alias: FieldName](/auto-docs/form/types/FieldName.md): FieldName: string - [Type alias: FieldProps](/auto-docs/form/types/FieldProps.md): FieldProps: FieldOptions & { children?: (props: FieldRenderProps) => React.ReactElement | React.ReactElement ; deps?: FieldName[] } Type parameters - [Type alias: FieldValue](/auto-docs/form/types/FieldValue.md): FieldValue: any - [Type alias: FieldWarning](/auto-docs/form/types/FieldWarning.md): FieldWarning: Feedback - [Type alias: FormProps](/auto-docs/form/types/FormProps.md): FormProps: FormOptions & { children?: (props: FormRenderProps) => React.ReactNode | React.ReactNode ; control?: FormControl ; keepModelOnUnMount?: boolean } Type parameters - [Type alias: FormValidateReturn](/auto-docs/form/types/FormValidateReturn.md): FormValidateReturn: (FieldError | FieldWarning)[] - [Type alias: Validate](/auto-docs/form/types/Validate.md): Validate: (props: { context: Context ; formValues: TFormValues ; name: FieldName ; value: TFieldValue }) => MaybePromise | MaybePromise | MaybePromise | MaybePromise Type parameters Type declaration (props): MaybePromise | MaybePromise | MaybePromise | MaybePromise Parameters Returns MaybePromise | MaybePromise | MaybePromise | MaybePromise - [Type alias: Warnings](/auto-docs/form/types/Warnings.md): Warnings: Record - [Variable: ALL](/auto-docs/form/variables/Glob.ALL.md): Glob.ALL Const ALL: "*" - [Variable: DIVIDER](/auto-docs/form/variables/Glob.DIVIDER.md): Glob.DIVIDER Const DIVIDER: "." - [Class: DecoratorAbility](/auto-docs/form-core/classes/DecoratorAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: DefaultAbility](/auto-docs/form-core/classes/DefaultAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: EffectAbility](/auto-docs/form-core/classes/EffectAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowNodeErrorData](/auto-docs/form-core/classes/FlowNodeErrorData.md) - [Class: FlowNodeFormData](/auto-docs/form-core/classes/FlowNodeFormData.md) - [Class: FormAbilityExtensionRegistry](/auto-docs/form-core/classes/FormAbilityExtensionRegistry.md) - [Class: FormContextMaker](/auto-docs/form-core/classes/FormContextMaker.md) - [Class: FormItem](/auto-docs/form-core/classes/FormItem.md) - [Class: FormManager](/auto-docs/form-core/classes/FormManager.md) - [Class: FormMeta](/auto-docs/form-core/classes/FormMeta.md) - [Class: FormModel](/auto-docs/form-core/classes/FormModel.md) - [Class: FormPathService](/auto-docs/form-core/classes/FormPathService.md) - [Class: NodeEngine](/auto-docs/form-core/classes/NodeEngine.md) - [Class: NodeEngineContext](/auto-docs/form-core/classes/NodeEngineContext.md): NodeEngineContext 在 Node Engine 中为全局单例, 它的作用是让Node之间共享数据。 context 分为内置context(如 readonly) 和 自定义context(业务可以按需注入) - [Class: NodeManager](/auto-docs/form-core/classes/NodeManager.md) - [Class: SetterAbility](/auto-docs/form-core/classes/SetterAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: ValidationAbility](/auto-docs/form-core/classes/ValidationAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: VisibilityAbility](/auto-docs/form-core/classes/VisibilityAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FormItemEventName](/auto-docs/form-core/enums/FormItemEventName.md) - [Enumeration: MaterialRenderKey](/auto-docs/form-core/enums/MaterialRenderKey.md) - [Function: NodeRender](/auto-docs/form-core/functions/NodeRender.md): NodeRender(props): null | ReactElement> Parameters Returns null | ReactElement> - [Function: createNodeContainerModules](/auto-docs/form-core/functions/createNodeContainerModules.md): createNodeContainerModules(): ContainerModule[] Returns ContainerModule[] - [Function: createNodeEntityDatas](/auto-docs/form-core/functions/createNodeEntityDatas.md): createNodeEntityDatas(): EntityDataRegistry[] Returns EntityDataRegistry[] - [Function: getFormModel](/auto-docs/form-core/functions/getFormModel.md): getFormModel(node): FormModel Parameters Returns FormModel - [Function: getNodeError](/auto-docs/form-core/functions/getNodeError.md): getNodeError(node): Error Parameters Returns Error - [Function: isNodeFormReady](/auto-docs/form-core/functions/isNodeFormReady.md): isNodeFormReady(node): boolean Parameters Returns boolean - [Function: registerNodeErrorRender](/auto-docs/form-core/functions/registerNodeErrorRender.md): registerNodeErrorRender(nodeManager, render): void Parameters Returns void - [Function: registerNodePlaceholderRender](/auto-docs/form-core/functions/registerNodePlaceholderRender.md): registerNodePlaceholderRender(nodeManager, render): void Parameters Returns void - [Function: useFormItem](/auto-docs/form-core/functions/useFormItem.md): useFormItem(path): IFormItem | undefined Parameters Returns IFormItem | undefined - [Function: useNodeEngineContext](/auto-docs/form-core/functions/useNodeEngineContext.md): useNodeEngineContext(): NodeEngineContext Returns NodeEngineContext - [Interface: AbilityClass](/auto-docs/form-core/interfaces/AbilityClass.md) - [Interface: DecoratorAbilityOptions](/auto-docs/form-core/interfaces/DecoratorAbilityOptions.md) - [Interface: DecoratorComponentProps](/auto-docs/form-core/interfaces/DecoratorComponentProps.md): Deprecated - [Interface: DecoratorExtension](/auto-docs/form-core/interfaces/DecoratorExtension.md) - [Interface: DefaultAbilityOptions](/auto-docs/form-core/interfaces/DefaultAbilityOptions.md) - [Interface: DetailChangeEvent](/auto-docs/form-core/interfaces/DetailChangeEvent.md) - [Interface: EffectAbilityOptions](/auto-docs/form-core/interfaces/EffectAbilityOptions.md) - [Interface: EffectEvent](/auto-docs/form-core/interfaces/EffectEvent.md) - [Interface: EffectExtension](/auto-docs/form-core/interfaces/EffectExtension.md) - [Interface: EffectProps](/auto-docs/form-core/interfaces/EffectProps.md): Deprecated - [Interface: ErrorData](/auto-docs/form-core/interfaces/ErrorData.md) - [Interface: Extension](/auto-docs/form-core/interfaces/Extension.md) - [Interface: FormContribution](/auto-docs/form-core/interfaces/FormContribution.md) - [Interface: FormDataObject](/auto-docs/form-core/interfaces/FormDataObject.md) - [Interface: FormFeedback](/auto-docs/form-core/interfaces/FormFeedback.md) - [Interface: FormItemAbility](/auto-docs/form-core/interfaces/FormItemAbility.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: FormItemAbilityMeta](/auto-docs/form-core/interfaces/FormItemAbilityMeta.md) - [Interface: FormItemContext](/auto-docs/form-core/interfaces/FormItemContext.md): Deprecated - [Interface: FormItemDomRef](/auto-docs/form-core/interfaces/FormItemDomRef.md) - [Interface: FormItemFeedback](/auto-docs/form-core/interfaces/FormItemFeedback.md) - [Interface: FormItemHookParams](/auto-docs/form-core/interfaces/FormItemHookParams.md): Deprecated - [Interface: FormItemHooks](/auto-docs/form-core/interfaces/FormItemHooks.md) - [Interface: FormItemMaterialContext](/auto-docs/form-core/interfaces/FormItemMaterialContext.md) - [Interface: FormMetaGeneratorParams](/auto-docs/form-core/interfaces/FormMetaGeneratorParams.md) - [Interface: FormMetaTraverseParams](/auto-docs/form-core/interfaces/FormMetaTraverseParams.md) - [Interface: GetDefaultValueProps](/auto-docs/form-core/interfaces/GetDefaultValueProps.md): Deprecated - [Interface: IFormItem](/auto-docs/form-core/interfaces/IFormItem.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: IFormItemMeta](/auto-docs/form-core/interfaces/IFormItemMeta.md) - [Interface: IFormMeta](/auto-docs/form-core/interfaces/IFormMeta.md) - [Interface: IFormMetaOptions](/auto-docs/form-core/interfaces/IFormMetaOptions.md) - [Interface: INodeEngineContext](/auto-docs/form-core/interfaces/INodeEngineContext.md) - [Interface: IValidateResult](/auto-docs/form-core/interfaces/IValidateResult.md) - [Interface: NodeContribution](/auto-docs/form-core/interfaces/NodeContribution.md) - [Interface: NodeErrorRenderProps](/auto-docs/form-core/interfaces/NodeErrorRenderProps.md) - [Interface: NodeFormContext](/auto-docs/form-core/interfaces/NodeFormContext.md) - [Interface: NodeRenderProps](/auto-docs/form-core/interfaces/NodeRenderProps.md) - [Interface: OnFormValuesChangePayload](/auto-docs/form-core/interfaces/OnFormValuesChangePayload.md) - [Interface: SetterAbilityOptions](/auto-docs/form-core/interfaces/SetterAbilityOptions.md) - [Interface: SetterComponentProps](/auto-docs/form-core/interfaces/SetterComponentProps.md): Deprecated - [Interface: SetterExtension](/auto-docs/form-core/interfaces/SetterExtension.md) - [Interface: TreeNode](/auto-docs/form-core/interfaces/TreeNode.md) - [Interface: ValidationAbilityOptions](/auto-docs/form-core/interfaces/ValidationAbilityOptions.md) - [Interface: ValidationExtension](/auto-docs/form-core/interfaces/ValidationExtension.md) - [Interface: ValidatorProps](/auto-docs/form-core/interfaces/ValidatorProps.md) - [Interface: VisibilityAbilityOptions](/auto-docs/form-core/interfaces/VisibilityAbilityOptions.md) - [Type alias: DataArray](/auto-docs/form-core/types/DataArray.md): DataArray: FormDataType[] - [Type alias: EffectFunction](/auto-docs/form-core/types/EffectFunction.md): EffectFunction: (props: EffectProps) => void Type declaration (props): void Parameters Returns void - [Type alias: FeedbackStatus](/auto-docs/form-core/types/FeedbackStatus.md): FeedbackStatus: "error" | "warning" | "pending" - [Type alias: FeedbackText](/auto-docs/form-core/types/FeedbackText.md): FeedbackText: string - [Type alias: FormDataType](/auto-docs/form-core/types/FormDataType.md): FormDataType: string | number | boolean | FormDataObject | DataArray | null - [Type alias: FormDataTypeName](/auto-docs/form-core/types/FormDataTypeName.md): FormDataTypeName: "string" | "number" | "integer" | "boolean" | "object" | "array" | "null" - [Type alias: FormMetaGenerator](/auto-docs/form-core/types/FormMetaGenerator.md): FormMetaGenerator: (params: FormMetaGeneratorParams) => MaybePromise Type parameters Type declaration (params): MaybePromise Parameters Returns MaybePromise - [Type alias: FormMetaOrFormMetaGenerator](/auto-docs/form-core/types/FormMetaOrFormMetaGenerator.md): FormMetaOrFormMetaGenerator: FormMetaGenerator | IFormMeta - [Type alias: FormModelFactory](/auto-docs/form-core/types/FormModelFactory.md): FormModelFactory: (entity: FlowNodeEntity) => FormModel Type declaration (entity): FormModel Parameters Returns FormModel - [Type alias: FormModelValid](/auto-docs/form-core/types/FormModelValid.md): FormModelValid: boolean | null - [Type alias: NodeContext](/auto-docs/form-core/types/NodeContext.md): NodeContext: NodeFormContext Deprecated use NodeFormContext instead - [Type alias: NodeErrorRender](/auto-docs/form-core/types/NodeErrorRender.md): NodeErrorRender: Render - [Type alias: NodePlaceholderRender](/auto-docs/form-core/types/NodePlaceholderRender.md): NodePlaceholderRender: Render - [Type alias: NodePluginRender](/auto-docs/form-core/types/NodePluginRender.md): NodePluginRender: Render - [Type alias: NodeRenderHoc](/auto-docs/form-core/types/NodeRenderHoc.md): NodeRenderHoc: (Component: React.JSXElementConstructor) => React.JSXElementConstructor Type declaration (Component): React.JSXElementConstructor Parameters Returns React.JSXElementConstructor - [Type alias: Render](/auto-docs/form-core/types/Render.md): Render: (props: T) => any Type parameters Type declaration (props): any Parameters Returns any - [Type alias: SetterHoc](/auto-docs/form-core/types/SetterHoc.md): SetterHoc: (Component: React.JSXElementConstructor) => React.JSXElementConstructor Type declaration (Component): React.JSXElementConstructor Parameters Returns React.JSXElementConstructor - [Type alias: SetterOrDecoratorContext](/auto-docs/form-core/types/SetterOrDecoratorContext.md): SetterOrDecoratorContext: Omit Setter context 是 FormItemMaterialContext 的外观 基于外观设计模式设计，屏蔽了FormItemMaterialContext中一些setter不可见的接口 readonly: 对于setter 已经放在props 根级别，所以在这里屏蔽，防止干扰 getFormItemValueByPath: setter需通过表单联动方式获取其他表单项的值，不推荐是用这个方法，所以屏蔽 - [Type alias: ValidatorFunction](/auto-docs/form-core/types/ValidatorFunction.md): ValidatorFunction: (props: ValidatorProps) => ValidatorFunctionResponse Type declaration (props): ValidatorFunctionResponse Parameters Returns ValidatorFunctionResponse - [Type alias: ValidatorFunctionResponse](/auto-docs/form-core/types/ValidatorFunctionResponse.md): ValidatorFunctionResponse: null | void | undefined | string | boolean | IValidateResult - [Variable: ErrorContainerModule](/auto-docs/form-core/variables/ErrorContainerModule.md): Const ErrorContainerModule: ContainerModule - [Variable: FORM_VOID](/auto-docs/form-core/variables/FORM_VOID.md): Const FORM_VOID: "form-void" - [Variable: FormContribution](/auto-docs/form-core/variables/FormContribution-1.md): Const FormContribution: typeof FormContribution - [Variable: FormCoreContainerModule](/auto-docs/form-core/variables/FormCoreContainerModule.md): Const FormCoreContainerModule: ContainerModule - [Variable: FormModelEntity](/auto-docs/form-core/variables/FormModelEntity.md): Const FormModelEntity: typeof FormModelEntity - [Variable: FormModelFactory](/auto-docs/form-core/variables/FormModelFactory-1.md): FormModelFactory: typeof FormModelFactory - [Variable: MATERIAL_KEY](/auto-docs/form-core/variables/MATERIAL_KEY.md): Const MATERIAL_KEY: Object Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type declaration - [Variable: NodeContainerModule](/auto-docs/form-core/variables/NodeContainerModule.md): Const NodeContainerModule: ContainerModule - [Variable: NodeContribution](/auto-docs/form-core/variables/NodeContribution-1.md): Const NodeContribution: typeof NodeContribution - [Variable: NodeEngineReactContext](/auto-docs/form-core/variables/NodeEngineReactContext.md): Const NodeEngineReactContext: Context - [Variable: PLUGIN_KEY](/auto-docs/form-core/variables/PLUGIN_KEY.md): Const PLUGIN_KEY: Object Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type declaration - [Class: FormModelV2](/auto-docs/node/classes/FormModelV2.md) - [Class: FormPlugin](/auto-docs/node/classes/FormPlugin.md) - [Enumeration: DataEvent](/auto-docs/node/enums/DataEvent.md) - [Function: createEffectOptions](/auto-docs/node/functions/createEffectOptions.md): createEffectOptions(event, effect): Object Type parameters Parameters Returns Object - [Function: defineFormPluginCreator](/auto-docs/node/functions/defineFormPluginCreator.md): defineFormPluginCreator(config): FormPluginCreator Type parameters Parameters Returns FormPluginCreator - [Function: getNodeForm](/auto-docs/node/functions/getNodeForm.md): getNodeForm(node): NodeFormProps | undefined Use node.form instead Type parameters Parameters Returns NodeFormProps | undefined Deprecated - [Function: isFormMetaV2](/auto-docs/node/functions/isFormMetaV2.md): isFormMetaV2(formMeta): boolean Parameters Returns boolean - [Function: isFormModelV2](/auto-docs/node/functions/isFormModelV2.md): isFormModelV2(fm): fm is FormModelV2 Parameters Returns fm is FormModelV2 - [Function: isFormV2](/auto-docs/node/functions/isFormV2.md): isFormV2(node): boolean Parameters Returns boolean - [Function: useInitializedFormModel](/auto-docs/node/functions/useInitializedFormModel.md): useInitializedFormModel(node): FormModelV2 Listen to FormModel's initialization and refresh React component. By providing related node, you can use this hook outside the Form Component. Parameters Returns FormModelV2 - [Function: useWatchFormErrors](/auto-docs/node/functions/useWatchFormErrors.md): useWatchFormErrors(node): Errors | undefined Get Form's errors, Form errors is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Errors | undefined - [Function: useWatchFormState](/auto-docs/node/functions/useWatchFormState.md): useWatchFormState(node): FormState | undefined Get Form's state, Form State is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns FormState | undefined - [Function: useWatchFormValueIn](/auto-docs/node/functions/useWatchFormValueIn.md): useWatchFormValueIn(node, name): T | undefined Listen to Form's value in a certain path and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormValues](/auto-docs/node/functions/useWatchFormValues.md): useWatchFormValues(node): T | undefined Listen to Form's values and refresh the React component. By providing related node, you can use this hook outside the Form Component. Type parameters Parameters Returns T | undefined - [Function: useWatchFormWarnings](/auto-docs/node/functions/useWatchFormWarnings.md): useWatchFormWarnings(node): Warnings | undefined Get Form's warnings, Form warnings is a proxy, it will refresh the React component when the value you accessed changed By providing related node, you can use this hook outside the Form Component. Parameters Returns Warnings | undefined - [Interface: EffectFuncProps](/auto-docs/node/interfaces/EffectFuncProps.md) - [Interface: Flow](/auto-docs/node/interfaces/Flow.md) - [Interface: FormMeta](/auto-docs/node/interfaces/FormMeta.md) - [Interface: FormPluginConfig](/auto-docs/node/interfaces/FormPluginConfig.md) - [Interface: Node](/auto-docs/node/interfaces/Node.md) - [Interface: NodeFormProps](/auto-docs/node/interfaces/NodeFormProps.md) - [Interface: onFormValueChangeInPayload](/auto-docs/node/interfaces/onFormValueChangeInPayload.md) - [Type alias: ArrayAppendEffect](/auto-docs/node/types/ArrayAppendEffect.md): ArrayAppendEffect: (props: { arrayValues: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number ; value: TFieldValue }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: ArrayDeleteEffect](/auto-docs/node/types/ArrayDeleteEffect.md): ArrayDeleteEffect: (props: { arrayValue: TFieldValue[] ; context: NodeContext ; form: IForm ; formValues: TFormValues ; index: number }) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: Effect](/auto-docs/node/types/Effect.md): Effect: (props: EffectFuncProps) => void | EffectReturn Type parameters Type declaration (props): void | EffectReturn Parameters Returns void | EffectReturn - [Type alias: EffectOptions](/auto-docs/node/types/EffectOptions.md): EffectOptions: { effect: Effect ; event: DataEvent } | { effect: ArrayAppendEffect ; event: DataEvent } | { effect: ArrayDeleteEffect ; event: DataEvent } - [Type alias: EffectReturn](/auto-docs/node/types/EffectReturn.md): EffectReturn: () => void Type declaration (): void Returns void - [Type alias: FormPluginCreator](/auto-docs/node/types/FormPluginCreator.md): FormPluginCreator: (opts: Opts) => FormPlugin Type parameters Type declaration (opts): FormPlugin Parameters Returns FormPlugin - [Type alias: FormPluginCtx](/auto-docs/node/types/FormPluginCtx.md): FormPluginCtx: { formModel: FormModelV2 } & NodeContext - [Type alias: FormPluginSetupMetaCtx](/auto-docs/node/types/FormPluginSetupMetaCtx.md): FormPluginSetupMetaCtx: { addFormatOnInit: (formatOnInit: FormMeta["formatOnInit"]) => void ; addFormatOnSubmit: (formatOnSubmit: FormMeta["formatOnSubmit"]) => void ; mergeEffect: (effect: Record) => void ; mergeValidate: (validate: Record) => void } & NodeContext - [Type alias: Validate](/auto-docs/node/types/Validate.md): Validate: (props: { context: NodeContext ; formValues: TFormValues ; name: FieldName ; value: TFieldValue }) => ReturnType> Type parameters Type declaration (props): ReturnType> Parameters Returns ReturnType> - [Class: BackgroundLayer](/auto-docs/background-plugin/classes/BackgroundLayer.md): dot 网格背景 - [Function: createBackgroundPlugin](/auto-docs/background-plugin/functions/createBackgroundPlugin.md): createBackgroundPlugin(opts): Plugin 点位背景插件 Parameters Returns Plugin - [Interface: BackgroundLayerOptions](/auto-docs/background-plugin/interfaces/BackgroundLayerOptions.md) - [Variable: BackgroundConfig](/auto-docs/background-plugin/variables/BackgroundConfig.md): Const BackgroundConfig: typeof BackgroundConfig - [Class: FlowDownloadService](/auto-docs/export-plugin/classes/FlowDownloadService.md) - [Enumeration: FlowDownloadFormat](/auto-docs/export-plugin/enums/FlowDownloadFormat.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Function: createDownloadPlugin](/auto-docs/export-plugin/functions/createDownloadPlugin.md): createDownloadPlugin(opts): Plugin Parameters Returns Plugin - [Interface: CreateDownloadPluginOptions](/auto-docs/export-plugin/interfaces/CreateDownloadPluginOptions.md) - [Interface: DownloadServiceOptions](/auto-docs/export-plugin/interfaces/DownloadServiceOptions.md) - [Function: createFixedDragPlugin](/auto-docs/fixed-drag-plugin/functions/createFixedDragPlugin.md): createFixedDragPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: useStartDragNode](/auto-docs/fixed-drag-plugin/functions/useStartDragNode.md): useStartDragNode(): Object Returns Object - [Interface: FixDragPluginOptions](/auto-docs/fixed-drag-plugin/interfaces/FixDragPluginOptions.md) - [Class: FixedHistoryConfig](/auto-docs/fixed-history-plugin/classes/FixedHistoryConfig.md) - [Class: FixedHistoryFormDataService](/auto-docs/fixed-history-plugin/classes/FixedHistoryFormDataService.md) - [Class: FixedHistoryOperationService](/auto-docs/fixed-history-plugin/classes/FixedHistoryOperationService.md) - [Class: FixedHistoryService](/auto-docs/fixed-history-plugin/classes/FixedHistoryService.md) - [Class: HistoryConfig](/auto-docs/fixed-history-plugin/classes/HistoryConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryContext](/auto-docs/fixed-history-plugin/classes/HistoryContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryManager](/auto-docs/fixed-history-plugin/classes/HistoryManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryService](/auto-docs/fixed-history-plugin/classes/HistoryService.md): 历史服务 - [Class: HistoryStack](/auto-docs/fixed-history-plugin/classes/HistoryStack.md): 历史栈，聚合所有历史操作 - [Class: OperationRegistry](/auto-docs/fixed-history-plugin/classes/OperationRegistry.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OperationService](/auto-docs/fixed-history-plugin/classes/OperationService.md) - [Class: StackOperation](/auto-docs/fixed-history-plugin/classes/StackOperation.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: UndoRedoService](/auto-docs/fixed-history-plugin/classes/UndoRedoService.md): UndoRedo服务 - [Enumeration: HistoryMergeEventType](/auto-docs/fixed-history-plugin/enums/HistoryMergeEventType.md) - [Enumeration: HistoryStackChangeType](/auto-docs/fixed-history-plugin/enums/HistoryStackChangeType.md): 历史栈变化类型 - [Enumeration: UndoRedoChangeType](/auto-docs/fixed-history-plugin/enums/UndoRedoChangeType.md): undo redo 类型 - [Function: createFixedHistoryPlugin](/auto-docs/fixed-history-plugin/functions/createFixedHistoryPlugin.md): createFixedHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: createHistoryPlugin](/auto-docs/fixed-history-plugin/functions/createHistoryPlugin.md): createHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Interface: FixedHistoryPluginOptions](/auto-docs/fixed-history-plugin/interfaces/FixedHistoryPluginOptions.md): 插件配置 - [Interface: HistoryItem](/auto-docs/fixed-history-plugin/interfaces/HistoryItem.md) - [Interface: HistoryOperation](/auto-docs/fixed-history-plugin/interfaces/HistoryOperation.md): 操作历史 - [Interface: HistoryPluginOptions](/auto-docs/fixed-history-plugin/interfaces/HistoryPluginOptions.md) - [Interface: HistoryRecord](/auto-docs/fixed-history-plugin/interfaces/HistoryRecord.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryStackAddEvent](/auto-docs/fixed-history-plugin/interfaces/HistoryStackAddEvent.md): 添加历史事件 - [Interface: HistoryStackAddOperationEvent](/auto-docs/fixed-history-plugin/interfaces/HistoryStackAddOperationEvent.md): 添加操作事件 - [Interface: HistoryStackBaseEvent](/auto-docs/fixed-history-plugin/interfaces/HistoryStackBaseEvent.md): 历史栈变化事件基础 - [Interface: HistoryStackItem](/auto-docs/fixed-history-plugin/interfaces/HistoryStackItem.md) - [Interface: HistoryStackUpdateEvent](/auto-docs/fixed-history-plugin/interfaces/HistoryStackUpdateEvent.md): 更新历史事件 - [Interface: HistoryStackUpdateOperationEvent](/auto-docs/fixed-history-plugin/interfaces/HistoryStackUpdateOperationEvent.md): 更新操作事件 - [Interface: IHistoryDocument](/auto-docs/fixed-history-plugin/interfaces/IHistoryDocument.md) - [Interface: IHistoryManager](/auto-docs/fixed-history-plugin/interfaces/IHistoryManager.md): 历史服务管理 - [Interface: IHistoryService](/auto-docs/fixed-history-plugin/interfaces/IHistoryService.md): 历史服务 - [Interface: IOperationRegistry](/auto-docs/fixed-history-plugin/interfaces/IOperationRegistry.md): 操作注册 - [Interface: IOperationService](/auto-docs/fixed-history-plugin/interfaces/IOperationService.md) - [Interface: IUndoRedoElement](/auto-docs/fixed-history-plugin/interfaces/IUndoRedoElement.md): UndoRedo元素 - [Interface: IUndoRedoService](/auto-docs/fixed-history-plugin/interfaces/IUndoRedoService.md): UndoRedo服务 - [Interface: Operation](/auto-docs/fixed-history-plugin/interfaces/Operation.md): 操作 - [Interface: OperationContribution](/auto-docs/fixed-history-plugin/interfaces/OperationContribution.md) - [Interface: OperationMeta](/auto-docs/fixed-history-plugin/interfaces/OperationMeta.md): 操作元数据 - [Interface: PushOperationOptions](/auto-docs/fixed-history-plugin/interfaces/PushOperationOptions.md): push操作配置 - [Interface: UndoRedoChangeElementEvent](/auto-docs/fixed-history-plugin/interfaces/UndoRedoChangeElementEvent.md): 带element的事件 - [Interface: UndoRedoClearEvent](/auto-docs/fixed-history-plugin/interfaces/UndoRedoClearEvent.md): 清空事件 - [Type alias: GetBlockLabel](/auto-docs/fixed-history-plugin/types/GetBlockLabel.md): GetBlockLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据分支获取label Parameters Returns string - [Type alias: GetDocumentJSON](/auto-docs/fixed-history-plugin/types/GetDocumentJSON.md): GetDocumentJSON: () => unknown Type declaration (): unknown 获取文档JSON Returns unknown - [Type alias: GetNodeLabel](/auto-docs/fixed-history-plugin/types/GetNodeLabel.md): GetNodeLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据节点获取label Parameters Returns string - [Type alias: GetNodeLabelById](/auto-docs/fixed-history-plugin/types/GetNodeLabelById.md): GetNodeLabelById: (id: string) => string Type declaration (id): string 根据节点id获取label Parameters Returns string - [Type alias: GetNodeURI](/auto-docs/fixed-history-plugin/types/GetNodeURI.md): GetNodeURI: (id: string) => string | any Type declaration (id): string | any 根据节点获取URI Parameters Returns string | any - [Type alias: HistoryMergeEvent](/auto-docs/fixed-history-plugin/types/HistoryMergeEvent.md): HistoryMergeEvent: { type: ADD ; value: { element: IUndoRedoElement ; operation: Operation } } | { type: UPDATE ; value: { element: IUndoRedoElement ; operation: Operation ; value: any } } 历史合并事件 - [Type alias: HistoryStackChangeEvent](/auto-docs/fixed-history-plugin/types/HistoryStackChangeEvent.md): HistoryStackChangeEvent: HistoryStackAddEvent | HistoryStackUpdateEvent | HistoryStackAddOperationEvent | HistoryStackUpdateOperationEvent 历史记录变化事件 - [Type alias: IUndoRedoElementFactory](/auto-docs/fixed-history-plugin/types/IUndoRedoElementFactory.md): IUndoRedoElementFactory: (operation: Operation) => IUndoRedoElement Type parameters Type declaration (operation): IUndoRedoElement 操作工厂 Parameters Returns IUndoRedoElement - [Type alias: NodeToJson](/auto-docs/fixed-history-plugin/types/NodeToJson.md): NodeToJson: (node: FlowNodeEntity) => FlowNodeJSON Type declaration (node): FlowNodeJSON 将node转成json Parameters Returns FlowNodeJSON - [Type alias: OperationWithId](/auto-docs/fixed-history-plugin/types/OperationWithId.md): OperationWithId: Operation & { id: string } - [Type alias: UndoRedoChangeEvent](/auto-docs/fixed-history-plugin/types/UndoRedoChangeEvent.md): UndoRedoChangeEvent: UndoRedoChangeElementEvent | UndoRedoClearEvent undo redo变化事件 - [Variable: HistoryContainerModule](/auto-docs/fixed-history-plugin/variables/HistoryContainerModule.md): Const HistoryContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OperationContribution](/auto-docs/fixed-history-plugin/variables/OperationContribution-1.md): Const OperationContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: AutoLayoutService](/auto-docs/free-auto-layout-plugin/classes/AutoLayoutService.md) - [Class: DagreGraph](/auto-docs/free-auto-layout-plugin/classes/DagreGraph.md) - [Class: Layout](/auto-docs/free-auto-layout-plugin/classes/Layout.md) - [Class: LayoutStore](/auto-docs/free-auto-layout-plugin/classes/LayoutStore.md) - [Function: createFreeAutoLayoutPlugin](/auto-docs/free-auto-layout-plugin/functions/createFreeAutoLayoutPlugin.md): createFreeAutoLayoutPlugin(opts): Plugin Auto layout plugin - 自动布局插件 https://flowgram.ai/guide/plugin/free-auto-layout-plugin.html Parameters Returns Plugin - [Interface: LayoutEdge](/auto-docs/free-auto-layout-plugin/interfaces/LayoutEdge.md) - [Interface: LayoutNode](/auto-docs/free-auto-layout-plugin/interfaces/LayoutNode.md) - [Interface: LayoutOptions](/auto-docs/free-auto-layout-plugin/interfaces/LayoutOptions.md) - [Type alias: GetFollowNode](/auto-docs/free-auto-layout-plugin/types/GetFollowNode.md): GetFollowNode: (node: LayoutNode, context: { [key: string]: any; store: ILayoutStore }) => { followTo?: string } | undefined Type declaration (node, context): { followTo?: string } | undefined Parameters Returns { followTo?: string } | undefined - [Variable: DefaultLayoutConfig](/auto-docs/free-auto-layout-plugin/variables/DefaultLayoutConfig.md): Const DefaultLayoutConfig: LayoutConfig - [Variable: dagreLib](/auto-docs/free-auto-layout-plugin/variables/dagreLib.md): Const dagreLib: Object Type declaration - [Class: NodeIntoContainerService](/auto-docs/free-container-plugin/classes/NodeIntoContainerService.md) - [Enumeration: NodeIntoContainerType](/auto-docs/free-container-plugin/enums/NodeIntoContainerType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Function: SubCanvasBackground](/auto-docs/free-container-plugin/functions/SubCanvasBackground.md): SubCanvasBackground(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: SubCanvasBorder](/auto-docs/free-container-plugin/functions/SubCanvasBorder.md): SubCanvasBorder(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: SubCanvasRender](/auto-docs/free-container-plugin/functions/SubCanvasRender.md): SubCanvasRender(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: SubCanvasTips](/auto-docs/free-container-plugin/functions/SubCanvasTips.md): SubCanvasTips(«destructured»): null | Element Parameters Returns null | Element - [Function: createContainerNodePlugin](/auto-docs/free-container-plugin/functions/createContainerNodePlugin.md): createContainerNodePlugin(opts): Plugin Parameters Returns Plugin - [Function: useNodeSize](/auto-docs/free-container-plugin/functions/useNodeSize.md): useNodeSize(): undefined | NodeSize Returns undefined | NodeSize - [Function: useSyncNodeRenderSize](/auto-docs/free-container-plugin/functions/useSyncNodeRenderSize.md): useSyncNodeRenderSize(nodeSize?): void Parameters Returns void - [Interface: NodeIntoContainerEvent](/auto-docs/free-container-plugin/interfaces/NodeIntoContainerEvent.md) - [Interface: NodeIntoContainerState](/auto-docs/free-container-plugin/interfaces/NodeIntoContainerState.md) - [Interface: NodeSize](/auto-docs/free-container-plugin/interfaces/NodeSize.md) - [Interface: WorkflowContainerPluginOptions](/auto-docs/free-container-plugin/interfaces/WorkflowContainerPluginOptions.md) - [Variable: ContainerUtils](/auto-docs/free-container-plugin/variables/ContainerUtils.md): Const ContainerUtils: Object Type declaration - [Class: WorkflowGroupService](/auto-docs/free-group-plugin/classes/WorkflowGroupService.md) - [Enumeration: WorkflowGroupCommand](/auto-docs/free-group-plugin/enums/WorkflowGroupCommand.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Function: createFreeGroupPlugin](/auto-docs/free-group-plugin/functions/createFreeGroupPlugin.md): createFreeGroupPlugin(opts): Plugin Parameters Returns Plugin - [Class: FreeHistoryConfig](/auto-docs/free-history-plugin/classes/FreeHistoryConfig.md) - [Class: FreeHistoryRegisters](/auto-docs/free-history-plugin/classes/FreeHistoryRegisters.md) - [Class: HistoryConfig](/auto-docs/free-history-plugin/classes/HistoryConfig.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryContext](/auto-docs/free-history-plugin/classes/HistoryContext.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryManager](/auto-docs/free-history-plugin/classes/HistoryManager.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: HistoryService](/auto-docs/free-history-plugin/classes/HistoryService.md): 历史服务 - [Class: HistoryStack](/auto-docs/free-history-plugin/classes/HistoryStack.md): 历史栈，聚合所有历史操作 - [Class: OperationRegistry](/auto-docs/free-history-plugin/classes/OperationRegistry.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: OperationService](/auto-docs/free-history-plugin/classes/OperationService.md) - [Class: StackOperation](/auto-docs/free-history-plugin/classes/StackOperation.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: UndoRedoService](/auto-docs/free-history-plugin/classes/UndoRedoService.md): UndoRedo服务 - [Enumeration: FreeOperationType](/auto-docs/free-history-plugin/enums/FreeOperationType.md) - [Enumeration: HistoryMergeEventType](/auto-docs/free-history-plugin/enums/HistoryMergeEventType.md) - [Enumeration: HistoryStackChangeType](/auto-docs/free-history-plugin/enums/HistoryStackChangeType.md): 历史栈变化类型 - [Enumeration: UndoRedoChangeType](/auto-docs/free-history-plugin/enums/UndoRedoChangeType.md): undo redo 类型 - [Function: createFreeHistoryPlugin](/auto-docs/free-history-plugin/functions/createFreeHistoryPlugin.md): createFreeHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: createHistoryPlugin](/auto-docs/free-history-plugin/functions/createHistoryPlugin.md): createHistoryPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: useUndoRedo](/auto-docs/free-history-plugin/functions/useUndoRedo.md): useUndoRedo(): UndoRedo Returns UndoRedo - [Interface: AddLineOperation](/auto-docs/free-history-plugin/interfaces/AddLineOperation.md): 操作 - [Interface: AddOrDeleteLineOperationValue](/auto-docs/free-history-plugin/interfaces/AddOrDeleteLineOperationValue.md) - [Interface: AddOrDeleteWorkflowNodeOperationValue](/auto-docs/free-history-plugin/interfaces/AddOrDeleteWorkflowNodeOperationValue.md) - [Interface: AddWorkflowNodeOperation](/auto-docs/free-history-plugin/interfaces/AddWorkflowNodeOperation.md): 操作 - [Interface: ChangeLineDataOperation](/auto-docs/free-history-plugin/interfaces/ChangeLineDataOperation.md): 操作 - [Interface: ChangeLineDataValue](/auto-docs/free-history-plugin/interfaces/ChangeLineDataValue.md) - [Interface: ChangeNodeDataValue](/auto-docs/free-history-plugin/interfaces/ChangeNodeDataValue.md) - [Interface: ContentChangeTypeToOperation](/auto-docs/free-history-plugin/interfaces/ContentChangeTypeToOperation.md) - [Interface: DeleteLineOperation](/auto-docs/free-history-plugin/interfaces/DeleteLineOperation.md): 操作 - [Interface: DeleteWorkflowNodeOperation](/auto-docs/free-history-plugin/interfaces/DeleteWorkflowNodeOperation.md): 操作 - [Interface: DragNodeOperationValue](/auto-docs/free-history-plugin/interfaces/DragNodeOperationValue.md) - [Interface: EntityDataType](/auto-docs/free-history-plugin/interfaces/EntityDataType.md) - [Interface: FreeHistoryPluginOptions](/auto-docs/free-history-plugin/interfaces/FreeHistoryPluginOptions.md): 插件配置 - [Interface: HistoryItem](/auto-docs/free-history-plugin/interfaces/HistoryItem.md) - [Interface: HistoryOperation](/auto-docs/free-history-plugin/interfaces/HistoryOperation.md): 操作历史 - [Interface: HistoryPluginOptions](/auto-docs/free-history-plugin/interfaces/HistoryPluginOptions.md) - [Interface: HistoryRecord](/auto-docs/free-history-plugin/interfaces/HistoryRecord.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: HistoryStackAddEvent](/auto-docs/free-history-plugin/interfaces/HistoryStackAddEvent.md): 添加历史事件 - [Interface: HistoryStackAddOperationEvent](/auto-docs/free-history-plugin/interfaces/HistoryStackAddOperationEvent.md): 添加操作事件 - [Interface: HistoryStackBaseEvent](/auto-docs/free-history-plugin/interfaces/HistoryStackBaseEvent.md): 历史栈变化事件基础 - [Interface: HistoryStackItem](/auto-docs/free-history-plugin/interfaces/HistoryStackItem.md) - [Interface: HistoryStackUpdateEvent](/auto-docs/free-history-plugin/interfaces/HistoryStackUpdateEvent.md): 更新历史事件 - [Interface: HistoryStackUpdateOperationEvent](/auto-docs/free-history-plugin/interfaces/HistoryStackUpdateOperationEvent.md): 更新操作事件 - [Interface: IHandler](/auto-docs/free-history-plugin/interfaces/IHandler.md) - [Interface: IHistoryManager](/auto-docs/free-history-plugin/interfaces/IHistoryManager.md): 历史服务管理 - [Interface: IHistoryService](/auto-docs/free-history-plugin/interfaces/IHistoryService.md): 历史服务 - [Interface: IOperationRegistry](/auto-docs/free-history-plugin/interfaces/IOperationRegistry.md): 操作注册 - [Interface: IOperationService](/auto-docs/free-history-plugin/interfaces/IOperationService.md) - [Interface: IUndoRedoElement](/auto-docs/free-history-plugin/interfaces/IUndoRedoElement.md): UndoRedo元素 - [Interface: IUndoRedoService](/auto-docs/free-history-plugin/interfaces/IUndoRedoService.md): UndoRedo服务 - [Interface: MoveNodeOperation](/auto-docs/free-history-plugin/interfaces/MoveNodeOperation.md): 操作 - [Interface: MoveNodeOperationValue](/auto-docs/free-history-plugin/interfaces/MoveNodeOperationValue.md) - [Interface: Operation](/auto-docs/free-history-plugin/interfaces/Operation.md): 操作 - [Interface: OperationContribution](/auto-docs/free-history-plugin/interfaces/OperationContribution.md) - [Interface: OperationMeta](/auto-docs/free-history-plugin/interfaces/OperationMeta.md): 操作元数据 - [Interface: PushOperationOptions](/auto-docs/free-history-plugin/interfaces/PushOperationOptions.md): push操作配置 - [Interface: ResetLayoutOperationValue](/auto-docs/free-history-plugin/interfaces/ResetLayoutOperationValue.md) - [Interface: UndoRedoChangeElementEvent](/auto-docs/free-history-plugin/interfaces/UndoRedoChangeElementEvent.md): 带element的事件 - [Interface: UndoRedoClearEvent](/auto-docs/free-history-plugin/interfaces/UndoRedoClearEvent.md): 清空事件 - [Type alias: GetBlockLabel](/auto-docs/free-history-plugin/types/GetBlockLabel.md): GetBlockLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据分支获取label Parameters Returns string - [Type alias: GetLineURI](/auto-docs/free-history-plugin/types/GetLineURI.md): GetLineURI: (id: string) => string | any Type declaration (id): string | any 根据连线获取URI Parameters Returns string | any - [Type alias: GetNodeLabel](/auto-docs/free-history-plugin/types/GetNodeLabel.md): GetNodeLabel: (node: FlowNodeJSON) => string Type declaration (node): string 根据节点获取label Parameters Returns string - [Type alias: GetNodeLabelById](/auto-docs/free-history-plugin/types/GetNodeLabelById.md): GetNodeLabelById: (id: string) => string Type declaration (id): string 根据节点id获取label Parameters Returns string - [Type alias: GetNodeURI](/auto-docs/free-history-plugin/types/GetNodeURI.md): GetNodeURI: (id: string) => string | any Type declaration (id): string | any 根据节点获取URI Parameters Returns string | any - [Type alias: HistoryMergeEvent](/auto-docs/free-history-plugin/types/HistoryMergeEvent.md): HistoryMergeEvent: { type: ADD ; value: { element: IUndoRedoElement ; operation: Operation } } | { type: UPDATE ; value: { element: IUndoRedoElement ; operation: Operation ; value: any } } 历史合并事件 - [Type alias: HistoryStackChangeEvent](/auto-docs/free-history-plugin/types/HistoryStackChangeEvent.md): HistoryStackChangeEvent: HistoryStackAddEvent | HistoryStackUpdateEvent | HistoryStackAddOperationEvent | HistoryStackUpdateOperationEvent 历史记录变化事件 - [Type alias: IUndoRedoElementFactory](/auto-docs/free-history-plugin/types/IUndoRedoElementFactory.md): IUndoRedoElementFactory: (operation: Operation) => IUndoRedoElement Type parameters Type declaration (operation): IUndoRedoElement 操作工厂 Parameters Returns IUndoRedoElement - [Type alias: LineToJson](/auto-docs/free-history-plugin/types/LineToJson.md): LineToJson: (node: WorkflowLineEntity) => FlowNodeJSON Type declaration (node): FlowNodeJSON 将line转成json Parameters Returns FlowNodeJSON - [Type alias: NodeToJson](/auto-docs/free-history-plugin/types/NodeToJson.md): NodeToJson: (node: FlowNodeEntity) => FlowNodeJSON Type declaration (node): FlowNodeJSON 将node转成json Parameters Returns FlowNodeJSON - [Type alias: OperationWithId](/auto-docs/free-history-plugin/types/OperationWithId.md): OperationWithId: Operation & { id: string } - [Type alias: UndoRedoChangeEvent](/auto-docs/free-history-plugin/types/UndoRedoChangeEvent.md): UndoRedoChangeEvent: UndoRedoChangeElementEvent | UndoRedoClearEvent undo redo变化事件 - [Variable: HistoryContainerModule](/auto-docs/free-history-plugin/variables/HistoryContainerModule.md): Const HistoryContainerModule: ContainerModule Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: OperationContribution](/auto-docs/free-history-plugin/variables/OperationContribution-1.md): Const OperationContribution: unique symbol Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Function: createFreeHoverPlugin](/auto-docs/free-hover-plugin/functions/createFreeHoverPlugin.md): createFreeHoverPlugin(opts): Plugin Parameters Returns Plugin - [Class: LinesLayer](/auto-docs/free-lines-plugin/classes/LinesLayer.md) - [Class: WorkflowBezierLineContribution](/auto-docs/free-lines-plugin/classes/WorkflowBezierLineContribution.md) - [Class: WorkflowFoldLineContribution](/auto-docs/free-lines-plugin/classes/WorkflowFoldLineContribution.md) - [Class: WorkflowStraightLineContribution](/auto-docs/free-lines-plugin/classes/WorkflowStraightLineContribution.md) - [Function: WorkflowPortRender](/auto-docs/free-lines-plugin/functions/WorkflowPortRender.md): WorkflowPortRender(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: createFreeLinesPlugin](/auto-docs/free-lines-plugin/functions/createFreeLinesPlugin.md): createFreeLinesPlugin(opts): Plugin Parameters Returns Plugin - [Interface: ArrowRendererProps](/auto-docs/free-lines-plugin/interfaces/ArrowRendererProps.md): 箭头渲染器属性接口 - [Interface: BezierData](/auto-docs/free-lines-plugin/interfaces/BezierData.md) - [Interface: FoldData](/auto-docs/free-lines-plugin/interfaces/FoldData.md) - [Interface: FreeLinesPluginOptions](/auto-docs/free-lines-plugin/interfaces/FreeLinesPluginOptions.md) - [Interface: LineRenderProps](/auto-docs/free-lines-plugin/interfaces/LineRenderProps.md) - [Interface: LinesLayerOptions](/auto-docs/free-lines-plugin/interfaces/LinesLayerOptions.md) - [Interface: StraightData](/auto-docs/free-lines-plugin/interfaces/StraightData.md) - [Interface: WorkflowPortRenderProps](/auto-docs/free-lines-plugin/interfaces/WorkflowPortRenderProps.md) - [Type alias: ArrowRendererComponent](/auto-docs/free-lines-plugin/types/ArrowRendererComponent.md): ArrowRendererComponent: React.ComponentType 箭头渲染器组件类型 - [Variable: LINE_OFFSET](/auto-docs/free-lines-plugin/variables/LINE_OFFSET.md): Const LINE_OFFSET: 6 Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Variable: LINE_PADDING](/auto-docs/free-lines-plugin/variables/LINE_PADDING.md): Const LINE_PADDING: 12 - [Class: WorkflowNodePanelService](/auto-docs/free-node-panel-plugin/classes/WorkflowNodePanelService.md): 添加节点面板服务 - [Function: createFreeNodePanelPlugin](/auto-docs/free-node-panel-plugin/functions/createFreeNodePanelPlugin.md): createFreeNodePanelPlugin(opts): Plugin Parameters Returns Plugin - [Interface: CallNodePanelParams](/auto-docs/free-node-panel-plugin/interfaces/CallNodePanelParams.md) - [Interface: IWorkflowNodePanelUtils](/auto-docs/free-node-panel-plugin/interfaces/IWorkflowNodePanelUtils.md) - [Interface: NodePanelPluginOptions](/auto-docs/free-node-panel-plugin/interfaces/NodePanelPluginOptions.md) - [Interface: NodePanelRenderProps](/auto-docs/free-node-panel-plugin/interfaces/NodePanelRenderProps.md) - [Interface: NodePanelServiceOptions](/auto-docs/free-node-panel-plugin/interfaces/NodePanelServiceOptions.md) - [Type alias: NodePanelRender](/auto-docs/free-node-panel-plugin/types/NodePanelRender.md): NodePanelRender: React.FC - [Type alias: NodePanelResult](/auto-docs/free-node-panel-plugin/types/NodePanelResult.md): NodePanelResult: { nodeJSON?: WorkflowNodeJSON ; nodeType: string ; selectEvent: React.MouseEvent } | undefined - [Variable: WorkflowNodePanelUtils](/auto-docs/free-node-panel-plugin/variables/WorkflowNodePanelUtils.md): Const WorkflowNodePanelUtils: IWorkflowNodePanelUtils - [Class: WorkflowSnapService](/auto-docs/free-snap-plugin/classes/WorkflowSnapService.md) - [Function: createFreeSnapPlugin](/auto-docs/free-snap-plugin/functions/createFreeSnapPlugin.md): createFreeSnapPlugin(opts): Plugin> Parameters Returns Plugin> - [Class: StackingComputing](/auto-docs/free-stack-plugin/classes/StackingComputing.md) - [Class: StackingContextManager](/auto-docs/free-stack-plugin/classes/StackingContextManager.md) - [Function: createFreeStackPlugin](/auto-docs/free-stack-plugin/functions/createFreeStackPlugin.md): createFreeStackPlugin(opts): Plugin> Parameters Returns Plugin> - [Interface: StackContextManagerOptions](/auto-docs/free-stack-plugin/interfaces/StackContextManagerOptions.md) - [Interface: StackingContext](/auto-docs/free-stack-plugin/interfaces/StackingContext.md) - [Type alias: FreeStackPluginOptions](/auto-docs/free-stack-plugin/types/FreeStackPluginOptions.md): FreeStackPluginOptions: Partial - [Variable: BASE_Z_INDEX](/auto-docs/free-stack-plugin/variables/BASE_Z_INDEX.md): Const BASE_Z_INDEX: 8 Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: FlowGroupController](/auto-docs/group-plugin/classes/FlowGroupController.md): 分组控制器 - [Class: GroupsLayer](/auto-docs/group-plugin/classes/GroupsLayer.md) - [Enumeration: GroupPluginRegister](/auto-docs/group-plugin/enums/GroupPluginRegister.md) - [Enumeration: GroupRenderer](/auto-docs/group-plugin/enums/GroupRenderer.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Function: GroupBox](/auto-docs/group-plugin/functions/GroupBox.md): GroupBox(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: GroupRender](/auto-docs/group-plugin/functions/GroupRender.md): GroupRender(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: createGroupPlugin](/auto-docs/group-plugin/functions/createGroupPlugin.md): createGroupPlugin(opts): Plugin 分组插件 Parameters Returns Plugin - [Interface: GroupsLayerOptions](/auto-docs/group-plugin/interfaces/GroupsLayerOptions.md) - [Type alias: CreateGroupPluginOptions](/auto-docs/group-plugin/types/CreateGroupPluginOptions.md): CreateGroupPluginOptions: GroupsLayerOptions & { components?: { GroupBoxHeader: IGroupBoxHeader ; GroupNode: IGroupNode } ; registers?: { [key in GroupPluginRegister]?: IGroupPluginRegister | boolean } } - [Type alias: IGroupBox](/auto-docs/group-plugin/types/IGroupBox.md): IGroupBox: FC<{ backgroundStyle?: (groupController: FlowGroupController) => CSSProperties ; groupNode: FlowNodeEntity }> - [Type alias: IGroupBoxHeader](/auto-docs/group-plugin/types/IGroupBoxHeader.md): IGroupBoxHeader: FC<{ groupController: FlowGroupController ; groupNode: FlowNodeEntity }> - [Type alias: IGroupNode](/auto-docs/group-plugin/types/IGroupNode.md): IGroupNode: FC<{ groupController: FlowGroupController ; groupNode: FlowNodeEntity }> - [Type alias: IGroupPluginRegister](/auto-docs/group-plugin/types/IGroupPluginRegister.md): IGroupPluginRegister: (ctx: PluginContext, opts: CreateGroupPluginOptions) => void Type declaration (ctx, opts): void Parameters Returns void - [Type alias: IGroupRender](/auto-docs/group-plugin/types/IGroupRender.md): IGroupRender: FC<{ GroupBoxHeader: IGroupBoxHeader ; GroupNode: IGroupNode ; groupNode: FlowNodeEntity }> - [Variable: GroupRegister](/auto-docs/group-plugin/variables/GroupRegister.md): Const GroupRegister: FlowNodeRegistry - [Variable: PositionConfig](/auto-docs/group-plugin/variables/PositionConfig.md): Const PositionConfig: Object Type declaration - [Function: createHistoryNodePlugin](/auto-docs/history-node-plugin/functions/createHistoryNodePlugin.md): createHistoryNodePlugin(opts): Plugin 表单历史插件 Parameters Returns Plugin - [Function: createI18nPlugin](/auto-docs/i18n-plugin/functions/createI18nPlugin.md): createI18nPlugin(opts): Plugin I18n Plugin Parameters Returns Plugin - [Interface: I18nLanguage](/auto-docs/i18n-plugin/interfaces/I18nLanguage.md) - [Interface: I18nPluginOptions](/auto-docs/i18n-plugin/interfaces/I18nPluginOptions.md) - [Variable: I18n](/auto-docs/i18n-plugin/variables/I18n.md): Const I18n: I18nImpl - [Function: createMaterialsPlugin](/auto-docs/materials-plugin/functions/createMaterialsPlugin.md): createMaterialsPlugin(opts): Plugin Parameters Returns Plugin - [Interface: MaterialsPluginOptions](/auto-docs/materials-plugin/interfaces/MaterialsPluginOptions.md) - [Type alias: MaterialReactComponent](/auto-docs/materials-plugin/types/MaterialReactComponent.md): MaterialReactComponent: (props: T) => React.ReactNode | null Type parameters Type declaration (props): React.ReactNode | null Parameters Returns React.ReactNode | null - [Class: FlowMinimapLayer](/auto-docs/minimap-plugin/classes/FlowMinimapLayer.md) - [Class: FlowMinimapService](/auto-docs/minimap-plugin/classes/FlowMinimapService.md) - [Function: MinimapRender](/auto-docs/minimap-plugin/functions/MinimapRender.md): MinimapRender(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: createMinimapPlugin](/auto-docs/minimap-plugin/functions/createMinimapPlugin.md): createMinimapPlugin(opts): Plugin Parameters Returns Plugin - [Interface: CreateMinimapPluginOptions](/auto-docs/minimap-plugin/interfaces/CreateMinimapPluginOptions.md) - [Interface: MinimapCanvasStyle](/auto-docs/minimap-plugin/interfaces/MinimapCanvasStyle.md) - [Interface: MinimapInactiveStyle](/auto-docs/minimap-plugin/interfaces/MinimapInactiveStyle.md) - [Interface: MinimapLayerOptions](/auto-docs/minimap-plugin/interfaces/MinimapLayerOptions.md) - [Interface: MinimapRenderContext](/auto-docs/minimap-plugin/interfaces/MinimapRenderContext.md) - [Interface: MinimapServiceOptions](/auto-docs/minimap-plugin/interfaces/MinimapServiceOptions.md) - [Variable: MinimapDefaultCanvasStyle](/auto-docs/minimap-plugin/variables/MinimapDefaultCanvasStyle.md): Const MinimapDefaultCanvasStyle: MinimapCanvasStyle - [Variable: MinimapDefaultInactiveStyle](/auto-docs/minimap-plugin/variables/MinimapDefaultInactiveStyle.md): Const MinimapDefaultInactiveStyle: MinimapInactiveStyle - [Variable: MinimapDefaultOptions](/auto-docs/minimap-plugin/variables/MinimapDefaultOptions.md): Const MinimapDefaultOptions: MinimapServiceOptions - [Function: createNodeCorePlugin](/auto-docs/node-core-plugin/functions/createNodeCorePlugin.md): createNodeCorePlugin(opts): Plugin Parameters Returns Plugin - [Function: registerNodeMaterial](/auto-docs/node-core-plugin/functions/registerNodeMaterial.md): registerNodeMaterial(«destructured»): void Parameters Returns void - [Interface: NodeCorePluginOptions](/auto-docs/node-core-plugin/interfaces/NodeCorePluginOptions.md) - [Interface: NodeEngineMaterialOptions](/auto-docs/node-core-plugin/interfaces/NodeEngineMaterialOptions.md) - [Function: PrivateScopeProvider](/auto-docs/node-variable-plugin/functions/PrivateScopeProvider.md): PrivateScopeProvider(«destructured»): Element PrivateScopeProvider provides the private scope to its children via context. Parameters Returns Element - [Function: PublicScopeProvider](/auto-docs/node-variable-plugin/functions/PublicScopeProvider.md): PublicScopeProvider(«destructured»): Element PublicScopeProvider provides the public scope to its children via context. Parameters Returns Element - [Function: createEffectFromVariableProvider](/auto-docs/node-variable-plugin/functions/createEffectFromVariableProvider.md): createEffectFromVariableProvider(options): EffectOptions[] 根据 VariableProvider 生成 FormV2 的 Effect Parameters Returns EffectOptions[] - [Function: createNodeVariablePlugin](/auto-docs/node-variable-plugin/functions/createNodeVariablePlugin.md): createNodeVariablePlugin(opts): Plugin Parameters Returns Plugin - [Function: createVariableProviderPlugin](/auto-docs/node-variable-plugin/functions/createVariableProviderPlugin.md): createVariableProviderPlugin(opts): FormPlugin Parameters Returns FormPlugin - [Interface: VariableAbilityParseContext](/auto-docs/node-variable-plugin/interfaces/VariableAbilityParseContext.md) - [Interface: VariableConsumerAbilityOptions](/auto-docs/node-variable-plugin/interfaces/VariableConsumerAbilityOptions.md) - [Interface: VariableProviderAbilityOptions](/auto-docs/node-variable-plugin/interfaces/VariableProviderAbilityOptions.md) - [Class: PanelManager](/auto-docs/panel-manager-plugin/classes/PanelManager.md) - [Function: DockedPanelLayer](/auto-docs/panel-manager-plugin/functions/DockedPanelLayer.md): DockedPanelLayer(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: ResizeBar](/auto-docs/panel-manager-plugin/functions/ResizeBar.md): ResizeBar(props, deprecatedLegacyContext?): null | ReactElement Parameters Returns null | ReactElement - [Function: createPanelManagerPlugin](/auto-docs/panel-manager-plugin/functions/createPanelManagerPlugin.md): createPanelManagerPlugin(opts): Plugin> Parameters Returns Plugin> - [Function: usePanel](/auto-docs/panel-manager-plugin/functions/usePanel.md): usePanel(): PanelEntity Returns PanelEntity - [Function: usePanelManager](/auto-docs/panel-manager-plugin/functions/usePanelManager.md): usePanelManager(): PanelManager Returns PanelManager - [Interface: PanelFactory](/auto-docs/panel-manager-plugin/interfaces/PanelFactory.md) - [Interface: PanelManagerConfig](/auto-docs/panel-manager-plugin/interfaces/PanelManagerConfig.md) - [Interface: PanelRestore](/auto-docs/panel-manager-plugin/interfaces/PanelRestore.md) - [Type alias: Area](/auto-docs/panel-manager-plugin/types/Area.md): Area: "right" | "bottom" | "docked-right" | "docked-bottom" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: DockedPanelLayerProps](/auto-docs/panel-manager-plugin/types/DockedPanelLayerProps.md): DockedPanelLayerProps: Omit - [Variable: PanelManagerConfig](/auto-docs/panel-manager-plugin/variables/PanelManagerConfig-1.md): PanelManagerConfig: typeof PanelManagerConfig - [Variable: PanelRestore](/auto-docs/panel-manager-plugin/variables/PanelRestore-1.md): Const PanelRestore: typeof PanelRestore - [Class: ECSConnector](/auto-docs/redux-devtool-plugin/classes/ECSConnector.md) - [Function: createReduxDevToolPlugin](/auto-docs/redux-devtool-plugin/functions/createReduxDevToolPlugin.md): createReduxDevToolPlugin(opts): Plugin Parameters Returns Plugin - [Interface: ReduxDevToolPluginOptions](/auto-docs/redux-devtool-plugin/interfaces/ReduxDevToolPluginOptions.md) - [Function: createSelectBoxPlugin](/auto-docs/select-box-plugin/functions/createSelectBoxPlugin.md): createSelectBoxPlugin(opts): Plugin Parameters Returns Plugin - [Interface: SelectBoxPluginOptions](/auto-docs/select-box-plugin/interfaces/SelectBoxPluginOptions.md) - [Interface: SelectorBoxPopoverProps](/auto-docs/select-box-plugin/interfaces/SelectorBoxPopoverProps.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Class: ShortcutsRegistry](/auto-docs/shortcuts-plugin/classes/ShortcutsRegistry.md) - [Function: createShortcutsPlugin](/auto-docs/shortcuts-plugin/functions/createShortcutsPlugin.md): createShortcutsPlugin(opts): Plugin Parameters Returns Plugin - [Interface: ShortcutsContribution](/auto-docs/shortcuts-plugin/interfaces/ShortcutsContribution.md) - [Interface: ShortcutsHandler](/auto-docs/shortcuts-plugin/interfaces/ShortcutsHandler.md) - [Variable: ShortcutsContribution](/auto-docs/shortcuts-plugin/variables/ShortcutsContribution-1.md): Const ShortcutsContribution: typeof ShortcutsContribution - [Class: TestRunPipelineEntity](/auto-docs/test-run-plugin/classes/TestRunPipelineEntity.md) - [Function: connect](/auto-docs/test-run-plugin/functions/connect.md): connect(Component, mapProps): (props: any) => any Type parameters Parameters Returns fn (props): any Parameters Returns any - [Function: useCreateForm](/auto-docs/test-run-plugin/functions/useCreateForm.md): useCreateForm(«destructured»): Object Parameters Returns Object - [Function: useTestRunService](/auto-docs/test-run-plugin/functions/useTestRunService.md): useTestRunService(): any Returns any - [Interface: FormInstance](/auto-docs/test-run-plugin/interfaces/FormInstance.md) - [Interface: FormSchema](/auto-docs/test-run-plugin/interfaces/FormSchema.md) - [Interface: TestRunConfig](/auto-docs/test-run-plugin/interfaces/TestRunConfig.md) - [Interface: TestRunPipelineEntityCtx](/auto-docs/test-run-plugin/interfaces/TestRunPipelineEntityCtx.md) - [Interface: TestRunPipelinePlugin](/auto-docs/test-run-plugin/interfaces/TestRunPipelinePlugin.md) - [Type alias: FormComponentProps](/auto-docs/test-run-plugin/types/FormComponentProps.md): FormComponentProps: { [key: string]: any; disabled?: boolean ; type?: FormSchemaType } & FormSchema["x-component-props"] & FormSchema["x-decorator-props"] & Partial - [Type alias: FormEngineProps](/auto-docs/test-run-plugin/types/FormEngineProps.md): FormEngineProps: React.PropsWithChildren<{ components?: FormComponents ; schema: FormSchema } & UseCreateFormOptions> - [Variable: FormEngine](/auto-docs/test-run-plugin/variables/FormEngine.md): Const FormEngine: React.FC - [Variable: TestRunConfig](/auto-docs/test-run-plugin/variables/TestRunConfig-1.md): TestRunConfig: any - [Variable: createTestRunPlugin](/auto-docs/test-run-plugin/variables/createTestRunPlugin.md): Const createTestRunPlugin: any - [Class: ASTNode](/auto-docs/variable-plugin/classes/ASTNode.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: ASTRegisters](/auto-docs/variable-plugin/classes/ASTRegisters.md): Register the AST node to the engine. - [Class: ArrayType](/auto-docs/variable-plugin/classes/ArrayType.md): Represents an array type. - [Class: BaseExpression](/auto-docs/variable-plugin/classes/BaseExpression.md): Base class for all expressions. All other expressions should extend this class. - [Class: BaseType](/auto-docs/variable-plugin/classes/BaseType.md): Base class for all types. All other types should extend this class. - [Class: BaseVariableField](/auto-docs/variable-plugin/classes/BaseVariableField.md): Variable Field abstract class, which is the base class for VariableDeclaration and Property VariableDeclaration is used to declare a variable in a block scope.Property is used to declare a property in an object. - [Class: BooleanType](/auto-docs/variable-plugin/classes/BooleanType.md): Represents a boolean type. - [Class: CustomType](/auto-docs/variable-plugin/classes/CustomType.md): Represents a custom type. - [Class: DataNode](/auto-docs/variable-plugin/classes/DataNode.md): Represents a general data node with no child nodes. - [Class: EnumerateExpression](/auto-docs/variable-plugin/classes/EnumerateExpression.md): Represents an enumeration expression, which iterates over a list and returns the type of the enumerated variable. - [Class: FlowNodeVariableData](/auto-docs/variable-plugin/classes/FlowNodeVariableData.md): Manages variable data for a flow node, including public and private scopes. - [Class: GlobalScope](/auto-docs/variable-plugin/classes/GlobalScope.md): Global Scope stores all variables that are not scoped to any node. Variables in Global Scope can be accessed by any node.Any other scope's variables can not be accessed by Global Scope. - [Class: IntegerType](/auto-docs/variable-plugin/classes/IntegerType.md): Represents an integer type. - [Class: KeyPathExpression](/auto-docs/variable-plugin/classes/KeyPathExpression.md): Represents a key path expression, which is used to reference a variable by its key path. This is the V2 of KeyPathExpression, with the following improvements: returnType is copied to a new instance to avoid reference issues.Circular reference detection is introduced. - [Class: LegacyKeyPathExpression](/auto-docs/variable-plugin/classes/LegacyKeyPathExpression.md): Deprecated Use KeyPathExpression instead. Represents a key path expression, which is used to reference a variable by its key path. - [Class: ListNode](/auto-docs/variable-plugin/classes/ListNode.md): Represents a list of nodes. - [Class: MapNode](/auto-docs/variable-plugin/classes/MapNode.md): Represents a map of nodes. - [Class: MapType](/auto-docs/variable-plugin/classes/MapType.md): Represents a map type. - [Class: NumberType](/auto-docs/variable-plugin/classes/NumberType.md): Represents a number type. - [Class: ObjectType](/auto-docs/variable-plugin/classes/ObjectType.md): Represents an object type. - [Class: Property](/auto-docs/variable-plugin/classes/Property.md): Property is a variable field that represents a property of a ObjectType. - [Class: Scope](/auto-docs/variable-plugin/classes/Scope.md): Represents a variable scope, which manages its own set of variables and their lifecycle. scope.output represents the variables declared within this scope.scope.available represents all variables accessible from this scope, including those from parent scopes. - [Class: ScopeChain](/auto-docs/variable-plugin/classes/ScopeChain.md): Manages the dependency relationships between scopes. This is an abstract class, and specific implementations determine how the scope order is managed. - [Class: ScopeChainTransformService](/auto-docs/variable-plugin/classes/ScopeChainTransformService.md): A service for transforming scope chains. - [Class: ScopeOutputData](/auto-docs/variable-plugin/classes/ScopeOutputData.md): Manages the output variables of a scope. - [Class: StringType](/auto-docs/variable-plugin/classes/StringType.md): Base class for all types. All other types should extend this class. - [Class: VariableDeclaration](/auto-docs/variable-plugin/classes/VariableDeclaration.md): VariableDeclaration is a variable field that represents a variable declaration. - [Class: VariableDeclarationList](/auto-docs/variable-plugin/classes/VariableDeclarationList.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: VariableEngine](/auto-docs/variable-plugin/classes/VariableEngine.md): The core of the variable engine system. It manages scopes, variables, and events within the system. - [Class: VariableFieldKeyRenameService](/auto-docs/variable-plugin/classes/VariableFieldKeyRenameService.md): This service is responsible for detecting when a variable field's key is renamed. It listens for changes in variable declaration lists and object properties, and determines if a change constitutes a rename operation. - [Class: WrapArrayExpression](/auto-docs/variable-plugin/classes/WrapArrayExpression.md): Represents a wrap expression, which wraps an expression with an array. - [Enumeration: ASTKind](/auto-docs/variable-plugin/enums/ASTKind.md): Core AST node types. - [Enumeration: ASTNodeFlags](/auto-docs/variable-plugin/enums/ASTNodeFlags.md): ASTNode flags. Stored in the flags property of the ASTNode. - [Enumeration: FlowNodeScopeType](/auto-docs/variable-plugin/enums/FlowNodeScopeType.md): Enum for flow node scope types. - [Function: create](/auto-docs/variable-plugin/functions/ASTFactory.create.md): ASTFactory.create create(targetType, json): { kind: string } & JSON Creates Type-Safe ASTNodeJSON object based on the provided AST class. Type parameters Parameters Returns { kind: string } & JSON The ASTNode JSON object. - [Function: createArray](/auto-docs/variable-plugin/functions/ASTFactory.createArray.md): ASTFactory.createArray createArray(json): Object Creates an Array type node. Parameters Returns Object - [Function: createBoolean](/auto-docs/variable-plugin/functions/ASTFactory.createBoolean.md): ASTFactory.createBoolean createBoolean(): Object Creates a Boolean type node. Returns Object - [Function: createCustomType](/auto-docs/variable-plugin/functions/ASTFactory.createCustomType.md): ASTFactory.createCustomType createCustomType(json): Object Creates a CustomType node. Parameters Returns Object - [Function: createEnumerateExpression](/auto-docs/variable-plugin/functions/ASTFactory.createEnumerateExpression.md): ASTFactory.createEnumerateExpression createEnumerateExpression(json): Object Creates an EnumerateExpression node. Parameters Returns Object - [Function: createInteger](/auto-docs/variable-plugin/functions/ASTFactory.createInteger.md): ASTFactory.createInteger createInteger(): Object Creates an Integer type node. Returns Object - [Function: createKeyPathExpression](/auto-docs/variable-plugin/functions/ASTFactory.createKeyPathExpression.md): ASTFactory.createKeyPathExpression createKeyPathExpression(json): Object Creates a KeyPathExpression node. Parameters Returns Object - [Function: createMap](/auto-docs/variable-plugin/functions/ASTFactory.createMap.md): ASTFactory.createMap createMap(json): Object Creates a Map type node. Parameters Returns Object - [Function: createNumber](/auto-docs/variable-plugin/functions/ASTFactory.createNumber.md): ASTFactory.createNumber createNumber(): Object Creates a Number type node. Returns Object - [Function: createObject](/auto-docs/variable-plugin/functions/ASTFactory.createObject.md): ASTFactory.createObject createObject(json): Object Creates an Object type node. Parameters Returns Object - [Function: createProperty](/auto-docs/variable-plugin/functions/ASTFactory.createProperty.md): ASTFactory.createProperty createProperty(json): Object Creates a Property node. Type parameters Parameters Returns Object - [Function: createString](/auto-docs/variable-plugin/functions/ASTFactory.createString.md): ASTFactory.createString createString(json?): Object Creates a String type node. Parameters Returns Object - [Function: createUnion](/auto-docs/variable-plugin/functions/ASTFactory.createUnion.md): ASTFactory.createUnion createUnion(json): Object Creates a Union type node. Parameters Returns Object - [Function: createVariableDeclaration](/auto-docs/variable-plugin/functions/ASTFactory.createVariableDeclaration.md): ASTFactory.createVariableDeclaration createVariableDeclaration(json): Object Creates a VariableDeclaration node. Type parameters Parameters Returns Object - [Function: createVariableDeclarationList](/auto-docs/variable-plugin/functions/ASTFactory.createVariableDeclarationList.md): ASTFactory.createVariableDeclarationList createVariableDeclarationList(json): Object Creates a VariableDeclarationList node. Parameters Returns Object - [Function: createWrapArrayExpression](/auto-docs/variable-plugin/functions/ASTFactory.createWrapArrayExpression.md): ASTFactory.createWrapArrayExpression createWrapArrayExpression(json): Object Creates a WrapArrayExpression node. Parameters Returns Object - [Function: is](/auto-docs/variable-plugin/functions/ASTMatch.is.md): ASTMatch.is is(node?, targetType?): node is TargetASTNode Check ASTNode Match by ASTClass Type parameters Parameters Returns node is TargetASTNode Whether the node is of the target type. - [Function: isArray](/auto-docs/variable-plugin/functions/ASTMatch.isArray.md): ASTMatch.isArray isArray(node?): node is ArrayType Check if the node is a ArrayType. Parameters Returns node is ArrayType - [Function: isBaseVariableField](/auto-docs/variable-plugin/functions/ASTMatch.isBaseVariableField.md): ASTMatch.isBaseVariableField isBaseVariableField(node?): node is BaseVariableField Check if the node is a BaseVariableField. Parameters Returns node is BaseVariableField - [Function: isBoolean](/auto-docs/variable-plugin/functions/ASTMatch.isBoolean.md): ASTMatch.isBoolean isBoolean(node?): node is BooleanType Check if the node is a BooleanType. Parameters Returns node is BooleanType - [Function: isCustomType](/auto-docs/variable-plugin/functions/ASTMatch.isCustomType.md): ASTMatch.isCustomType isCustomType(node?): node is CustomType Check if the node is a CustomType. Parameters Returns node is CustomType - [Function: isEnumerateExpression](/auto-docs/variable-plugin/functions/ASTMatch.isEnumerateExpression.md): ASTMatch.isEnumerateExpression isEnumerateExpression(node?): node is EnumerateExpression Check if the node is a EnumerateExpression. Parameters Returns node is EnumerateExpression - [Function: isInteger](/auto-docs/variable-plugin/functions/ASTMatch.isInteger.md): ASTMatch.isInteger isInteger(node?): node is IntegerType Check if the node is a IntegerType. Parameters Returns node is IntegerType - [Function: isKeyPathExpression](/auto-docs/variable-plugin/functions/ASTMatch.isKeyPathExpression.md): ASTMatch.isKeyPathExpression isKeyPathExpression(node?): node is KeyPathExpression Check if the node is a KeyPathExpression. Parameters Returns node is KeyPathExpression - [Function: isMap](/auto-docs/variable-plugin/functions/ASTMatch.isMap.md): ASTMatch.isMap isMap(node?): node is MapType Check if the node is a MapType. Parameters Returns node is MapType - [Function: isNumber](/auto-docs/variable-plugin/functions/ASTMatch.isNumber.md): ASTMatch.isNumber isNumber(node?): node is NumberType Check if the node is a NumberType. Parameters Returns node is NumberType - [Function: isObject](/auto-docs/variable-plugin/functions/ASTMatch.isObject.md): ASTMatch.isObject isObject(node?): node is ObjectType Check if the node is a ObjectType. Parameters Returns node is ObjectType - [Function: isProperty](/auto-docs/variable-plugin/functions/ASTMatch.isProperty.md): ASTMatch.isProperty isProperty(node?): node is Property Check if the node is a Property. Type parameters Parameters Returns node is Property - [Function: isString](/auto-docs/variable-plugin/functions/ASTMatch.isString.md): ASTMatch.isString isString(node?): node is StringType Check if the node is a StringType. Parameters Returns node is StringType - [Function: isVariableDeclaration](/auto-docs/variable-plugin/functions/ASTMatch.isVariableDeclaration.md): ASTMatch.isVariableDeclaration isVariableDeclaration(node?): node is VariableDeclaration Check if the node is a VariableDeclaration. Type parameters Parameters Returns node is VariableDeclaration - [Function: isVariableDeclarationList](/auto-docs/variable-plugin/functions/ASTMatch.isVariableDeclarationList.md): ASTMatch.isVariableDeclarationList isVariableDeclarationList(node?): node is VariableDeclarationList Check if the node is a VariableDeclarationList. Parameters Returns node is VariableDeclarationList - [Function: isWrapArrayExpression](/auto-docs/variable-plugin/functions/ASTMatch.isWrapArrayExpression.md): ASTMatch.isWrapArrayExpression isWrapArrayExpression(node?): node is WrapArrayExpression Check if the node is a WrapArrayExpression. Parameters Returns node is WrapArrayExpression - [Function: ScopeProvider](/auto-docs/variable-plugin/functions/ScopeProvider.md): ScopeProvider(props): Element ScopeProvider provides the scope to its children via context. Parameters Returns Element - [Function: createVariablePlugin](/auto-docs/variable-plugin/functions/createVariablePlugin.md): createVariablePlugin(opts): Plugin Parameters Returns Plugin - [Function: getNodePrivateScope](/auto-docs/variable-plugin/functions/getNodePrivateScope.md): getNodePrivateScope(node): FlowNodeScope Use node.privateScope instead. Parameters Returns FlowNodeScope The private scope of the node. Deprecated - [Function: getNodeScope](/auto-docs/variable-plugin/functions/getNodeScope.md): getNodeScope(node): FlowNodeScope Use node.scope instead. Parameters Returns FlowNodeScope The public scope of the node. Deprecated - [Function: injectToAST](/auto-docs/variable-plugin/functions/injectToAST.md): injectToAST(serviceIdentifier): (target: any, propertyKey: string) => any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: isMatchAST](/auto-docs/variable-plugin/functions/isMatchAST.md): isMatchAST(node?, targetType?): node is TargetASTNode isMatchAST is same as ASTMatch.is Type parameters Parameters Returns node is TargetASTNode - [Function: postConstructAST](/auto-docs/variable-plugin/functions/postConstructAST.md): postConstructAST(): (target: any, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: useAvailableVariables](/auto-docs/variable-plugin/functions/useAvailableVariables.md): useAvailableVariables(): VariableDeclaration[] Get available variable list in the current scope. If no scope, return global variable list.The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useCurrentScope](/auto-docs/variable-plugin/functions/useCurrentScope.md): useCurrentScope(params?): Strict extends true ? Scope> : undefined | Scope> useCurrentScope returns the scope provided by ScopeProvider. Type parameters Parameters Returns Strict extends true ? Scope> : undefined | Scope> - [Function: useOutputVariables](/auto-docs/variable-plugin/functions/useOutputVariables.md): useOutputVariables(): VariableDeclaration[] Get output variable list in the current scope. The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useScopeAvailable](/auto-docs/variable-plugin/functions/useScopeAvailable.md): useScopeAvailable(params?): ScopeAvailableData Get the available variables in the current scope. 获取作用域的可访问变量 Parameters Returns ScopeAvailableData the available variables in the current scope - [Interface: ASTNodeJSON](/auto-docs/variable-plugin/interfaces/ASTNodeJSON.md): ASTNodeJSON is the JSON representation of an ASTNode. - [Interface: ASTNodeRegistry](/auto-docs/variable-plugin/interfaces/ASTNodeRegistry.md) - [Interface: CreateASTParams](/auto-docs/variable-plugin/interfaces/CreateASTParams.md) - [Interface: CustomTypeJSON](/auto-docs/variable-plugin/interfaces/CustomTypeJSON.md): ASTNodeJSON representation of CustomType - [Interface: EnumerateExpressionJSON](/auto-docs/variable-plugin/interfaces/EnumerateExpressionJSON.md): ASTNodeJSON representation of EnumerateExpression - [Interface: FlowNodeScope](/auto-docs/variable-plugin/interfaces/FlowNodeScope.md): Represents a scope associated with a flow node. - [Interface: FlowNodeScopeMeta](/auto-docs/variable-plugin/interfaces/FlowNodeScopeMeta.md): Metadata for a flow node scope. - [Interface: GlobalEventActionType](/auto-docs/variable-plugin/interfaces/GlobalEventActionType.md): Global event action type. Global event might be dispatched from ASTNode or Scope. - [Interface: IVariableTable](/auto-docs/variable-plugin/interfaces/IVariableTable.md): Interface for a variable table. - [Interface: KeyPathExpressionJSON](/auto-docs/variable-plugin/interfaces/KeyPathExpressionJSON.md): ASTNodeJSON representation of KeyPathExpression - [Interface: ListNodeJSON](/auto-docs/variable-plugin/interfaces/ListNodeJSON.md): ASTNodeJSON representation of ListNode - [Interface: MapNodeJSON](/auto-docs/variable-plugin/interfaces/MapNodeJSON.md): ASTNodeJSON representation of MapNode - [Interface: ObjectJSON](/auto-docs/variable-plugin/interfaces/ObjectJSON.md): ASTNodeJSON representation of ObjectType - [Interface: Observer](/auto-docs/variable-plugin/interfaces/Observer.md): An object interface that defines a set of callback functions a user can use to get notified of any set of Observable guide/glossary-and-semantics#notification notification events. For more info, please refer to guide/observer this guide. - [Interface: UnionJSON](/auto-docs/variable-plugin/interfaces/UnionJSON.md): ASTNodeJSON representation of UnionType, which union multiple BaseType. - [Interface: VariableDeclarationListJSON](/auto-docs/variable-plugin/interfaces/VariableDeclarationListJSON.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: VariablePluginOptions](/auto-docs/variable-plugin/interfaces/VariablePluginOptions.md) - [Interface: WrapArrayExpressionJSON](/auto-docs/variable-plugin/interfaces/WrapArrayExpressionJSON.md): ASTNodeJSON representation of WrapArrayExpression - [Namespace: ASTFactory](/auto-docs/variable-plugin/modules/ASTFactory.md): Variable-core ASTNode factories. - [Namespace: ASTMatch](/auto-docs/variable-plugin/modules/ASTMatch.md): Variable-core ASTNode matchers. Typescript code inside if statement will be type guarded. - [Type alias: GetKindJSON](/auto-docs/variable-plugin/types/GetKindJSON.md): GetKindJSON: { key?: Identifier ; kind: KindType } & JSON TypeUtils to get the JSON representation of an AST node with a specific kind. Type parameters - [Type alias: GetKindJSONOrKind](/auto-docs/variable-plugin/types/GetKindJSONOrKind.md): GetKindJSONOrKind: { key?: Identifier ; kind: KindType } & JSON | KindType TypeUtils to get the JSON representation of an AST node with a specific kind or just the kind string. Type parameters - [Type alias: ObjectPropertiesChangeAction](/auto-docs/variable-plugin/types/ObjectPropertiesChangeAction.md): ObjectPropertiesChangeAction: GlobalEventActionType<"ObjectPropertiesChange", { next: Property[] ; prev: Property[] }, ObjectType> Action type for object properties change. - [Type alias: PropertyJSON](/auto-docs/variable-plugin/types/PropertyJSON.md): PropertyJSON: BaseVariableFieldJSON ASTNodeJSON representation of the Property. Type parameters - [Type alias: VariableDeclarationJSON](/auto-docs/variable-plugin/types/VariableDeclarationJSON.md): VariableDeclarationJSON: BaseVariableFieldJSON & { order?: number } ASTNodeJSON representation of the VariableDeclaration. Type parameters - [Type alias: VariableDeclarationListChangeAction](/auto-docs/variable-plugin/types/VariableDeclarationListChangeAction.md): VariableDeclarationListChangeAction: GlobalEventActionType<"VariableListChange", { next: VariableDeclaration[] ; prev: VariableDeclaration[] }, VariableDeclarationList> - [Type alias: VariableEngineProvider](/auto-docs/variable-plugin/types/VariableEngineProvider.md): VariableEngineProvider: () => VariableEngine Type declaration (): VariableEngine Returns VariableEngine - [Variable: VariableContainerModule](/auto-docs/variable-plugin/variables/VariableContainerModule.md): Const VariableContainerModule: ContainerModule An InversifyJS container module that binds all the necessary services for the variable engine. This module sets up the dependency injection for the core components of the variable engine. - [Variable: VariableEngineProvider](/auto-docs/variable-plugin/variables/VariableEngineProvider-1.md): Const VariableEngineProvider: unique symbol A provider for dynamically obtaining the VariableEngine instance. This is used to prevent circular dependencies when injecting VariableEngine. - [Enumeration: ConditionOperator](/auto-docs/interface/enums/ConditionOperator.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowGramAPIMethod](/auto-docs/interface/enums/FlowGramAPIMethod.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: FlowGramAPIModule](/auto-docs/interface/enums/FlowGramAPIModule.md) - [Enumeration: FlowGramAPIName](/auto-docs/interface/enums/FlowGramAPIName.md) - [Enumeration: FlowGramNode](/auto-docs/interface/enums/FlowGramNode.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: HTTPBodyType](/auto-docs/interface/enums/HTTPBodyType.md) - [Enumeration: HTTPMethod](/auto-docs/interface/enums/HTTPMethod.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: WorkflowMessageType](/auto-docs/interface/enums/WorkflowMessageType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: WorkflowPortType](/auto-docs/interface/enums/WorkflowPortType.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: WorkflowStatus](/auto-docs/interface/enums/WorkflowStatus.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Enumeration: WorkflowVariableType](/auto-docs/interface/enums/WorkflowVariableType.md) - [Interface: ConditionItem](/auto-docs/interface/interfaces/ConditionItem.md) - [Interface: ContextData](/auto-docs/interface/interfaces/ContextData.md) - [Interface: CreateEdgeParams](/auto-docs/interface/interfaces/CreateEdgeParams.md) - [Interface: CreateNodeParams](/auto-docs/interface/interfaces/CreateNodeParams.md) - [Interface: CreatePortParams](/auto-docs/interface/interfaces/CreatePortParams.md) - [Interface: EngineServices](/auto-docs/interface/interfaces/EngineServices.md) - [Interface: ExecutionContext](/auto-docs/interface/interfaces/ExecutionContext.md) - [Interface: ExecutionResult](/auto-docs/interface/interfaces/ExecutionResult.md) - [Interface: FlowGramAPIDefine](/auto-docs/interface/interfaces/FlowGramAPIDefine.md) - [Interface: FlowGramAPIDefines](/auto-docs/interface/interfaces/FlowGramAPIDefines.md) - [Interface: ICache](/auto-docs/interface/interfaces/ICache.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: IContainer](/auto-docs/interface/interfaces/IContainer.md) - [Interface: IContext](/auto-docs/interface/interfaces/IContext.md) - [Interface: IDocument](/auto-docs/interface/interfaces/IDocument.md) - [Interface: IEdge](/auto-docs/interface/interfaces/IEdge.md) - [Interface: IEngine](/auto-docs/interface/interfaces/IEngine.md) - [Interface: IExecutor](/auto-docs/interface/interfaces/IExecutor.md) - [Interface: IFlowConstantValue](/auto-docs/interface/interfaces/IFlowConstantValue.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: IFlowRefValue](/auto-docs/interface/interfaces/IFlowRefValue.md) - [Interface: IFlowTemplateValue](/auto-docs/interface/interfaces/IFlowTemplateValue.md) - [Interface: IIOCenter](/auto-docs/interface/interfaces/IIOCenter.md): Input & Output - [Interface: IJsonSchema](/auto-docs/interface/interfaces/IJsonSchema.md) - [Interface: IMessage](/auto-docs/interface/interfaces/IMessage.md) - [Interface: IMessageCenter](/auto-docs/interface/interfaces/IMessageCenter.md) - [Interface: INode](/auto-docs/interface/interfaces/INode.md) - [Interface: INodeExecutor](/auto-docs/interface/interfaces/INodeExecutor.md) - [Interface: INodeExecutorFactory](/auto-docs/interface/interfaces/INodeExecutorFactory.md) - [Interface: IOData](/auto-docs/interface/interfaces/IOData.md) - [Interface: IPort](/auto-docs/interface/interfaces/IPort.md) - [Interface: IReport](/auto-docs/interface/interfaces/IReport.md) - [Interface: IReporter](/auto-docs/interface/interfaces/IReporter.md) - [Interface: IRuntimeClient](/auto-docs/interface/interfaces/IRuntimeClient.md) - [Interface: ISnapshot](/auto-docs/interface/interfaces/ISnapshot.md) - [Interface: ISnapshotCenter](/auto-docs/interface/interfaces/ISnapshotCenter.md) - [Interface: IState](/auto-docs/interface/interfaces/IState.md) - [Interface: IStatus](/auto-docs/interface/interfaces/IStatus.md) - [Interface: IStatusCenter](/auto-docs/interface/interfaces/IStatusCenter.md) - [Interface: ITask](/auto-docs/interface/interfaces/ITask.md) - [Interface: IValidation](/auto-docs/interface/interfaces/IValidation.md) - [Interface: IVariable](/auto-docs/interface/interfaces/IVariable.md) - [Interface: IVariableParseResult](/auto-docs/interface/interfaces/IVariableParseResult.md) - [Interface: IVariableStore](/auto-docs/interface/interfaces/IVariableStore.md) - [Interface: InvokeParams](/auto-docs/interface/interfaces/InvokeParams.md) - [Interface: MessageData](/auto-docs/interface/interfaces/MessageData.md) - [Interface: NodeReport](/auto-docs/interface/interfaces/NodeReport.md) - [Interface: NodeVariable](/auto-docs/interface/interfaces/NodeVariable.md) - [Interface: ServerInfoInput](/auto-docs/interface/interfaces/ServerInfoInput.md) - [Interface: ServerInfoOutput](/auto-docs/interface/interfaces/ServerInfoOutput.md) - [Interface: Snapshot](/auto-docs/interface/interfaces/Snapshot.md) - [Interface: SnapshotData](/auto-docs/interface/interfaces/SnapshotData.md) - [Interface: StatusData](/auto-docs/interface/interfaces/StatusData.md) - [Interface: TaskCancelInput](/auto-docs/interface/interfaces/TaskCancelInput.md) - [Interface: TaskParams](/auto-docs/interface/interfaces/TaskParams.md) - [Interface: TaskReportInput](/auto-docs/interface/interfaces/TaskReportInput.md) - [Interface: TaskResultInput](/auto-docs/interface/interfaces/TaskResultInput.md) - [Interface: TaskRunInput](/auto-docs/interface/interfaces/TaskRunInput.md) - [Interface: TaskRunOutput](/auto-docs/interface/interfaces/TaskRunOutput.md) - [Interface: TaskValidateInput](/auto-docs/interface/interfaces/TaskValidateInput.md) - [Interface: TaskValidateOutput](/auto-docs/interface/interfaces/TaskValidateOutput.md) - [Interface: ValidationResult](/auto-docs/interface/interfaces/ValidationResult.md) - [Interface: WorkflowEdgeSchema](/auto-docs/interface/interfaces/WorkflowEdgeSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Interface: WorkflowNodeMetaSchema](/auto-docs/interface/interfaces/WorkflowNodeMetaSchema.md) - [Interface: WorkflowNodeSchema](/auto-docs/interface/interfaces/WorkflowNodeSchema.md) - [Interface: WorkflowSchema](/auto-docs/interface/interfaces/WorkflowSchema.md) - [Interface: XYSchema](/auto-docs/interface/interfaces/XYSchema.md): Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: BreakNodeSchema](/auto-docs/interface/types/BreakNodeSchema.md): BreakNodeSchema: WorkflowNodeSchema - [Type alias: CodeNodeSchema](/auto-docs/interface/types/CodeNodeSchema.md): CodeNodeSchema: WorkflowNodeSchema - [Type alias: ConditionNodeSchema](/auto-docs/interface/types/ConditionNodeSchema.md): ConditionNodeSchema: WorkflowNodeSchema - [Type alias: ContainerService](/auto-docs/interface/types/ContainerService.md): ContainerService: any Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: ContinueNodeSchema](/auto-docs/interface/types/ContinueNodeSchema.md): ContinueNodeSchema: WorkflowNodeSchema - [Type alias: EndNodeSchema](/auto-docs/interface/types/EndNodeSchema.md): EndNodeSchema: WorkflowNodeSchema - [Type alias: HTTPNodeSchema](/auto-docs/interface/types/HTTPNodeSchema.md): HTTPNodeSchema: WorkflowNodeSchema - [Type alias: IBasicJsonSchema](/auto-docs/interface/types/IBasicJsonSchema.md): IBasicJsonSchema: IJsonSchema - [Type alias: IFlowConstantRefValue](/auto-docs/interface/types/IFlowConstantRefValue.md): IFlowConstantRefValue: IFlowConstantValue | IFlowRefValue - [Type alias: IFlowValue](/auto-docs/interface/types/IFlowValue.md): IFlowValue: IFlowConstantValue | IFlowRefValue | IFlowExpressionValue | IFlowTemplateValue - [Type alias: JsonSchemaBasicType](/auto-docs/interface/types/JsonSchemaBasicType.md): JsonSchemaBasicType: "boolean" | "string" | "integer" | "number" | "object" | "array" | "map" Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: LLMNodeSchema](/auto-docs/interface/types/LLMNodeSchema.md): LLMNodeSchema: WorkflowNodeSchema - [Type alias: LoopNodeSchema](/auto-docs/interface/types/LoopNodeSchema.md): LoopNodeSchema: WorkflowNodeSchema - [Type alias: PositionSchema](/auto-docs/interface/types/PositionSchema.md): PositionSchema: XYSchema - [Type alias: StartNodeSchema](/auto-docs/interface/types/StartNodeSchema.md): StartNodeSchema: WorkflowNodeSchema - [Type alias: TaskCancelOutput](/auto-docs/interface/types/TaskCancelOutput.md): TaskCancelOutput: Object Type declaration - [Type alias: TaskReportOutput](/auto-docs/interface/types/TaskReportOutput.md): TaskReportOutput: IReport | undefined - [Type alias: TaskResultOutput](/auto-docs/interface/types/TaskResultOutput.md): TaskResultOutput: WorkflowOutputs | undefined - [Type alias: VOData](/auto-docs/interface/types/VOData.md): VOData: Omit Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT Type parameters - [Type alias: WorkflowInputs](/auto-docs/interface/types/WorkflowInputs.md): WorkflowInputs: Record Copyright (c) 2025 Bytedance Ltd. and/or its affiliates SPDX-License-Identifier: MIT - [Type alias: WorkflowMessages](/auto-docs/interface/types/WorkflowMessages.md): WorkflowMessages: Record - [Type alias: WorkflowOutputs](/auto-docs/interface/types/WorkflowOutputs.md): WorkflowOutputs: Record - [Type alias: WorkflowReports](/auto-docs/interface/types/WorkflowReports.md): WorkflowReports: Record - [Type alias: WorkflowRuntimeInvoke](/auto-docs/interface/types/WorkflowRuntimeInvoke.md): WorkflowRuntimeInvoke: (params: InvokeParams) => Promise Type declaration (params): Promise Parameters Returns Promise - [Variable: FlowGramAPINames](/auto-docs/interface/variables/FlowGramAPINames.md): Const FlowGramAPINames: FlowGramAPIName[] - [Variable: FlowGramAPIs](/auto-docs/interface/variables/FlowGramAPIs.md): Const FlowGramAPIs: FlowGramAPIDefines - [Variable: IEngine](/auto-docs/interface/variables/IEngine-1.md): IEngine: typeof IEngine - [Variable: IExecutor](/auto-docs/interface/variables/IExecutor-1.md): IExecutor: typeof IExecutor - [Variable: IValidation](/auto-docs/interface/variables/IValidation-1.md): IValidation: typeof IValidation - [Variable: ServerInfoDefine](/auto-docs/interface/variables/ServerInfoDefine.md): Const ServerInfoDefine: FlowGramAPIDefine - [Variable: TaskCancelDefine](/auto-docs/interface/variables/TaskCancelDefine.md): Const TaskCancelDefine: FlowGramAPIDefine - [Variable: TaskReportDefine](/auto-docs/interface/variables/TaskReportDefine.md): Const TaskReportDefine: FlowGramAPIDefine - [Variable: TaskResultDefine](/auto-docs/interface/variables/TaskResultDefine.md): Const TaskResultDefine: FlowGramAPIDefine - [Variable: TaskRunDefine](/auto-docs/interface/variables/TaskRunDefine.md): Const TaskRunDefine: FlowGramAPIDefine - [Variable: TaskValidateDefine](/auto-docs/interface/variables/TaskValidateDefine.md): Const TaskValidateDefine: FlowGramAPIDefine - [Function: TaskCancelAPI](/auto-docs/js-core/functions/TaskCancelAPI.md): TaskCancelAPI(input): Promise Parameters Returns Promise - [Function: TaskReportAPI](/auto-docs/js-core/functions/TaskReportAPI.md): TaskReportAPI(input): Promise Parameters Returns Promise - [Function: TaskResultAPI](/auto-docs/js-core/functions/TaskResultAPI.md): TaskResultAPI(input): Promise Parameters Returns Promise - [Function: TaskRunAPI](/auto-docs/js-core/functions/TaskRunAPI.md): TaskRunAPI(input): Promise Parameters Returns Promise - [Function: TaskValidateAPI](/auto-docs/js-core/functions/TaskValidateAPI.md): TaskValidateAPI(input): Promise Parameters Returns Promise - [Variable: WorkflowRuntimeAPIs](/auto-docs/js-core/variables/WorkflowRuntimeAPIs.md): Const WorkflowRuntimeAPIs: Record any> - [Class: BaseTypeManager](/auto-docs/json-schema/classes/BaseTypeManager.md) - [Class: JsonSchemaTypeManager](/auto-docs/json-schema/classes/JsonSchemaTypeManager.md) - [Function: astToSchema](/auto-docs/json-schema/functions/JsonSchemaUtils.astToSchema.md): JsonSchemaUtils.astToSchema astToSchema(typeAST?, options?): IJsonSchema | undefined Convert AST To JSON Schema Parameters Returns IJsonSchema | undefined - [Function: isASTMatchSchema](/auto-docs/json-schema/functions/JsonSchemaUtils.isASTMatchSchema.md): JsonSchemaUtils.isASTMatchSchema isASTMatchSchema(typeAST, schema): boolean Check if the AST type is match the JSON Schema Parameters Returns boolean - [Function: schemaToAST](/auto-docs/json-schema/functions/JsonSchemaUtils.schemaToAST.md): JsonSchemaUtils.schemaToAST schemaToAST(jsonSchema): ASTNodeJSON | undefined Converts a JSON schema to an Abstract Syntax Tree (AST) representation. This function recursively processes the JSON schema and creates corresponding AST nodes. For more information on JSON Schema, refer to the official documentation: https://json-schema.org/ Parameters Returns ASTNodeJSON | undefined An AST node representing the JSON schema, or undefined if the schema type is not recognized. - [Function: TypePresetProvider](/auto-docs/json-schema/functions/TypePresetProvider.md): TypePresetProvider(«destructured»): Element Type parameters Parameters Returns Element - [Function: useTypeManager](/auto-docs/json-schema/functions/useTypeManager.md): useTypeManager(): JsonSchemaTypeManager, JsonSchemaTypeRegistry>> | BaseTypeManager>>> Returns JsonSchemaTypeManager, JsonSchemaTypeRegistry>> | BaseTypeManager>>> - [Interface: BaseTypeRegistry](/auto-docs/json-schema/interfaces/BaseTypeRegistry.md): Base information for TypeRegistry - [Interface: IJsonSchema](/auto-docs/json-schema/interfaces/IJsonSchema.md) - [Interface: JsonSchemaTypeRegistry](/auto-docs/json-schema/interfaces/JsonSchemaTypeRegistry.md): TypeRegistry based on IJsonSchema - [Namespace: JsonSchemaUtils](/auto-docs/json-schema/modules/JsonSchemaUtils.md) - [Type alias: IBasicJsonSchema](/auto-docs/json-schema/types/IBasicJsonSchema.md): IBasicJsonSchema: IJsonSchema - [Type alias: JsonSchemaBasicType](/auto-docs/json-schema/types/JsonSchemaBasicType.md): JsonSchemaBasicType: "boolean" | "string" | "integer" | "number" | "object" | "array" | "map" - [Type alias: JsonSchemaTypeRegistryCreator](/auto-docs/json-schema/types/JsonSchemaTypeRegistryCreator.md): JsonSchemaTypeRegistryCreator: TypeRegistryCreator Type parameters - [Type alias: TypeRegistryCreator](/auto-docs/json-schema/types/TypeRegistryCreator.md): TypeRegistryCreator: (ctx: { typeManager: Manager }) => Partial Type parameters Type declaration (ctx): Partial TypeRegistryCreator Parameters Returns Partial - [Variable: jsonSchemaContainerModule](/auto-docs/json-schema/variables/jsonSchemaContainerModule.md): Const jsonSchemaContainerModule: ContainerModule - [Variable: jsonSchemaTypeManager](/auto-docs/json-schema/variables/jsonSchemaTypeManager-1.md): Const jsonSchemaTypeManager: JsonSchemaTypeManager, JsonSchemaTypeRegistry>> - [Class: ASTNode](/auto-docs/variable-core/classes/ASTNode.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: ASTRegisters](/auto-docs/variable-core/classes/ASTRegisters.md): Register the AST node to the engine. - [Class: ArrayType](/auto-docs/variable-core/classes/ArrayType.md): Represents an array type. - [Class: BaseExpression](/auto-docs/variable-core/classes/BaseExpression.md): Base class for all expressions. All other expressions should extend this class. - [Class: BaseType](/auto-docs/variable-core/classes/BaseType.md): Base class for all types. All other types should extend this class. - [Class: BaseVariableField](/auto-docs/variable-core/classes/BaseVariableField.md): Variable Field abstract class, which is the base class for VariableDeclaration and Property VariableDeclaration is used to declare a variable in a block scope.Property is used to declare a property in an object. - [Class: BooleanType](/auto-docs/variable-core/classes/BooleanType.md): Represents a boolean type. - [Class: CustomType](/auto-docs/variable-core/classes/CustomType.md): Represents a custom type. - [Class: DataNode](/auto-docs/variable-core/classes/DataNode.md): Represents a general data node with no child nodes. - [Class: EnumerateExpression](/auto-docs/variable-core/classes/EnumerateExpression.md): Represents an enumeration expression, which iterates over a list and returns the type of the enumerated variable. - [Class: IntegerType](/auto-docs/variable-core/classes/IntegerType.md): Represents an integer type. - [Class: KeyPathExpression](/auto-docs/variable-core/classes/KeyPathExpression.md): Represents a key path expression, which is used to reference a variable by its key path. This is the V2 of KeyPathExpression, with the following improvements: returnType is copied to a new instance to avoid reference issues.Circular reference detection is introduced. - [Class: LegacyKeyPathExpression](/auto-docs/variable-core/classes/LegacyKeyPathExpression.md): Deprecated Use KeyPathExpression instead. Represents a key path expression, which is used to reference a variable by its key path. - [Class: ListNode](/auto-docs/variable-core/classes/ListNode.md): Represents a list of nodes. - [Class: MapNode](/auto-docs/variable-core/classes/MapNode.md): Represents a map of nodes. - [Class: MapType](/auto-docs/variable-core/classes/MapType.md): Represents a map type. - [Class: NumberType](/auto-docs/variable-core/classes/NumberType.md): Represents a number type. - [Class: ObjectType](/auto-docs/variable-core/classes/ObjectType.md): Represents an object type. - [Class: Property](/auto-docs/variable-core/classes/Property.md): Property is a variable field that represents a property of a ObjectType. - [Class: Scope](/auto-docs/variable-core/classes/Scope.md): Represents a variable scope, which manages its own set of variables and their lifecycle. scope.output represents the variables declared within this scope.scope.available represents all variables accessible from this scope, including those from parent scopes. - [Class: ScopeChain](/auto-docs/variable-core/classes/ScopeChain.md): Manages the dependency relationships between scopes. This is an abstract class, and specific implementations determine how the scope order is managed. - [Class: ScopeOutputData](/auto-docs/variable-core/classes/ScopeOutputData.md): Manages the output variables of a scope. - [Class: StringType](/auto-docs/variable-core/classes/StringType.md): Base class for all types. All other types should extend this class. - [Class: VariableDeclaration](/auto-docs/variable-core/classes/VariableDeclaration.md): VariableDeclaration is a variable field that represents a variable declaration. - [Class: VariableDeclarationList](/auto-docs/variable-core/classes/VariableDeclarationList.md): An ASTNode represents a fundamental unit of variable information within the system's Abstract Syntax Tree. It can model various constructs, for example: Declarations: const a = 1Expressions: a.b.cTypes: number, string, boolean Here is some characteristic of ASTNode: Tree-like Structure: ASTNodes can be nested to form a tree, representing complex variable structures.Extendable: New features can be added by extending the base ASTNode class.Reactive: Changes in an ASTNode's value trigger events, enabling reactive programming patterns.Serializable: ASTNodes can be converted to and from a JSON format (ASTNodeJSON) for storage or transmission. - [Class: VariableEngine](/auto-docs/variable-core/classes/VariableEngine.md): The core of the variable engine system. It manages scopes, variables, and events within the system. - [Class: VariableFieldKeyRenameService](/auto-docs/variable-core/classes/VariableFieldKeyRenameService.md): This service is responsible for detecting when a variable field's key is renamed. It listens for changes in variable declaration lists and object properties, and determines if a change constitutes a rename operation. - [Class: WrapArrayExpression](/auto-docs/variable-core/classes/WrapArrayExpression.md): Represents a wrap expression, which wraps an expression with an array. - [Enumeration: ASTKind](/auto-docs/variable-core/enums/ASTKind.md): Core AST node types. - [Enumeration: ASTNodeFlags](/auto-docs/variable-core/enums/ASTNodeFlags.md): ASTNode flags. Stored in the flags property of the ASTNode. - [Function: create](/auto-docs/variable-core/functions/ASTFactory.create.md): ASTFactory.create create(targetType, json): { kind: string = targetType.kind } & JSON Creates Type-Safe ASTNodeJSON object based on the provided AST class. Type parameters Parameters Returns { kind: string = targetType.kind } & JSON The ASTNode JSON object. - [Function: createArray](/auto-docs/variable-core/functions/ASTFactory.createArray.md): ASTFactory.createArray createArray(json): Object Creates an Array type node. Parameters Returns Object - [Function: createBoolean](/auto-docs/variable-core/functions/ASTFactory.createBoolean.md): ASTFactory.createBoolean createBoolean(): Object Creates a Boolean type node. Returns Object - [Function: createCustomType](/auto-docs/variable-core/functions/ASTFactory.createCustomType.md): ASTFactory.createCustomType createCustomType(json): Object Creates a CustomType node. Parameters Returns Object - [Function: createEnumerateExpression](/auto-docs/variable-core/functions/ASTFactory.createEnumerateExpression.md): ASTFactory.createEnumerateExpression createEnumerateExpression(json): Object Creates an EnumerateExpression node. Parameters Returns Object - [Function: createInteger](/auto-docs/variable-core/functions/ASTFactory.createInteger.md): ASTFactory.createInteger createInteger(): Object Creates an Integer type node. Returns Object - [Function: createKeyPathExpression](/auto-docs/variable-core/functions/ASTFactory.createKeyPathExpression.md): ASTFactory.createKeyPathExpression createKeyPathExpression(json): Object Creates a KeyPathExpression node. Parameters Returns Object - [Function: createMap](/auto-docs/variable-core/functions/ASTFactory.createMap.md): ASTFactory.createMap createMap(json): Object Creates a Map type node. Parameters Returns Object - [Function: createNumber](/auto-docs/variable-core/functions/ASTFactory.createNumber.md): ASTFactory.createNumber createNumber(): Object Creates a Number type node. Returns Object - [Function: createObject](/auto-docs/variable-core/functions/ASTFactory.createObject.md): ASTFactory.createObject createObject(json): Object Creates an Object type node. Parameters Returns Object - [Function: createProperty](/auto-docs/variable-core/functions/ASTFactory.createProperty.md): ASTFactory.createProperty createProperty(json): Object Creates a Property node. Type parameters Parameters Returns Object - [Function: createString](/auto-docs/variable-core/functions/ASTFactory.createString.md): ASTFactory.createString createString(json?): Object Creates a String type node. Parameters Returns Object - [Function: createUnion](/auto-docs/variable-core/functions/ASTFactory.createUnion.md): ASTFactory.createUnion createUnion(json): Object Creates a Union type node. Parameters Returns Object - [Function: createVariableDeclaration](/auto-docs/variable-core/functions/ASTFactory.createVariableDeclaration.md): ASTFactory.createVariableDeclaration createVariableDeclaration(json): Object Creates a VariableDeclaration node. Type parameters Parameters Returns Object - [Function: createVariableDeclarationList](/auto-docs/variable-core/functions/ASTFactory.createVariableDeclarationList.md): ASTFactory.createVariableDeclarationList createVariableDeclarationList(json): Object Creates a VariableDeclarationList node. Parameters Returns Object - [Function: createWrapArrayExpression](/auto-docs/variable-core/functions/ASTFactory.createWrapArrayExpression.md): ASTFactory.createWrapArrayExpression createWrapArrayExpression(json): Object Creates a WrapArrayExpression node. Parameters Returns Object - [Function: is](/auto-docs/variable-core/functions/ASTMatch.is.md): ASTMatch.is is(node?, targetType?): node is TargetASTNode Check ASTNode Match by ASTClass Type parameters Parameters Returns node is TargetASTNode Whether the node is of the target type. - [Function: isArray](/auto-docs/variable-core/functions/ASTMatch.isArray.md): ASTMatch.isArray isArray(node?): node is ArrayType Check if the node is a ArrayType. Parameters Returns node is ArrayType - [Function: isBaseVariableField](/auto-docs/variable-core/functions/ASTMatch.isBaseVariableField.md): ASTMatch.isBaseVariableField isBaseVariableField(node?): node is BaseVariableField Check if the node is a BaseVariableField. Parameters Returns node is BaseVariableField - [Function: isBoolean](/auto-docs/variable-core/functions/ASTMatch.isBoolean.md): ASTMatch.isBoolean isBoolean(node?): node is BooleanType Check if the node is a BooleanType. Parameters Returns node is BooleanType - [Function: isCustomType](/auto-docs/variable-core/functions/ASTMatch.isCustomType.md): ASTMatch.isCustomType isCustomType(node?): node is CustomType Check if the node is a CustomType. Parameters Returns node is CustomType - [Function: isEnumerateExpression](/auto-docs/variable-core/functions/ASTMatch.isEnumerateExpression.md): ASTMatch.isEnumerateExpression isEnumerateExpression(node?): node is EnumerateExpression Check if the node is a EnumerateExpression. Parameters Returns node is EnumerateExpression - [Function: isInteger](/auto-docs/variable-core/functions/ASTMatch.isInteger.md): ASTMatch.isInteger isInteger(node?): node is IntegerType Check if the node is a IntegerType. Parameters Returns node is IntegerType - [Function: isKeyPathExpression](/auto-docs/variable-core/functions/ASTMatch.isKeyPathExpression.md): ASTMatch.isKeyPathExpression isKeyPathExpression(node?): node is KeyPathExpression Check if the node is a KeyPathExpression. Parameters Returns node is KeyPathExpression - [Function: isMap](/auto-docs/variable-core/functions/ASTMatch.isMap.md): ASTMatch.isMap isMap(node?): node is MapType Check if the node is a MapType. Parameters Returns node is MapType - [Function: isNumber](/auto-docs/variable-core/functions/ASTMatch.isNumber.md): ASTMatch.isNumber isNumber(node?): node is NumberType Check if the node is a NumberType. Parameters Returns node is NumberType - [Function: isObject](/auto-docs/variable-core/functions/ASTMatch.isObject.md): ASTMatch.isObject isObject(node?): node is ObjectType Check if the node is a ObjectType. Parameters Returns node is ObjectType - [Function: isProperty](/auto-docs/variable-core/functions/ASTMatch.isProperty.md): ASTMatch.isProperty isProperty(node?): node is Property Check if the node is a Property. Type parameters Parameters Returns node is Property - [Function: isString](/auto-docs/variable-core/functions/ASTMatch.isString.md): ASTMatch.isString isString(node?): node is StringType Check if the node is a StringType. Parameters Returns node is StringType - [Function: isVariableDeclaration](/auto-docs/variable-core/functions/ASTMatch.isVariableDeclaration.md): ASTMatch.isVariableDeclaration isVariableDeclaration(node?): node is VariableDeclaration Check if the node is a VariableDeclaration. Type parameters Parameters Returns node is VariableDeclaration - [Function: isVariableDeclarationList](/auto-docs/variable-core/functions/ASTMatch.isVariableDeclarationList.md): ASTMatch.isVariableDeclarationList isVariableDeclarationList(node?): node is VariableDeclarationList Check if the node is a VariableDeclarationList. Parameters Returns node is VariableDeclarationList - [Function: isWrapArrayExpression](/auto-docs/variable-core/functions/ASTMatch.isWrapArrayExpression.md): ASTMatch.isWrapArrayExpression isWrapArrayExpression(node?): node is WrapArrayExpression Check if the node is a WrapArrayExpression. Parameters Returns node is WrapArrayExpression - [Function: ScopeProvider](/auto-docs/variable-core/functions/ScopeProvider.md): ScopeProvider(props): Element ScopeProvider provides the scope to its children via context. Parameters Returns Element - [Function: injectToAST](/auto-docs/variable-core/functions/injectToAST.md): injectToAST(serviceIdentifier): (target: any, propertyKey: string) => any Parameters Returns fn (target, propertyKey): any Parameters Returns any - [Function: isMatchAST](/auto-docs/variable-core/functions/isMatchAST.md): isMatchAST(node?, targetType?): node is TargetASTNode isMatchAST is same as ASTMatch.is Type parameters Parameters Returns node is TargetASTNode - [Function: postConstructAST](/auto-docs/variable-core/functions/postConstructAST.md): postConstructAST(): (target: any, propertyKey: string) => void Returns fn (target, propertyKey): void Parameters Returns void - [Function: useAvailableVariables](/auto-docs/variable-core/functions/useAvailableVariables.md): useAvailableVariables(): VariableDeclaration[] Get available variable list in the current scope. If no scope, return global variable list.The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useCurrentScope](/auto-docs/variable-core/functions/useCurrentScope.md): useCurrentScope(params?): Strict extends true ? Scope> : undefined | Scope> useCurrentScope returns the scope provided by ScopeProvider. Type parameters Parameters Returns Strict extends true ? Scope> : undefined | Scope> - [Function: useOutputVariables](/auto-docs/variable-core/functions/useOutputVariables.md): useOutputVariables(): VariableDeclaration[] Get output variable list in the current scope. The hook is reactive to variable list or any variables change. Returns VariableDeclaration[] - [Function: useScopeAvailable](/auto-docs/variable-core/functions/useScopeAvailable.md): useScopeAvailable(params?): ScopeAvailableData Get the available variables in the current scope. 获取作用域的可访问变量 Parameters Returns ScopeAvailableData the available variables in the current scope - [Interface: ASTNodeJSON](/auto-docs/variable-core/interfaces/ASTNodeJSON.md): ASTNodeJSON is the JSON representation of an ASTNode. - [Interface: ASTNodeRegistry](/auto-docs/variable-core/interfaces/ASTNodeRegistry.md) - [Interface: CreateASTParams](/auto-docs/variable-core/interfaces/CreateASTParams.md) - [Interface: CustomTypeJSON](/auto-docs/variable-core/interfaces/CustomTypeJSON.md): ASTNodeJSON representation of CustomType - [Interface: EnumerateExpressionJSON](/auto-docs/variable-core/interfaces/EnumerateExpressionJSON.md): ASTNodeJSON representation of EnumerateExpression - [Interface: GlobalEventActionType](/auto-docs/variable-core/interfaces/GlobalEventActionType.md): Global event action type. Global event might be dispatched from ASTNode or Scope. - [Interface: IVariableTable](/auto-docs/variable-core/interfaces/IVariableTable.md): Interface for a variable table. - [Interface: KeyPathExpressionJSON](/auto-docs/variable-core/interfaces/KeyPathExpressionJSON.md): ASTNodeJSON representation of KeyPathExpression - [Interface: ListNodeJSON](/auto-docs/variable-core/interfaces/ListNodeJSON.md): ASTNodeJSON representation of ListNode - [Interface: MapNodeJSON](/auto-docs/variable-core/interfaces/MapNodeJSON.md): ASTNodeJSON representation of MapNode - [Interface: ObjectJSON](/auto-docs/variable-core/interfaces/ObjectJSON.md): ASTNodeJSON representation of ObjectType - [Interface: Observer](/auto-docs/variable-core/interfaces/Observer.md): An object interface that defines a set of callback functions a user can use to get notified of any set of Observable guide/glossary-and-semantics#notification notification events. For more info, please refer to guide/observer this guide. - [Interface: UnionJSON](/auto-docs/variable-core/interfaces/UnionJSON.md): ASTNodeJSON representation of UnionType, which union multiple BaseType. - [Interface: VariableDeclarationListJSON](/auto-docs/variable-core/interfaces/VariableDeclarationListJSON.md) - [Interface: WrapArrayExpressionJSON](/auto-docs/variable-core/interfaces/WrapArrayExpressionJSON.md): ASTNodeJSON representation of WrapArrayExpression - [Namespace: ASTFactory](/auto-docs/variable-core/modules/ASTFactory.md): Variable-core ASTNode factories. - [Namespace: ASTMatch](/auto-docs/variable-core/modules/ASTMatch.md): Variable-core ASTNode matchers. Typescript code inside if statement will be type guarded. - [Type alias: GetKindJSON](/auto-docs/variable-core/types/GetKindJSON.md): GetKindJSON: { key?: Identifier ; kind: KindType } & JSON TypeUtils to get the JSON representation of an AST node with a specific kind. Type parameters - [Type alias: GetKindJSONOrKind](/auto-docs/variable-core/types/GetKindJSONOrKind.md): GetKindJSONOrKind: { key?: Identifier ; kind: KindType } & JSON | KindType TypeUtils to get the JSON representation of an AST node with a specific kind or just the kind string. Type parameters - [Type alias: ObjectPropertiesChangeAction](/auto-docs/variable-core/types/ObjectPropertiesChangeAction.md): ObjectPropertiesChangeAction: GlobalEventActionType<"ObjectPropertiesChange", { next: Property[] ; prev: Property[] }, ObjectType> Action type for object properties change. - [Type alias: PropertyJSON](/auto-docs/variable-core/types/PropertyJSON.md): PropertyJSON: BaseVariableFieldJSON ASTNodeJSON representation of the Property. Type parameters - [Type alias: VariableDeclarationJSON](/auto-docs/variable-core/types/VariableDeclarationJSON.md): VariableDeclarationJSON: BaseVariableFieldJSON & { order?: number } ASTNodeJSON representation of the VariableDeclaration. Type parameters - [Type alias: VariableDeclarationListChangeAction](/auto-docs/variable-core/types/VariableDeclarationListChangeAction.md): VariableDeclarationListChangeAction: GlobalEventActionType<"VariableListChange", { next: VariableDeclaration[] ; prev: VariableDeclaration[] }, VariableDeclarationList> - [Type alias: VariableEngineProvider](/auto-docs/variable-core/types/VariableEngineProvider.md): VariableEngineProvider: () => VariableEngine Type declaration (): VariableEngine Returns VariableEngine - [Variable: VariableContainerModule](/auto-docs/variable-core/variables/VariableContainerModule.md): Const VariableContainerModule: ContainerModule An InversifyJS container module that binds all the necessary services for the variable engine. This module sets up the dependency injection for the core components of the variable engine. - [Variable: VariableEngineProvider](/auto-docs/variable-core/variables/VariableEngineProvider-1.md): Const VariableEngineProvider: typeof VariableEngineProvider A provider for dynamically obtaining the VariableEngine instance. This is used to prevent circular dependencies when injecting VariableEngine. - [Class: FixedLayoutScopeChain](/auto-docs/variable-layout/classes/FixedLayoutScopeChain.md): Scope chain implementation based on FlowVirtualTree. - [Class: FlowNodeVariableData](/auto-docs/variable-layout/classes/FlowNodeVariableData.md): Manages variable data for a flow node, including public and private scopes. - [Class: FreeLayoutScopeChain](/auto-docs/variable-layout/classes/FreeLayoutScopeChain.md): Scope chain implementation for free layout. - [Class: GlobalScope](/auto-docs/variable-layout/classes/GlobalScope.md): Global Scope stores all variables that are not scoped to any node. Variables in Global Scope can be accessed by any node.Any other scope's variables can not be accessed by Global Scope. - [Class: ScopeChainTransformService](/auto-docs/variable-layout/classes/ScopeChainTransformService.md): A service for transforming scope chains. - [Enumeration: FlowNodeScopeType](/auto-docs/variable-layout/enums/FlowNodeScopeType.md): Enum for flow node scope types. - [Function: bindGlobalScope](/auto-docs/variable-layout/functions/bindGlobalScope.md): bindGlobalScope(bind): void Parameters Returns void - [Function: getNodePrivateScope](/auto-docs/variable-layout/functions/getNodePrivateScope.md): getNodePrivateScope(node): FlowNodeScope Use node.privateScope instead. Parameters Returns FlowNodeScope The private scope of the node. Deprecated - [Function: getNodeScope](/auto-docs/variable-layout/functions/getNodeScope.md): getNodeScope(node): FlowNodeScope Use node.scope instead. Parameters Returns FlowNodeScope The public scope of the node. Deprecated - [Interface: FlowNodeScope](/auto-docs/variable-layout/interfaces/FlowNodeScope.md): Represents a scope associated with a flow node. - [Interface: FlowNodeScopeMeta](/auto-docs/variable-layout/interfaces/FlowNodeScopeMeta.md): Metadata for a flow node scope. - [Interface: VariableChainConfig](/auto-docs/variable-layout/interfaces/VariableChainConfig.md): Configuration for the variable chain. - [Variable: VariableChainConfig](/auto-docs/variable-layout/variables/VariableChainConfig-1.md): VariableChainConfig: typeof VariableChainConfig