mirror of
https://github.com/Tencent/tmagic-editor.git
synced 2026-07-28 00:47:44 +00:00
52 lines
58 KiB
HTML
52 lines
58 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>DataSourceManager | tmagic-editor</title>
|
||
<meta name="description" content="页面可视化平台">
|
||
<meta name="generator" content="VitePress v2.0.0-alpha.18">
|
||
<link rel="preload stylesheet" href="/tmagic-editor/docs/assets/style.Ch7UhAWw.css" as="style">
|
||
<link rel="preload stylesheet" href="/tmagic-editor/docs/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/tmagic-editor/docs/assets/app.C4PDWoQ9.js"></script>
|
||
<link rel="preload" href="/tmagic-editor/docs/assets/inter-roman-latin.Cy4MYw_J.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/tmagic-editor/docs/assets/chunks/theme.DjefmpVa.js">
|
||
<link rel="modulepreload" href="/tmagic-editor/docs/assets/chunks/framework.ECw2lWOt.js">
|
||
<link rel="modulepreload" href="/tmagic-editor/docs/assets/runtime-api_data-source_dataSourceManager.md.B0C4k-Pw.lean.js">
|
||
<meta name="theme-color" content="#646cff">
|
||
<script id="check-dark-mode">(()=>{let e=localStorage.getItem(`vitepress-theme-appearance`)||`auto`,t=window.matchMedia(`(prefers-color-scheme: dark)`).matches;(!e||e===`auto`?t:e===`dark`)&&document.documentElement.classList.add(`dark`)})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle(`mac`,/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-2932c6cf><!--[--><!--]--><!--[--><span tabindex="-1" data-v-f9a479f9></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-f9a479f9>Skip to content</a><!--]--><!----><header class="VPNav" data-v-2932c6cf data-v-5ec118a8><div class="VPNavBar has-sidebar top" data-v-5ec118a8 data-v-cd6df6d0><div class="wrapper" data-v-cd6df6d0><div class="container" data-v-cd6df6d0><div class="title" data-v-cd6df6d0><div class="VPNavBarTitle has-sidebar" data-v-cd6df6d0 data-v-22741a41><a class="title" href="/tmagic-editor/docs/" data-v-22741a41><!--[--><!--]--><!--[--><img class="VPImage logo" src="./favicon.png" alt data-v-4582fcab><!--]--><span data-v-22741a41>tmagic-editor</span><!--[--><!--]--></a></div></div><div class="content" data-v-cd6df6d0><div class="content-body" data-v-cd6df6d0><!--[--><!--]--><div class="VPNavBarSearch search" data-v-cd6df6d0 data-v-8cc82bae><!--[--><button type="button" class="VPNavBarSearchButton" aria-label="Search" aria-keyshortcuts="/ control+k meta+k" data-v-8cc82bae data-v-e341e05d><span class="vpi-search" aria-hidden="true" data-v-e341e05d></span><span class="text" data-v-e341e05d>Search</span><span class="keys" aria-hidden="true" data-v-e341e05d><kbd class="key-cmd" data-v-e341e05d>⌘</kbd><kbd class="key-ctrl" data-v-e341e05d>Ctrl</kbd><kbd data-v-e341e05d>K</kbd></span></button><!----><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-cd6df6d0 data-v-2cceaaa0><span id="main-nav-aria-label" class="visually-hidden" data-v-2cceaaa0> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tmagic-editor/docs/guide/" tabindex="0" data-v-2cceaaa0 data-v-1f52e8ac><!--[--><span data-v-1f52e8ac>文档</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tmagic-editor/docs/api/editor/props.html" tabindex="0" data-v-2cceaaa0 data-v-1f52e8ac><!--[--><span data-v-1f52e8ac>Editor API</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/tmagic-editor/docs/runtime-api/core/app.html" tabindex="0" data-v-2cceaaa0 data-v-1f52e8ac><!--[--><span data-v-1f52e8ac>Runtime API</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/tmagic-editor/docs/form-config/fields/text.html" tabindex="0" data-v-2cceaaa0 data-v-1f52e8ac><!--[--><span data-v-1f52e8ac>表单配置</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="https://github.com/Tencent/tmagic-editor/releases" tabindex="0" data-v-2cceaaa0 data-v-1f52e8ac><!--[--><span data-v-1f52e8ac>更新日志</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="https://tencent.github.io/tmagic-editor/playground/index.html" tabindex="0" data-v-2cceaaa0 data-v-1f52e8ac><!--[--><span data-v-1f52e8ac>Playground</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-cd6df6d0 data-v-11250d7e><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-11250d7e data-v-a274f63d data-v-091ddd52><span class="check" data-v-091ddd52><span class="icon" data-v-091ddd52><!--[--><span class="vpi-sun sun" data-v-a274f63d></span><span class="vpi-moon moon" data-v-a274f63d></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-cd6df6d0 data-v-67340789 data-v-882b9947><!--[--><a class="VPSocialLink no-icon" href="https://github.com/Tencent/tmagic-editor" aria-label="github" target="_blank" rel="me noopener" data-v-882b9947 data-v-3899771d><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-cd6df6d0 data-v-ec4151bd data-v-8c70178b><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-8c70178b><span class="vpi-more-horizontal icon" data-v-8c70178b></span></button><div class="menu" data-v-8c70178b><div class="VPMenu" data-v-8c70178b data-v-d3c72699><!----><!--[--><!--[--><!----><div class="group" data-v-ec4151bd><div class="item appearance" data-v-ec4151bd><p class="label" data-v-ec4151bd>Appearance</p><div class="appearance-action" data-v-ec4151bd><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-ec4151bd data-v-a274f63d data-v-091ddd52><span class="check" data-v-091ddd52><span class="icon" data-v-091ddd52><!--[--><span class="vpi-sun sun" data-v-a274f63d></span><span class="vpi-moon moon" data-v-a274f63d></span><!--]--></span></span></button></div></div></div><div class="group" data-v-ec4151bd><div class="item social-links" data-v-ec4151bd><div class="VPSocialLinks social-links-list" data-v-ec4151bd data-v-882b9947><!--[--><a class="VPSocialLink no-icon" href="https://github.com/Tencent/tmagic-editor" aria-label="github" target="_blank" rel="me noopener" data-v-882b9947 data-v-3899771d><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-cd6df6d0 data-v-baa7e450><span class="container" data-v-baa7e450><span class="top" data-v-baa7e450></span><span class="middle" data-v-baa7e450></span><span class="bottom" data-v-baa7e450></span></span></button></div></div></div></div><div class="divider" data-v-cd6df6d0><div class="divider-line" data-v-cd6df6d0></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-2932c6cf data-v-1c5126ae><div class="container" data-v-1c5126ae><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-1c5126ae><span class="vpi-align-left menu-icon" data-v-1c5126ae></span><span class="menu-text" data-v-1c5126ae>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-1c5126ae data-v-dd68c105><button data-v-dd68c105>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-2932c6cf data-v-42fb1f13><div class="curtain" data-v-42fb1f13></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-42fb1f13><span class="visually-hidden" id="sidebar-aria-label" data-v-42fb1f13> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-debffcca><section class="VPSidebarItem level-0" data-v-debffcca data-v-0f69b1fe><div class="item" role="button" tabindex="0" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><h2 class="text" data-v-0f69b1fe>@tmagic/core</h2><!----></div><div class="items" data-v-0f69b1fe><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/app.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>App</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/node.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>Node</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/page.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>Page</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/eventHelper.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>EventHelper</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/env.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>Env</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/iteratorContainer.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>IteratorContainer</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/flowState.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>FlowState</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/devtoolApi.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>DevtoolApi</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/core/utils.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>工具函数</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-debffcca><section class="VPSidebarItem level-0 has-active" data-v-debffcca data-v-0f69b1fe><div class="item" role="button" tabindex="0" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><h2 class="text" data-v-0f69b1fe>@tmagic/data-source</h2><!----></div><div class="items" data-v-0f69b1fe><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/data-source/dataSourceManager.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>DataSourceManager</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/data-source/dataSource.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>DataSource</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/data-source/httpDataSource.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>HttpDataSource</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/data-source/observedData.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>观察者数据类</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0f69b1fe><div class="item" data-v-0f69b1fe><div class="indicator" data-v-0f69b1fe></div><a class="VPLink link link" href="/tmagic-editor/docs/runtime-api/data-source/utils.html" data-v-0f69b1fe><!--[--><p class="text" data-v-0f69b1fe>工具函数</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-2932c6cf data-v-58117d44><div class="VPDoc has-sidebar has-aside" data-v-58117d44 data-v-6fc6448d><!--[--><!--]--><div class="container" data-v-6fc6448d><div class="aside" data-v-6fc6448d><div class="aside-curtain" data-v-6fc6448d></div><div class="aside-container" data-v-6fc6448d><div class="aside-content" data-v-6fc6448d><div class="VPDocAside" data-v-6fc6448d data-v-9ea761ae><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-9ea761ae data-v-d5e90846><div class="content" data-v-d5e90846><div class="outline-marker" data-v-d5e90846></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-d5e90846>On this page</div><ul class="VPDocOutlineItem root" data-v-d5e90846 data-v-c55a35f3><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-9ea761ae></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-6fc6448d><div class="content-container" data-v-6fc6448d><!--[--><!--]--><main class="main" data-v-6fc6448d><div style="position:relative;" class="vp-doc _tmagic-editor_docs_runtime-api_data-source_dataSourceManager" data-v-6fc6448d><div><h1 id="datasourcemanager" tabindex="-1">DataSourceManager <a class="header-anchor" href="#datasourcemanager" aria-label="Permalink to “DataSourceManager”"></a></h1><p><code>DataSourceManager</code> 是 <code>@tmagic/data-source</code> 的核心类，用于管理所有数据源的生命周期、数据编译和事件分发。</p><h2 id="构造函数" tabindex="-1">构造函数 <a class="header-anchor" href="#构造函数" aria-label="Permalink to “构造函数”"></a></h2><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> DataSourceManager</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(options: DataSourceManagerOptions)</span></span></code></pre></div><h3 id="datasourcemanageroptions" tabindex="-1">DataSourceManagerOptions <a class="header-anchor" href="#datasourcemanageroptions" aria-label="Permalink to “DataSourceManagerOptions”"></a></h3><table tabindex="0"><thead><tr><th>参数</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>app</code></td><td><code>TMagicApp</code></td><td>应用实例</td></tr><tr><td><code>initialData</code></td><td><code>DataSourceManagerData</code></td><td>初始数据（可选，用于 SSR）</td></tr><tr><td><code>useMock</code></td><td><code>boolean</code></td><td>是否使用 Mock 数据（可选）</td></tr></tbody></table><h2 id="属性" tabindex="-1">属性 <a class="header-anchor" href="#属性" aria-label="Permalink to “属性”"></a></h2><table tabindex="0"><thead><tr><th>属性</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>app</code></td><td><code>TMagicApp</code></td><td>应用实例</td></tr><tr><td><code>dataSourceMap</code></td><td><code>Map<string, DataSource></code></td><td>数据源映射表</td></tr><tr><td><code>data</code></td><td><code>DataSourceManagerData</code></td><td>所有数据源的数据</td></tr><tr><td><code>initialData</code></td><td><code>DataSourceManagerData</code></td><td>初始化数据</td></tr><tr><td><code>useMock</code></td><td><code>boolean</code></td><td>是否使用 Mock 数据</td></tr></tbody></table><h2 id="静态方法" tabindex="-1">静态方法 <a class="header-anchor" href="#静态方法" aria-label="Permalink to “静态方法”"></a></h2><h3 id="register" tabindex="-1">register <a class="header-anchor" href="#register" aria-label="Permalink to “register”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{string} type</code> 数据源类型</li><li><code>{typeof DataSource} dataSourceClass</code> 数据源类</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>注册自定义数据源类型。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">import</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> { DataSourceManager } </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">from</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '@tmagic/data-source'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">;</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">class</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> CustomDataSource</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> extends</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> DataSource</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
||
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;"> // 自定义实现</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">DataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">register</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'custom'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, CustomDataSource);</span></span></code></pre></div><h3 id="getdatasourceclass" tabindex="-1">getDataSourceClass <a class="header-anchor" href="#getdatasourceclass" aria-label="Permalink to “getDataSourceClass”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{string} type</code> 数据源类型</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{typeof DataSource | undefined}</code></li></ul></li><li><p><strong>详情：</strong></p><p>获取已注册的数据源类。</p></li></ul><h3 id="cleardatasourceclass" tabindex="-1">clearDataSourceClass <a class="header-anchor" href="#cleardatasourceclass" aria-label="Permalink to “clearDataSourceClass”"></a></h3><ul><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>清除所有已注册的数据源类（保留 <code>base</code> 和 <code>http</code>）。</p></li></ul><h3 id="registerobserveddata" tabindex="-1">registerObservedData <a class="header-anchor" href="#registerobserveddata" aria-label="Permalink to “registerObservedData”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{ObservedDataClass} observedDataClass</code> 观察者数据类</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>注册自定义的观察者数据类。</p></li></ul><h2 id="实例方法" tabindex="-1">实例方法 <a class="header-anchor" href="#实例方法" aria-label="Permalink to “实例方法”"></a></h2><h3 id="init" tabindex="-1">init <a class="header-anchor" href="#init" aria-label="Permalink to “init”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{DataSource} ds</code> 单个数据源实例（必填）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{Promise<void>}</code></li></ul></li><li><p><strong>详情：</strong></p><p>初始化单个数据源。会按 <code>methods</code> 中 <code>timing === 'beforeInit'</code> 的方法依次执行，再调用 <code>ds.init()</code>，最后执行 <code>timing === 'afterInit'</code> 的方法。当 <code>ds.isInit</code> 为 <code>true</code>，或当前 <code>app.jsEngine</code> 命中 <code>ds.schema.disabledInitInJsEngine</code> 时直接跳过。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> ds</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">get</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'ds_1'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span>
|
||
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (ds) {</span></span>
|
||
<span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">init</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(ds);</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">}</span></span></code></pre></div><h3 id="get" tabindex="-1">get <a class="header-anchor" href="#get" aria-label="Permalink to “get”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{string} id</code> 数据源 ID</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{DataSource | undefined}</code></li></ul></li><li><p><strong>详情：</strong></p><p>获取指定 ID 的数据源实例。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> ds</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">get</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'ds_1'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h3 id="adddatasource" tabindex="-1">addDataSource <a class="header-anchor" href="#adddatasource" aria-label="Permalink to “addDataSource”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{DataSourceSchema} config</code> 数据源配置（可选）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{DataSource | undefined}</code></li></ul></li><li><p><strong>详情：</strong></p><p>添加新的数据源。当对应类型尚未注册（即 <code>dataSourceClassMap</code> 中无该类型）时，会将配置缓存到 <code>waitInitSchemaList</code>，并返回 <code>undefined</code>，待 <code>register</code> 时再补建实例。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> ds</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">addDataSource</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> id: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'new_ds'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> type: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'base'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> fields: []</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h3 id="removedatasource" tabindex="-1">removeDataSource <a class="header-anchor" href="#removedatasource" aria-label="Permalink to “removeDataSource”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{string} id</code> 数据源 ID</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>移除指定的数据源。</p></li></ul><h3 id="setdata" tabindex="-1">setData <a class="header-anchor" href="#setdata" aria-label="Permalink to “setData”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{DataSource} ds</code> 数据源实例</li><li><code>{ChangeEvent} changeEvent</code> 变化事件，形如 <code>{ updateData, path? }</code></li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>将 <code>ds.data</code> 同步到 <code>this.data[ds.id]</code>，并以 <code>(ds.id, changeEvent)</code> 触发 <code>change</code> 事件。</p></li></ul><h3 id="updateschema" tabindex="-1">updateSchema <a class="header-anchor" href="#updateschema" aria-label="Permalink to “updateSchema”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{DataSourceSchema[]} schemas</code> 数据源配置数组</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>同步更新数据源 DSL 配置：先按 <code>id</code> 移除已有数据源，再以 <code>cloneDeep</code> 重新 <code>addDataSource</code>，并对新建实例触发 <code>init</code>（异步执行，不会被该方法 <code>await</code>）。一般在编辑器中修改配置后调用。</p></li></ul><h3 id="compilednode" tabindex="-1">compiledNode <a class="header-anchor" href="#compilednode" aria-label="Permalink to “compiledNode”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{MNode} node</code> 节点配置</li><li><code>{string} sourceId</code> 数据源 ID（可选）</li><li><code>{boolean} deep</code> 是否深度编译（可选）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{MNode}</code></li></ul></li><li><p><strong>详情：</strong></p><p>编译节点 DSL 中的数据源配置，将数据源引用替换为实际值。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> compiledNode</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">compiledNode</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">({</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> id: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'text_1'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> type: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'text'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> text: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'${ds_1.username}'</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span>
|
||
<span class="line"><span style="--shiki-light:#62687b;--shiki-dark:#818e99;">// compiledNode.text 会被替换为实际的用户名</span></span></code></pre></div><h3 id="compliedconds" tabindex="-1">compliedConds <a class="header-anchor" href="#compliedconds" aria-label="Permalink to “compliedConds”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{ { [NODE_CONDS_KEY]?: DisplayCond[]; [NODE_CONDS_RESULT_KEY]?: boolean; [NODE_DISABLE_DATA_SOURCE_KEY]?: boolean } } node</code> 带条件字段的结构（不要求是完整的 MNode）</li><li><code>{DataSourceManagerData} data</code> 数据上下文（可选，默认使用 <code>this.data</code>）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{boolean}</code> 节点是否应该显示</li></ul></li><li><p><strong>详情：</strong></p><p>编译显示条件，返回节点是否应该显示。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> shouldShow</span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">compliedConds</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(node);</span></span></code></pre></div><h3 id="compliediteratoritemconds" tabindex="-1">compliedIteratorItemConds <a class="header-anchor" href="#compliediteratoritemconds" aria-label="Permalink to “compliedIteratorItemConds”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{any} itemData</code> 迭代项数据</li><li><code>{ { [NODE_CONDS_KEY]?: DisplayCond[] } } node</code> 带条件字段的结构</li><li><code>{string[]} dataSourceField</code> 迭代数据在数据源中的字段路径，格式如 <code>['dsId', 'key1', 'key2']</code>（可选，默认 <code>[]</code>）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{boolean}</code></li></ul></li><li><p><strong>详情：</strong></p><p>编译迭代器项的显示条件。</p></li></ul><h3 id="compliediteratoritems" tabindex="-1">compliedIteratorItems <a class="header-anchor" href="#compliediteratoritems" aria-label="Permalink to “compliedIteratorItems”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{any} itemData</code> 迭代项数据</li><li><code>{MNode[]} nodes</code> 节点配置数组</li><li><code>{string[]} dataSourceField</code> 迭代数据在数据源中的字段路径（可选，默认 <code>[]</code>）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{MNode[]}</code></li></ul></li><li><p><strong>详情：</strong></p><p>编译迭代器项的节点配置。</p></li></ul><h3 id="isalldatasourceregistered" tabindex="-1">isAllDataSourceRegistered <a class="header-anchor" href="#isalldatasourceregistered" aria-label="Permalink to “isAllDataSourceRegistered”"></a></h3><ul><li><p><strong>返回：</strong></p><ul><li><code>{boolean}</code></li></ul></li><li><p><strong>详情：</strong></p><p>判断 DSL 中声明的所有数据源是否都已注册并实例化（即 <code>dataSourceMap.size === dsl.dataSources.length</code>，或 DSL 未声明数据源）。</p><div class="tip custom-block"><p class="custom-block-title"><code>registered-all</code> 触发时机</p><p><code>registered-all</code> 事件<strong>仅</strong>在 <code>addDataSource</code> 末尾、<code>isAllDataSourceRegistered()</code> 为真时触发。当 <code>dsl.dataSources</code> 为空数组时，构造函数不会进入任何一次 <code>addDataSource</code> 调用，因此<strong>不会</strong>触发该事件，但仍可能执行 <code>callDsInit()</code>。</p></div></li></ul><h3 id="ondatachange" tabindex="-1">onDataChange <a class="header-anchor" href="#ondatachange" aria-label="Permalink to “onDataChange”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{string} id</code> 数据源 ID</li><li><code>{string} path</code> 数据路径</li><li><code>{(payload: any) => void} callback</code> 回调函数（具体入参取决于 <code>ObservedData</code> 实现，详见 <a href="./dataSource.html#ondatachange">DataSource.onDataChange</a>）</li><li><code>{ { immediate?: boolean } } options</code> 选项（可选）</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>监听数据源数据变化。<code>options.immediate</code> 为 <code>true</code> 时，订阅后立即用当前值触发一次回调（具体语义取决于 <code>ObservedData</code> 的实现）。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">onDataChange</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'ds_1'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'user.name'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, (</span><span style="--shiki-light:#c13617;--shiki-dark:#FFAB70;">newVal</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'用户名变更:'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, newVal);</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div><h3 id="offdatachange" tabindex="-1">offDataChange <a class="header-anchor" href="#offdatachange" aria-label="Permalink to “offDataChange”"></a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{string} id</code> 数据源 ID</li><li><code>{string} path</code> 数据路径</li><li><code>{(newVal: any) => void} callback</code> 回调函数</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>取消监听数据源数据变化。</p></li></ul><h3 id="destroy" tabindex="-1">destroy <a class="header-anchor" href="#destroy" aria-label="Permalink to “destroy”"></a></h3><ul><li><p><strong>返回：</strong></p><ul><li><code>{void}</code></li></ul></li><li><p><strong>详情：</strong></p><p>销毁数据源管理器，清理所有数据源。</p></li></ul><h2 id="事件" tabindex="-1">事件 <a class="header-anchor" href="#事件" aria-label="Permalink to “事件”"></a></h2><p>DataSourceManager 继承自 EventEmitter，支持以下事件：</p><table tabindex="0"><thead><tr><th>事件名</th><th>说明</th><th>回调参数</th></tr></thead><tbody><tr><td><code>change</code></td><td>单个数据源数据变化</td><td><code>(dsId: string, changeEvent: ChangeEvent)</code></td></tr><tr><td><code>init</code></td><td>所有数据源初始化完成；现代分支携带 <code>(data, errors)</code>，旧 Promise.all 分支为 <code>(this.data)</code></td><td><code>(data, errors?)</code></td></tr><tr><td><code>registered-all</code></td><td>所有数据源注册完成</td><td>无</td></tr><tr><td><code>update-data</code></td><td>由 <code>createDataSourceManager</code> 在数据变化后发出，用于通知节点重新渲染</td><td><code>(newNodes: MNode[], sourceId: string, changeEvent: ChangeEvent, pageId: Id)</code></td></tr></tbody></table><h3 id="事件监听示例" tabindex="-1">事件监听示例 <a class="header-anchor" href="#事件监听示例" aria-label="Permalink to “事件监听示例”"></a></h3><div class="language-typescript"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark" style="--shiki-light:#24292e;--shiki-dark:#e1e4e8;--shiki-light-bg:#fff;--shiki-dark-bg:#24292e;" tabindex="0" dir="ltr"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">on</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'change'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, (</span><span style="--shiki-light:#c13617;--shiki-dark:#FFAB70;">dsId</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#c13617;--shiki-dark:#FFAB70;">changeEvent</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">`数据源 ${</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">dsId</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">} 变更:`</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, changeEvent);</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">dataSourceManager.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">on</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'init'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, (</span><span style="--shiki-light:#c13617;--shiki-dark:#FFAB70;">data</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#c13617;--shiki-dark:#FFAB70;">errors</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) </span><span style="--shiki-light:#c62739;--shiki-dark:#F97583;">=></span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> {</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> console.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">log</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">'所有数据源初始化完成'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, data, errors);</span></span>
|
||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">});</span></span></code></pre></div></div></div></main><footer class="VPDocFooter" data-v-6fc6448d data-v-caf0f700><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-caf0f700><span class="visually-hidden" id="doc-footer-aria-label" data-v-caf0f700>Pager</span><div class="pager" data-v-caf0f700><a class="VPLink link pager-link prev" href="/tmagic-editor/docs/runtime-api/core/utils.html" data-v-caf0f700><!--[--><span class="desc" data-v-caf0f700>Previous page</span><span class="title" data-v-caf0f700>工具函数</span><!--]--></a></div><div class="pager" data-v-caf0f700><a class="VPLink link pager-link next" href="/tmagic-editor/docs/runtime-api/data-source/dataSource.html" data-v-caf0f700><!--[--><span class="desc" data-v-caf0f700>Next page</span><span class="title" data-v-caf0f700>DataSource</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-2932c6cf data-v-53df1d78><div class="container" data-v-53df1d78><p class="message" data-v-53df1d78>Powered by 腾讯视频会员平台技术中心</p><p class="copyright" data-v-53df1d78>Copyright (C) 2025 Tencent.</p></div></footer><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_editor_codeblockservicemethods.md\":\"B0JWNSG9\",\"api_editor_componentlistservicemethods.md\":\"CBP2S7wE\",\"api_editor_datasourceservicemethods.md\":\"Dqsgtsza\",\"api_editor_editorserviceevents.md\":\"D8xRN9za\",\"api_editor_editorservicemethods.md\":\"Bk-06sWx\",\"api_editor_events.md\":\"BRiMzDnt\",\"api_editor_eventsservicemethods.md\":\"dwupZk8N\",\"api_editor_historyserviceevents.md\":\"BtP81g1-\",\"api_editor_historyservicemethods.md\":\"BjNQp3OU\",\"api_editor_props.md\":\"BhoqoNOV\",\"api_editor_propsserviceevents.md\":\"Buhcztd1\",\"api_editor_propsservicemethods.md\":\"BzKNuOaj\",\"api_editor_slots.md\":\"CM6xNMn8\",\"api_editor_storageservicemethods.md\":\"efkyIGFc\",\"api_editor_uiserviceevents.md\":\"0dV3tgwH\",\"api_editor_uiservicemethods.md\":\"BYnnqy4l\",\"api_form_form-dialog-events.md\":\"uk6NOP07\",\"api_form_form-dialog-methods.md\":\"B6jmcnJU\",\"api_form_form-dialog-props.md\":\"bOkTzdnl\",\"api_form_form-events.md\":\"DMpt-Smk\",\"api_form_form-methods.md\":\"DwT7cEhd\",\"api_form_form-props.md\":\"Dg-76p7a\",\"api_form_submit-form.md\":\"nS0JshyL\",\"api_stage_coreevents.md\":\"Bf0PhKAQ\",\"api_stage_coremethods.md\":\"BfJ-Bzds\",\"api_table_events.md\":\"CmdGltTm\",\"api_table_methods.md\":\"CDy1hOhW\",\"api_table_props.md\":\"D0XbY-XC\",\"form-config_compare.md\":\"BZ2qHWJP\",\"form-config_editor-fields_code-link.md\":\"BpuuSraL\",\"form-config_editor-fields_code-select-col.md\":\"C54C6HBq\",\"form-config_editor-fields_code-select.md\":\"CdTMmJRk\",\"form-config_editor-fields_code.md\":\"DBDZ9aIQ\",\"form-config_editor-fields_cond-op-select.md\":\"0vX39ttH\",\"form-config_editor-fields_data-source-field-select.md\":\"-jRdW6U6\",\"form-config_editor-fields_data-source-fields.md\":\"CO7fjwNI\",\"form-config_editor-fields_data-source-input.md\":\"DpgkSVzn\",\"form-config_editor-fields_data-source-method-select.md\":\"CjX7GYAV\",\"form-config_editor-fields_data-source-methods.md\":\"YdiUw-3k\",\"form-config_editor-fields_data-source-mocks.md\":\"D3UjxvJ1\",\"form-config_editor-fields_data-source-select.md\":\"CF-Bi9Rd\",\"form-config_editor-fields_display-conds.md\":\"QPsgn3i7\",\"form-config_editor-fields_event-select.md\":\"O34LrrHB\",\"form-config_editor-fields_key-value.md\":\"PMq3b0FT\",\"form-config_editor-fields_page-fragment-select.md\":\"D3CJRip6\",\"form-config_editor-fields_ui-select.md\":\"BgtJ5AxZ\",\"form-config_fields_cascader.md\":\"DhJC40cS\",\"form-config_fields_checkbox.md\":\"nvv9BCrN\",\"form-config_fields_color-picker.md\":\"D31BXkuH\",\"form-config_fields_date-picker.md\":\"C0Jc2sM4\",\"form-config_fields_daterange-picker.md\":\"hZiPs5Uv\",\"form-config_fields_datetime-picker.md\":\"BAb8t3p_\",\"form-config_fields_display.md\":\"CwHJEg6e\",\"form-config_fields_dynamic-field.md\":\"1EuSDWFw\",\"form-config_fields_hidden.md\":\"kjCPK54I\",\"form-config_fields_link.md\":\"JBng1KBn\",\"form-config_fields_number-range.md\":\"pk4oxFSa\",\"form-config_fields_number.md\":\"B-L5x_DS\",\"form-config_fields_radio.md\":\"DQIt8zrV\",\"form-config_fields_select.md\":\"CvxobLp8\",\"form-config_fields_switch.md\":\"CaohlziY\",\"form-config_fields_text.md\":\"-xxYJ1yb\",\"form-config_fields_textarea.md\":\"JLm1vGhr\",\"form-config_fields_time-picker.md\":\"B0kEAtsi\",\"form-config_fields_timerange-picker.md\":\"BBWsAvYr\",\"form-config_layout.md\":\"BouY35z0\",\"form-config_relate.md\":\"QHBTFWrk\",\"form-config_rules.md\":\"BLmymsyx\",\"guide_advanced_code-block.md\":\"DzhFxdMX\",\"guide_advanced_coupling.md\":\"B_NEBwJV\",\"guide_advanced_data-source.md\":\"R6g6a5Js\",\"guide_advanced_history-list.md\":\"Dp7f-5wV\",\"guide_advanced_js-schema.md\":\"DURcb0gD\",\"guide_advanced_layout.md\":\"DfLeWfj5\",\"guide_advanced_page.md\":\"DZRwYmIT\",\"guide_advanced_prop-form-validate.md\":\"CfZaPKFi\",\"guide_advanced_tmagic-form.md\":\"BhAymOm7\",\"guide_component.md\":\"CHxd4qA-\",\"guide_conception.md\":\"r6YOd1Lq\",\"guide_editor-expand.md\":\"DGPm3bVd\",\"guide_index.md\":\"DHab0YEy\",\"guide_introduction.md\":\"Bs_e3Azr\",\"guide_migration.md\":\"GpzxeUHU\",\"guide_publish.md\":\"nlian04d\",\"guide_runtime.md\":\"C48c370I\",\"guide_tutorial_hello-world.md\":\"DY2j4gMO\",\"guide_tutorial_index.md\":\"DgGlEUue\",\"guide_tutorial_render.md\":\"Cp6KvBb3\",\"guide_tutorial_runtime.md\":\"B7CmcXE9\",\"index.md\":\"9RsHeZYQ\",\"runtime-api_core_app.md\":\"Dur674t2\",\"runtime-api_core_devtoolapi.md\":\"C1wqlpj3\",\"runtime-api_core_env.md\":\"wgvhhZGD\",\"runtime-api_core_eventhelper.md\":\"BcVTf8du\",\"runtime-api_core_flowstate.md\":\"Bd39Dl4m\",\"runtime-api_core_iteratorcontainer.md\":\"BjjzJUgF\",\"runtime-api_core_node.md\":\"DpKm8jlu\",\"runtime-api_core_page.md\":\"aMeRWFmG\",\"runtime-api_core_utils.md\":\"BNL-iA4H\",\"runtime-api_data-source_datasource.md\":\"CTrOiEBp\",\"runtime-api_data-source_datasourcemanager.md\":\"B0C4k-Pw\",\"runtime-api_data-source_httpdatasource.md\":\"C2nCaEQ4\",\"runtime-api_data-source_observeddata.md\":\"XXpQQO8h\",\"runtime-api_data-source_utils.md\":\"BeoHBz0Y\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"tmagic-editor\",\"description\":\"页面可视化平台\",\"base\":\"/tmagic-editor/docs/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"logo\":\"./favicon.png\",\"search\":{\"provider\":\"local\"},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/Tencent/tmagic-editor\"}],\"footer\":{\"message\":\"Powered by 腾讯视频会员平台技术中心\",\"copyright\":\"Copyright (C) 2025 Tencent.\"},\"nav\":[{\"text\":\"文档\",\"link\":\"/guide/\",\"activeMatch\":\"/guide/\"},{\"text\":\"Editor API\",\"link\":\"/api/editor/props\",\"activeMatch\":\"/api/\"},{\"text\":\"Runtime API\",\"link\":\"/runtime-api/core/app\",\"activeMatch\":\"/runtime-api/\"},{\"text\":\"表单配置\",\"link\":\"/form-config/fields/text\",\"activeMatch\":\"/form-config/\"},{\"text\":\"更新日志\",\"link\":\"https://github.com/Tencent/tmagic-editor/releases\"},{\"text\":\"Playground\",\"link\":\"https://tencent.github.io/tmagic-editor/playground/index.html\"}],\"sidebar\":{\"/guide/\":[{\"text\":\"文档\",\"items\":[{\"text\":\"介绍\",\"link\":\"/guide/introduction.md\"},{\"text\":\"快速开始\",\"link\":\"/guide/\"},{\"text\":\"RUNTIME\",\"link\":\"/guide/runtime.md\"},{\"text\":\"组件开发\",\"link\":\"/guide/component.md\"},{\"text\":\"基础概念\",\"link\":\"/guide/conception.md\"},{\"text\":\"页面发布\",\"link\":\"/guide/publish.md\"},{\"text\":\"编辑器扩展\",\"link\":\"/guide/editor-expand.md\"},{\"text\":\"升级到1.5.x\",\"link\":\"/guide/migration.md\"}]},{\"text\":\"进阶指南\",\"items\":[{\"text\":\"JS Schema\",\"link\":\"/guide/advanced/js-schema.md\"},{\"text\":\"布局原理\",\"link\":\"/guide/advanced/layout.md\"},{\"text\":\"页面渲染\",\"link\":\"/guide/advanced/page.md\"},{\"text\":\"联动原理\",\"link\":\"/guide/advanced/coupling.md\"},{\"text\":\"代码块\",\"link\":\"/guide/advanced/code-block.md\"},{\"text\":\"数据源\",\"link\":\"/guide/advanced/data-source.md\"},{\"text\":\"历史记录面板\",\"link\":\"/guide/advanced/history-list.md\"},{\"text\":\"@tmagic/form\",\"link\":\"/guide/advanced/tmagic-form.md\"},{\"text\":\"属性配置表单校验联动\",\"link\":\"/guide/advanced/prop-form-validate.md\"}]},{\"text\":\"教程\",\"items\":[{\"text\":\"写在前面\",\"link\":\"/guide/tutorial/\"},{\"text\":\"1.Hello World\",\"link\":\"/guide/tutorial/hello-world.md\"},{\"text\":\"2.Runtime\",\"link\":\"/guide/tutorial/runtime.md\"},{\"text\":\"3.DSL解析渲染\",\"link\":\"/guide/tutorial/render.md\"}]}],\"/api/\":[{\"text\":\"编辑器\",\"items\":[{\"text\":\"Editor组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/editor/props.md\"},{\"text\":\"slots\",\"link\":\"/api/editor/slots.md\"},{\"text\":\"events\",\"link\":\"/api/editor/events.md\"}]},{\"text\":\"editorService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/editorServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/editorServiceEvents.md\"}]},{\"text\":\"propsService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/propsServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/propsServiceEvents.md\"}]},{\"text\":\"historyService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/historyServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/historyServiceEvents.md\"}]},{\"text\":\"eventsService\",\"link\":\"/api/editor/eventsServiceMethods.md\"},{\"text\":\"uiService\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/editor/uiServiceMethods.md\"},{\"text\":\"事件\",\"link\":\"/api/editor/uiServiceEvents.md\"}]},{\"text\":\"codeBlockService\",\"link\":\"/api/editor/codeBlockServiceMethods.md\"},{\"text\":\"componentListService\",\"link\":\"/api/editor/componentListServiceMethods.md\"},{\"text\":\"storageService\",\"link\":\"/api/editor/storageServiceMethods.md\"}]},{\"text\":\"表单\",\"items\":[{\"text\":\"Form组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/form/form-props\"},{\"text\":\"methods\",\"link\":\"/api/form/form-methods\"},{\"text\":\"events\",\"link\":\"/api/form/form-events\"}]},{\"text\":\"FormDialog组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/form/form-dialog-props\"},{\"text\":\"methods\",\"link\":\"/api/form/form-dialog-methods\"},{\"text\":\"events\",\"link\":\"/api/form/form-dialog-events\"}]},{\"text\":\"工具函数\",\"items\":[{\"text\":\"submitForm\",\"link\":\"/api/form/submit-form\"}]}]},{\"text\":\"表格\",\"items\":[{\"text\":\"Table组件\",\"items\":[{\"text\":\"props\",\"link\":\"/api/table/props\"},{\"text\":\"methods\",\"link\":\"/api/table/methods\"},{\"text\":\"events\",\"link\":\"/api/table/events\"}]}]},{\"text\":\"stage\",\"items\":[{\"text\":\"StageCore\",\"items\":[{\"text\":\"方法\",\"link\":\"/api/stage/coreMethods\"},{\"text\":\"事件\",\"link\":\"/api/stage/coreEvents\"}]}]}],\"/form-config/\":[{\"text\":\"基础配置\",\"items\":[{\"text\":\"Input输入框\",\"link\":\"/form-config/fields/text.md\"},{\"text\":\"Textarea文本域\",\"link\":\"/form-config/fields/textarea.md\"},{\"text\":\"InputNumber计数器\",\"link\":\"/form-config/fields/number.md\"},{\"text\":\"NumberRange数字范围\",\"link\":\"/form-config/fields/number-range.md\"},{\"text\":\"Display只读文本\",\"link\":\"/form-config/fields/display.md\"},{\"text\":\"Hidden隐藏域\",\"link\":\"/form-config/fields/hidden.md\"},{\"text\":\"Link链接\",\"link\":\"/form-config/fields/link.md\"},{\"text\":\"Checkbox多选框\",\"link\":\"/form-config/fields/checkbox.md\"},{\"text\":\"Radio单选框\",\"link\":\"/form-config/fields/radio.md\"},{\"text\":\"Switch开关\",\"link\":\"/form-config/fields/switch.md\"},{\"text\":\"Select选择器\",\"link\":\"/form-config/fields/select.md\"},{\"text\":\"Cascader级联选择器\",\"link\":\"/form-config/fields/cascader.md\"},{\"text\":\"ColorPicker颜色选择器\",\"link\":\"/form-config/fields/color-picker.md\"},{\"text\":\"DatePick日期选择器\",\"link\":\"/form-config/fields/date-picker.md\"},{\"text\":\"DateRangePick日期范围选择器\",\"link\":\"/form-config/fields/daterange-picker.md\"},{\"text\":\"DatetimePick日期时间选择器\",\"link\":\"/form-config/fields/datetime-picker.md\"},{\"text\":\"TimePick时间选择器\",\"link\":\"/form-config/fields/time-picker.md\"},{\"text\":\"TimeRangePick时间范围选择器\",\"link\":\"/form-config/fields/timerange-picker.md\"},{\"text\":\"DynamicField动态表单\",\"link\":\"/form-config/fields/dynamic-field.md\"}]},{\"text\":\"编辑器中可用配置\",\"items\":[{\"text\":\"Code代码编辑器\",\"link\":\"/form-config/editor-fields/code.md\"},{\"text\":\"CodeLink代码链接\",\"link\":\"/form-config/editor-fields/code-link.md\"},{\"text\":\"CodeSelect代码块选择器\",\"link\":\"/form-config/editor-fields/code-select.md\"},{\"text\":\"CodeSelectCol代码块选择列\",\"link\":\"/form-config/editor-fields/code-select-col.md\"},{\"text\":\"DataSourceSelect数据源选择器\",\"link\":\"/form-config/editor-fields/data-source-select.md\"},{\"text\":\"DataSourceFieldSelect数据源字段选择器\",\"link\":\"/form-config/editor-fields/data-source-field-select.md\"},{\"text\":\"DataSourceMethodSelect数据源方法选择器\",\"link\":\"/form-config/editor-fields/data-source-method-select.md\"},{\"text\":\"DataSourceFields数据源字段配置\",\"link\":\"/form-config/editor-fields/data-source-fields.md\"},{\"text\":\"DataSourceInput数据源输入框\",\"link\":\"/form-config/editor-fields/data-source-input.md\"},{\"text\":\"DataSourceMethods数据源方法配置\",\"link\":\"/form-config/editor-fields/data-source-methods.md\"},{\"text\":\"DataSourceMocks数据源Mock配置\",\"link\":\"/form-config/editor-fields/data-source-mocks.md\"},{\"text\":\"UISelect组件选择器\",\"link\":\"/form-config/editor-fields/ui-select.md\"},{\"text\":\"KeyValue键值对\",\"link\":\"/form-config/editor-fields/key-value.md\"},{\"text\":\"PageFragmentSelect页面片选择器\",\"link\":\"/form-config/editor-fields/page-fragment-select.md\"},{\"text\":\"EventSelect事件选择器\",\"link\":\"/form-config/editor-fields/event-select.md\"},{\"text\":\"DisplayConds显示条件配置\",\"link\":\"/form-config/editor-fields/display-conds.md\"},{\"text\":\"CondOpSelect条件操作选择器\",\"link\":\"/form-config/editor-fields/cond-op-select.md\"}]},{\"text\":\"布局配置\",\"items\":[{\"text\":\"布局\",\"link\":\"/form-config/layout.md\"}]},{\"text\":\"联动配置\",\"items\":[{\"text\":\"联动\",\"link\":\"/form-config/relate.md\"}]},{\"text\":\"表单校验\",\"items\":[{\"text\":\"表单校验\",\"link\":\"/form-config/rules.md\"}]},{\"text\":\"表单对比\",\"items\":[{\"text\":\"表单对比\",\"link\":\"/form-config/compare.md\"}]}],\"/runtime-api/\":[{\"text\":\"@tmagic/core\",\"items\":[{\"text\":\"App\",\"link\":\"/runtime-api/core/app\"},{\"text\":\"Node\",\"link\":\"/runtime-api/core/node\"},{\"text\":\"Page\",\"link\":\"/runtime-api/core/page\"},{\"text\":\"EventHelper\",\"link\":\"/runtime-api/core/eventHelper\"},{\"text\":\"Env\",\"link\":\"/runtime-api/core/env\"},{\"text\":\"IteratorContainer\",\"link\":\"/runtime-api/core/iteratorContainer\"},{\"text\":\"FlowState\",\"link\":\"/runtime-api/core/flowState\"},{\"text\":\"DevtoolApi\",\"link\":\"/runtime-api/core/devtoolApi\"},{\"text\":\"工具函数\",\"link\":\"/runtime-api/core/utils\"}]},{\"text\":\"@tmagic/data-source\",\"items\":[{\"text\":\"DataSourceManager\",\"link\":\"/runtime-api/data-source/dataSourceManager\"},{\"text\":\"DataSource\",\"link\":\"/runtime-api/data-source/dataSource\"},{\"text\":\"HttpDataSource\",\"link\":\"/runtime-api/data-source/httpDataSource\"},{\"text\":\"观察者数据类\",\"link\":\"/runtime-api/data-source/observedData\"},{\"text\":\"工具函数\",\"link\":\"/runtime-api/data-source/utils\"}]}]}},\"locales\":{},\"cleanUrls\":false,\"additionalConfig\":{}}");</script>
|
||
|
||
</body>
|
||
</html> |