tmagic-editor/docs/assets/runtime-api_core_devtoolApi.md.CNtmpnLO.js

import{ax as s,z as a,A as t,b2 as l}from"./chunks/framework.DkLJC2NO.js";const c=JSON.parse('{"title":"DevtoolApi","description":"","frontmatter":{},"headers":[],"relativePath":"runtime-api/core/devtoolApi.md","filePath":"runtime-api/core/devtoolApi.md"}'),e={name:"runtime-api/core/devtoolApi.md"};function p(n,i,o,h,d,r){return t(),a("div",null,[...i[0]||(i[0]=[l(`<h1 id="devtoolapi" tabindex="-1">DevtoolApi <a class="header-anchor" href="#devtoolapi" aria-label="Permalink to &quot;DevtoolApi&quot;">​</a></h1><p><code>DevtoolApi</code> 是 <code>@tmagic/core</code> 提供给开发工具使用的 API 接口类。</p><h2 id="构造函数" tabindex="-1">构造函数 <a class="header-anchor" href="#构造函数" aria-label="Permalink to &quot;构造函数&quot;">​</a></h2><div class="language-typescript vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">new</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> DevtoolApi</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(options: DevtoolApiOptions)</span></span></code></pre></div><h3 id="devtoolapioptions" tabindex="-1">DevtoolApiOptions <a class="header-anchor" href="#devtoolapioptions" aria-label="Permalink to &quot;DevtoolApiOptions&quot;">​</a></h3><table tabindex="0"><thead><tr><th>参数</th><th>类型</th><th>说明</th></tr></thead><tbody><tr><td><code>app</code></td><td><code>App</code></td><td>应用实例</td></tr></tbody></table><h2 id="实例方法" tabindex="-1">实例方法 <a class="header-anchor" href="#实例方法" aria-label="Permalink to &quot;实例方法&quot;">​</a></h2><h3 id="openpop" tabindex="-1">openPop <a class="header-anchor" href="#openpop" aria-label="Permalink to &quot;openPop&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} popId</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><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">openPop</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;dialog_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h3 id="setdatasourcedata" tabindex="-1">setDataSourceData <a class="header-anchor" href="#setdatasourcedata" aria-label="Permalink to &quot;setDataSourceData&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} dsId</code> 数据源 ID</li><li><code>{any} data</code> 数据</li><li><code>{string} path</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 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 设置整个数据源数据</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setDataSourceData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;ds_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { name: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;test&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// 设置数据源的某个字段</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">setDataSourceData</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;ds_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;newValue&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;user.name&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h3 id="requestdatasource" tabindex="-1">requestDataSource <a class="header-anchor" href="#requestdatasource" aria-label="Permalink to &quot;requestDataSource&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} dsId</code> 数据源 ID</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{Promise&lt;void&gt;}</code></li></ul></li><li><p><strong>详情：</strong></p><p>触发 HTTP 数据源的请求。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">requestDataSource</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;http_ds_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h3 id="getdisplaycondrealvalue" tabindex="-1">getDisplayCondRealValue <a class="header-anchor" href="#getdisplaycondrealvalue" aria-label="Permalink to &quot;getDisplayCondRealValue&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} nodeId</code> 节点 ID</li><li><code>{CondItem} condItem</code> 条件项</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{any}</code></li></ul></li><li><p><strong>详情：</strong></p><p>获取显示条件的实际计算值。</p></li></ul><h3 id="callhook" tabindex="-1">callHook <a class="header-anchor" href="#callhook" aria-label="Permalink to &quot;callHook&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} nodeId</code> 节点 ID</li><li><code>{string} hookName</code> 钩子名称</li><li><code>{any} hookData</code> 钩子数据</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{Promise&lt;any&gt;}</code></li></ul></li><li><p><strong>详情：</strong></p><p>调用节点的钩子函数。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">callHook</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;button_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;mounted&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, { data: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;test&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> });</span></span></code></pre></div><h3 id="trigger" tabindex="-1">trigger <a class="header-anchor" href="#trigger" aria-label="Permalink to &quot;trigger&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} nodeId</code> 节点 ID</li><li><code>{EventConfig[]} events</code> 事件配置数组</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{Promise&lt;void&gt;}</code></li></ul></li><li><p><strong>详情：</strong></p><p>触发节点的事件。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">await</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">trigger</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;button_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, [</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  {</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    name: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;click&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">    actions: [{ actionType: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;code&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, codeId: </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;code_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> }]</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">  }</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]);</span></span></code></pre></div><h3 id="isvalueincludedatasource" tabindex="-1">isValueIncludeDataSource <a class="header-anchor" href="#isvalueincludedatasource" aria-label="Permalink to &quot;isValueIncludeDataSource&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{any} value</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 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> hasDs</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">isValueIncludeDataSource</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;\${ds_1.field}&#39;</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;">(hasDs); </span><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;">// true</span></span></code></pre></div><h3 id="compiledatasourcevalue" tabindex="-1">compileDataSourceValue <a class="header-anchor" href="#compiledatasourcevalue" aria-label="Permalink to &quot;compileDataSourceValue&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{any} value</code> 包含数据源引用的值</li></ul></li><li><p><strong>返回：</strong></p><ul><li><code>{any}</code></li></ul></li><li><p><strong>详情：</strong></p><p>编译数据源值，将数据源引用替换为实际值。</p></li><li><p><strong>示例：</strong></p></li></ul><div class="language-typescript vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">const</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> compiled</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> =</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">compileDataSourceValue</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;用户名：\${ds_1.user.name}&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div><h3 id="updatecode" tabindex="-1">updateCode <a class="header-anchor" href="#updatecode" aria-label="Permalink to &quot;updateCode&quot;">​</a></h3><ul><li><p><strong>参数：</strong></p><ul><li><code>{Id} codeId</code> 代码块 ID</li><li><code>{any} value</code> 新值</li><li><code>{string} path</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 vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">typescript</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">devtoolApi.</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">updateCode</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;code_1&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;return data.value * 2;&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;content&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">);</span></span></code></pre></div>`,33)])])}const g=s(e,[["render",p]]);export{c as __pageData,g as default};