From 911dffc64e8b3e9633643a3421c3ea57ac9575e3 Mon Sep 17 00:00:00 2001 From: lijianxiong <1518062161@qq.com> Date: Mon, 14 Apr 2025 20:45:21 +0800 Subject: [PATCH 1/4] =?UTF-8?q?feat=EF=BC=9A=E9=80=82=E9=85=8D=E9=A2=9D?= =?UTF-8?q?=E5=A4=96=E5=8C=85loading=E7=8A=B6=E6=80=81=E5=8F=8A=E8=AE=BE?= =?UTF-8?q?=E7=BD=AE=E6=99=BA=E8=83=BD=E8=A1=A5=E5=85=A8=E6=8F=90=E7=A4=BA?= =?UTF-8?q?=E9=BB=98=E8=AE=A4=E5=85=A8=E5=B1=95=E5=BC=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../module/completion-item/completion-item.ts | 4 +- packages/ai-code/src/module/interface.ts | 7 +++ .../src/monaco-editor/monaco-editor.tsx | 58 +++++++++++++++++++ 3 files changed, 67 insertions(+), 2 deletions(-) diff --git a/packages/ai-code/src/module/completion-item/completion-item.ts b/packages/ai-code/src/module/completion-item/completion-item.ts index 75824e2e..51077469 100644 --- a/packages/ai-code/src/module/completion-item/completion-item.ts +++ b/packages/ai-code/src/module/completion-item/completion-item.ts @@ -65,7 +65,7 @@ export class CompletionItem { this.editor.onDidBlurEditorText(() => { disposable?.dispose(); }); - const libName = 'ibiz.d.ts'; + const { libName } = this.config; const libs = this.monaco.languages.typescript.typescriptDefaults.getExtraLibs(); // 全局只注册一次 @@ -104,7 +104,7 @@ export class CompletionItem { // 计算全局变量所需接口 const interfaceText = `import { ${Array.from(new Set(interfaces)).join( ',', - )} } from './ibiz'`; + )} } from './ibiz-global'`; // 计算当前全局变量 const variableText = `declare global {${Array.from( diff --git a/packages/ai-code/src/module/interface.ts b/packages/ai-code/src/module/interface.ts index e661d5f3..f04af2dc 100644 --- a/packages/ai-code/src/module/interface.ts +++ b/packages/ai-code/src/module/interface.ts @@ -44,4 +44,11 @@ export interface IConfig { * @memberof IConfig */ language: string; + /** + * 额外库文件名称 + * + * @type {string} + * @memberof IConfig + */ + libName: string; } diff --git a/packages/ai-code/src/monaco-editor/monaco-editor.tsx b/packages/ai-code/src/monaco-editor/monaco-editor.tsx index 1afea671..7b0ea9ac 100644 --- a/packages/ai-code/src/monaco-editor/monaco-editor.tsx +++ b/packages/ai-code/src/monaco-editor/monaco-editor.tsx @@ -34,6 +34,7 @@ import { CodeEditorController } from '../code-editor.controller'; import { calcAiToolbarItemsByAc } from '../util'; import { CodeModuleCenter } from '../module'; import './monaco-editor.scss'; +import { Monaco } from '../module/interface'; export const IBizAICode = defineComponent({ name: 'IBizAICode', @@ -64,6 +65,12 @@ export const IBizAICode = defineComponent({ // 是否加载中 const isLoading = ref(false); + // 语言初始化是否在加载中 + const isTSFileLoading = ref(false); + + // 额外库文件名称 + const libName = 'ibiz-global.d.ts'; + const editorModel = c.model; if (editorModel.editorParams) { if (editorModel.editorParams.enableEdit) { @@ -460,6 +467,45 @@ export const IBizAICode = defineComponent({ return true; }; + /** + * 轮询等待额外库文件名称加载完成。 + * + * @param _monaco - Monaco 编辑器实例 + * @param _fileName - 额外库文件名称 + */ + const waitForTSFileReady = async ( + _monaco: Monaco, + _fileName: string, + ): Promise => { + // 获取当前已注册的额外 TypeScript 库 + const libs = + _monaco.languages.typescript.typescriptDefaults.getExtraLibs(); + if (libs[_fileName]) return; + + isTSFileLoading.value = true; + // 获取 TypeScript Worker 工厂方法 + const getWorker = + await _monaco.languages.typescript.getTypeScriptWorker(); + // 获取与额外库文件对应的 Worker 实例 + const worker = await getWorker(_monaco.Uri.parse(_fileName)); + + let timer: ReturnType | null; + + /** 检查 Worker 中是否已经加载了额外库文件 */ + const checkLoaded = async () => { + const files = await (worker as IParams).getScriptFileNames(); + if (files.includes(_fileName) && timer) { + clearInterval(timer); + timer = null; + isTSFileLoading.value = false; + } + }; + + timer = setInterval(() => { + checkLoaded(); + }, 600); + }; + const editorInit = (): void => { nextTick(() => { isLoading.value = true; @@ -480,6 +526,7 @@ export const IBizAICode = defineComponent({ context: c.context, params: c.params, language: props.language || props.controller.language, + libName, }); monacoEditor = loaderMonaco.editor; editor = monacoEditor.create(codeEditBox.value, { @@ -491,6 +538,9 @@ export const IBizAICode = defineComponent({ minimap: { enabled: true, }, + suggest: { + preview: true, + }, readOnly: hasEnableEdit.value ? readonlyState.value : props.readonly || props.disabled, // 只读 @@ -504,6 +554,13 @@ export const IBizAICode = defineComponent({ }); // 为当前编辑器实例添加自定义属性 (editor as any).__instanceId = UUID; + // 设置默认展开建议详情面板 + ( + editor.getContribution( + 'editor.contrib.suggestController', + ) as any + )?.widget?.value?._setDetailsVisible(true); + waitForTSFileReady(loaderMonaco, libName); codeModuleCenter.initModules(editor); if (c.deACMode) { codeLensProviderDisposable = @@ -755,6 +812,7 @@ export const IBizAICode = defineComponent({ hasEnableEdit, readonlyState, isLoading, + isTSFileLoading, renderFooter, renderHeaderToolbar, renderCodeContent, -- Gitee From af6a95075b4b912f86f9a50e55a2432b7553f4ce Mon Sep 17 00:00:00 2001 From: lijianxiong <1518062161@qq.com> Date: Mon, 14 Apr 2025 20:49:48 +0800 Subject: [PATCH 2/4] =?UTF-8?q?feat=EF=BC=9A=E6=96=B0=E5=A2=9E=E6=96=B9?= =?UTF-8?q?=E6=B3=95=E5=8F=82=E6=95=B0=E6=8F=90=E7=A4=BA=E5=8A=9F=E8=83=BD?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../module/completion-item/completion-item.ts | 87 ++++++++++++++++++- 1 file changed, 85 insertions(+), 2 deletions(-) diff --git a/packages/ai-code/src/module/completion-item/completion-item.ts b/packages/ai-code/src/module/completion-item/completion-item.ts index 51077469..68cc19cc 100644 --- a/packages/ai-code/src/module/completion-item/completion-item.ts +++ b/packages/ai-code/src/module/completion-item/completion-item.ts @@ -54,11 +54,24 @@ export class CompletionItem { // 聚焦时注册当前全局变量 this.editor.onDidFocusEditorText(() => { + const content = this.getTypeScriptVariable(); + const libName = `ibiz-editor.d.ts`; disposable = this.monaco.languages.typescript.typescriptDefaults.addExtraLib( - this.getTypeScriptVariable(), - `ibiz-editor.d.ts`, + content, + libName, ); + + const model = this.monaco.editor.getModel(this.monaco.Uri.parse(libName)); + if (model) { + model.setValue(content); + } else { + this.monaco.editor.createModel( + content, // 内容 + this.config.language, // 语言 + this.monaco.Uri.parse(libName), // 地址要跟上面 ExtraLib 的一致 + ); + } }); // 失去焦点移除当前全局变量 @@ -80,6 +93,76 @@ export class CompletionItem { `${content}`, libName, ); + + // 创建模型，主要用于适配可通过ctrl + click跳转到定义的接口，查看接口参数 + this.monaco.editor.createModel( + `${content}`, // 内容 + this.config.language, // 语言 + this.monaco.Uri.parse(libName), + ); + + // 注册跳转定义 + this.monaco.languages.registerDefinitionProvider( + this.config.language, + { + provideDefinition: async ( + model, + position, + ): Promise => { + try { + // 获取 TypeScript Worker + const worker = + await this.monaco.languages.typescript.getTypeScriptWorker(); + const client = await worker(model.uri); + // 计算当前光标位置的 offset + const offset = model.getOffsetAt(position); + // 调用 TS Worker 内置方法获得定义信息 + const defs = await client.getDefinitionAtPosition( + model.uri.toString(), + offset, + ); + + if (defs && defs.length > 0) { + const results = defs + .map(item => { + const libUri = this.monaco.Uri.parse(item.fileName); + + const targetModel = this.monaco.editor.getModel(libUri); + if (targetModel) { + // 获取点击单词的开始下标位置 + const startPos = targetModel.getPositionAt( + item.textSpan.start, + ); + + // 获取点击单词的结束下标位置 + const endPos = targetModel.getPositionAt( + item.textSpan.start + item.textSpan.length, + ); + return { + uri: libUri, + range: new this.monaco.Range( + startPos.lineNumber - 1, + startPos.column - 1, + endPos.lineNumber - 1, + endPos.column - 1, + ), + }; + } + return ''; + }) + .filter(_item => !!_item); + return results; + } + } catch (err) { + console.error(err); + } + return { + uri: model.uri, // 跳转目标文件 + range: new this.monaco.Range(1, 1, 1, 1), // 跳转到 utils.js 文件的第 1 行第 1 列 + }; + }, + }, + ); } } } catch (error) { -- Gitee From 62817e3648b22e0ac048d771d8fe00d1f7776d09 Mon Sep 17 00:00:00 2001 From: lijianxiong <1518062161@qq.com> Date: Mon, 14 Apr 2025 20:52:07 +0800 Subject: [PATCH 3/4] =?UTF-8?q?feat=EF=BC=9A=E6=96=B0=E5=A2=9E=E5=85=A8?= =?UTF-8?q?=E5=B1=80=E5=8F=98=E9=87=8F=E5=8F=AF=E9=85=8D=E7=BD=AE=E9=80=BB?= =?UTF-8?q?=E8=BE=91?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/ai-code/public/assets/type/types.txt | 41 ++++++++++ .../module/completion-item/completion-item.ts | 45 ++++++++--- .../completion-item/variable/type-script.ts | 81 +++++-------------- packages/ai-code/src/module/interface.ts | 7 ++ .../src/monaco-editor/monaco-editor.tsx | 7 ++ 5 files changed, 111 insertions(+), 70 deletions(-) diff --git a/packages/ai-code/public/assets/type/types.txt b/packages/ai-code/public/assets/type/types.txt index ee0ebf1f..37eaaa51 100644 --- a/packages/ai-code/public/assets/type/types.txt +++ b/packages/ai-code/public/assets/type/types.txt @@ -4287,4 +4287,45 @@ export interface IApiRuntimeIbizsys { qrcodeUtil: IApiQrcodeUtil; } +/** + * @description 环境变量配置接口 + * @export + * @interface IApiEnvGlobalConfig + */ +export interface IApiEnvGlobalConfig { + /** + * @description 全局配置 + * @type {IApiGlobalConfig} + */ + globalConfig: IApiGlobalConfig; +} + +/** + * @description 应用工具接口 + * @export + * @interface IApiUtil + */ +export interface IApiUtil { + /** + * @description 消息通知服务 + * @type {IApiMessageUtil} + */ + message: IApiMessageUtil; + /** + * @description 简洁信息提示服务 + * @type {IApiModalUtil} + */ + modal: IApiModalUtil; + /** + * @description 确认操作弹窗服务 + * @type {IApiConfirmUtil} + */ + confirm: IApiConfirmUtil; + /** + * @description 打开视图工具 + * @type {IApiOpenViewUtil} + */ + openView: IApiOpenViewUtil; +}; + export {}; diff --git a/packages/ai-code/src/module/completion-item/completion-item.ts b/packages/ai-code/src/module/completion-item/completion-item.ts index 68cc19cc..4d22edae 100644 --- a/packages/ai-code/src/module/completion-item/completion-item.ts +++ b/packages/ai-code/src/module/completion-item/completion-item.ts @@ -178,23 +178,46 @@ export class CompletionItem { * @memberof CompletionItem */ private getTypeScriptVariable(): string { - const variables = Array.from(TypeScriptVariable.values()); + const variables: Array<{ declare: string; interface: string }> = []; + const { globalVariable } = this.config; + // 如果配置了全局变量，以配置为准 + if (globalVariable) { + const parts = globalVariable.split('|'); + parts.forEach(part => { + const [name, newInterface = ''] = part.split(':'); + const variable = TypeScriptVariable.get(name); + if (variable) { + // 如果配置了接口，则替换默认申明的接口内容 + const interfaceType = newInterface || variable.interface; + const declare = variable.declare.replaceAll( + variable.interface, + interfaceType, + ); + variables.push({ + declare, + interface: interfaceType, + }); + } + }); + } else { + variables.push(...Array.from(TypeScriptVariable.values())); + } // 获取全局对象接口 const interfaces: string[] = []; - variables.forEach(v => { - interfaces.push(...v.interface); - }); + variables.forEach(v => + v.interface.includes('&') + ? interfaces.push(...v.interface.split('&')) + : interfaces.push(v.interface), + ); // 计算全局变量所需接口 - const interfaceText = `import { ${Array.from(new Set(interfaces)).join( - ',', - )} } from './ibiz-global'`; + const interfaceText = `import { ${Array.from( + new Set(interfaces), + ).join()} } from './ibiz-global'`; // 计算当前全局变量 - const variableText = `declare global {${Array.from( - TypeScriptVariable.values(), - ) + const variableText = `declare global {${variables .map(v => v.declare) - .join()}}`; + .join('')}}`; return `${interfaceText}\n${variableText}`; } } diff --git a/packages/ai-code/src/module/completion-item/variable/type-script.ts b/packages/ai-code/src/module/completion-item/variable/type-script.ts index c4ab784b..09f49372 100644 --- a/packages/ai-code/src/module/completion-item/variable/type-script.ts +++ b/packages/ai-code/src/module/completion-item/variable/type-script.ts @@ -3,7 +3,7 @@ */ export const TypeScriptVariable: Map< string, - { declare: string; interface: string[] } + { declare: string; interface: string } > = new Map([ [ 'ibiz', @@ -15,7 +15,7 @@ export const TypeScriptVariable: Map< */ const ibiz: IApiIBizsys & IApiRuntimeIbizsys; `, - interface: ['IApiIBizsys', 'IApiRuntimeIbizsys'], + interface: 'IApiIBizsys & IApiRuntimeIbizsys', }, ], [ @@ -28,7 +28,7 @@ export const TypeScriptVariable: Map< */ const view: IApiViewController; `, - interface: ['IApiViewController'], + interface: 'IApiViewController', }, ], [ @@ -41,7 +41,7 @@ export const TypeScriptVariable: Map< */ const ctrl: IApiControlController; `, - interface: ['IApiControlController'], + interface: 'IApiControlController', }, ], [ @@ -54,7 +54,7 @@ export const TypeScriptVariable: Map< */ const context: IApiContext; `, - interface: ['IApiContext'], + interface: 'IApiContext', }, ], [ @@ -67,7 +67,7 @@ export const TypeScriptVariable: Map< */ const params: IApiParams; `, - interface: ['IApiParams'], + interface: 'IApiParams', }, ], [ @@ -78,15 +78,9 @@ export const TypeScriptVariable: Map< * @description ibiz环境变量 * @type {IEnvironment} */ - const env: IEnvironment & { - /** - * @description 全局配置 - * @type {IApiGlobalConfig} - */ - globalConfig: IApiGlobalConfig - }; + const env: IEnvironment & IApiEnvGlobalConfig; `, - interface: ['IEnvironment', 'IApiGlobalConfig'], + interface: 'IEnvironment & IApiEnvGlobalConfig', }, ], [ @@ -99,7 +93,7 @@ export const TypeScriptVariable: Map< */ const app: IApiAppHubController; `, - interface: ['IApiAppHubController'], + interface: 'IApiAppHubController', }, ], [ @@ -112,7 +106,7 @@ export const TypeScriptVariable: Map< */ const data: IApiData | IApiData[]; `, - interface: ['IApiData'], + interface: 'IApiData', }, ], [ @@ -125,7 +119,7 @@ export const TypeScriptVariable: Map< */ const appSession: IApiData; `, - interface: ['IApiData'], + interface: 'IApiData', }, ], [ @@ -138,7 +132,7 @@ export const TypeScriptVariable: Map< */ const parent: IApiViewController; `, - interface: ['IApiViewController'], + interface: 'IApiViewController', }, ], [ @@ -151,7 +145,7 @@ export const TypeScriptVariable: Map< */ const topView: IApiViewController; `, - interface: ['IApiViewController'], + interface: 'IApiViewController', }, ], [ @@ -164,7 +158,7 @@ export const TypeScriptVariable: Map< */ const parentView: IApiViewController; `, - interface: ['IApiViewController'], + interface: 'IApiViewController', }, ], [ @@ -177,7 +171,7 @@ export const TypeScriptVariable: Map< */ const topViewSession: IApiData; `, - interface: ['IApiData'], + interface: 'IApiData', }, ], [ @@ -190,7 +184,7 @@ export const TypeScriptVariable: Map< */ const viewSession: IApiData; `, - interface: ['IApiData'], + interface: 'IApiData', }, ], [ @@ -203,7 +197,7 @@ export const TypeScriptVariable: Map< */ const uiLogic: IApiData; `, - interface: ['IApiData'], + interface: 'IApiData', }, ], [ @@ -212,42 +206,11 @@ export const TypeScriptVariable: Map< declare: ` /** * @description 应用工具 - * @type {{ - * message: IApiMessageUtil; - * modal: IApiModalUtil; - * confirm: IApiConfirmUtil; - * openView: IApiOpenViewUtil; - * }} - */ - const util: { - /** - * @description 消息通知服务 - * @type {IApiMessageUtil} - */ - message: IApiMessageUtil; - /** - * @description 简洁信息提示服务 - * @type {IApiModalUtil} - */ - modal: IApiModalUtil; - /** - * @description 确认操作弹窗服务 - * @type {IApiConfirmUtil} - */ - confirm: IApiConfirmUtil; - /** - * @description 打开视图工具 - * @type {IApiOpenViewUtil} - */ - openView: IApiOpenViewUtil; - }; - `, - interface: [ - 'IApiMessageUtil', - 'IApiModalUtil', - 'IApiConfirmUtil', - 'IApiOpenViewUtil', - ], + * @type {IApiUtil} + */ + const util: IApiUtil; + `, + interface: 'IApiUtil', }, ], ]); diff --git a/packages/ai-code/src/module/interface.ts b/packages/ai-code/src/module/interface.ts index f04af2dc..e2c3eaef 100644 --- a/packages/ai-code/src/module/interface.ts +++ b/packages/ai-code/src/module/interface.ts @@ -51,4 +51,11 @@ export interface IConfig { * @memberof IConfig */ libName: string; + /** + * 全局变量映射 + * + * @type {string} + * @memberof IConfig + */ + globalVariable?: string; } diff --git a/packages/ai-code/src/monaco-editor/monaco-editor.tsx b/packages/ai-code/src/monaco-editor/monaco-editor.tsx index 7b0ea9ac..92b5b9d4 100644 --- a/packages/ai-code/src/monaco-editor/monaco-editor.tsx +++ b/packages/ai-code/src/monaco-editor/monaco-editor.tsx @@ -71,6 +71,9 @@ export const IBizAICode = defineComponent({ // 额外库文件名称 const libName = 'ibiz-global.d.ts'; + // 全局变量映射 + let globalVariable = ''; + const editorModel = c.model; if (editorModel.editorParams) { if (editorModel.editorParams.enableEdit) { @@ -86,6 +89,9 @@ export const IBizAICode = defineComponent({ editorModel.editorParams.enableFullScreen, ); } + if (editorModel.editorParams.GLOBALVARIABLE) { + globalVariable = editorModel.editorParams.GLOBALVARIABLE; + } } let codeModuleCenter: CodeModuleCenter | null; @@ -527,6 +533,7 @@ export const IBizAICode = defineComponent({ params: c.params, language: props.language || props.controller.language, libName, + globalVariable, }); monacoEditor = loaderMonaco.editor; editor = monacoEditor.create(codeEditBox.value, { -- Gitee From 532c48fc641bbf1ea2a9ade7e142fda71a1bb9a8 Mon Sep 17 00:00:00 2001 From: lijianxiong <1518062161@qq.com> Date: Wed, 16 Apr 2025 19:25:34 +0800 Subject: [PATCH 4/4] =?UTF-8?q?fix=EF=BC=9A=E6=9B=B4=E6=96=B0AI=E4=BB=A3?= =?UTF-8?q?=E7=A0=81=E7=BC=96=E8=BE=91=E5=99=A8=E6=8E=A5=E5=8F=A3=E7=B1=BB?= =?UTF-8?q?=E5=9E=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- packages/ai-code/public/assets/type/types.txt | 15837 ++++++++++++---- 1 file changed, 12175 insertions(+), 3662 deletions(-) diff --git a/packages/ai-code/public/assets/type/types.txt b/packages/ai-code/public/assets/type/types.txt index 37eaaa51..58bdef6f 100644 --- a/packages/ai-code/public/assets/type/types.txt +++ b/packages/ai-code/public/assets/type/types.txt @@ -1,25 +1,8 @@ -/* eslint-disable @typescript-eslint/no-explicit-any */ -/* eslint-disable no-use-before-define */ // Generated by dts-bundle-generator v9.5.1 -import { - IAppCodeList, - IAppDataEntity as IAppDataEntity$1, - IAppView, - IApplication, - IControl, - IDEGrid, - IMDControl, - IPanel, - IPanelItem, - ISysImage, - IViewLayoutPanel, -} from '@ibiz/model-core'; -import { - AxiosRequestConfig, - AxiosResponse, - RawAxiosRequestHeaders, -} from 'axios'; +import { IAppCodeList, IAppDECalendarExplorerView, IAppDECalendarView, IAppDEChartExplorerView, IAppDEChartView, IAppDECustomView, IAppDEDataView, IAppDEDataViewExplorerView, IAppDEEditView, IAppDEExplorerView, IAppDEGanttView, IAppDEGridExplorerView, IAppDEGridView, IAppDEIndexView, IAppDEKanbanView, IAppDEListExplorerView, IAppDEListView, IAppDEMEditView, IAppDEMapView, IAppDEMobMDView, IAppDEMobPickupView, IAppDEMobTreeView, IAppDEMobWFDynaActionView, IAppDEMobWFDynaEditView, IAppDEMobWFDynaStartView, IAppDEMultiDataView, IAppDEPickupView, IAppDEReportView, IAppDESubAppRefView, IAppDETabExplorerView, IAppDETabSearchView, IAppDETreeExplorerView, IAppDETreeGridExView, IAppDETreeGridView, IAppDETreeView, IAppDEWFDynaActionView, IAppDEWFDynaEditView, IAppDEWFDynaStartView, IAppDEWizardView, IAppDataEntity as IAppDataEntity$1, IAppIndexView, IAppMenu, IAppMenuItem, IAppMobView, IAppView, IApplication, ICalendarExpBar, ICaptionBar, IChartExpBar, IControl, IDECalendar, IDEChart, IDEContextMenu, IDEDataView, IDEEditForm, IDEForm, IDEGantt, IDEGrid, IDEKanban, IDEList, IDEMobMDCtrl, IDEMultiEditViewPanel, IDEPickupViewPanel, IDEReportPanel, IDESearchForm, IDEToolbar, IDETree, IDETreeGrid, IDETreeGridEx, IDEWizardForm, IDEWizardPanel, IDRBar, IDRTab, IDashboard, IExpBar, IMDControl, IPanel, IPanelItem, ISearchBar, ISysImage, ISysMap, ITabExpPanel, IViewLayoutPanel } from '@ibiz/model-core'; +import { AxiosRequestConfig, AxiosResponse, RawAxiosRequestHeaders } from 'axios'; +import { Base64 } from 'js-base64'; import { LogLevelDesc } from 'loglevel'; /** @@ -28,22 +11,22 @@ import { LogLevelDesc } from 'loglevel'; * @enum {number} */ export declare enum LoginMode { - /** - * 默认标准登录 - */ - DEFAULT = 'DEFAULT', - /** - * 自定义登录 - */ - CUSTOM = 'CUSTOM', - /** - * 中央认证登录 - */ - CAS = 'CAS', - /** - * oauth登录 - */ - OAUTH = 'OAUTH', + /** + * 默认标准登录 + */ + DEFAULT = "DEFAULT", + /** + * 自定义登录 + */ + CUSTOM = "CUSTOM", + /** + * 中央认证登录 + */ + CAS = "CAS", + /** + * oauth登录 + */ + OAUTH = "OAUTH" } /** * @description 菜单权限校验模式 @@ -51,18 +34,18 @@ export declare enum LoginMode { * @enum {number} */ export declare enum MenuPermissionMode { - /** - * 混合模式（默认） - */ - MIXIN = 'MIXIN', - /** - * 统一资源模式 - */ - RESOURCE = 'RESOURCE', - /** - * RT模式 - */ - RT = 'RT', + /** + * 混合模式（默认） + */ + MIXIN = "MIXIN", + /** + * 统一资源模式 + */ + RESOURCE = "RESOURCE", + /** + * RT模式 + */ + RT = "RT" } /** * @description devtool的配置对象 @@ -70,30 +53,30 @@ export declare enum MenuPermissionMode { * @interface IDevToolConfig */ export interface IDevToolConfig { - /** - * @description 配置平台基础路径 - * @type {string} - * @memberof IDevToolConfig - */ - studioBaseUrl?: string; - /** - * @description 模型预览宽度 - * @type {number} - * @memberof IDevToolConfig - */ - modelPreviewWidth?: number; - /** - * @description 日志级别 - * @type {LogLevelDesc} - * @memberof IDevToolConfig - */ - logLevel?: LogLevelDesc; - /** - * @description 是否启用v9模式 - * @type {boolean} - * @memberof IDevToolConfig - */ - v9Mode?: boolean; + /** + * @description 配置平台基础路径 + * @type {string} + * @memberof IDevToolConfig + */ + studioBaseUrl?: string; + /** + * @description 模型预览宽度 + * @type {number} + * @memberof IDevToolConfig + */ + modelPreviewWidth?: number; + /** + * @description 日志级别 + * @type {LogLevelDesc} + * @memberof IDevToolConfig + */ + logLevel?: LogLevelDesc; + /** + * @description 是否启用v9模式 + * @type {boolean} + * @memberof IDevToolConfig + */ + v9Mode?: boolean; } /** * @description 应用上下文 @@ -101,31 +84,31 @@ export interface IDevToolConfig { * @interface IApiContext */ export interface IApiContext { - [key: string | symbol]: any; - /** - * @description 界面域标识，每个独立路由导航的视图生成 - * @type {string} - * @memberof IApiContext - */ - srfsessionid: string; - /** - * @description 应用标识 - * @type {string} - * @memberof IApiContext - */ - srfappid: string; - /** - * @description 是否简单模式，简单模式下服务层会以界面数据为准，不会进行 DTO 处理 - * @type {boolean} - * @memberof IApiContext - */ - srfsimple?: boolean; - /** - * @description 编辑视图上一个，下一步等功能数据来源的多数据部件标识 - * @type {string} - * @memberof IApiContext - */ - srfnavctrlid?: string; + [key: string | symbol]: any; + /** + * @description 界面域标识，每个独立路由导航的视图生成 + * @type {string} + * @memberof IApiContext + */ + srfsessionid: string; + /** + * @description 应用标识 + * @type {string} + * @memberof IApiContext + */ + srfappid: string; + /** + * @description 是否简单模式，简单模式下服务层会以界面数据为准，不会进行 DTO 处理 + * @type {boolean} + * @memberof IApiContext + */ + srfsimple?: boolean; + /** + * @description 编辑视图上一个，下一步等功能数据来源的多数据部件标识 + * @type {string} + * @memberof IApiContext + */ + srfnavctrlid?: string; } /** * @description 参数对象接口定义 @@ -133,7 +116,7 @@ export interface IApiContext { * @interface IApiParams */ export interface IApiParams { - [key: string | symbol]: any; + [key: string | symbol]: any; } /** * @description 数据对象接口定义 @@ -141,7 +124,7 @@ export interface IApiParams { * @interface IApiData */ export interface IApiData { - [key: string | symbol]: any; + [key: string | symbol]: any; } /** * @description 任意对象结构定义 @@ -149,7 +132,7 @@ export interface IApiData { * @interface IApiObject */ export interface IApiObject { - [key: string | symbol]: any; + [key: string | symbol]: any; } /** * @description 环境变量 @@ -157,264 +140,276 @@ export interface IApiObject { * @interface IEnvironment */ export interface IEnvironment { - /** - * @description 命名空间 - * @type {string} - * @memberof IEnvironment - */ - namespace?: string; - /** - * @description 是否为开发模式 - * @type {boolean} - * @memberof IEnvironment - */ - dev: boolean; - /** - * @description 是否为多应用 hub 基座模式 - * @type {boolean} - * @memberof IEnvironment - */ - hub: boolean; - /** - * @description 是否启用 mqtt (ws模式消息) - * @type {boolean} - * @memberof IEnvironment - */ - enableMqtt: boolean; - /** - * @description mqtt 默认连接地址,emq 服务地址 /portal/mqtt/mqtt, rebbitmq 服务地址 /portal/mqtt/ws - * @type {string} - * @memberof IEnvironment - */ - mqttUrl: string; - /** - * @description 默认应用的应用标识 - * @type {string} - * @memberof IEnvironment - */ - appId: string; - /** - * @description 日志级别 - * @type {LogLevelDesc} - * @memberof IEnvironment - */ - logLevel: LogLevelDesc; - /** - * @description 请求根路径 - * @type {string} - * @memberof IEnvironment - */ - baseUrl: string; - /** - * @description 插件默认所在目录 - * @type {string} - * @memberof IEnvironment - */ - pluginBaseUrl: string; - /** - * @description 登录模式 - * @type {LoginMode} - * @memberof IEnvironment - */ - loginMode: LoginMode; - /** - * @description oauth 开放接入标识 - * @type {string} - * @memberof IEnvironment - */ - oauthOpenAccessId: string; - /** - * @description 中央认证登录地址 - * @type {string} - * @memberof IEnvironment - */ - casLoginUrl: string; - /** - * @description 模型是否为本地模型(走静态资源模式) - * @type {boolean} - * @memberof IEnvironment - */ - isLocalModel: boolean; - /** - * @description 远程模型路径 - * @type {string} - * @memberof IEnvironment - */ - remoteModelUrl: string; - /** - * @description 资源文件根路径 - * @type {string} - * @memberof IEnvironment - */ - assetsUrl: string; - /** - * @description 中心系统标识 - * @type {string} - * @memberof IEnvironment - */ - dcSystem: string; - /** - * @description 文件下载url - * @type {string} - * @memberof IEnvironment - */ - downloadFileUrl: string; - /** - * @description 文件上传url - * @type {string} - * @memberof IEnvironment - */ - uploadFileUrl: string; - /** - * @description 是否启用权限校验（默认true） - * @type {boolean} - * @memberof IEnvironment - */ - enablePermission: boolean; - /** - * @description 菜单权限校验模式（默认MIXIN） - * @type {MenuPermissionMode} - * @memberof IEnvironment - */ - menuPermissionMode: MenuPermissionMode; - /** - * @description 路由占位符 - * @type {string} - * @memberof IEnvironment - */ - routePlaceholder: string; - /** - * @description 是否让所有工作流history接口走all - * @type {boolean} - * @memberof IEnvironment - */ - enableWfAllHistory: boolean; - /** - * @description 是否启用加密 - * @type {boolean} - * @memberof IEnvironment - */ - enableEncryption: boolean; - /** - * @description 应用loadding主题 - * @type {('DEFAULT' | 'DARK' | 'LIGHT')} - * @memberof IEnvironment - */ - appLoadingTheme: 'DEFAULT' | 'DARK' | 'LIGHT'; - /** - * @description 应用标题 - * @type {string} - * @memberof IEnvironment - */ - AppTitle?: string; - /** - * @description 应用标记 - * @type {string} - * @memberof IEnvironment - */ - AppLabel?: string; - /** - * @description 是否为 SaaS 模式 - * @type {boolean} - * @memberof IEnvironment - */ - isSaaSMode?: boolean; - /** - * @description 是否为移动端应用 - * @type {boolean} - * @memberof IEnvironment - */ - isMob?: boolean; - /** - * @description 应用图标地址 - * @type {string} - * @memberof IEnvironment - */ - favicon?: string; - /** - * @description 是否启用多语言,此值是默认加载后，根据应用模型中的配置来决定是否启用多语言。请勿手动修改此值 - * @type {boolean} - * @memberof IEnvironment - */ - isEnableMultiLan?: boolean; - /** - * @description 匿名用户名 - * @type {string} - * @memberof IEnvironment - */ - anonymousUser?: string; - /** - * @description 匿名用户密码 - * @type {string} - * @memberof IEnvironment - */ - anonymousPwd?: string; - /** - * @description 启用匿名模式 - * @type {boolean} - * @memberof IEnvironment - */ - enableAnonymous?: boolean; - /** - * @description 市场地址 - * @type {string} - * @memberof IEnvironment - */ - marketAddress?: string; - /** - * @description devtool的配置对象 - * @type {IDevToolConfig} - * @memberof IEnvironment - */ - devtoolConfig?: IDevToolConfig; - /** - * @description 是否启用title - * @type {boolean} - * @memberof IEnvironment - */ - enableTitle?: boolean; - /** - * @description token头 - * @type {string} - * @memberof IEnvironment - */ - tokenHeader?: string; - /** - * @description token前缀 - * @type {string} - * @memberof IEnvironment - */ - tokenPrefix?: string; - /** - * @description 自定义动态参数，格式如：{\"XXX\":\"YYY\",\"AAA\":\"BBB\"} - * @type {IApiParams} - * @memberof IEnvironment - */ - customParams?: IApiParams; - /** - * @description 定义cookie作用域 - * @type {string} - * @memberof IEnvironment - */ - cookieDomain?: string; - /** - * @description 环境类型 - * @type {('development' | 'test' | 'production')} - * @memberof IEnvironment - */ - environmentTag?: 'development' | 'test' | 'production'; - /** - * @description 移动端菜单呈现模式，DEFAULT：菜单映射的页面菜单显示，非菜单映射的页面菜单不显示；ALWAYS：所有页面菜单都显示,默认：DEFAULT - * @type {('DEFAULT' | 'ALWAYS')} - * @memberof IEnvironment - */ - mobMenuShowMode?: 'DEFAULT' | 'ALWAYS'; - /** - * @description 是否启用AI支持 - * @type {boolean} - * @memberof IEnvironment - */ - enableAI: boolean; + /** + * @description 命名空间 + * @type {string} + * @memberof IEnvironment + */ + namespace?: string; + /** + * @description 是否为开发模式 + * @type {boolean} + * @memberof IEnvironment + */ + dev: boolean; + /** + * @description 是否为多应用 hub 基座模式 + * @type {boolean} + * @memberof IEnvironment + */ + hub: boolean; + /** + * @description 是否启用 mqtt (ws模式消息) + * @type {boolean} + * @memberof IEnvironment + */ + enableMqtt: boolean; + /** + * @description mqtt 默认连接地址,emq 服务地址 /portal/mqtt/mqtt, rebbitmq 服务地址 /portal/mqtt/ws + * @type {string} + * @memberof IEnvironment + */ + mqttUrl: string; + /** + * @description 默认应用的应用标识 + * @type {string} + * @memberof IEnvironment + */ + appId: string; + /** + * @description 日志级别 + * @type {LogLevelDesc} + * @memberof IEnvironment + */ + logLevel: LogLevelDesc; + /** + * @description 请求根路径 + * @type {string} + * @memberof IEnvironment + */ + baseUrl: string; + /** + * @description 插件默认所在目录 + * @type {string} + * @memberof IEnvironment + */ + pluginBaseUrl: string; + /** + * @description 登录模式 + * @type {LoginMode} + * @memberof IEnvironment + */ + loginMode: LoginMode; + /** + * @description oauth 开放接入标识 + * @type {string} + * @memberof IEnvironment + */ + oauthOpenAccessId: string; + /** + * @description 中央认证登录地址 + * @type {string} + * @memberof IEnvironment + */ + casLoginUrl: string; + /** + * @description 模型是否为本地模型(走静态资源模式) + * @type {boolean} + * @memberof IEnvironment + */ + isLocalModel: boolean; + /** + * @description 远程模型路径 + * @type {string} + * @memberof IEnvironment + */ + remoteModelUrl: string; + /** + * @description 资源文件根路径 + * @type {string} + * @memberof IEnvironment + */ + assetsUrl: string; + /** + * @description 中心系统标识 + * @type {string} + * @memberof IEnvironment + */ + dcSystem: string; + /** + * @description 文件下载url + * @type {string} + * @memberof IEnvironment + */ + downloadFileUrl: string; + /** + * @description 文件上传url + * @type {string} + * @memberof IEnvironment + */ + uploadFileUrl: string; + /** + * @description 是否启用权限校验（默认true） + * @type {boolean} + * @memberof IEnvironment + */ + enablePermission: boolean; + /** + * @description 菜单权限校验模式（默认MIXIN） + * @type {MenuPermissionMode} + * @memberof IEnvironment + */ + menuPermissionMode: MenuPermissionMode; + /** + * @description 路由占位符 + * @type {string} + * @memberof IEnvironment + */ + routePlaceholder: string; + /** + * @description 是否让所有工作流history接口走all + * @type {boolean} + * @memberof IEnvironment + */ + enableWfAllHistory: boolean; + /** + * @description 是否启用加密 + * @type {boolean} + * @memberof IEnvironment + */ + enableEncryption: boolean; + /** + * @description 应用loadding主题 + * @type {('DEFAULT' | 'DARK' | 'LIGHT')} + * @memberof IEnvironment + */ + appLoadingTheme: "DEFAULT" | "DARK" | "LIGHT"; + /** + * @description 应用标题 + * @type {string} + * @memberof IEnvironment + */ + AppTitle?: string; + /** + * @description 应用标记 + * @type {string} + * @memberof IEnvironment + */ + AppLabel?: string; + /** + * @description 是否为 SaaS 模式 + * @type {boolean} + * @memberof IEnvironment + */ + isSaaSMode?: boolean; + /** + * @description 是否为移动端应用 + * @type {boolean} + * @memberof IEnvironment + */ + isMob?: boolean; + /** + * @description 应用图标地址 + * @type {string} + * @memberof IEnvironment + */ + favicon?: string; + /** + * @description 是否启用多语言,此值是默认加载后，根据应用模型中的配置来决定是否启用多语言。请勿手动修改此值 + * @type {boolean} + * @memberof IEnvironment + */ + isEnableMultiLan?: boolean; + /** + * @description 匿名用户名 + * @type {string} + * @memberof IEnvironment + */ + anonymousUser?: string; + /** + * @description 匿名用户密码 + * @type {string} + * @memberof IEnvironment + */ + anonymousPwd?: string; + /** + * @description 启用匿名模式 + * @type {boolean} + * @memberof IEnvironment + */ + enableAnonymous?: boolean; + /** + * @description 访问数据存储区域 + * @type {('COOKIE' | 'LOCALSTORAGE' | 'SESSIONSTORAGE')} + * @memberof IEnvironment + */ + accessStoreArea: "COOKIE" | "LOCALSTORAGE" | "SESSIONSTORAGE"; + /** + * @description 市场地址 + * @type {string} + * @memberof IEnvironment + */ + marketAddress?: string; + /** + * @description devtool的配置对象 + * @type {IDevToolConfig} + * @memberof IEnvironment + */ + devtoolConfig?: IDevToolConfig; + /** + * @description 是否启用title + * @type {boolean} + * @memberof IEnvironment + */ + enableTitle?: boolean; + /** + * @description token头 + * @type {string} + * @memberof IEnvironment + */ + tokenHeader?: string; + /** + * @description token前缀 + * @type {string} + * @memberof IEnvironment + */ + tokenPrefix?: string; + /** + * @description 自定义动态参数，格式如：{\"XXX\":\"YYY\",\"AAA\":\"BBB\"} + * @type {IApiParams} + * @memberof IEnvironment + */ + customParams?: IApiParams; + /** + * @description 定义cookie作用域 + * @type {string} + * @memberof IEnvironment + */ + cookieDomain?: string; + /** + * @description 环境类型 + * @type {('development' | 'test' | 'production')} + * @memberof IEnvironment + */ + environmentTag?: "development" | "test" | "production"; + /** + * @description 移动端菜单呈现模式，DEFAULT：菜单映射的页面菜单显示，非菜单映射的页面菜单不显示；ALWAYS：所有页面菜单都显示,默认：DEFAULT + * @type {('DEFAULT' | 'ALWAYS')} + * @memberof IEnvironment + */ + mobMenuShowMode?: "DEFAULT" | "ALWAYS"; + /** + * @description 是否启用AI支持 + * @type {boolean} + * @memberof IEnvironment + */ + enableAI: boolean; + /** + * @description 应用版本号 + * @type {string} + * @memberof IEnvironment + */ + appVersion?: string; } /** * @description 异步作业信息 @@ -422,132 +417,132 @@ export interface IEnvironment { * @interface IPortalAsyncAction */ export interface IPortalAsyncAction { - /** - * @description 异步操作标识 - * @type {string} - * @memberof IPortalAsyncAction - */ - asyncacitonid: string; - /** - * @description 异步操作名称 - * @type {string} - * @memberof IPortalAsyncAction - */ - asyncacitonname: string; - /** - * @description 会话标识 - * @type {string} - * @memberof IPortalAsyncAction - */ - fulltopictag: string; - /** - * @description 租户标识 - * @type {string} - * @memberof IPortalAsyncAction - */ - srfdcid: string; - /** - * @description 租户系统标识 - * @type {string} - * @memberof IPortalAsyncAction - */ - dcsystemid: string; - /** - * @description 异步作业类型，DEIMPORTDATA2: 异步导入 - * @type {string} - * @memberof IPortalAsyncAction - */ - actiontype: string; - /** - * @description 作业状态 - * @type {(10 | 20 | 30 | 40)} 未开始 | 执行中 | 已执行 | 执行失败 - * @memberof IPortalAsyncAction - */ - actionstate: 10 | 20 | 30 | 40; - /** - * @description 异步作业执行结果 - * @type {unknown} - * @memberof IPortalAsyncAction - */ - actionresult?: unknown; - /** - * @description 步骤信息 - * @type {string} - * @memberof IPortalAsyncAction - */ - stepinfo?: string; - /** - * @description 完成百分比 - * @type {number} - * @memberof IPortalAsyncAction - */ - completionrate?: number; - /** - * @description 异步结果下载路径，目前是留给导出数据使用 - * @type {string} - * @memberof IPortalAsyncAction - */ - asyncresultdownloadurl?: string; - /** - * @description 预留参数 - * @type {unknown} - * @memberof IPortalAsyncAction - */ - actionparam?: unknown; - /** - * @description 预留参数2 - * @type {unknown} - * @memberof IPortalAsyncAction - */ - actionparam2?: unknown; - /** - * @description 预留参数3 - * @type {unknown} - * @memberof IPortalAsyncAction - */ - actionparam3?: unknown; - /** - * @description 预留参数4 - * @type {unknown} - * @memberof IPortalAsyncAction - */ - actionparam4?: unknown; - /** - * @description 操作开始时间 - * @type {string} - * @memberof IPortalAsyncAction - */ - begintime: string; - /** - * @description 操作结束时间 - * @type {string} - * @memberof IPortalAsyncAction - */ - endtime: string; - /** - * @description 创建人标识 - * @type {string} - * @memberof IPortalAsyncAction - */ - createman: string; - /** - * @description 创建时间 - * @type {string} - * @memberof IPortalAsyncAction - */ - createdate: string; - /** - * @description 更新人标识 - * @type {string} - * @memberof IPortalAsyncAction - */ - updateman: string; - /** - * @description 更新时间 - * @type {string} - * @memberof IPortalAsyncAction - */ - updatedate: string; + /** + * @description 异步操作标识 + * @type {string} + * @memberof IPortalAsyncAction + */ + asyncacitonid: string; + /** + * @description 异步操作名称 + * @type {string} + * @memberof IPortalAsyncAction + */ + asyncacitonname: string; + /** + * @description 会话标识 + * @type {string} + * @memberof IPortalAsyncAction + */ + fulltopictag: string; + /** + * @description 租户标识 + * @type {string} + * @memberof IPortalAsyncAction + */ + srfdcid: string; + /** + * @description 租户系统标识 + * @type {string} + * @memberof IPortalAsyncAction + */ + dcsystemid: string; + /** + * @description 异步作业类型，DEIMPORTDATA2: 异步导入 + * @type {string} + * @memberof IPortalAsyncAction + */ + actiontype: string; + /** + * @description 作业状态 + * @type {(10 | 20 | 30 | 40)} 未开始 | 执行中 | 已执行 | 执行失败 + * @memberof IPortalAsyncAction + */ + actionstate: 10 | 20 | 30 | 40; + /** + * @description 异步作业执行结果 + * @type {unknown} + * @memberof IPortalAsyncAction + */ + actionresult?: unknown; + /** + * @description 步骤信息 + * @type {string} + * @memberof IPortalAsyncAction + */ + stepinfo?: string; + /** + * @description 完成百分比 + * @type {number} + * @memberof IPortalAsyncAction + */ + completionrate?: number; + /** + * @description 异步结果下载路径，目前是留给导出数据使用 + * @type {string} + * @memberof IPortalAsyncAction + */ + asyncresultdownloadurl?: string; + /** + * @description 预留参数 + * @type {unknown} + * @memberof IPortalAsyncAction + */ + actionparam?: unknown; + /** + * @description 预留参数2 + * @type {unknown} + * @memberof IPortalAsyncAction + */ + actionparam2?: unknown; + /** + * @description 预留参数3 + * @type {unknown} + * @memberof IPortalAsyncAction + */ + actionparam3?: unknown; + /** + * @description 预留参数4 + * @type {unknown} + * @memberof IPortalAsyncAction + */ + actionparam4?: unknown; + /** + * @description 操作开始时间 + * @type {string} + * @memberof IPortalAsyncAction + */ + begintime: string; + /** + * @description 操作结束时间 + * @type {string} + * @memberof IPortalAsyncAction + */ + endtime: string; + /** + * @description 创建人标识 + * @type {string} + * @memberof IPortalAsyncAction + */ + createman: string; + /** + * @description 创建时间 + * @type {string} + * @memberof IPortalAsyncAction + */ + createdate: string; + /** + * @description 更新人标识 + * @type {string} + * @memberof IPortalAsyncAction + */ + updateman: string; + /** + * @description 更新时间 + * @type {string} + * @memberof IPortalAsyncAction + */ + updatedate: string; } /** * @description 消息数据 @@ -555,73 +550,66 @@ export interface IPortalAsyncAction { * @interface IPortalMessage */ export interface IPortalMessage { - /** - * @description 消息标识 - * @type {string} - * @memberof IPortalMessage - */ - messageid: string; - /** - * @description 消息名称 - * @type {string} - * @memberof IPortalMessage - */ - messagename?: string; - /** - * @description 消息类型 - * @type {('CONSOLE' | 'COMMAND' | 'ERROR')} 日志消息 | 命令 | 错误消息 - * @memberof IPortalMessage - */ - type: 'CONSOLE' | 'COMMAND' | 'ERROR'; - /** - * @description 消息子类型 - * @type {('MARKOPENDATA' - * | 'ASYNCACTION' - * | 'INTERNALMESSAGE' - * | 'OBJECTUPDATED' - * | 'OBJECTREMOVED' - * | 'OBJECTCREATED' - * | 'ADDINCHANGED')} 标注打开数据 | 异步作业 | 站内信 | 数据更新 | 数据删除 | 数据创建 | 添加更改 - * @memberof IPortalMessage - */ - subtype?: - | 'MARKOPENDATA' - | 'ASYNCACTION' - | 'INTERNALMESSAGE' - | 'OBJECTUPDATED' - | 'OBJECTREMOVED' - | 'OBJECTCREATED' - | 'ADDINCHANGED'; - /** - * @description 内容摘要 - * @type {string} - * @memberof IPortalMessage - */ - content?: string; - /** - * @description 消息数据 - * @type {(IPortalAsyncAction | IApiData | string | unknown)} - * @memberof IPortalMessage - */ - data?: IPortalAsyncAction | IApiData | string | unknown; - /** - * @description 消息路径 - * @type {string} - * @memberof IPortalMessage - */ - url?: string; - /** - * @description 移动端消息路径 - * @type {string} - * @memberof IPortalMessage - */ - mobileurl?: string; - /** - * @description 触发源的key - * @type {string} - * @memberof IPortalMessage - */ - triggerKey?: string; + /** + * @description 消息标识 + * @type {string} + * @memberof IPortalMessage + */ + messageid: string; + /** + * @description 消息名称 + * @type {string} + * @memberof IPortalMessage + */ + messagename?: string; + /** + * @description 消息类型 + * @type {('CONSOLE' | 'COMMAND' | 'ERROR')} 日志消息 | 命令 | 错误消息 + * @memberof IPortalMessage + */ + type: "CONSOLE" | "COMMAND" | "ERROR"; + /** + * @description 消息子类型 + * @type {('MARKOPENDATA' + * | 'ASYNCACTION' + * | 'INTERNALMESSAGE' + * | 'OBJECTUPDATED' + * | 'OBJECTREMOVED' + * | 'OBJECTCREATED' + * | 'ADDINCHANGED')} 标注打开数据 | 异步作业 | 站内信 | 数据更新 | 数据删除 | 数据创建 | 添加更改 + * @memberof IPortalMessage + */ + subtype?: "MARKOPENDATA" | "ASYNCACTION" | "INTERNALMESSAGE" | "OBJECTUPDATED" | "OBJECTREMOVED" | "OBJECTCREATED" | "ADDINCHANGED"; + /** + * @description 内容摘要 + * @type {string} + * @memberof IPortalMessage + */ + content?: string; + /** + * @description 消息数据 + * @type {(IPortalAsyncAction | IApiData | string | unknown)} + * @memberof IPortalMessage + */ + data?: IPortalAsyncAction | IApiData | string | unknown; + /** + * @description 消息路径 + * @type {string} + * @memberof IPortalMessage + */ + url?: string; + /** + * @description 移动端消息路径 + * @type {string} + * @memberof IPortalMessage + */ + mobileurl?: string; + /** + * @description 触发源的key + * @type {string} + * @memberof IPortalMessage + */ + triggerKey?: string; } /** * @description 消息事件 @@ -629,7 +617,7 @@ export interface IPortalMessage { * @interface IMessageCenterEvent */ export interface IMessageCenterEvent { - all: (msg: IPortalMessage) => void; + all: (msg: IPortalMessage) => void; } /** * @description 应用实体数据对象 @@ -638,12 +626,12 @@ export interface IMessageCenterEvent { * @extends {IApiData} */ export interface IAppDataEntity extends IApiData { - /** - * @description 应用实体数据对象标识 - * @type {string} - * @memberof IAppDataEntity - */ - srfdecodename: string; + /** + * @description 应用实体数据对象标识 + * @type {string} + * @memberof IAppDataEntity + */ + srfdecodename: string; } /** * @description 实体数据变更通知元数据接口 @@ -651,12 +639,12 @@ export interface IAppDataEntity extends IApiData { * @interface IMsgMetaData */ export interface IMsgMetaData { - /** - * @description 触发源的key - * @type {string} - * @memberof IMsgMetaData - */ - triggerKey: string; + /** + * @description 触发源的key + * @type {string} + * @memberof IMsgMetaData + */ + triggerKey: string; } /** * @description 消息基类控制器，各个类型消息继承此类 @@ -664,24 +652,24 @@ export interface IMsgMetaData { * @interface IMessageBase */ export interface IMessageBase { - /** - * @description 推送标准结构消息 - * @param {IPortalMessage} msg - * @memberof IMessageBase - */ - next(msg: IPortalMessage): void; - /** - * @description 订阅消息 - * @param {(msg: IPortalMessage) => void} cb - * @memberof IMessageBase - */ - on(cb: (msg: IPortalMessage) => void): void; - /** - * @description 取消订阅消息 - * @param {(msg: IPortalMessage) => void} cb - * @memberof IMessageBase - */ - off(cb: (msg: IPortalMessage) => void): void; + /** + * @description 推送标准结构消息 + * @param {IPortalMessage} msg + * @memberof IMessageBase + */ + next(msg: IPortalMessage): void; + /** + * @description 订阅消息 + * @param {(msg: IPortalMessage) => void} cb + * @memberof IMessageBase + */ + on(cb: (msg: IPortalMessage) => void): void; + /** + * @description 取消订阅消息 + * @param {(msg: IPortalMessage) => void} cb + * @memberof IMessageBase + */ + off(cb: (msg: IPortalMessage) => void): void; } /** * @description 所有消息控制器 @@ -689,7 +677,8 @@ export interface IMessageBase { * @interface IMessageAll * @extends {IMessageBase} */ -export interface IMessageAll extends IMessageBase {} +export interface IMessageAll extends IMessageBase { +} /** * @description 指令消息基类控制器接口 * @export @@ -697,18 +686,14 @@ export interface IMessageAll extends IMessageBase {} * @extends {IMessageBase} */ export interface ICommandBase extends IMessageBase { - /** - * @description 发送指令消息 - * @param {IApiData} data 数据 - * @param {IPortalMessage['subtype']} subtype 子类型 - * @param {string} [triggerKey] 触发源 - * @memberof ICommandBase - */ - sendCommand( - data: IApiData, - subtype: IPortalMessage['subtype'], - triggerKey?: string, - ): void; + /** + * @description 发送指令消息 + * @param {IApiData} data 数据 + * @param {IPortalMessage['subtype']} subtype 子类型 + * @param {string} [triggerKey] 触发源 + * @memberof ICommandBase + */ + sendCommand(data: IApiData, subtype: IPortalMessage["subtype"], triggerKey?: string): void; } /** * @description 添加变更 @@ -716,24 +701,24 @@ export interface ICommandBase extends IMessageBase { * @interface IAddInChanged */ export interface IAddInChanged { - /** - * @description 标题 - * @type {string} - * @memberof IAddInChanged - */ - title: string; - /** - * @description 内容 - * @type {string} - * @memberof IAddInChanged - */ - content: string; - /** - * @description 消息类型 - * @type {string} - * @memberof IAddInChanged - */ - message_type: string; + /** + * @description 标题 + * @type {string} + * @memberof IAddInChanged + */ + title: string; + /** + * @description 内容 + * @type {string} + * @memberof IAddInChanged + */ + content: string; + /** + * @description 消息类型 + * @type {string} + * @memberof IAddInChanged + */ + message_type: string; } /** * @description 添加变更指令消息控制器 @@ -742,12 +727,12 @@ export interface IAddInChanged { * @extends {ICommandBase} */ export interface ICommandAddInChanged extends ICommandBase { - /** - * @description 发送消息 - * @param {IAddInChanged} data - * @memberof ICommandAddInChanged - */ - send(data: IAddInChanged): void; + /** + * @description 发送消息 + * @param {IAddInChanged} data + * @memberof ICommandAddInChanged + */ + send(data: IAddInChanged): void; } /** * @description 异步作业指令消息控制器 @@ -756,12 +741,12 @@ export interface ICommandAddInChanged extends ICommandBase { * @extends {ICommandBase} */ export interface ICommandAsyncAction extends ICommandBase { - /** - * @description 发送消息 - * @param {IPortalAsyncAction} data - * @memberof ICommandAsyncAction - */ - send(data: IPortalAsyncAction): void; + /** + * @description 发送消息 + * @param {IPortalAsyncAction} data + * @memberof ICommandAsyncAction + */ + send(data: IPortalAsyncAction): void; } /** * @description 数据变更指令消息控制器 @@ -769,7 +754,8 @@ export interface ICommandAsyncAction extends ICommandBase { * @interface ICommandChange * @extends {ICommandBase} */ -export interface ICommandChange extends ICommandBase {} +export interface ICommandChange extends ICommandBase { +} /** * @description 创建指令消息控制器 * @export @@ -777,131 +763,124 @@ export interface ICommandChange extends ICommandBase {} * @extends {ICommandBase} */ export interface ICommandCreate extends ICommandBase { - /** - * @description 发送数据 - * @param {IAppDataEntity} data 实体数据 - * @param {IMsgMetaData} [meta] 元数据 - * @memberof ICommandCreate - */ - send(data: IAppDataEntity, meta?: IMsgMetaData): void; -} -export type InternalMessageStatus = - | 'SENT' - | 'RECEIVED' - | 'READ' - | 'NOT_SENT' - | 'SEND_FAILED' - | 'REPLIED' - | 'DELETED'; -export type InternalMessageContentType = 'TEXT' | 'HTML' | 'MARKDOWN' | 'JSON'; + /** + * @description 发送数据 + * @param {IAppDataEntity} data 实体数据 + * @param {IMsgMetaData} [meta] 元数据 + * @memberof ICommandCreate + */ + send(data: IAppDataEntity, meta?: IMsgMetaData): void; +} +export type InternalMessageStatus = "SENT" | "RECEIVED" | "READ" | "NOT_SENT" | "SEND_FAILED" | "REPLIED" | "DELETED"; +export type InternalMessageContentType = "TEXT" | "HTML" | "MARKDOWN" | "JSON"; /** * @description 站内信消息 * @export * @interface IInternalMessage */ export interface IInternalMessage { - /** - * @description 更新人 - * @type {string} - * @memberof IInternalMessage - */ - update_man: string; - /** - * @description 更新时间 - * @type {string} - * @memberof IInternalMessage - */ - update_time: string; - /** - * @description 创建人 - * @type {string} - * @memberof IInternalMessage - */ - create_man: string; - /** - * @description 创建时间 - * @type {string} - * @memberof IInternalMessage - */ - create_time: string; - /** - * @description 唯一标识 - * @type {string} - * @memberof IInternalMessage - */ - id: string; - /** - * @description 状态 - * @type {InternalMessageStatus} - * @memberof IInternalMessage - */ - status: InternalMessageStatus; - /** - * @description 内容类型 - * @type {InternalMessageContentType} - * @memberof IInternalMessage - */ - content_type: InternalMessageContentType; - /** - * @description 内容 - * @type {string} - * @memberof IInternalMessage - */ - content: string; - /** - * @description 系统标记 - * @type {string} - * @memberof IInternalMessage - */ - system_tag: string; - /** - * @description 所有者标记 - * @type {string} - * @memberof IInternalMessage - */ - owner_id: string; - /** - * @description 消息所有者类型 - * @type {('PERSONAL' | 'SYSTEM')} - * @memberof IInternalMessage - */ - owner_type: 'PERSONAL' | 'SYSTEM'; - /** - * @description 消息类型 - * @type {string} - * @memberof IInternalMessage - */ - message_type: string; - /** - * @description 标题 - * @type {string} - * @memberof IInternalMessage - */ - title: string; - /** - * @description 接受者 - * @type {string} - * @memberof IInternalMessage - */ - receiver: string; - /** - * @description 短内容 - * @type {string} - * @memberof IInternalMessage - */ - short_content?: string; - /** - * @description 链接 - * @type {string} - * @memberof IInternalMessage - */ - url?: string; - /** - * @description 移动端链接 - * @type {string} - * @memberof IInternalMessage - */ - mobile_url?: string; + /** + * @description 更新人 + * @type {string} + * @memberof IInternalMessage + */ + update_man: string; + /** + * @description 更新时间 + * @type {string} + * @memberof IInternalMessage + */ + update_time: string; + /** + * @description 创建人 + * @type {string} + * @memberof IInternalMessage + */ + create_man: string; + /** + * @description 创建时间 + * @type {string} + * @memberof IInternalMessage + */ + create_time: string; + /** + * @description 唯一标识 + * @type {string} + * @memberof IInternalMessage + */ + id: string; + /** + * @description 状态 + * @type {InternalMessageStatus} + * @memberof IInternalMessage + */ + status: InternalMessageStatus; + /** + * @description 内容类型 + * @type {InternalMessageContentType} + * @memberof IInternalMessage + */ + content_type: InternalMessageContentType; + /** + * @description 内容 + * @type {string} + * @memberof IInternalMessage + */ + content: string; + /** + * @description 系统标记 + * @type {string} + * @memberof IInternalMessage + */ + system_tag: string; + /** + * @description 所有者标记 + * @type {string} + * @memberof IInternalMessage + */ + owner_id: string; + /** + * @description 消息所有者类型 + * @type {('PERSONAL' | 'SYSTEM')} + * @memberof IInternalMessage + */ + owner_type: "PERSONAL" | "SYSTEM"; + /** + * @description 消息类型 + * @type {string} + * @memberof IInternalMessage + */ + message_type: string; + /** + * @description 标题 + * @type {string} + * @memberof IInternalMessage + */ + title: string; + /** + * @description 接受者 + * @type {string} + * @memberof IInternalMessage + */ + receiver: string; + /** + * @description 短内容 + * @type {string} + * @memberof IInternalMessage + */ + short_content?: string; + /** + * @description 链接 + * @type {string} + * @memberof IInternalMessage + */ + url?: string; + /** + * @description 移动端链接 + * @type {string} + * @memberof IInternalMessage + */ + mobile_url?: string; } /** * @description 站内信指令消息控制器 @@ -910,56 +889,56 @@ export interface IInternalMessage { * @extends {ICommandBase} */ export interface ICommandInternalMessage extends ICommandBase { - /** - * @description 发送消息 - * @param {IInternalMessage} data - * @memberof ICommandInternalMessage - */ - send(data: IInternalMessage): void; + /** + * @description 发送消息 + * @param {IInternalMessage} data + * @memberof ICommandInternalMessage + */ + send(data: IInternalMessage): void; } -export type MarkOpenDataAction = 'VIEW' | 'EDIT' | 'UPDATE' | 'CLOSE'; +export type MarkOpenDataAction = "VIEW" | "EDIT" | "UPDATE" | "CLOSE"; /** * @description 协同消息 * @export * @interface IMarkOpenData */ export interface IMarkOpenData { - /** - * @description 行为类型 - * @type {MarkOpenDataAction} - * @memberof IMarkOpenData - */ - action: MarkOpenDataAction; - /** - * @description 实体名称 - * @type {string} - * @memberof IMarkOpenData - */ - entity: string; - /** - * @description 实体主键 - * @type {string} - * @memberof IMarkOpenData - */ - key: string; - /** - * @description 时间戳 - * @type {number} - * @memberof IMarkOpenData - */ - time: number; - /** - * @description 消息数据 - * @type {IApiData} - * @memberof IMarkOpenData - */ - data?: IApiData; - /** - * @description 用户名 - * @type {string} - * @memberof IMarkOpenData - */ - username: string; + /** + * @description 行为类型 + * @type {MarkOpenDataAction} + * @memberof IMarkOpenData + */ + action: MarkOpenDataAction; + /** + * @description 实体名称 + * @type {string} + * @memberof IMarkOpenData + */ + entity: string; + /** + * @description 实体主键 + * @type {string} + * @memberof IMarkOpenData + */ + key: string; + /** + * @description 时间戳 + * @type {number} + * @memberof IMarkOpenData + */ + time: number; + /** + * @description 消息数据 + * @type {IApiData} + * @memberof IMarkOpenData + */ + data?: IApiData; + /** + * @description 用户名 + * @type {string} + * @memberof IMarkOpenData + */ + username: string; } /** * @description 协同指令消息控制器 @@ -968,12 +947,12 @@ export interface IMarkOpenData { * @extends {ICommandBase} */ export interface ICommandMarkOpenData extends ICommandBase { - /** - * @description 发送消息 - * @param {IMarkOpenData} data - * @memberof ICommandMarkOpenData - */ - send(data: IMarkOpenData): void; + /** + * @description 发送消息 + * @param {IMarkOpenData} data + * @memberof ICommandMarkOpenData + */ + send(data: IMarkOpenData): void; } /** * @description 删除指令消息控制器 @@ -982,13 +961,13 @@ export interface ICommandMarkOpenData extends ICommandBase { * @extends {ICommandBase} */ export interface ICommandRemove extends ICommandBase { - /** - * @description 发送消息 - * @param {IAppDataEntity} data 实体数据 - * @param {IMsgMetaData} [meta] 元数据 - * @memberof ICommandRemove - */ - send(data: IAppDataEntity, meta?: IMsgMetaData): void; + /** + * @description 发送消息 + * @param {IAppDataEntity} data 实体数据 + * @param {IMsgMetaData} [meta] 元数据 + * @memberof ICommandRemove + */ + send(data: IAppDataEntity, meta?: IMsgMetaData): void; } /** * @description 更新指令消息控制器 @@ -997,13 +976,13 @@ export interface ICommandRemove extends ICommandBase { * @extends {ICommandBase} */ export interface ICommandUpdate extends ICommandBase { - /** - * @description 发送消息 - * @param {IAppDataEntity} data 实体数据 - * @param {IMsgMetaData} [meta] 元数据 - * @memberof ICommandUpdate - */ - send(data: IAppDataEntity, meta?: IMsgMetaData): void; + /** + * @description 发送消息 + * @param {IAppDataEntity} data 实体数据 + * @param {IMsgMetaData} [meta] 元数据 + * @memberof ICommandUpdate + */ + send(data: IAppDataEntity, meta?: IMsgMetaData): void; } /** * @description 指令消息控制器 @@ -1012,72 +991,68 @@ export interface ICommandUpdate extends ICommandBase { * @extends {IMessageBase} */ export interface IMessageCommand extends IMessageBase { - /** - * @description 数据变更指令消息控制器 - * @type {ICommandChange} - * @memberof IMessageCommand - */ - readonly change: ICommandChange; - /** - * @description 数据新建指令消息控制器 - * @type {ICommandCreate} - * @memberof IMessageCommand - */ - readonly create: ICommandCreate; - /** - * @description 数据更新指令消息控制器 - * @type {ICommandUpdate} - * @memberof IMessageCommand - */ - readonly update: ICommandUpdate; - /** - * @description 数据删除指令消息控制器 - * @type {ICommandRemove} - * @memberof IMessageCommand - */ - readonly remove: ICommandRemove; - /** - * @description 异步作业指令消息控制器 - * @type {ICommandAsyncAction} - * @memberof IMessageCommand - */ - readonly asyncAction: ICommandAsyncAction; - /** - * @description 内部消息指令消息控制器 - * @type {ICommandInternalMessage} - * @memberof IMessageCommand - */ - readonly internalMessage: ICommandInternalMessage; - /** - * @description 协同指令消息控制器 - * @type {ICommandMarkOpenData} - * @memberof IMessageCommand - */ - readonly markOpenData: ICommandMarkOpenData; - /** - * @description 添加变更指令消息控制器 - * @type {ICommandAddInChanged} - * @memberof IMessageCommand - */ - readonly addInChanged: ICommandAddInChanged; - /** - * @description 推送指令消息 - * @param {IPortalMessage} msg - * @memberof IMessageCommand - */ - next(msg: IPortalMessage): void; - /** - * @description 发送指令消息 - * @param {IApiData} data 数据 - * @param {IPortalMessage['subtype']} subtype 子类型 - * @param {string} [triggerKey] 触发源 - * @memberof IMessageCommand - */ - send( - data: IApiData, - subtype: IPortalMessage['subtype'], - triggerKey?: string, - ): void; + /** + * @description 数据变更指令消息控制器 + * @type {ICommandChange} + * @memberof IMessageCommand + */ + readonly change: ICommandChange; + /** + * @description 数据新建指令消息控制器 + * @type {ICommandCreate} + * @memberof IMessageCommand + */ + readonly create: ICommandCreate; + /** + * @description 数据更新指令消息控制器 + * @type {ICommandUpdate} + * @memberof IMessageCommand + */ + readonly update: ICommandUpdate; + /** + * @description 数据删除指令消息控制器 + * @type {ICommandRemove} + * @memberof IMessageCommand + */ + readonly remove: ICommandRemove; + /** + * @description 异步作业指令消息控制器 + * @type {ICommandAsyncAction} + * @memberof IMessageCommand + */ + readonly asyncAction: ICommandAsyncAction; + /** + * @description 内部消息指令消息控制器 + * @type {ICommandInternalMessage} + * @memberof IMessageCommand + */ + readonly internalMessage: ICommandInternalMessage; + /** + * @description 协同指令消息控制器 + * @type {ICommandMarkOpenData} + * @memberof IMessageCommand + */ + readonly markOpenData: ICommandMarkOpenData; + /** + * @description 添加变更指令消息控制器 + * @type {ICommandAddInChanged} + * @memberof IMessageCommand + */ + readonly addInChanged: ICommandAddInChanged; + /** + * @description 推送指令消息 + * @param {IPortalMessage} msg + * @memberof IMessageCommand + */ + next(msg: IPortalMessage): void; + /** + * @description 发送指令消息 + * @param {IApiData} data 数据 + * @param {IPortalMessage['subtype']} subtype 子类型 + * @param {string} [triggerKey] 触发源 + * @memberof IMessageCommand + */ + send(data: IApiData, subtype: IPortalMessage["subtype"], triggerKey?: string): void; } /** * @description 日志消息控制器 @@ -1086,12 +1061,12 @@ export interface IMessageCommand extends IMessageBase { * @extends {IMessageBase} */ export interface IMessageConsole extends IMessageBase { - /** - * @description 发送消息 - * @param {(IApiData | string)} data - * @memberof IMessageConsole - */ - send(data: IApiData | string): void; + /** + * @description 发送消息 + * @param {(IApiData | string)} data + * @memberof IMessageConsole + */ + send(data: IApiData | string): void; } /** * @description 错误消息控制器 @@ -1100,12 +1075,12 @@ export interface IMessageConsole extends IMessageBase { * @extends {IMessageBase} */ export interface IMessageError extends IMessageBase { - /** - * @description 发送消息 - * @param {(IApiData | string)} data - * @memberof IMessageError - */ - send(data: IApiData | string): void; + /** + * @description 发送消息 + * @param {(IApiData | string)} data + * @memberof IMessageError + */ + send(data: IApiData | string): void; } /** * @description 界面消息中心 @@ -1113,42 +1088,42 @@ export interface IMessageError extends IMessageBase { * @interface IMessageCenter */ export interface IMessageCenter { - /** - * @description 指令消息 - * @type {IMessageCommand} - * @memberof IMessageCenter - */ - readonly command: IMessageCommand; - /** - * @description 日志消息 - * @type {IMessageConsole} - * @memberof IMessageCenter - */ - readonly console: IMessageConsole; - /** - * @description 错误消息 - * @type {IMessageError} - * @memberof IMessageCenter - */ - readonly error: IMessageError; - /** - * @description 发送消息 - * @param {IPortalMessage} msg 消息 - * @memberof IMessageCenter - */ - next(msg: IPortalMessage): void; - /** - * @description 订阅消息 - * @param {(msg: IPortalMessage) => void} callback - * @memberof IMessageCenter - */ - on(callback: (msg: IPortalMessage) => void): void; - /** - * @description 取消订阅 - * @param {(msg: IPortalMessage) => void} callback - * @memberof IMessageCenter - */ - off(callback: (msg: IPortalMessage) => void): void; + /** + * @description 指令消息 + * @type {IMessageCommand} + * @memberof IMessageCenter + */ + readonly command: IMessageCommand; + /** + * @description 日志消息 + * @type {IMessageConsole} + * @memberof IMessageCenter + */ + readonly console: IMessageConsole; + /** + * @description 错误消息 + * @type {IMessageError} + * @memberof IMessageCenter + */ + readonly error: IMessageError; + /** + * @description 发送消息 + * @param {IPortalMessage} msg 消息 + * @memberof IMessageCenter + */ + next(msg: IPortalMessage): void; + /** + * @description 订阅消息 + * @param {(msg: IPortalMessage) => void} callback + * @memberof IMessageCenter + */ + on(callback: (msg: IPortalMessage) => void): void; + /** + * @description 取消订阅 + * @param {(msg: IPortalMessage) => void} callback + * @memberof IMessageCenter + */ + off(callback: (msg: IPortalMessage) => void): void; } /** * @description 多语言工具接口 @@ -1156,48 +1131,48 @@ export interface IMessageCenter { * @interface IApiI18n */ export interface IApiI18n { - /** - * @description 设置当前语言 - * @param {string} lang - * @memberof IApiI18n - */ - setLang(lang: string): void; - /** - * @description 获取当前语言 - * @returns {*} {string} - * @memberof IApiI18n - */ - getLang(): string; - /** - * @description 消息格式化 - * @param {string} tag - * @param {IApiParams} [options] - * @returns {*} {string} - * @memberof IApiI18n - */ - t(tag: string, options?: IApiParams): string; - /** - * @description 消息格式化 - * @param {string} tag - * @param {string} [defaultMsg] - * @param {IApiParams} [options] - * @returns {*} {string} - * @memberof IApiI18n - */ - t(tag: string, defaultMsg?: string, options?: IApiParams): string; - /** - * @description 合并指定语言语言资源 - * @param {string} lang - * @param {IApiParams} data - * @memberof IApiI18n - */ - mergeLocaleMessage(lang: string, data: IApiParams): void; - /** - * @description 合并语言资源 - * @param {IApiParams} data - * @memberof IApiI18n - */ - mergeLocaleMessage(data: IApiParams): void; + /** + * @description 设置当前语言 + * @param {string} lang + * @memberof IApiI18n + */ + setLang(lang: string): void; + /** + * @description 获取当前语言 + * @returns {*} {string} + * @memberof IApiI18n + */ + getLang(): string; + /** + * @description 消息格式化 + * @param {string} tag + * @param {IApiParams} [options] + * @returns {*} {string} + * @memberof IApiI18n + */ + t(tag: string, options?: IApiParams): string; + /** + * @description 消息格式化 + * @param {string} tag + * @param {string} [defaultMsg] + * @param {IApiParams} [options] + * @returns {*} {string} + * @memberof IApiI18n + */ + t(tag: string, defaultMsg?: string, options?: IApiParams): string; + /** + * @description 合并指定语言语言资源 + * @param {string} lang + * @param {IApiParams} data + * @memberof IApiI18n + */ + mergeLocaleMessage(lang: string, data: IApiParams): void; + /** + * @description 合并语言资源 + * @param {IApiParams} data + * @memberof IApiI18n + */ + mergeLocaleMessage(data: IApiParams): void; } /** * @description Http请求返回接口 @@ -1207,54 +1182,54 @@ export interface IApiI18n { * @template T */ export interface IHttpResponse extends AxiosResponse { - /** - * @description 是否请求成功,当状态码为 200-299 时认为成功 - * @type {boolean} - * @memberof IHttpResponse - */ - ok: boolean; - /** - * @description 是否为本地仿造响应,只有当值为 true 时, 才认为是本地仿造响应 - * @type {boolean} - * @memberof IHttpResponse - */ - local: boolean; - /** - * @description 响应数据 - * @type {T} - * @memberof IHttpResponse - */ - data: T; - /** - * @description 当前页 - * @type {number} - * @memberof IHttpResponse - */ - page?: number; - /** - * @description 分页条数 - * @type {number} - * @memberof IHttpResponse - */ - size?: number; - /** - * @description 总条数 - * @type {number} - * @memberof IHttpResponse - */ - total?: number; - /** - * @description 全部计数条数 - * @type {number} - * @memberof IHttpResponse - */ - totalx?: number; - /** - * @description 总页数 - * @type {number} - * @memberof IHttpResponse - */ - totalPages?: number; + /** + * @description 是否请求成功,当状态码为 200-299 时认为成功 + * @type {boolean} + * @memberof IHttpResponse + */ + ok: boolean; + /** + * @description 是否为本地仿造响应,只有当值为 true 时, 才认为是本地仿造响应 + * @type {boolean} + * @memberof IHttpResponse + */ + local: boolean; + /** + * @description 响应数据 + * @type {T} + * @memberof IHttpResponse + */ + data: T; + /** + * @description 当前页 + * @type {number} + * @memberof IHttpResponse + */ + page?: number; + /** + * @description 分页条数 + * @type {number} + * @memberof IHttpResponse + */ + size?: number; + /** + * @description 总条数 + * @type {number} + * @memberof IHttpResponse + */ + total?: number; + /** + * @description 全部计数条数 + * @type {number} + * @memberof IHttpResponse + */ + totalx?: number; + /** + * @description 总页数 + * @type {number} + * @memberof IHttpResponse + */ + totalPages?: number; } /** * @description 网络请求工具 @@ -1262,79 +1237,60 @@ export interface IHttpResponse extends AxiosResponse { * @interface IApiNet */ export interface IApiNet { - /** - * @description Post 请求 - * @param {string} url 请求地址 - * @param {IApiData} data 请求数据 - * @param {IApiParams} [params={}] 请求参数 - * @param {RawAxiosRequestHeaders} [headers={}] 请求头 - * @returns {*} {Promise} - * @memberof IApiNet - */ - post( - url: string, - data: IApiData, - params?: IApiParams, - headers?: RawAxiosRequestHeaders, - ): Promise; - /** - * @description Get 请求 - * @param {string} url 请求地址 - * @param {IApiParams} [params={}] 请求参数 - * @param {RawAxiosRequestHeaders} [headers={}] 请求头 - * @param {AxiosRequestConfig} [option={}] 请求配置 - * @returns {*} {Promise} - * @memberof IApiNet - */ - get( - url: string, - params?: IApiParams, - headers?: RawAxiosRequestHeaders, - option?: AxiosRequestConfig, - ): Promise; - /** - * @description Delete 请求 - * @param {string} url 请求地址 - * @param {IApiParams} [params] 请求参数 - * @param {RawAxiosRequestHeaders} [headers] 请求头 - * @returns {*} {Promise} - * @memberof IApiNet - */ - delete( - url: string, - params?: IApiParams, - headers?: RawAxiosRequestHeaders, - ): Promise; - /** - * @description Put 请求 - * @param {string} url 请求地址 - * @param {IApiData} data 请求数据 - * @param {IApiParams} [params={}] 请求参数 - * @param {RawAxiosRequestHeaders} [headers={}] 请求头 - * @returns {*} {Promise} - * @memberof IApiNet - */ - put( - url: string, - data: IApiData, - params?: IApiParams, - headers?: RawAxiosRequestHeaders, - ): Promise; - /** - * @description 基础请求方法，会合并预置配置 - * @param {string} url 请求地址 - * @param {AxiosRequestConfig} [config={}] 请求配置 - * @returns {*} {Promise} - * @memberof IApiNet - */ - request(url: string, config?: AxiosRequestConfig): Promise; - /** - * @description 创建标准 axios 请求 - * @param {AxiosRequestConfig} config 请求配置 - * @returns {*} {Promise} - * @memberof IApiNet - */ - axios(config: AxiosRequestConfig): Promise; + /** + * @description Post 请求 + * @param {string} url 请求地址 + * @param {IApiData} data 请求数据 + * @param {IApiParams} [params={}] 请求参数 + * @param {RawAxiosRequestHeaders} [headers={}] 请求头 + * @returns {*} {Promise} + * @memberof IApiNet + */ + post(url: string, data: IApiData, params?: IApiParams, headers?: RawAxiosRequestHeaders): Promise; + /** + * @description Get 请求 + * @param {string} url 请求地址 + * @param {IApiParams} [params={}] 请求参数 + * @param {RawAxiosRequestHeaders} [headers={}] 请求头 + * @param {AxiosRequestConfig} [option={}] 请求配置 + * @returns {*} {Promise} + * @memberof IApiNet + */ + get(url: string, params?: IApiParams, headers?: RawAxiosRequestHeaders, option?: AxiosRequestConfig): Promise; + /** + * @description Delete 请求 + * @param {string} url 请求地址 + * @param {IApiParams} [params] 请求参数 + * @param {RawAxiosRequestHeaders} [headers] 请求头 + * @returns {*} {Promise} + * @memberof IApiNet + */ + delete(url: string, params?: IApiParams, headers?: RawAxiosRequestHeaders): Promise; + /** + * @description Put 请求 + * @param {string} url 请求地址 + * @param {IApiData} data 请求数据 + * @param {IApiParams} [params={}] 请求参数 + * @param {RawAxiosRequestHeaders} [headers={}] 请求头 + * @returns {*} {Promise} + * @memberof IApiNet + */ + put(url: string, data: IApiData, params?: IApiParams, headers?: RawAxiosRequestHeaders): Promise; + /** + * @description 基础请求方法，会合并预置配置 + * @param {string} url 请求地址 + * @param {AxiosRequestConfig} [config={}] 请求配置 + * @returns {*} {Promise} + * @memberof IApiNet + */ + request(url: string, config?: AxiosRequestConfig): Promise; + /** + * @description 创建标准 axios 请求 + * @param {AxiosRequestConfig} config 请求配置 + * @returns {*} {Promise} + * @memberof IApiNet + */ + axios(config: AxiosRequestConfig): Promise; } /** * @description 组织数据 @@ -1342,30 +1298,30 @@ export interface IApiNet { * @interface IOrgData */ export interface IOrgData { - /** - * @description 组织标识 - * @type {string} - * @memberof IOrgData - */ - orgid: string; - /** - * @description 组织名称 - * @type {string} - * @memberof IOrgData - */ - orgname: string; - /** - * @description 中心系统标识 - * @type {string} - * @memberof IOrgData - */ - dcsystemid: string; - /** - * @description 系统标识 - * @type {string} - * @memberof IOrgData - */ - systemid: string; + /** + * @description 组织标识 + * @type {string} + * @memberof IOrgData + */ + orgid: string; + /** + * @description 组织名称 + * @type {string} + * @memberof IOrgData + */ + orgname: string; + /** + * @description 中心系统标识 + * @type {string} + * @memberof IOrgData + */ + dcsystemid: string; + /** + * @description 系统标识 + * @type {string} + * @memberof IOrgData + */ + systemid: string; } /** * @description 全局对象 @@ -1373,42 +1329,42 @@ export interface IOrgData { * @interface IApiIBizsys */ export interface IApiIBizsys { - /** - * @description 环境变量 - * @type {IEnvironment} - * @memberof IApiIBizsys - */ - env: IEnvironment; - /** - * @description 网络请求工具 - * @type {IApiNet} - * @memberof IApiIBizsys - */ - net: IApiNet; - /** - * @description 界面消息中心 - * @type {IMessageCenter} - * @memberof IApiIBizsys - */ - mc: IMessageCenter; - /** - * @description 国际化工具 - * @type {IApiI18n} - * @memberof IApiIBizsys - */ - i18n: IApiI18n; - /** - * @description sass 模式下的中心系统数据 - * @type {IOrgData} - * @memberof IApiIBizsys - */ - orgData?: IOrgData; - /** - * @description 应用数据 - * @type {IApiData} - * @memberof IApiIBizsys - */ - appData?: IApiData; + /** + * @description 环境变量 + * @type {IEnvironment} + * @memberof IApiIBizsys + */ + env: IEnvironment; + /** + * @description 网络请求工具 + * @type {IApiNet} + * @memberof IApiIBizsys + */ + net: IApiNet; + /** + * @description 界面消息中心 + * @type {IMessageCenter} + * @memberof IApiIBizsys + */ + mc: IMessageCenter; + /** + * @description 国际化工具 + * @type {IApiI18n} + * @memberof IApiIBizsys + */ + i18n: IApiI18n; + /** + * @description sass 模式下的中心系统数据 + * @type {IOrgData} + * @memberof IApiIBizsys + */ + orgData?: IOrgData; + /** + * @description 应用数据 + * @type {IApiData} + * @memberof IApiIBizsys + */ + appData?: IApiData; } /** * @description 实体数据服务接口 @@ -1416,191 +1372,137 @@ export interface IApiIBizsys { * @interface IApiAppDEService */ export interface IApiAppDEService { - /** - * @description 是否本地模式(临时数据模式)，由 method.dto.ts 在 DTO 填充，根据是否为子嵌套数据进行设置 - * @type {boolean} - * @memberof IApiAppDEService - */ - isLocalMode: boolean; - /** - * @description 当前实体服务对应的实体模型 - * @type {IAppDataEntity} - * @memberof IApiAppDEService - */ - readonly model: IAppDataEntity$1; - /** - * @description 执行实体服务方法 - * @param {string} id - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @param {IApiData} [header] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - exec( - id: string, - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - header?: IApiData, - ): Promise; - /** - * @description 获取草稿数据[系统预置] - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - getDraft( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 获取草稿数据[系统预置](临时数据) - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - getDraftTemp( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 创建数据[系统预置] - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - create( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 创建数据[系统预置](临时数据) - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - createTemp( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 获取数据[系统预置] - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - get( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 获取数据[系统预置](临时数据) - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - getTemp( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 更新数据[系统预置] - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - update( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 更新数据[系统预置](临时数据) - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - updateTemp( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 删除数据[系统预置] - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - remove( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 删除数据[系统预置](临时数据) - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - removeTemp( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 获取默认数据集[系统预置] - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - fetchDefault( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; - /** - * @description 获取默认数据集[系统预置](临时数据) - * @param {IApiContext} context - * @param {(IApiData | IApiData[])} [params] - * @param {IApiParams} [params2] - * @returns {*} {Promise} - * @memberof IApiAppDEService - */ - fetchTempDefault( - context: IApiContext, - params?: IApiData | IApiData[], - params2?: IApiParams, - ): Promise; + /** + * @description 是否本地模式(临时数据模式)，由 method.dto.ts 在 DTO 填充，根据是否为子嵌套数据进行设置 + * @type {boolean} + * @memberof IApiAppDEService + */ + isLocalMode: boolean; + /** + * @description 当前实体服务对应的实体模型 + * @type {IAppDataEntity} + * @memberof IApiAppDEService + */ + readonly model: IAppDataEntity$1; + /** + * @description 执行实体服务方法 + * @param {string} id + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @param {IApiData} [header] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + exec(id: string, context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams, header?: IApiData): Promise; + /** + * @description 获取草稿数据[系统预置] + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + getDraft(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 获取草稿数据[系统预置](临时数据) + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + getDraftTemp(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 创建数据[系统预置] + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + create(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 创建数据[系统预置](临时数据) + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + createTemp(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 获取数据[系统预置] + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + get(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 获取数据[系统预置](临时数据) + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + getTemp(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 更新数据[系统预置] + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + update(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 更新数据[系统预置](临时数据) + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + updateTemp(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 删除数据[系统预置] + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + remove(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 删除数据[系统预置](临时数据) + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + removeTemp(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 获取默认数据集[系统预置] + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + fetchDefault(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; + /** + * @description 获取默认数据集[系统预置](临时数据) + * @param {IApiContext} context + * @param {(IApiData | IApiData[])} [params] + * @param {IApiParams} [params2] + * @returns {*} {Promise} + * @memberof IApiAppDEService + */ + fetchTempDefault(context: IApiContext, params?: IApiData | IApiData[], params2?: IApiParams): Promise; } /** * @description 实体服务构造工具接口 @@ -1608,39 +1510,32 @@ export interface IApiAppDEService { * @interface IApiDEServiceUtil */ export interface IApiDEServiceUtil { - /** - * @description 根据实体标识获取实体服务 - * @param {IApiContext} context - * @param {string} id - * @returns {*} {Promise} - * @memberof IApiDEServiceUtil - */ - getService(context: IApiContext, id: string): Promise; - /** - * @description 重置服务, 删除指定域下的所有服务缓存 - * @param {IApiContext} context - * @memberof IApiDEServiceUtil - */ - reset(context: IApiContext): void; - /** - * @description 执行服务方法 - * @param {string} appDataEntityId 实体名称 - * @param {string} methodName 方法名 - * @param {IApiContext} context 上下文 - * @param {(IApiData | IApiData[] | undefined)} [params] 数据 - * @param {(IApiParams | undefined)} [params2] 视图参数 - * @param {IApiData} [header] - * @returns {*} {Promise>} - * @memberof IApiDEServiceUtil - */ - exec( - appDataEntityId: string, - methodName: string, - context: IApiContext, - params?: IApiData | IApiData[] | undefined, - params2?: IApiParams | undefined, - header?: IApiData, - ): Promise>; + /** + * @description 根据实体标识获取实体服务 + * @param {IApiContext} context + * @param {string} id + * @returns {*} {Promise} + * @memberof IApiDEServiceUtil + */ + getService(context: IApiContext, id: string): Promise; + /** + * @description 重置服务, 删除指定域下的所有服务缓存 + * @param {IApiContext} context + * @memberof IApiDEServiceUtil + */ + reset(context: IApiContext): void; + /** + * @description 执行服务方法 + * @param {string} appDataEntityId 实体名称 + * @param {string} methodName 方法名 + * @param {IApiContext} context 上下文 + * @param {(IApiData | IApiData[] | undefined)} [params] 数据 + * @param {(IApiParams | undefined)} [params2] 视图参数 + * @param {IApiData} [header] + * @returns {*} {Promise>} + * @memberof IApiDEServiceUtil + */ + exec(appDataEntityId: string, methodName: string, context: IApiContext, params?: IApiData | IApiData[] | undefined, params2?: IApiParams | undefined, header?: IApiData): Promise>; } /** * @description 代码项数据接口 @@ -1648,108 +1543,108 @@ export interface IApiDEServiceUtil { * @interface CodeListItem */ export interface CodeListItem { - /** - * @description 值 - * @type {(string | number)} - * @memberof CodeListItem - */ - value: string | number; - /** - * @description 文本 - * @type {string} - * @memberof CodeListItem - */ - text: string; - /** - * @description 代码标识 - * @type {string} - * @memberof CodeListItem - */ - id: string; - /** - * @description 颜色 - * @type {string} - * @memberof CodeListItem - */ - color?: string; - /** - * @description 背景颜色 - * @type {string} - * @memberof CodeListItem - */ - bkcolor?: string; - /** - * @description 子代码项 - * @type {CodeListItem[]} - * @memberof CodeListItem - */ - children?: CodeListItem[]; - /** - * @description 文本样式 - * @type {string} - * @memberof CodeListItem - */ - textCls?: string; - /** - * @description 样式表名称 - * @type {string} - * @memberof CodeListItem - */ - cls?: string; - /** - * @description 禁止选择 - * @type {boolean} - * @memberof CodeListItem - */ - disableSelect?: boolean; - /** - * @description 图标对象 - * @type {ISysImage} - * @memberof CodeListItem - */ - sysImage?: ISysImage; - /** - * @description 代码项数据 - * @type {IApiData} - * @memberof CodeListItem - */ - data?: IApiData; - /** - * @description 提示信息 - * @type {string} - * @memberof CodeListItem - */ - tooltip?: string; - /** - * @description 代码表标记 - * @type {string} - * @memberof CodeListItem - */ - userData?: string; - /** - * @description 阈值起始值 - * @type {number} - * @memberof CodeListItem - */ - beginValue?: number; - /** - * @description 阈值结束值 - * @type {number} - * @memberof CodeListItem - */ - endValue?: number; - /** - * @description 包含阈值起始值 - * @type {boolean} - * @memberof CodeListItem - */ - includeBeginValue?: boolean; - /** - * @description 包含阈值结束值 - * @type {boolean} - * @memberof CodeListItem - */ - includeEndValue?: boolean; + /** + * @description 值 + * @type {(string | number)} + * @memberof CodeListItem + */ + value: string | number; + /** + * @description 文本 + * @type {string} + * @memberof CodeListItem + */ + text: string; + /** + * @description 代码标识 + * @type {string} + * @memberof CodeListItem + */ + id: string; + /** + * @description 颜色 + * @type {string} + * @memberof CodeListItem + */ + color?: string; + /** + * @description 背景颜色 + * @type {string} + * @memberof CodeListItem + */ + bkcolor?: string; + /** + * @description 子代码项 + * @type {CodeListItem[]} + * @memberof CodeListItem + */ + children?: CodeListItem[]; + /** + * @description 文本样式 + * @type {string} + * @memberof CodeListItem + */ + textCls?: string; + /** + * @description 样式表名称 + * @type {string} + * @memberof CodeListItem + */ + cls?: string; + /** + * @description 禁止选择 + * @type {boolean} + * @memberof CodeListItem + */ + disableSelect?: boolean; + /** + * @description 图标对象 + * @type {ISysImage} + * @memberof CodeListItem + */ + sysImage?: ISysImage; + /** + * @description 代码项数据 + * @type {IApiData} + * @memberof CodeListItem + */ + data?: IApiData; + /** + * @description 提示信息 + * @type {string} + * @memberof CodeListItem + */ + tooltip?: string; + /** + * @description 代码表标记 + * @type {string} + * @memberof CodeListItem + */ + userData?: string; + /** + * @description 阈值起始值 + * @type {number} + * @memberof CodeListItem + */ + beginValue?: number; + /** + * @description 阈值结束值 + * @type {number} + * @memberof CodeListItem + */ + endValue?: number; + /** + * @description 包含阈值起始值 + * @type {boolean} + * @memberof CodeListItem + */ + includeBeginValue?: boolean; + /** + * @description 包含阈值结束值 + * @type {boolean} + * @memberof CodeListItem + */ + includeEndValue?: boolean; } /** * @description 代码表服务接口 @@ -1757,41 +1652,32 @@ export interface CodeListItem { * @interface IApiCodeListService */ export interface IApiCodeListService { - /** - * @description 获取代码表模型 - * @param {string} tag - * @returns {*} {(IAppCodeList | undefined)} - * @memberof IApiCodeListService - */ - getCodeList(tag: string): IAppCodeList | undefined; - /** - * @description 获取指定代码表所有代码表项 - * @param {string} tag - * @param {IApiContext} context - * @param {IApiParams} [params] - * @returns {*} {Promise; - /** - * @description 获取指定代码表指定值对应的代码表项 - * @param {string} tag 代码表标识 - * @param {(string | number)} value 代码项值 - * @param {IApiContext} context 上下文 - * @param {IApiParams} [params] 视图参数 - * @returns {*} {Promise} - * @memberof IApiCodeListService - */ - getItem( - tag: string, - value: string | number, - context: IApiContext, - params?: IApiParams, - ): Promise; + /** + * @description 获取代码表模型 + * @param {string} tag + * @returns {*} {(IAppCodeList | undefined)} + * @memberof IApiCodeListService + */ + getCodeList(tag: string): IAppCodeList | undefined; + /** + * @description 获取指定代码表所有代码表项 + * @param {string} tag + * @param {IApiContext} context + * @param {IApiParams} [params] + * @returns {*} {Promise; + /** + * @description 获取指定代码表指定值对应的代码表项 + * @param {string} tag 代码表标识 + * @param {(string | number)} value 代码项值 + * @param {IApiContext} context 上下文 + * @param {IApiParams} [params] 视图参数 + * @returns {*} {Promise} + * @memberof IApiCodeListService + */ + getItem(tag: string, value: string | number, context: IApiContext, params?: IApiParams): Promise; } /** * @description 权限结果 @@ -1799,18 +1685,18 @@ export interface IApiCodeListService { * @interface IApiAuthResult */ export interface IApiAuthResult { - /** - * @description 是否成功 - * @type {boolean} - * @memberof IApiAuthResult - */ - ok: boolean; - /** - * @description 结果 - * @type {IApiData} - * @memberof IApiAuthResult - */ - result: IApiData; + /** + * @description 是否成功 + * @type {boolean} + * @memberof IApiAuthResult + */ + ok: boolean; + /** + * @description 结果 + * @type {IApiData} + * @memberof IApiAuthResult + */ + result: IApiData; } /** * @description 应用中心控制器 @@ -1818,88 +1704,66 @@ export interface IApiAuthResult { * @interface IApiAppHubController */ export interface IApiAppHubController { - /** - * @description 全局共享数据对象 - * @type {IApiData} - * @memberof IApiAppHubController - */ - session: IApiData; - /** - * @description 登录（包含调用登录逻辑，及跳转应用界面） - * @param {string} loginName - * @param {string} password - * @param {boolean} [remember] - * @param {IApiData} [headers] - * @param {IApiData} [opts] - * @returns {*} {Promise} - * @memberof IApiAppHubController - */ - login( - loginName: string, - password: string, - remember?: boolean, - headers?: IApiData, - opts?: IApiData, - ): Promise; - /** - * @description 登出 - * @param {IApiData} [opts] - * @returns {*} {Promise} - * @memberof IApiAppHubController - */ - logout(opts?: IApiData): Promise; - /** - * @description 变更密码 - * @param {string} oldPwd - * @param {string} newPwd - * @param {IApiData} [opts] - * @returns {*} {Promise} - * @memberof IApiAppHubController - */ - changePwd( - oldPwd: string, - newPwd: string, - opts?: IApiData, - ): Promise; - /** - * @description 切换组织 - * @param {string} oldOrgId - * @param {string} newOrgId - * @param {IApiData} [opts] - * @returns {*} {Promise} - * @memberof IApiAppHubController - */ - switchOrg( - oldOrgId: string, - newOrgId: string, - opts?: IApiData, - ): Promise; - /** - * @description 切换主题 - * @param {string} oldTheme - * @param {string} newTheme - * @param {IApiData} [opts] - * @returns {*} {Promise} - * @memberof IApiAppHubController - */ - switchTheme( - oldTheme: string, - newTheme: string, - opts?: IApiData, - ): Promise; - /** - * @description 切换语言 - * @param {string} oldLanguage - * @param {string} newLanguage - * @param {IApiData} [opts] - * @returns {*} {Promise} - * @memberof IApiAppHubController - */ - switchLanguage( - oldLanguage: string, - newLanguage: string, - opts?: IApiData, - ): Promise; + /** + * @description 全局共享数据对象 + * @type {IApiData} + * @memberof IApiAppHubController + */ + session: IApiData; + /** + * @description 登录（包含调用登录逻辑，及跳转应用界面） + * @param {string} loginName + * @param {string} password + * @param {boolean} [remember] + * @param {IApiData} [headers] + * @param {IApiData} [opts] + * @returns {*} {Promise} + * @memberof IApiAppHubController + */ + login(loginName: string, password: string, remember?: boolean, headers?: IApiData, opts?: IApiData): Promise; + /** + * @description 登出 + * @param {IApiData} [opts] + * @returns {*} {Promise} + * @memberof IApiAppHubController + */ + logout(opts?: IApiData): Promise; + /** + * @description 变更密码 + * @param {string} oldPwd + * @param {string} newPwd + * @param {IApiData} [opts] + * @returns {*} {Promise} + * @memberof IApiAppHubController + */ + changePwd(oldPwd: string, newPwd: string, opts?: IApiData): Promise; + /** + * @description 切换组织 + * @param {string} oldOrgId + * @param {string} newOrgId + * @param {IApiData} [opts] + * @returns {*} {Promise} + * @memberof IApiAppHubController + */ + switchOrg(oldOrgId: string, newOrgId: string, opts?: IApiData): Promise; + /** + * @description 切换主题 + * @param {string} oldTheme + * @param {string} newTheme + * @param {IApiData} [opts] + * @returns {*} {Promise} + * @memberof IApiAppHubController + */ + switchTheme(oldTheme: string, newTheme: string, opts?: IApiData): Promise; + /** + * @description 切换语言 + * @param {string} oldLanguage + * @param {string} newLanguage + * @param {IApiData} [opts] + * @returns {*} {Promise} + * @memberof IApiAppHubController + */ + switchLanguage(oldLanguage: string, newLanguage: string, opts?: IApiData): Promise; } /** * @description 应用服务接口 @@ -1907,47 +1771,47 @@ export interface IApiAppHubController { * @interface IApiAppService */ export interface IApiAppService { - /** - * @description 当前应用标识(带系统标识) - * @type {string} - * @memberof IApiAppService - */ - readonly appId: string; - /** - * @description 当前应用标识(仅标识) - * @type {string} - * @memberof IApiAppService - */ - readonly id: string; - /** - * @description 应用模型 - * @type {IApplication} - * @memberof IApiAppService - */ - readonly model: IApplication; - /** - * @description 请求服务 - * @type {IApiNet} - * @memberof IApiAppService - */ - readonly net: IApiNet; - /** - * @description 实体服务工具类 - * @type {IApiDEServiceUtil} - * @memberof IApiAppService - */ - readonly deService: IApiDEServiceUtil; - /** - * @description 代码表服务 - * @type {IApiCodeListService} - * @memberof IApiAppService - */ - readonly codeList: IApiCodeListService; - /** - * @description 销毁应用 - * @memberof IApiAppService - */ - destroy(): void; + /** + * @description 当前应用标识(带系统标识) + * @type {string} + * @memberof IApiAppService + */ + readonly appId: string; + /** + * @description 当前应用标识(仅标识) + * @type {string} + * @memberof IApiAppService + */ + readonly id: string; + /** + * @description 应用模型 + * @type {IApplication} + * @memberof IApiAppService + */ + readonly model: IApplication; + /** + * @description 请求服务 + * @type {IApiNet} + * @memberof IApiAppService + */ + readonly net: IApiNet; + /** + * @description 实体服务工具类 + * @type {IApiDEServiceUtil} + * @memberof IApiAppService + */ + readonly deService: IApiDEServiceUtil; + /** + * @description 代码表服务 + * @type {IApiCodeListService} + * @memberof IApiAppService + */ + readonly codeList: IApiCodeListService; + /** + * @description 销毁应用 + * @memberof IApiAppService + */ + destroy(): void; } /** * @description 应用中心服务接口 @@ -1955,89 +1819,85 @@ export interface IApiAppService { * @interface IApiAppHubService */ export interface IApiAppHubService { - /** - * @description 全局控制器，放置全局性的功能性方法 - * @type {IApiAppHubController} - * @memberof IApiAppHubService - */ - readonly controller: IApiAppHubController; - /** - * @description 默认应用首页视图 - * @type {string} - * @memberof IApiAppHubService - */ - defaultAppIndexViewName: string; - /** - * @description 默认页面（用于匿名访问获取默认页面数据） - * @type {(IModel | undefined)} - * @memberof IApiAppHubService - */ - defaultPage: IModel | undefined; - /** - * @description 根据应用视图 codeName 或 id 获取应用视图模型 - * @param {string} tag - * @returns {*} {Promise} - * @memberof IApiAppHubService - */ - getAppView(tag: string): Promise; - /** - * @description 获取应用实体模型 - * @param {string} id - * @param {string} [appId] - * @returns {*} {Promise} - * @memberof IApiAppHubService - */ - getAppDataEntity(id: string, appId?: string): Promise; - /** - * @description 异步获取应用对象，用于不确定应用是否已经加载的情况 - * @param {string} [appId=ibiz.env.appId] - * @returns {*} {Promise} - * @memberof IApiAppHubService - */ - getAppAsync(appId?: string): Promise; - /** - * @description 获取应用实例 - * @param {(string | IApplication)} [app] - * @returns {*} {IApiAppService} - * @memberof IApiAppHubService - */ - getApp(app?: string | IApplication): IApiAppService; - /** - * @description 获取所有应用实例 - * @returns {*} {IApiAppService[]} - * @memberof IApiAppHubService - */ - getAllApps(): IApiAppService[]; - /** - * @description 通过标识获取应用对象 - * @param {string} id - * @returns {*} {(IApiAppService | undefined)} - * @memberof IApiAppHubService - */ - getAppById(id: string): IApiAppService | undefined; - /** - * @description 获取应用实体服务 - * @param {string} appId - * @param {string} entityId - * @param {IApiContext} context - * @returns {*} {Promise} - * @memberof IApiAppHubService - */ - getAppDEService( - appId: string, - entityId: string, - context: IApiContext, - ): Promise; - /** - * @description 重置清空应用中心 - * @memberof IApiAppHubService - */ - reset(): void; - /** - * @description 销毁应用中心 - * @memberof IApiAppHubService - */ - destroy(): void; + /** + * @description 全局控制器，放置全局性的功能性方法 + * @type {IApiAppHubController} + * @memberof IApiAppHubService + */ + readonly controller: IApiAppHubController; + /** + * @description 默认应用首页视图 + * @type {string} + * @memberof IApiAppHubService + */ + defaultAppIndexViewName: string; + /** + * @description 默认页面（用于匿名访问获取默认页面数据） + * @type {(IModel | undefined)} + * @memberof IApiAppHubService + */ + defaultPage: IModel | undefined; + /** + * @description 根据应用视图 codeName 或 id 获取应用视图模型 + * @param {string} tag + * @returns {*} {Promise} + * @memberof IApiAppHubService + */ + getAppView(tag: string): Promise; + /** + * @description 获取应用实体模型 + * @param {string} id + * @param {string} [appId] + * @returns {*} {Promise} + * @memberof IApiAppHubService + */ + getAppDataEntity(id: string, appId?: string): Promise; + /** + * @description 异步获取应用对象，用于不确定应用是否已经加载的情况 + * @param {string} [appId=ibiz.env.appId] + * @returns {*} {Promise} + * @memberof IApiAppHubService + */ + getAppAsync(appId?: string): Promise; + /** + * @description 获取应用实例 + * @param {(string | IApplication)} [app] + * @returns {*} {IApiAppService} + * @memberof IApiAppHubService + */ + getApp(app?: string | IApplication): IApiAppService; + /** + * @description 获取所有应用实例 + * @returns {*} {IApiAppService[]} + * @memberof IApiAppHubService + */ + getAllApps(): IApiAppService[]; + /** + * @description 通过标识获取应用对象 + * @param {string} id + * @returns {*} {(IApiAppService | undefined)} + * @memberof IApiAppHubService + */ + getAppById(id: string): IApiAppService | undefined; + /** + * @description 获取应用实体服务 + * @param {string} appId + * @param {string} entityId + * @param {IApiContext} context + * @returns {*} {Promise} + * @memberof IApiAppHubService + */ + getAppDEService(appId: string, entityId: string, context: IApiContext): Promise; + /** + * @description 重置清空应用中心 + * @memberof IApiAppHubService + */ + reset(): void; + /** + * @description 销毁应用中心 + * @memberof IApiAppHubService + */ + destroy(): void; } /** * @description 全局菜单配置 @@ -2045,13 +1905,13 @@ export interface IApiAppHubService { * @interface IApiGlobalAppMenuConfig */ export interface IApiGlobalAppMenuConfig { - /** - * @description 菜单是否根据路由回显激活项，true：回显/false：不回显 - * @type {boolean} - * @default false - * @memberof IApiGlobalAppMenuConfig - */ - enableEcho: boolean; + /** + * @description 菜单是否根据路由回显激活项，true：回显/false：不回显 + * @type {boolean} + * @default false + * @memberof IApiGlobalAppMenuConfig + */ + enableEcho: boolean; } /** * @description 全局代码表配置 @@ -2059,13 +1919,13 @@ export interface IApiGlobalAppMenuConfig { * @interface IApiGlobalCodeListConfig */ export interface IApiGlobalCodeListConfig { - /** - * @description 默认代码表超时时间(单位：毫秒) - * @type {number} - * @default 60 * 60 * 1000 - * @memberof IApiGlobalCodeListConfig - */ - timeout: number; + /** + * @description 默认代码表超时时间(单位：毫秒) + * @type {number} + * @default 60 * 60 * 1000 + * @memberof IApiGlobalCodeListConfig + */ + timeout: number; } /** * @description 全局通用配置 @@ -2073,24 +1933,24 @@ export interface IApiGlobalCodeListConfig { * @interface IApiGlobalCommonConfig */ export interface IApiGlobalCommonConfig { - /** - * @description 无值显示文本 - * @type {string} - * @memberof IApiGlobalCommonConfig - */ - emptyText: string; - /** - * @description 模态参数 - * @type {string} - * @memberof IApiGlobalCommonConfig - */ - modalOption?: string; - /** - * @description 抽屉参数 - * @type {string} - * @memberof IApiGlobalCommonConfig - */ - drawerOption?: string; + /** + * @description 无值显示文本 + * @type {string} + * @memberof IApiGlobalCommonConfig + */ + emptyText: string; + /** + * @description 模态参数 + * @type {string} + * @memberof IApiGlobalCommonConfig + */ + modalOption?: string; + /** + * @description 抽屉参数 + * @type {string} + * @memberof IApiGlobalCommonConfig + */ + drawerOption?: string; } /** * @description 全局表单配置 @@ -2098,36 +1958,36 @@ export interface IApiGlobalCommonConfig { * @interface IApiGlobalFormConfig */ export interface IApiGlobalFormConfig { - /** - * @description 多数据部件删除前是否需要确认 - * @type {boolean} - * @memberof IApiGlobalFormConfig - */ - mdCtrlConfirmBeforeRemove: boolean; - /** - * @description 是否展示表单项下方下划线 - * @type {boolean} - * @memberof IApiGlobalFormConfig - */ - mobShowUnderLine: boolean; - /** - * @description 文本在输入框中的位置 - * @type {('right' | 'left' | '')} - * @memberof IApiGlobalFormConfig - */ - mobFormItemAlignMode: 'right' | 'left' | ''; - /** - * @description 是否显示表单项边框 - * @type {boolean} - * @memberof IApiGlobalFormConfig - */ - mobShowEditorBorder: boolean; - /** - * @description 隐藏无值的单位 - * @type {boolean} - * @memberof IApiGlobalFormConfig - */ - emptyHiddenUnit: boolean; + /** + * @description 多数据部件删除前是否需要确认 + * @type {boolean} + * @memberof IApiGlobalFormConfig + */ + mdCtrlConfirmBeforeRemove: boolean; + /** + * @description 是否展示表单项下方下划线 + * @type {boolean} + * @memberof IApiGlobalFormConfig + */ + mobShowUnderLine: boolean; + /** + * @description 文本在输入框中的位置 + * @type {('right' | 'left' | '')} + * @memberof IApiGlobalFormConfig + */ + mobFormItemAlignMode: "right" | "left" | ""; + /** + * @description 是否显示表单项边框 + * @type {boolean} + * @memberof IApiGlobalFormConfig + */ + mobShowEditorBorder: boolean; + /** + * @description 隐藏无值的单位 + * @type {boolean} + * @memberof IApiGlobalFormConfig + */ + emptyHiddenUnit: boolean; } /** * @description 全局表格配置 @@ -2135,39 +1995,39 @@ export interface IApiGlobalFormConfig { * @interface IApiGlobalGridConfig */ export interface IApiGlobalGridConfig { - /** - * @description 表格行编辑呈现模式 - * @type {('cell' | 'row' | 'all')} cell 每次只呈现悬浮点击之后的一个单元格的编辑态；row 每次呈现编辑中的那一行所有单元格的编辑态；all 呈现所有编辑项的编辑态 - * @default cell - * @memberof IApiGlobalGridConfig - */ - editShowMode: 'cell' | 'row' | 'all'; - /** - * @description 表格行编辑保存模式 - * @type {('cell-blur' | 'auto' | 'manual')} cell-blur 单元格失焦时保存整行数据；auto 自动保存，值变更之后一段时间保存整行数据；manual 手动保存，由界面行为调用表格整体保存或行保存 - * @default cell-blur - * @memberof IApiGlobalGridConfig - */ - editSaveMode: 'cell-blur' | 'auto' | 'manual'; - /** - * @description 表格保存错误处理模式 - * @type {('default' | 'reset')} default：表格保存失败，界面弹出错误信息，编辑错误项切换为错误状态（红色边框、hover显示错误信息）；reset：表格保存失败，界面弹出错误信息，编辑错误项还原为保存之前的值 - * @default default - * @memberof IApiGlobalGridConfig - */ - saveErrorHandleMode: 'default' | 'reset'; - /** - * @description 单元格超出呈现模式 - * @type {('wrap' | 'ellipsis')}wrap 换行，高度自动增高；ellipsis 省略，出...，悬浮出tooltip - * @memberof IApiGlobalGridConfig - */ - overflowMode: 'wrap' | 'ellipsis'; - /** - * @description 隐藏无值的单位 - * @type {boolean} - * @memberof IApiGlobalGridConfig - */ - emptyHiddenUnit: boolean; + /** + * @description 表格行编辑呈现模式 + * @type {('cell' | 'row' | 'all')} cell 每次只呈现悬浮点击之后的一个单元格的编辑态；row 每次呈现编辑中的那一行所有单元格的编辑态；all 呈现所有编辑项的编辑态 + * @default cell + * @memberof IApiGlobalGridConfig + */ + editShowMode: "cell" | "row" | "all"; + /** + * @description 表格行编辑保存模式 + * @type {('cell-blur' | 'auto' | 'manual')} cell-blur 单元格失焦时保存整行数据；auto 自动保存，值变更之后一段时间保存整行数据；manual 手动保存，由界面行为调用表格整体保存或行保存 + * @default cell-blur + * @memberof IApiGlobalGridConfig + */ + editSaveMode: "cell-blur" | "auto" | "manual"; + /** + * @description 表格保存错误处理模式 + * @type {('default' | 'reset')} default：表格保存失败，界面弹出错误信息，编辑错误项切换为错误状态（红色边框、hover显示错误信息）；reset：表格保存失败，界面弹出错误信息，编辑错误项还原为保存之前的值 + * @default default + * @memberof IApiGlobalGridConfig + */ + saveErrorHandleMode: "default" | "reset"; + /** + * @description 单元格超出呈现模式 + * @type {('wrap' | 'ellipsis')}wrap 换行，高度自动增高；ellipsis 省略，出...，悬浮出tooltip + * @memberof IApiGlobalGridConfig + */ + overflowMode: "wrap" | "ellipsis"; + /** + * @description 隐藏无值的单位 + * @type {boolean} + * @memberof IApiGlobalGridConfig + */ + emptyHiddenUnit: boolean; } /** * @description 全局选择类编辑器配置 @@ -2175,13 +2035,13 @@ export interface IApiGlobalGridConfig { * @interface IApiGlobalPickerEditorConfig */ export interface IApiGlobalPickerEditorConfig { - /** - * @description 宽度模式 - * @type {('auto' | 'ellipsis')} auto 宽度自动延长；ellipsis 内容超出时出省略号，鼠标悬浮出现tooltip提示 - * @default auto - * @memberof IApiGlobalPickerEditorConfig - */ - overflowMode: 'auto' | 'ellipsis'; + /** + * @description 宽度模式 + * @type {('auto' | 'ellipsis')} auto 宽度自动延长；ellipsis 内容超出时出省略号，鼠标悬浮出现tooltip提示 + * @default auto + * @memberof IApiGlobalPickerEditorConfig + */ + overflowMode: "auto" | "ellipsis"; } /** * @description 搜索表单全局配置 @@ -2189,12 +2049,12 @@ export interface IApiGlobalPickerEditorConfig { * @interface IApiGlobalSearchFormConfig */ export interface IApiGlobalSearchFormConfig { - /** - * @description 启用存储过滤条件 - * @type {boolean} - * @memberof IApiGlobalSearchFormConfig - */ - enableStoredFilters: boolean; + /** + * @description 启用存储过滤条件 + * @type {boolean} + * @memberof IApiGlobalSearchFormConfig + */ + enableStoredFilters: boolean; } /** * @description 全局树配置 @@ -2202,12 +2062,12 @@ export interface IApiGlobalSearchFormConfig { * @interface IApiGlobalTreeConfig */ export interface IApiGlobalTreeConfig { - /** - * @description 右键单击显示上下文菜单 - * @type {boolean} - * @memberof IApiGlobalTreeConfig - */ - contextMenuRightClickInvoke: boolean; + /** + * @description 右键单击显示上下文菜单 + * @type {boolean} + * @memberof IApiGlobalTreeConfig + */ + contextMenuRightClickInvoke: boolean; } /** * @description 全局视图配置 @@ -2215,36 +2075,36 @@ export interface IApiGlobalTreeConfig { * @interface IApiGlobalViewConfig */ export interface IApiGlobalViewConfig { - /** - * @description 是否启用信息栏 - * @type {boolean} true：才会识别模型的isShowDataInfoBar来控制是否显示信息栏；false：则一律不显示信息栏 - * @memberof IApiGlobalViewConfig - */ - enableDataInfoBar: boolean; - /** - * @description 用于控制全局哪些导航部件启用缓存，全大写。判断时将使用 `部件类型:` 的方式进行判断，如：TABEXPPANEL:，表示开启分页导航部件的缓存，多个部件用直接书写即可，必须用:结尾，如：TABEXPPANEL:GRIDEXPBAR: - * @type {string} - * @memberof IApiGlobalViewConfig - */ - expCacheMode: string; - /** - * @description 首页是否不采用分页导航模式 - * @type {boolean} - * @memberof IApiGlobalViewConfig - */ - disableHomeTabs: boolean; - /** - * @description 移动端是否展示返回按键 - * @type {boolean} - * @memberof IApiGlobalViewConfig - */ - mobShowPresetBack: boolean; - /** - * @description 用户操作超时周期，默认300s - * @type {number} - * @memberof IApiGlobalViewConfig - */ - timeoutDuration: number; + /** + * @description 是否启用信息栏 + * @type {boolean} true：才会识别模型的isShowDataInfoBar来控制是否显示信息栏；false：则一律不显示信息栏 + * @memberof IApiGlobalViewConfig + */ + enableDataInfoBar: boolean; + /** + * @description 用于控制全局哪些导航部件启用缓存，全大写。判断时将使用 `部件类型:` 的方式进行判断，如：TABEXPPANEL:，表示开启分页导航部件的缓存，多个部件用直接书写即可，必须用:结尾，如：TABEXPPANEL:GRIDEXPBAR: + * @type {string} + * @memberof IApiGlobalViewConfig + */ + expCacheMode: string; + /** + * @description 首页是否不采用分页导航模式 + * @type {boolean} + * @memberof IApiGlobalViewConfig + */ + disableHomeTabs: boolean; + /** + * @description 移动端是否展示返回按键 + * @type {boolean} + * @memberof IApiGlobalViewConfig + */ + mobShowPresetBack: boolean; + /** + * @description 用户操作超时周期，默认300s + * @type {number} + * @memberof IApiGlobalViewConfig + */ + timeoutDuration: number; } /** * @description 全局配置接口 @@ -2252,78 +2112,78 @@ export interface IApiGlobalViewConfig { * @interface IApiGlobalConfig */ export interface IApiGlobalConfig { - /** - * @description 应用默认主题 - * @type {('light' | 'dark' | 'blue')} (亮色|暗色|蓝色) - * @memberof IApiGlobalConfig - */ - theme?: 'light' | 'dark' | 'blue'; - /** - * @description 全局视图配置 - * @type {IApiGlobalViewConfig} - * @memberof IApiGlobalConfig - */ - view: IApiGlobalViewConfig; - /** - * @description 全局表格配置 - * @type {IApiGlobalGridConfig} - * @memberof IApiGlobalConfig - */ - grid: IApiGlobalGridConfig; - /** - * @description 全局菜单配置 - * @type {IApiGlobalAppMenuConfig} - * @memberof IApiGlobalConfig - */ - appMenu: IApiGlobalAppMenuConfig; - /** - * @description 全局代码表配置 - * @type {IApiGlobalCodeListConfig} - * @memberof IApiGlobalConfig - */ - codeList: IApiGlobalCodeListConfig; - /** - * @description 全局表单配置 - * @type {IApiGlobalFormConfig} - * @memberof IApiGlobalConfig - */ - form: IApiGlobalFormConfig; - /** - * @description 全局下拉选择类编辑器配置 - * @type {IApiGlobalPickerEditorConfig} - * @memberof IApiGlobalConfig - */ - pickerEditor: IApiGlobalPickerEditorConfig; - /** - * @description 全局搜索表单配置 - * @type {IApiGlobalSearchFormConfig} - * @memberof IApiGlobalConfig - */ - searchform: IApiGlobalSearchFormConfig; - /** - * @description 全局树配置 - * @type {IApiGlobalTreeConfig} - * @memberof IApiGlobalConfig - */ - tree: IApiGlobalTreeConfig; - /** - * @description 全局通用配置 - * @type {IApiGlobalCommonConfig} - * @memberof IApiGlobalConfig - */ - common: IApiGlobalCommonConfig; - /** - * @description 多数据部件默认排序配置 - * @type {string} - * @memberof IApiGlobalConfig - */ - mdctrldefaultsort: string; - /** - * @description 下拉选择类编辑器默认排序配置 - * @type {string} - * @memberof IApiGlobalConfig - */ - pickerdefaultsort: string; + /** + * @description 应用默认主题 + * @type {('light' | 'dark' | 'blue')} (亮色|暗色|蓝色) + * @memberof IApiGlobalConfig + */ + theme?: "light" | "dark" | "blue"; + /** + * @description 全局视图配置 + * @type {IApiGlobalViewConfig} + * @memberof IApiGlobalConfig + */ + view: IApiGlobalViewConfig; + /** + * @description 全局表格配置 + * @type {IApiGlobalGridConfig} + * @memberof IApiGlobalConfig + */ + grid: IApiGlobalGridConfig; + /** + * @description 全局菜单配置 + * @type {IApiGlobalAppMenuConfig} + * @memberof IApiGlobalConfig + */ + appMenu: IApiGlobalAppMenuConfig; + /** + * @description 全局代码表配置 + * @type {IApiGlobalCodeListConfig} + * @memberof IApiGlobalConfig + */ + codeList: IApiGlobalCodeListConfig; + /** + * @description 全局表单配置 + * @type {IApiGlobalFormConfig} + * @memberof IApiGlobalConfig + */ + form: IApiGlobalFormConfig; + /** + * @description 全局下拉选择类编辑器配置 + * @type {IApiGlobalPickerEditorConfig} + * @memberof IApiGlobalConfig + */ + pickerEditor: IApiGlobalPickerEditorConfig; + /** + * @description 全局搜索表单配置 + * @type {IApiGlobalSearchFormConfig} + * @memberof IApiGlobalConfig + */ + searchform: IApiGlobalSearchFormConfig; + /** + * @description 全局树配置 + * @type {IApiGlobalTreeConfig} + * @memberof IApiGlobalConfig + */ + tree: IApiGlobalTreeConfig; + /** + * @description 全局通用配置 + * @type {IApiGlobalCommonConfig} + * @memberof IApiGlobalConfig + */ + common: IApiGlobalCommonConfig; + /** + * @description 多数据部件默认排序配置 + * @type {string} + * @memberof IApiGlobalConfig + */ + mdctrldefaultsort: string; + /** + * @description 下拉选择类编辑器默认排序配置 + * @type {string} + * @memberof IApiGlobalConfig + */ + pickerdefaultsort: string; } /** * @description 关闭视图返回数据接口 @@ -2331,24 +2191,24 @@ export interface IApiGlobalConfig { * @interface IApiModalData */ export interface IApiModalData { - /** - * @description 关闭视图是否操作成功 - * @type {boolean} - * @memberof IApiModalData - */ - ok: boolean; - /** - * @description 返回的数据 - * @type {IApiData[]} - * @memberof IApiModalData - */ - data?: IApiData[]; - /** - * @description 额外参数 - * @type {IApiParams} - * @memberof IApiModalData - */ - params?: IApiParams; + /** + * @description 关闭视图是否操作成功 + * @type {boolean} + * @memberof IApiModalData + */ + ok: boolean; + /** + * @description 返回的数据 + * @type {IApiData[]} + * @memberof IApiModalData + */ + data?: IApiData[]; + /** + * @description 额外参数 + * @type {IApiParams} + * @memberof IApiModalData + */ + params?: IApiParams; } /** * @description 覆盖容器配置参数 @@ -2356,31 +2216,31 @@ export interface IApiModalData { * @interface IApiOverlayContainerOptions */ export interface IApiOverlayContainerOptions { - /** - * @description 上下文环境对象,一般为当前视图的ctx对象 - * @type {IApiData} - * @memberof IApiOverlayContainerOptions - */ - ctx?: IApiData; -} -export declare type ApiAlignment = 'start' | 'end'; -export declare type ApiSide = 'top' | 'right' | 'bottom' | 'left'; + /** + * @description 上下文环境对象,一般为当前视图的ctx对象 + * @type {IApiData} + * @memberof IApiOverlayContainerOptions + */ + ctx?: IApiData; +} +export declare type ApiAlignment = "start" | "end"; +export declare type ApiSide = "top" | "right" | "bottom" | "left"; export declare type ApiAlignedPlacement = `${ApiSide}-${ApiAlignment}`; export declare type ApiPlacement = ApiSide | ApiAlignedPlacement; export interface IApiAxesOffsets { - /** - * @description 浮动元素与参考元素之间的间距 - * @type {number} - * @memberof IApiAxesOffsets - */ - mainAxis?: number; - /** - * @description 浮动元素与参考元素之间的偏移量，与mainAxis垂直 - * @type {number} - * @memberof IApiAxesOffsets - */ - crossAxis?: number; - alignmentAxis?: number | null; + /** + * @description 浮动元素与参考元素之间的间距 + * @type {number} + * @memberof IApiAxesOffsets + */ + mainAxis?: number; + /** + * @description 浮动元素与参考元素之间的偏移量，与mainAxis垂直 + * @type {number} + * @memberof IApiAxesOffsets + */ + crossAxis?: number; + alignmentAxis?: number | null; } /** * @description 飘窗参数 @@ -2389,54 +2249,54 @@ export interface IApiAxesOffsets { * @template O */ export interface IApiPopoverOptions { - /** - * @description 宽度,数字0-100的时候算百分比，100以上算像素px，字符串原样设置 - * @type {(string | number)} - * @memberof IApiPopoverOptions - */ - width?: string | number; - /** - * @description 高度,数字0-100的时候算百分比，100以上算像素px，字符串原样设置 - * @type {(string | number)} - * @memberof IApiPopoverOptions - */ - height?: string | number; - /** - * @description 展示方向 - * @type {ApiPlacement} - * @memberof IApiPopoverOptions - */ - placement?: ApiPlacement; - /** - * @description 是否自动关闭 - * @type {boolean} - * @memberof IApiPopoverOptions - */ - autoClose?: boolean; - /** - * @description 偏移参数 - * @type {(IApiAxesOffsets | number)} - * @memberof IApiPopoverOptions - */ - offsetOpts?: IApiAxesOffsets | number; - /** - * @description 不显示箭头 - * @type {boolean} - * @memberof IApiPopoverOptions - */ - noArrow?: boolean; - /** - * @description 原始飘窗参数 - * @type {O} - * @memberof IApiPopoverOptions - */ - options?: O; - /** - * @description 自定义飘窗的类名，用来自定义飘窗样式 - * @type {string} - * @memberof IApiPopoverOptions - */ - modalClass?: string; + /** + * @description 宽度,数字0-100的时候算百分比，100以上算像素px，字符串原样设置 + * @type {(string | number)} + * @memberof IApiPopoverOptions + */ + width?: string | number; + /** + * @description 高度,数字0-100的时候算百分比，100以上算像素px，字符串原样设置 + * @type {(string | number)} + * @memberof IApiPopoverOptions + */ + height?: string | number; + /** + * @description 展示方向 + * @type {ApiPlacement} + * @memberof IApiPopoverOptions + */ + placement?: ApiPlacement; + /** + * @description 是否自动关闭 + * @type {boolean} + * @memberof IApiPopoverOptions + */ + autoClose?: boolean; + /** + * @description 偏移参数 + * @type {(IApiAxesOffsets | number)} + * @memberof IApiPopoverOptions + */ + offsetOpts?: IApiAxesOffsets | number; + /** + * @description 不显示箭头 + * @type {boolean} + * @memberof IApiPopoverOptions + */ + noArrow?: boolean; + /** + * @description 原始飘窗参数 + * @type {O} + * @memberof IApiPopoverOptions + */ + options?: O; + /** + * @description 自定义飘窗的类名，用来自定义飘窗样式 + * @type {string} + * @memberof IApiPopoverOptions + */ + modalClass?: string; } /** * @description 重绘数据 @@ -2444,30 +2304,30 @@ export interface IApiPopoverOptions { * @interface IApiRedrawData */ export interface IApiRedrawData { - /** - * @description 上下文 - * @type {IApiContext} - * @memberof IApiRedrawData - */ - context: IApiContext; - /** - * @description 视图参数 - * @type {IApiParams} - * @memberof IApiRedrawData - */ - params: IApiParams; - /** - * @description 重绘数据 - * @type {IApiData[]} - * @memberof IApiRedrawData - */ - data?: IApiData[]; - /** - * @description 是否重载模型 - * @type {boolean} - * @memberof IApiRedrawData - */ - isReloadModel?: boolean; + /** + * @description 上下文 + * @type {IApiContext} + * @memberof IApiRedrawData + */ + context: IApiContext; + /** + * @description 视图参数 + * @type {IApiParams} + * @memberof IApiRedrawData + */ + params: IApiParams; + /** + * @description 重绘数据 + * @type {IApiData[]} + * @memberof IApiRedrawData + */ + data?: IApiData[]; + /** + * @description 是否重载模型 + * @type {boolean} + * @memberof IApiRedrawData + */ + isReloadModel?: boolean; } /** * @description 数据能力方法的通用入参 @@ -2475,30 +2335,50 @@ export interface IApiRedrawData { * @interface IApiDataAbilityParams */ export interface IApiDataAbilityParams { - /** - * @description 当前这次操作附加的上下文参数 - * @type {IApiContext} - * @memberof IApiDataAbilityParams - */ - context?: IApiContext; - /** - * @description 当前这次操作附加的视图参数 - * @type {IApiParams} - * @memberof IApiDataAbilityParams - */ - viewParam?: IApiParams; - /** - * @description 执行能力使用的数据集合,没有则使用数据部件自身的数据或选中数据 - * @type {(IApiData[] | IApiData)} - * @memberof IApiDataAbilityParams - */ - data?: IApiData[] | IApiData; - /** - * @description 是否静默执行，不出loading效果，不弹成功提示 - * @type {boolean} - * @memberof IApiDataAbilityParams - */ - silent?: boolean; + /** + * @description 当前这次操作附加的上下文参数 + * @type {IApiContext} + * @memberof IApiDataAbilityParams + */ + context?: IApiContext; + /** + * @description 当前这次操作附加的视图参数 + * @type {IApiParams} + * @memberof IApiDataAbilityParams + */ + viewParam?: IApiParams; + /** + * @description 执行能力使用的数据集合,没有则使用数据部件自身的数据或选中数据 + * @type {(IApiData[] | IApiData)} + * @memberof IApiDataAbilityParams + */ + data?: IApiData[] | IApiData; + /** + * @description 是否静默执行，不出loading效果，不弹成功提示 + * @type {boolean} + * @memberof IApiDataAbilityParams + */ + silent?: boolean; +} +export interface IApiSortItem { + /** + * @description 唯一标识 + * @type {string} + * @memberof IApiSortItem + */ + key: string; + /** + * @description 显示标题 + * @type {string} + * @memberof IApiSortItem + */ + caption: string; + /** + * @description 排序顺序 + * @type {('asc' | 'desc')} + * @memberof IApiSortItem + */ + order?: "asc" | "desc"; } /** * @description 可以调用force的控制器接口 @@ -2506,12 +2386,12 @@ export interface IApiDataAbilityParams { * @interface IApiEnforceableController */ export interface IApiEnforceableController { - /** - * @description 强制更新，触发render函数 - * @param {() => void} [_callback] 更新之后，组件渲染完成后的回调 - * @memberof IApiEnforceableController - */ - force(_callback?: () => void): void; + /** + * @description 强制更新，触发render函数 + * @param {() => void} [_callback] 更新之后，组件渲染完成后的回调 + * @memberof IApiEnforceableController + */ + force(_callback?: () => void): void; } /** * @description 控制器基类UI状态 @@ -2519,30 +2399,30 @@ export interface IApiEnforceableController { * @interface IApiControllerState */ export interface IApiControllerState { - /** - * @description 控制器是否走完created生命周期 - * @type {boolean} - * @memberof IApiControllerState - */ - isCreated: boolean; - /** - * @description 控制器是否走完mounted生命周期 - * @type {boolean} - * @memberof IApiControllerState - */ - isMounted: boolean; - /** - * @description 控制器是否走完destroy生命周期 - * @type {boolean} - * @memberof IApiControllerState - */ - isDestroyed: boolean; - /** - * @description 上下文 - * @type {IApiContext} - * @memberof IControllerState - */ - context: IApiContext; + /** + * @description 控制器是否走完created生命周期 + * @type {boolean} + * @memberof IApiControllerState + */ + isCreated: boolean; + /** + * @description 控制器是否走完mounted生命周期 + * @type {boolean} + * @memberof IApiControllerState + */ + isMounted: boolean; + /** + * @description 控制器是否走完destroy生命周期 + * @type {boolean} + * @memberof IApiControllerState + */ + isDestroyed: boolean; + /** + * @description 上下文 + * @type {IApiContext} + * @memberof IControllerState + */ + context: IApiContext; } /** * @description 布局子成员的通用UI属性 @@ -2550,36 +2430,36 @@ export interface IApiControllerState { * @interface IApiLayoutState */ export interface IApiLayoutState { - /** - * @description 布局宽度 - * @type {string} - * @memberof IApiLayoutState - */ - width: string; - /** - * @description 布局高度 - * @type {string} - * @memberof IApiLayoutState - */ - height: string; - /** - * @description 额外样式，对象格式 - * @type {IApiData} - * @memberof IApiLayoutState - */ - extraStyle: IApiData; - /** - * @description 额外类名 - * @type {string[]} - * @memberof IApiLayoutState - */ - extraClass: string[]; - /** - * @description 压制自身内容的样式 - * @type {IApiData} - * @memberof IApiLayoutState - */ - contentStyle: IApiData; + /** + * @description 布局宽度 + * @type {string} + * @memberof IApiLayoutState + */ + width: string; + /** + * @description 布局高度 + * @type {string} + * @memberof IApiLayoutState + */ + height: string; + /** + * @description 额外样式，对象格式 + * @type {IApiData} + * @memberof IApiLayoutState + */ + extraStyle: IApiData; + /** + * @description 额外类名 + * @type {string[]} + * @memberof IApiLayoutState + */ + extraClass: string[]; + /** + * @description 压制自身内容的样式 + * @type {IApiData} + * @memberof IApiLayoutState + */ + contentStyle: IApiData; } /** * @description 界面布局需要用到的成员通用状态 @@ -2587,24 +2467,24 @@ export interface IApiLayoutState { * @interface IApiColState */ export interface IApiColState { - /** - * @description 是否显示 - * @type {boolean} - * @memberof IApiColState - */ - visible: boolean; - /** - * @description 不显示时是否保活，使其功能保留 - * @type {boolean} - * @memberof IApiColState - */ - keepAlive: boolean; - /** - * @description 布局相关 - * @type {IApiLayoutState} - * @memberof IApiColState - */ - layout: IApiLayoutState; + /** + * @description 是否显示 + * @type {boolean} + * @memberof IApiColState + */ + visible: boolean; + /** + * @description 不显示时是否保活，使其功能保留 + * @type {boolean} + * @memberof IApiColState + */ + keepAlive: boolean; + /** + * @description 布局相关 + * @type {IApiLayoutState} + * @memberof IApiColState + */ + layout: IApiLayoutState; } /** * @description 按钮UI状态 @@ -2612,43 +2492,39 @@ export interface IApiColState { * @interface IApiButtonState */ export interface IApiButtonState { - /** - * @description 是否禁用 - * @type {boolean} - * @memberof IApiButtonState - */ - disabled: boolean; - /** - * @description 显示与否 - * @type {boolean} - * @memberof IApiButtonState - */ - visible: boolean; - /** - * @description 是否显示loading状态 - * @type {boolean} - * @memberof IApiButtonState - */ - loading: boolean; - /** - * @description 按钮的唯一标识 - * @type {string} - * @memberof IApiButtonState - */ - name: string; - /** - * @description 更新自身状态 - * @param {IApiContext} context 上下文 - * @param {IApiData} [data] 后台数据，可能不存在 - * @param {string} [appDeId] 实体标识 - * @returns {*} {Promise} - * @memberof IApiButtonState - */ - update( - context: IApiContext, - data?: IApiData, - appDeId?: string, - ): Promise; + /** + * @description 是否禁用 + * @type {boolean} + * @memberof IApiButtonState + */ + disabled: boolean; + /** + * @description 显示与否 + * @type {boolean} + * @memberof IApiButtonState + */ + visible: boolean; + /** + * @description 是否显示loading状态 + * @type {boolean} + * @memberof IApiButtonState + */ + loading: boolean; + /** + * @description 按钮的唯一标识 + * @type {string} + * @memberof IApiButtonState + */ + name: string; + /** + * @description 更新自身状态 + * @param {IApiContext} context 上下文 + * @param {IApiData} [data] 后台数据，可能不存在 + * @param {string} [appDeId] 实体标识 + * @returns {*} {Promise} + * @memberof IApiButtonState + */ + update(context: IApiContext, data?: IApiData, appDeId?: string): Promise; } /** * @description 按钮容器的状态 @@ -2656,38 +2532,34 @@ export interface IApiButtonState { * @interface IApiButtonContainerState */ export interface IApiButtonContainerState { - /** - * @description 是否显示 - * @type {boolean} - * @memberof IApiButtonContainerState - */ - visible: boolean; - /** - * @description 是否禁用 - * @type {boolean} - * @memberof IApiButtonContainerState - */ - disabled: boolean; - /** - * @description 设置当前执行的按钮 - * @param {string} name - * @memberof IApiButtonContainerState - */ - setLoading(name: string): void; - /** - * @description 更新子的状态 - * @param {IApiContext} context 上下文 - * @param {IApiData} [data] 后台数据，可能不存在 - * @param {string} [appDeId] 实体标识 - * @returns {*} {Promise} - * @memberof IApiButtonContainerState - */ - update( - context: IApiContext, - data?: IApiData, - appDeId?: string, - ): Promise; - [p: string]: any; + /** + * @description 是否显示 + * @type {boolean} + * @memberof IApiButtonContainerState + */ + visible: boolean; + /** + * @description 是否禁用 + * @type {boolean} + * @memberof IApiButtonContainerState + */ + disabled: boolean; + /** + * @description 设置当前执行的按钮 + * @param {string} name + * @memberof IApiButtonContainerState + */ + setLoading(name: string): void; + /** + * @description 更新子的状态 + * @param {IApiContext} context 上下文 + * @param {IApiData} [data] 后台数据，可能不存在 + * @param {string} [appDeId] 实体标识 + * @returns {*} {Promise} + * @memberof IApiButtonContainerState + */ + update(context: IApiContext, data?: IApiData, appDeId?: string): Promise; + [p: string]: any; } /** * @description 面板项状态 @@ -2696,36 +2568,36 @@ export interface IApiButtonContainerState { * @extends {IApiColState} */ export interface IApiPanelItemState extends IApiColState { - /** - * @description 是否禁用 - * @type {boolean} - * @memberof IApiPanelItemState - */ - disabled: boolean; - /** - * @description 类名集合 - * @type {IApiPanelItemClass} - * @memberof IApiPanelItemState - */ - class: IApiPanelItemClass; - /** - * @description 是否必填 - * @type {boolean} - * @memberof IApiPanelItemState - */ - required: boolean; - /** - * @description 是否只读 - * @type {boolean} - * @memberof IApiPanelItemState - */ - readonly: boolean; - /** - * @description 上下文 - * @type {IApiContext} - * @memberof IApiPanelItemState - */ - context?: IApiContext; + /** + * @description 是否禁用 + * @type {boolean} + * @memberof IApiPanelItemState + */ + disabled: boolean; + /** + * @description 类名集合 + * @type {IApiPanelItemClass} + * @memberof IApiPanelItemState + */ + class: IApiPanelItemClass; + /** + * @description 是否必填 + * @type {boolean} + * @memberof IApiPanelItemState + */ + required: boolean; + /** + * @description 是否只读 + * @type {boolean} + * @memberof IApiPanelItemState + */ + readonly: boolean; + /** + * @description 上下文 + * @type {IApiContext} + * @memberof IApiPanelItemState + */ + context?: IApiContext; } /** * @description 面板项样式接口 @@ -2733,30 +2605,177 @@ export interface IApiPanelItemState extends IApiColState { * @interface IApiPanelItemClass */ export interface IApiPanelItemClass { - /** - * @description 容器样式 - * @type {string[]} - * @memberof IApiPanelItemClass - */ - container: string[]; - /** - * @description 容器动态样式 - * @type {string[]} - * @memberof IApiPanelItemClass - */ - containerDyna: string[]; - /** - * @description 标题样式 - * @type {string[]} - * @memberof IApiPanelItemClass - */ - label: string[]; - /** - * @description 标题动态样式 - * @type {string[]} - * @memberof IApiPanelItemClass - */ - labelDyna: string[]; + /** + * @description 容器样式 + * @type {string[]} + * @memberof IApiPanelItemClass + */ + container: string[]; + /** + * @description 容器动态样式 + * @type {string[]} + * @memberof IApiPanelItemClass + */ + containerDyna: string[]; + /** + * @description 标题样式 + * @type {string[]} + * @memberof IApiPanelItemClass + */ + label: string[]; + /** + * @description 标题动态样式 + * @type {string[]} + * @memberof IApiPanelItemClass + */ + labelDyna: string[]; +} +/** + * @description 表单成员类名集合接口 + * @export + * @interface IApiFormDetailClass + */ +export interface IApiFormDetailClass { + /** + * @description 容器样式 + * @type {string[]} + * @memberof IApiFormDetailClass + */ + container: string[]; + /** + * @description 容器动态样式 + * @type {string[]} + * @memberof IApiFormDetailClass + */ + containerDyna: string[]; + /** + * @description 标题样式 + * @type {string[]} + * @memberof IApiFormDetailClass + */ + label: string[]; + /** + * @description 标题动态样式 + * @type {string[]} + * @memberof IApiFormDetailClass + */ + labelDyna: string[]; +} +/** + * @description 表单成员状态 + * @export + * @interface IApiFormDetailState + * @extends {IApiColState} + */ +export interface IApiFormDetailState extends IApiColState { + /** + * @description 显示更多模式 {0：无、 1：受控内容、 2：管理容器} + * @type {(0 | 1 | 2 | number)} + * @memberof IApiFormDetailState + */ + showMoreMode: 0 | 1 | 2 | number; + /** + * @description 类名集合 + * @type {IFormDetailClass} + * @memberof IApiFormDetailState + */ + class: IApiFormDetailClass; + /** + * @description 是否禁用 + * @type {boolean} + * @memberof IApiFormDetailState + */ + disabled: boolean; + /** + * @description 是否必填 + * @type {boolean} + * @memberof IApiFormDetailState + */ + required: boolean; +} +/** + * @description 表单容器类型成员控制器状态 + * @export + * @interface IApiFormDetailContainerState + * @extends {IApiFormDetailState} + */ +export interface IApiFormDetailContainerState extends IApiFormDetailState { + /** + * @description 是否显示更多内容 + * @type {boolean} + * @memberof IApiFormDetailContainerState + */ + isShowMore?: boolean; +} +/** + * @description 门户样式 + * @export + * @interface IApiPortletClass + */ +export interface IApiPortletClass { + /** + * @description 容器样式 + * @type {string[]} + * @memberof IApiPortletClass + */ + container: string[]; + /** + * @description 容器动态样式 + * @type {string[]} + * @memberof IApiPortletClass + */ + containerDyna: string[]; +} +/** + * @description 门户状态 + * @export + * @interface IApiPortletState + * @extends {IApiColState} + */ +export interface IApiPortletState extends IApiColState { + /** + * @description 界面行为组状态 + * @type {(IApiButtonContainerState | null)} + * @memberof IApiPortletState + */ + actionGroupState: IApiButtonContainerState | null; + /** + * @description 类名集合 + * @type {IApiPortletClass} + * @memberof IApiPortletState + */ + class: IApiPortletClass; + /** + * @description 上下文 + * @type {IApiContext} + * @memberof IApiPortletState + */ + context: IApiContext; + /** + * @description 门户标题 + * @type {(string | undefined)} + * @memberof IApiPortletState + */ + title: string | undefined; +} +/** + * @description 快速搜索项接口 + * @export + * @interface IApiQuickSearchItem + */ +export interface IApiQuickSearchItem { + /** + * @description 属性名称 + * @type {string} + * @memberof IApiQuickSearchItem + */ + fieldName: string; + /** + * @description 标题 + * @type {string} + * @memberof IApiQuickSearchItem + */ + label: string; } /** * @description 部件UI状态接口 @@ -2765,30 +2784,80 @@ export interface IApiPanelItemClass { * @extends {IApiControllerState} */ export interface IApiControlState extends IApiControllerState { - /** - * @description 当前部件是否为激活状态(缓存下的激活状态，一般与框架的生命周期相同) - * @type {boolean} - * @memberof IApiControlState - */ - activated: boolean; - /** - * @description 是否是简单模式 - * @type {boolean} - * @memberof IApiControlState - */ - isSimple: boolean; - /** - * @description 部件是否正在加载 - * @type {boolean} - * @memberof IApiControlState - */ - isLoading: boolean; - /** - * @description 默认加载 - * @type {boolean} - * @memberof IApiControlState - */ - loadDefault: boolean; + /** + * @description 当前部件是否为激活状态(缓存下的激活状态，一般与框架的生命周期相同) + * @type {boolean} + * @memberof IApiControlState + */ + activated: boolean; + /** + * @description 是否是简单模式 + * @type {boolean} + * @memberof IApiControlState + */ + isSimple: boolean; + /** + * @description 部件是否正在加载 + * @type {boolean} + * @memberof IApiControlState + */ + isLoading: boolean; + /** + * @description 默认加载 + * @type {boolean} + * @memberof IApiControlState + */ + loadDefault: boolean; +} +/** + * @description 搜索栏状态接口 + * @export + * @interface IApiSearchBarState + * @extends {IApiControlState} + */ +export interface IApiSearchBarState extends IApiControlState { + /** + * @description 快速搜索字符串 + * @type {string} + * @memberof IApiSearchBarState + */ + query: string; + /** + * @description 是否显示 + * @type {boolean} + * @memberof IApiSearchBarState + */ + visible: boolean; + /** + * @description 快速搜索项集合 + * @type {IQuickSearchItem[]} + * @memberof IApiSearchBarState + */ + quickSearchItems: IApiQuickSearchItem[]; + /** + * @description 快速搜索字段名称集合 + * @type {string[]} + * @memberof IApiSearchBarState + */ + quickSearchFieldNames: string[]; + /** + * @description 快速搜索的占位信息 + * @type {string} + * @memberof IApiSearchBarState + */ + quickSearchPlaceHolder: string; + /** + * @description 过滤模式 + * @type {('default' | 'pql')} + * @memberof IApiSearchBarState + */ + filterMode?: "default" | "pql"; + /** + * @description 自定义条件 + * @type {string} + * @memberof IApiSearchBarState + */ + customCond?: string; } /** * @description 面板UI状态接口 @@ -2797,12 +2866,12 @@ export interface IApiControlState extends IApiControllerState { * @extends {IApiControlState} */ export interface IApiPanelState extends IApiControlState { - /** - * @description 面板数据 - * @type {IApiData} - * @memberof IApiPanelState - */ - data: IApiData; + /** + * @description 面板数据 + * @type {IApiData} + * @memberof IApiPanelState + */ + data: IApiData; } /** * @description 视图布局状态 @@ -2810,7 +2879,8 @@ export interface IApiPanelState extends IApiControlState { * @interface IApiViewLayoutPanelState * @extends {IApiPanelState} */ -export interface IApiViewLayoutPanelState extends IApiPanelState {} +export interface IApiViewLayoutPanelState extends IApiPanelState { +} /** * @description 多数据部件UI状态接口 * @export @@ -2818,114 +2888,114 @@ export interface IApiViewLayoutPanelState extends IApiPanelState {} * @extends {IApiControlState} */ export interface IApiMDControlState extends IApiControlState { - /** - * @description 多数据部件数据集合 - * @type {IApiData[]} - * @memberof IApiMDControlState - */ - items: IApiData[]; - /** - * @description 多数据部件已选中的数据集合 - * @type {IApiData[]} - * @memberof IApiMDControlState - */ - selectedData: IApiData[]; - /** - * @description 是否是单项选择 - * @type {boolean} - * @memberof IApiMDControlState - */ - singleSelect: boolean; - /** - * @description 多数据部件激活模式 - * @type {(number | 0 | 1 | 2)} 0：无、 1：单击、 2：双击 - * @memberof IApiMDControlState - */ - mdctrlActiveMode: number | 0 | 1 | 2; - /** - * @description 当前页 - * @type {number} - * @memberof IApiMDControlState - */ - curPage: number; - /** - * @description 分页条数 - * @type {number} - * @memberof IApiMDControlState - */ - size: number; - /** - * @description 总条数 - * @type {number} - * @memberof IApiMDControlState - */ - total: number; - /** - * @description 全部计数条数，数据集配置需勾选返回全部计数 - * @type {number} - * @memberof IApiMDControlState - */ - totalx?: number; - /** - * @description 总页数 - * @type {number} - * @memberof IApiMDControlState - */ - totalPages: number; - /** - * @description 是否加载过数据，用于某些需要等待数据加载回来之后的场景。 - * @type {boolean} - * @memberof IApiMDControlState - */ - isLoaded: boolean; - /** - * @description 搜索部件的查询参数 - * @type {IApiParams} - * @memberof IApiMDControlState - */ - searchParams: IApiParams; - /** - * @description 是否禁用排序 - * @type {boolean} - * @memberof IApiMDControlState - */ - noSort: boolean; - /** - * @description 排序查询条件 - * @type {string} - * @memberof IApiMDControlState - */ - sortQuery: string; - /** - * @description 分组数据 - * @type {IApiMDControlGroupState[]} - * @memberof IApiMDControlState - */ - groups: IApiMDControlGroupState[]; - /** - * @description 隐藏无数据图片 - * @type {boolean} - * @memberof IApiMDControlState - */ - hideNoDataImage: boolean; - /** - * @description 是否启用内置导航视图 - * @type {boolean} - * @memberof IApiMDControlState - */ - enableNavView: boolean; - /** - * @description 是否显示内置导航视图 - * @type {boolean} - * @memberof IApiMDControlState - */ - showNavView: boolean; - /** - * @description 是否显示内置导航图标，导航视图显示模式为程序控制时不显示 - * @type {boolean} - * @memberof IApiMDControlState - */ - showNavIcon: boolean; + /** + * @description 多数据部件数据集合 + * @type {IApiData[]} + * @memberof IApiMDControlState + */ + items: IApiData[]; + /** + * @description 多数据部件已选中的数据集合 + * @type {IApiData[]} + * @memberof IApiMDControlState + */ + selectedData: IApiData[]; + /** + * @description 是否是单项选择 + * @type {boolean} + * @memberof IApiMDControlState + */ + singleSelect: boolean; + /** + * @description 多数据部件激活模式 + * @type {(number | 0 | 1 | 2)} 0：无、 1：单击、 2：双击 + * @memberof IApiMDControlState + */ + mdctrlActiveMode: number | 0 | 1 | 2; + /** + * @description 当前页 + * @type {number} + * @memberof IApiMDControlState + */ + curPage: number; + /** + * @description 分页条数 + * @type {number} + * @memberof IApiMDControlState + */ + size: number; + /** + * @description 总条数 + * @type {number} + * @memberof IApiMDControlState + */ + total: number; + /** + * @description 全部计数条数，数据集配置需勾选返回全部计数 + * @type {number} + * @memberof IApiMDControlState + */ + totalx?: number; + /** + * @description 总页数 + * @type {number} + * @memberof IApiMDControlState + */ + totalPages: number; + /** + * @description 是否加载过数据，用于某些需要等待数据加载回来之后的场景。 + * @type {boolean} + * @memberof IApiMDControlState + */ + isLoaded: boolean; + /** + * @description 搜索部件的查询参数 + * @type {IApiParams} + * @memberof IApiMDControlState + */ + searchParams: IApiParams; + /** + * @description 是否禁用排序 + * @type {boolean} + * @memberof IApiMDControlState + */ + noSort: boolean; + /** + * @description 排序查询条件 + * @type {string} + * @memberof IApiMDControlState + */ + sortQuery: string; + /** + * @description 分组数据 + * @type {IApiMDControlGroupState[]} + * @memberof IApiMDControlState + */ + groups: IApiMDControlGroupState[]; + /** + * @description 隐藏无数据图片 + * @type {boolean} + * @memberof IApiMDControlState + */ + hideNoDataImage: boolean; + /** + * @description 是否启用内置导航视图 + * @type {boolean} + * @memberof IApiMDControlState + */ + enableNavView: boolean; + /** + * @description 是否显示内置导航视图 + * @type {boolean} + * @memberof IApiMDControlState + */ + showNavView: boolean; + /** + * @description 是否显示内置导航图标，导航视图显示模式为程序控制时不显示 + * @type {boolean} + * @memberof IApiMDControlState + */ + showNavIcon: boolean; } /** * @description 分组UI数据接口 @@ -2933,36 +3003,36 @@ export interface IApiMDControlState extends IApiControlState { * @interface IApiMDControlGroupState */ export interface IApiMDControlGroupState { - /** - * @description 子数据 - * @type {IApiData[]} - * @memberof IApiMDControlGroupState - */ - children: IApiData[]; - /** - * @description 分组标题 - * @type {string} - * @memberof IApiMDControlGroupState - */ - caption: string; - /** - * @description 分组唯一标识（分组属性对应的值） - * @type {(string | number)} - * @memberof IApiMDControlGroupState - */ - key: string | number; - /** - * @description 分组界面行为组状态 - * @type {IApiButtonContainerState} - * @memberof IApiMDControlGroupState - */ - groupActionGroupState?: IApiButtonContainerState; - /** - * @description 当前分组已选中的数据集合 - * @type {IApiData[]} - * @memberof IApiMDControlGroupState - */ - selectedData?: IApiData[]; + /** + * @description 子数据 + * @type {IApiData[]} + * @memberof IApiMDControlGroupState + */ + children: IApiData[]; + /** + * @description 分组标题 + * @type {string} + * @memberof IApiMDControlGroupState + */ + caption: string; + /** + * @description 分组唯一标识（分组属性对应的值） + * @type {(string | number)} + * @memberof IApiMDControlGroupState + */ + key: string | number; + /** + * @description 分组界面行为组状态 + * @type {IApiButtonContainerState} + * @memberof IApiMDControlGroupState + */ + groupActionGroupState?: IApiButtonContainerState; + /** + * @description 当前分组已选中的数据集合 + * @type {IApiData[]} + * @memberof IApiMDControlGroupState + */ + selectedData?: IApiData[]; } /** * @description 行数据状态 @@ -2970,92 +3040,92 @@ export interface IApiMDControlGroupState { * @interface IApiGridRowState */ export interface IApiGridRowState { - /** - * @description 数据 - * @type {IApiData} - * @memberof IApiGridRowState - */ - data: IApiData; - /** - * @description 旧数据 - * @type {IApiData} - * @memberof IApiGridRowState - */ - oldData: IApiData; - /** - * @description 错误信息集合，p是对应属性名称 - * @type {({ [p: string]: string | null })} - * @memberof IApiGridRowState - */ - errors: { - [p: string]: string | null; - }; - /** - * @description 操作列状态(p是操作列的标识) - * @type {{ [p: string]: IApiButtonContainerState }} - * @memberof IApiGridRowState - */ - uaColStates: { - [p: string]: IApiButtonContainerState; - }; - /** - * @description 界面行为组状态(p是界面行为的标识) - * @type {{ [p: string]: IApiButtonContainerState }} - * @memberof IApiGridRowState - */ - uiActionGroupStates: { - [p: string]: IApiButtonContainerState; - }; - /** - * @description 编辑列的状态 - * @type {{ - * [p: string]: { - * disabled: boolean; - * readonly: boolean; - * editable: boolean; - * required: boolean; - * }; - * }} - * @memberof IApiGridRowState - */ - editColStates: { - [p: string]: { - disabled: boolean; - readonly: boolean; - editable: boolean; - required: boolean; - }; - }; - /** - * @description 是否显示行编辑 - * @type {boolean} - * @memberof IApiGridRowState - */ - showRowEdit: boolean; - /** - * @description 是否被修改过 - * @type {boolean} - * @memberof IApiGridRowState - */ - modified: boolean; - /** - * @description 是否正在处理中(动态控制，值规则，表单项更新等逻辑中) - * @type {boolean} - * @memberof IApiGridRowState - */ - processing: boolean; - /** - * @description 缓存的数据对象 - * @type {IApiData} - * @memberof IApiGridRowState - */ - cacheData?: IApiData; - /** - * @description 获取改变数据 - * @returns {*} {IApiData} - * @memberof IApiGridRowState - */ - getDiffData(): IApiData; + /** + * @description 数据 + * @type {IApiData} + * @memberof IApiGridRowState + */ + data: IApiData; + /** + * @description 旧数据 + * @type {IApiData} + * @memberof IApiGridRowState + */ + oldData: IApiData; + /** + * @description 错误信息集合，p是对应属性名称 + * @type {({ [p: string]: string | null })} + * @memberof IApiGridRowState + */ + errors: { + [p: string]: string | null; + }; + /** + * @description 操作列状态(p是操作列的标识) + * @type {{ [p: string]: IApiButtonContainerState }} + * @memberof IApiGridRowState + */ + uaColStates: { + [p: string]: IApiButtonContainerState; + }; + /** + * @description 界面行为组状态(p是界面行为的标识) + * @type {{ [p: string]: IApiButtonContainerState }} + * @memberof IApiGridRowState + */ + uiActionGroupStates: { + [p: string]: IApiButtonContainerState; + }; + /** + * @description 编辑列的状态 + * @type {{ + * [p: string]: { + * disabled: boolean; + * readonly: boolean; + * editable: boolean; + * required: boolean; + * }; + * }} + * @memberof IApiGridRowState + */ + editColStates: { + [p: string]: { + disabled: boolean; + readonly: boolean; + editable: boolean; + required: boolean; + }; + }; + /** + * @description 是否显示行编辑 + * @type {boolean} + * @memberof IApiGridRowState + */ + showRowEdit: boolean; + /** + * @description 是否被修改过 + * @type {boolean} + * @memberof IApiGridRowState + */ + modified: boolean; + /** + * @description 是否正在处理中(动态控制，值规则，表单项更新等逻辑中) + * @type {boolean} + * @memberof IApiGridRowState + */ + processing: boolean; + /** + * @description 缓存的数据对象 + * @type {IApiData} + * @memberof IApiGridRowState + */ + cacheData?: IApiData; + /** + * @description 获取改变数据 + * @returns {*} {IApiData} + * @memberof IApiGridRowState + */ + getDiffData(): IApiData; } /** * @description 表格列状态 @@ -3063,54 +3133,54 @@ export interface IApiGridRowState { * @interface IApiColumnState */ export interface IApiColumnState { - /** - * @description 列标识,是列模型的codeName - * @type {string} - * @memberof IApiColumnState - */ - key: string; - /** - * @description 列标题 - * @type {string} - * @memberof IApiColumnState - */ - caption: string; - /** - * @description 显示隐藏 - * @type {boolean} - * @memberof IApiColumnState - */ - hidden: boolean; - /** - * @description 隐藏模式，0：默认不隐藏，1：默认隐藏，2：始终隐藏，3：从不隐藏 - * @type {number} - * @memberof IApiColumnState - */ - hideMode: number; - /** - * @description 是否是操作列 - * @type {boolean} - * @memberof IApiColumnState - */ - uaColumn: boolean; - /** - * @description 是否是固定列，固定在左侧还是右侧 - * @type {('left' | 'right')} - * @memberof IApiColumnState - */ - fixed?: 'left' | 'right'; - /** - * @description 是否是自适应列 - * @type {boolean} - * @memberof IApiColumnState - */ - adaptive?: boolean; - /** - * @description 列宽 - * @type {number} - * @memberof IApiColumnState - */ - columnWidth?: number; + /** + * @description 列标识,是列模型的codeName + * @type {string} + * @memberof IApiColumnState + */ + key: string; + /** + * @description 列标题 + * @type {string} + * @memberof IApiColumnState + */ + caption: string; + /** + * @description 显示隐藏 + * @type {boolean} + * @memberof IApiColumnState + */ + hidden: boolean; + /** + * @description 隐藏模式，0：默认不隐藏，1：默认隐藏，2：始终隐藏，3：从不隐藏 + * @type {number} + * @memberof IApiColumnState + */ + hideMode: number; + /** + * @description 是否是操作列 + * @type {boolean} + * @memberof IApiColumnState + */ + uaColumn: boolean; + /** + * @description 是否是固定列，固定在左侧还是右侧 + * @type {('left' | 'right')} + * @memberof IApiColumnState + */ + fixed?: "left" | "right"; + /** + * @description 是否是自适应列 + * @type {boolean} + * @memberof IApiColumnState + */ + adaptive?: boolean; + /** + * @description 列宽 + * @type {number} + * @memberof IApiColumnState + */ + columnWidth?: number; } /** * @description 本地存储表格列状态对象 @@ -3118,18 +3188,18 @@ export interface IApiColumnState { * @interface IApiStorageColumnStates */ export interface IApiStorageColumnStates { - /** - * @description 开启jsonschema下的表格列状态 - * @type {IApiColumnState[]} - * @memberof IApiStorageColumnStates - */ - schemaColumnStates?: IApiColumnState[]; - /** - * @description 默认表格列状态 - * @type {IApiColumnState[]} - * @memberof IApiStorageColumnStates - */ - defaultColumnStates?: IApiColumnState[]; + /** + * @description 开启jsonschema下的表格列状态 + * @type {IApiColumnState[]} + * @memberof IApiStorageColumnStates + */ + schemaColumnStates?: IApiColumnState[]; + /** + * @description 默认表格列状态 + * @type {IApiColumnState[]} + * @memberof IApiStorageColumnStates + */ + defaultColumnStates?: IApiColumnState[]; } /** * @description 表格UI状态接口 @@ -3138,1194 +3208,9637 @@ export interface IApiStorageColumnStates { * @extends {IApiMDControlState} */ export interface IApiGridState extends IApiMDControlState { - /** - * @description 表格行状态 - * @type {IApiGridRowState[]} - * @memberof IApiGridState - */ - rows: IApiGridRowState[]; - /** - * @description 表格列状态数组，顺序就是列的排序 - * @type {IApiColumnState[]} - * @memberof IApiGridState - */ - columnStates: IApiColumnState[]; - /** - * @description 聚合计算的结果 - * @type {IApiData} - * @memberof IApiGridState - */ - aggResult: IApiData; - /** - * @description 统计结果 - * @type {IApiData} - * @memberof IApiGridState - */ - totalResult: IApiData; - /** - * @description 远程聚合计算结果 - * @type {IApiData} - * @memberof IApiGridState - */ - remoteAggResult?: IApiData; - /** - * @description 开启表格行编辑 - * @type {boolean} - * @memberof IApiGridState - */ - rowEditOpen: boolean; - /** - * @description 是否为自动表格 - * @type {boolean} - * @memberof IApiGridState - */ - isAutoGrid: boolean; - /** - * @description 表格popover层级 - * @type {number} - * @memberof IApiGridState - */ - zIndex?: number; - /** - * @description 隐藏表格头部 - * @type {boolean} - * @memberof IApiGridState - */ - hideHeader?: boolean; - /** - * @description 是否启用分页栏 - * @type {boolean} - * @memberof IApiGridState - */ - enablePagingBar?: boolean; - /** - * @description simple数据 - * @type {IApiData[]} - * @memberof IApiGridState - */ - simpleData?: IApiData[]; + /** + * @description 表格行状态 + * @type {IApiGridRowState[]} + * @memberof IApiGridState + */ + rows: IApiGridRowState[]; + /** + * @description 表格列状态数组，顺序就是列的排序 + * @type {IApiColumnState[]} + * @memberof IApiGridState + */ + columnStates: IApiColumnState[]; + /** + * @description 聚合计算的结果 + * @type {IApiData} + * @memberof IApiGridState + */ + aggResult: IApiData; + /** + * @description 统计结果 + * @type {IApiData} + * @memberof IApiGridState + */ + totalResult: IApiData; + /** + * @description 远程聚合计算结果 + * @type {IApiData} + * @memberof IApiGridState + */ + remoteAggResult?: IApiData; + /** + * @description 开启表格行编辑 + * @type {boolean} + * @memberof IApiGridState + */ + rowEditOpen: boolean; + /** + * @description 是否为自动表格 + * @type {boolean} + * @memberof IApiGridState + */ + isAutoGrid: boolean; + /** + * @description 表格popover层级 + * @type {number} + * @memberof IApiGridState + */ + zIndex?: number; + /** + * @description 隐藏表格头部 + * @type {boolean} + * @memberof IApiGridState + */ + hideHeader?: boolean; + /** + * @description 是否启用分页栏 + * @type {boolean} + * @memberof IApiGridState + */ + enablePagingBar?: boolean; + /** + * @description simple数据 + * @type {IApiData[]} + * @memberof IApiGridState + */ + simpleData?: IApiData[]; } /** - * @description 视图会话共享变量接口 + * @description 表单状态 * @export - * @interface IApiViewSession + * @interface IApiFormState + * @extends {IApiControlState} */ -export interface IApiViewSession { - /** - * @description 当前视图的数据 - * @type {(IApiData | null)} - * @memberof IApiViewSession - */ - srfactiveviewdata: IApiData | null; +export interface IApiFormState extends IApiControlState { + /** + * @description 是否加载完数据 + * @type {boolean} + * @memberof IApiFormState + */ + isLoaded: boolean; + /** + * @description 表单数据 + * @type {IApiData} + * @memberof IApiFormState + */ + data: IApiData; + /** + * @description 是否正在处理中(动态控制，值规则，表单项更新等逻辑中) + * @type {boolean} + * @memberof IApiFormState + */ + processing: boolean; + /** + * @description 是否被修改过 + * @type {boolean} + * @memberof IApiFormState + */ + modified: boolean; + /** + * @description 当前激活分页 + * @type {string} + * @memberof IApiFormState + */ + activeTab: string; + /** + * @description 表单是否销毁(UI) + * @type {boolean} + * @memberof IApiFormState + */ + formIsDestroyed: boolean; } /** - * @description 视图UI状态接口 + * @description 编辑表单状态 * @export - * @interface IApiViewState - * @extends {IApiControllerState} - * @extends {IApiViewSession} + * @interface IApiEditFormState + * @extends {IApiFormState} */ -export interface IApiViewState extends IApiControllerState, IApiViewSession { - /** - * @description 当前视图是否为激活状态(缓存下的激活状态，一般与框架的生命周期相同) - * @type {boolean} - * @memberof IApiViewState - */ - activated: boolean; - /** - * @description 视图标题 - * @type {string} - * @memberof IApiViewState - */ - caption: string; - /** - * @description 视图是否正在加载 - * @type {boolean} - * @memberof IApiViewState - */ - isLoading: boolean; - /** - * @description 默认不加载 - * @type {boolean} - * @memberof IApiViewState - */ - noLoadDefault: boolean; - /** - * @description 当前视图是否出现错误 - * @type {boolean} - * @memberof IApiViewState - */ - hasError: boolean; - /** - * @description 关闭视图时返回给外面的状态 - * @type {boolean} - * @memberof IApiViewState - */ - closeOK?: boolean; - /** - * @description 视图正在关闭（用于阻止一些视图关闭后仍在继续的逻辑，比如表单保存时的通知） - * @type {boolean} - * @memberof IApiViewState - */ - isClosing: boolean; +export interface IApiEditFormState extends IApiFormState { } /** - * @description 多数据视图UI状态 + * @description 菜单状态接口 * @export - * @interface IApiMDViewState - * @extends {IApiViewState} + * @interface IApiAppMenuState + * @extends {IApiControlState} */ -export interface IApiMDViewState extends IApiViewState {} +export interface IApiAppMenuState extends IApiControlState { + /** + * @description 菜单项状态 + * @type {{ [p: string]: { visible: boolean; permitted: boolean } }} + * @memberof IApiAppMenuState + */ + menuItemsState: { + [p: string]: { + visible: boolean; + permitted: boolean; + }; + }; + /** + * @description 移动端菜单项集合 + * @type {IAppMenuItem[]} + * @memberof IApiAppMenuState + */ + mobMenuItems: IAppMenuItem[]; +} /** - * @description 表格视图UI状态 + * @description 导航栏状态接口 * @export - * @interface IApiGridViewState - * @extends {IApiMDViewState} + * @interface IApiExpBarControlState + * @extends {IApiControlState} */ -export interface IApiGridViewState extends IApiMDViewState {} +export interface IApiExpBarControlState extends IApiControlState { + /** + * @description 导航数据 + * @type {string} + * @memberof IApiExpBarControlState + */ + srfnav: string; + /** + * @description 查询条件 + * @type {string} + * @memberof IApiExpBarControlState + */ + query: string; + /** + * @description 占位符 + * @type {string} + * @memberof IApiExpBarControlState + */ + placeHolder: string; +} /** - * @description 视图控制器接口 + * @description 额外按钮接口 * @export - * @interface IApiViewController - * @extends {IApiController} - * @template T - * @template S + * @interface IApiExtraButton */ -export interface IApiViewController< - T extends IAppView = IAppView, - S extends IApiViewState = IApiViewState, -> extends IApiController { - /** - * @description 视图级共享数据对象 - * @type {IApiData} - * @memberof IApiViewController - */ - session: IApiData; - /** - * @description 视图错误信息 - * @type {IApiData} - * @memberof IApiViewController - */ - error: IApiData; - /** - * @description 上层视图控制器对象，顶层视图没有父 - * @type {((IApiViewController & IApiData) | undefined)} - * @memberof IApiViewController - */ - readonly parentView: (IApiViewController & IApiData) | undefined; - /** - * @description 视图是否处于激活状态 - * @type {boolean} - * @memberof IApiViewController - */ - readonly isActive: boolean; - /** - * @description 视图布局面板 - * @type {(IApiViewLayoutPanelController & IApiData)} - * @memberof IApiViewController - */ - layoutPanel?: IApiViewLayoutPanelController & IApiData; - /** - * @description 关闭视图 - * @param {IApiModalData} [modalData] - * @returns {*} {Promise} - * @memberof IApiViewController - */ - closeView(modalData?: IApiModalData): Promise; - /** - * @description 重绘视图 - * @param {IRedrawData} redrawData - * @memberof IApiViewController - */ - redrawView(redrawData: IApiRedrawData): void; - /** - * @description 执行视图的能力 - * @template A - * @param {string} key 视图能力的唯一标识 - * @param {A} [args] 视图能力需要的参数 - * @returns {*} {Promise} - * @memberof IApiViewController - */ - call(key: string, args?: A): Promise; - /** - * @description 开启视图loading - * @memberof IApiViewController - */ - startLoading(): void; - /** - * @description 关闭视图loading - * @memberof IApiViewController - */ - endLoading(): void; +export interface IApiExtraButton { + /** + * @description 唯一标识 + * @type {string} + * @memberof IApiExtraButton + */ + id: string; + /** + * @description 应用标识 + * @type {string} + * @memberof IApiExtraButton + */ + appId: string; + /** + * @description 按钮类型 + * @type {'extra'} + * @memberof IApiExtraButton + */ + buttonType: "extra"; + /** + * @description 标题 + * @type {string} + * @memberof IApiExtraButton + */ + caption: string; + /** + * @description 悬浮提示文字 + * @type {string} + * @memberof IApiExtraButton + */ + tooltip: string; + /** + * @description 图标类型 + * @type {IApiData} + * @memberof IApiExtraButton + */ + icon?: IApiData; } /** - * @description 视图布局面板控制器接口 + * @description 额外按钮集合 * @export - * @interface IApiViewLayoutPanelController - * @extends {IApiPanelController} + * @type IApiExtraButtons */ -export interface IApiViewLayoutPanelController< - T extends IViewLayoutPanel = IViewLayoutPanel, - S extends IApiViewLayoutPanelState = IApiViewLayoutPanelState, -> extends IApiPanelController {} +export type IApiExtraButtons = { + [p: string | number]: IApiExtraButton[]; +}; /** - * @description 部件控制器 + * @description 工具栏状态接口 * @export - * @interface IApiControlController - * @extends {IApiController} - * @template T - * @template S + * @interface IApiToolbarState + * @extends {IApiControlState} */ -export interface IApiControlController< - T extends IControl = IControl, - S extends IApiControlState = IApiControlState, -> extends IApiController { - /** - * @description 当前上下文环境的视图控制器 - * @type {(IApiViewController & IApiData)} - * @memberof IApiControlController - */ - view: IApiViewController & IApiData; - /** - * 部件标识 - * - * @author tony001 - * @date 2024-07-15 13:07:49 - * @type {string} - */ - ctrlId: string; - /** - * 部件参数 - * - * @author tony001 - * @date 2024-07-23 22:07:34 - * @type {IApiParams} - */ - controlParams: IApiParams; - /** - * @description 部件布局面板控制器 - * @type {(IApiViewLayoutPanelController & IApiData)} - * @memberof IApiControlController - */ - layoutPanel?: IApiViewLayoutPanelController & IApiData; - /** - * 运行模式 - * - * @type {('DESIGN' | 'RUNTIME')} （设计模式 | 运行时） - * @memberof IControlController - */ - runMode: 'DESIGN' | 'RUNTIME'; - /** - * 开始加载 - * - * @author lxm - * @date 2022-09-19 14:09:00 - */ - startLoading(): Promise; - /** - * 加载完毕 - * - * @author lxm - * @date 2022-09-19 14:09:09 - */ - endLoading(): Promise; +export interface IApiToolbarState extends IApiControlState { + /** + * @description 工具栏按钮状态 + * @type {IButtonContainerState} + * @memberof IApiToolbarState + */ + buttonsState: IApiButtonContainerState; + /** + * @description 额外按钮集合 + * @type {IExtraButtons} + * @memberof IApiToolbarState + */ + extraButtons: IApiExtraButtons; + /** + * @description 计数器数据 + * @memberof IApiToolbarState + */ + counterData: IApiData; } /** - * @description 面板控制器 + * @description 日历导航栏部件状态接口 * @export - * @interface IApiPanelController - * @extends {IApiControlController} - * @template T - * @template S + * @interface IApiCalendarExpBarState + * @extends {IApiExpBarControlState} */ -export interface IApiPanelController< - T extends IPanel = IPanel, - S extends IApiPanelState = IApiPanelState, -> extends IApiControlController { - /** - * @description 所有面板成员的控制器 - * @type {{ [key: string]: IApiPanelItemController }} - * @memberof IApiPanelController - */ - panelItems: { - [key: string]: IApiPanelItemController; - }; - /** - * @description 面板数据 - * @type {IApiData} - * @memberof IApiPanelController - */ - data: IApiData; - /** - * @description 容器控制器（可能是视图控制器，也可能是部件控制器） - * @type {IApiController} - * @memberof IApiPanelController - */ - container?: IApiController; - /** - * @description 设置面板数据的值 - * @param {string} name 要设置的数据的属性名称 - * @param {unknown} value 要设置的值 - * @returns {*} {Promise} - * @memberof IApiPanelController - */ - setDataValue(name: string, value: unknown): Promise; - /** - * @description 加载数据 - * @returns {*} {Promise} - * @memberof IApiPanelController - */ - load(): Promise; +export interface IApiCalendarExpBarState extends IApiExpBarControlState { } /** - * @description 面板成员控制器接口 + * @description 日历项数据接口 * @export - * @interface IApiPanelItemController + * @interface IApiCalendarItemData */ -export interface IApiPanelItemController { - /** - * @description 成员模型 - * @type {IPanelItem} - * @memberof IApiPanelItemController - */ - model: IPanelItem; - /** - * @description 面板控制器 - * @type {IApiPanelController} - * @memberof IApiPanelItemController - */ - panel: IApiPanelController; - /** - * @description 父容器控制器(除了根成员都存在) - * @type {IApiPanelItemContainerController} - * @memberof IApiPanelItemController - */ - parent?: IApiPanelItemContainerController; - /** - * @description 成员状态 - * @type {IApiPanelItemState} - * @memberof IApiPanelItemController - */ - state: IApiPanelItemState; - /** - * @description 数据对象 - * @type {IApiData} - * @memberof IApiPanelItemController - */ - data: IApiData; +export interface IApiCalendarItemData { + /** + * @description 背景色 + * @type {string} + * @memberof iApiCalendatItemData + */ + bkColor: string; + /** + * @description 开始时间 + * @type {string} + * @memberof iApiCalendatItemData + */ + beginTime: string; + /** + * @description 颜色 + * @type {string} + * @memberof iApiCalendatItemData + */ + color: string; + /** + * @description 内容 + * @type {string} + * @memberof iApiCalendatItemData + */ + content: string; + /** + * @description 结束时间 + * @type {string} + * @memberof iApiCalendatItemData + */ + endTime: string; + /** + * @description 图标 + * @type {string} + * @memberof iApiCalendatItemData + */ + icon: string; + /** + * @description id标识 + * @type {string} + * @memberof iApiCalendatItemData + */ + id: string; + /** + * @description 级别 + * @type {string} + * @memberof iApiCalendatItemData + */ + level: string; + /** + * @description 标记2 + * @type {string} + * @memberof iApiCalendatItemData + */ + tag2: string; + /** + * @description 标记1 + * @type {string} + * @memberof iApiCalendatItemData + */ + tag: string; + /** + * @description 文本 + * @type {string} + * @memberof iApiCalendatItemData + */ + text: string; + /** + * @description 提示 + * @type {string} + * @memberof iApiCalendatItemData + */ + tips: string; + /** + * @description 实体数据 + * @type {IApiData} + * @memberof iApiCalendatItemData + */ + deData: IApiData; + /** + * @description 日历项名称 + * @type {string} + * @memberof iApiCalendatItemData + */ + itemType: string; + /** + * @description 导航标识 + * @type {string} + * @memberof iApiCalendatItemData + */ + navId: string; } /** - * @description 容器类面板成员控制器接口 + * @description 日历分组数据接口 * @export - * @interface IApiPanelItemContainerController - * @extends {IApiPanelItemController} + * @interface IApiCalendarGroup */ -export interface IApiPanelItemContainerController - extends IApiPanelItemController { - /** - * @description 是否是数据父容器 - * @type {true} - * @memberof IApiPanelItemContainerController - */ - isDataContainer?: true; +export interface IApiCalendarGroup { + /** + * @description 分组标题 + * @type {string} + * @memberof IApiCalendarGroup + */ + caption: string; + /** + * @description 分组标识 + * @type {string} + * @memberof IApiCalendarGroup + */ + key: string; + /** + * @description 日历项数据 + * @type {IApiCalendarItemData[]} + * @memberof IApiCalendarGroup + */ + children: IApiCalendarItemData[]; } /** - * @description 多数据部件控制器加载参数 + * @description 日历控件状态接口 * @export - * @interface IApiMDCtrlLoadParams - * @extends {IApiDataAbilityParams} + * @interface IApiCalendarState + * @extends {IApiMDControlState} */ -export interface IApiMDCtrlLoadParams extends IApiDataAbilityParams { - /** - * @description 是否是初始加载 - * @type {boolean} - * @memberof IApiMDCtrlLoadParams - */ - isInitialLoad?: boolean; - /** - * @description 是否加载更多 - * @type {boolean} - * @memberof IApiMDCtrlLoadParams - */ - isLoadMore?: boolean; - /** - * @description 触发源 - * @type {('DEFAULT' | 'REFRESH' | string)} - * @memberof IApiMDCtrlLoadParams - */ - triggerSource?: 'DEFAULT' | 'REFRESH' | string; +export interface IApiCalendarState extends IApiMDControlState { + /** + * @description 日历项数据 + * @type {ICalendarItemData[]} + * @memberof IApiCalendarState + */ + items: IApiCalendarItemData[]; + /** + * @description 日历分组数据 + * @type {IApiCalendarGroup[]} + * @memberof IApiCalendarState + */ + groups: IApiCalendarGroup[]; + /** + * @description 选中的日期 + * @type {Date} + * @memberof IApiCalendarState + */ + selectedDate: Date; + /** + * @description 图例 + * @type {IAPiData[]} + * @memberof IApiCalendarState + */ + legends: IApiData[]; + /** + * @description 日历名称 + * @type {string} + * @memberof IApiCalendarState + */ + calendarTitle: string; } /** - * @description 多数据部件控制器删除参数 + * @description 标题栏状态接口 * @export - * @interface IApiMDCtrlRemoveParams - * @extends {IApiDataAbilityParams} + * @interface IApiCaptionBarState + * @extends {IApiControlState} */ -export interface IApiMDCtrlRemoveParams extends IApiDataAbilityParams { - /** - * @description 是否不需要刷新(默认为否，如果不需要刷新传true) - * @type {boolean} - * @memberof IApiMDCtrlRemoveParams - */ - notRefresh?: boolean; +export interface IApiCaptionBarState extends IApiControlState { + /** + * @description 标题 + * @type {string} + * @memberof IApiCaptionBarState + */ + caption: string; } /** - * @description 多数据部件控制器 + * @description 图表导航栏部件状态接口 * @export - * @interface IApiMDControlController - * @extends {IApiControlController} - * @template T - * @template S + * @interface IApiChartExpBarState + * @extends {IApiExpBarControlState} */ -export interface IApiMDControlController< - T extends IMDControl = IMDControl, - S extends IApiMDControlState = IApiMDControlState, -> extends IApiControlController { - /** - * @description 加载数据 - * @param {IApiMDCtrlLoadParams} [args] - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - load(args?: IApiMDCtrlLoadParams): Promise; - /** - * @description 删除数据 - * @param {IApiMDCtrlRemoveParams} [args] - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - remove(args?: IApiMDCtrlRemoveParams): Promise; - /** - * @description 刷新数据 - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - refresh(): Promise; - /** - * @description 导入数据 - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - importData(): Promise; - /** - * @description 导出数据 - * @param {{ event: MouseEvent }} _args - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - exportData(_args: { event: MouseEvent }): Promise; - /** - * @description 获取选中数据 - * @returns {*} {IApiData[]} - * @memberof IApiMDControlController - */ - getData(): IApiData[]; - /** - * @description 设置选中数据,会触发onSelectionChange事件,设置的数据和已经选中的一样时不会触发onSelectionChange事件 - * @param {IApiData[]} selection - * @memberof IApiMDControlController - */ - setSelection(selection: IApiData[]): void; - /** - * @description 设置激活数据 - * @param {IApiData} data - * @param {(MouseEvent | undefined)} [event] - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - setActive(data: IApiData, event?: MouseEvent | undefined): Promise; - /** - * @description - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - goToFirstPage(): Promise; - /** - * @description 获取上一页数据 - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - goToPreviousPage(): Promise; - /** - * @description 获取下一页数据 - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - goToNextPage(): Promise; - /** - * @description 获取最后一页数据 - * @returns {*} {Promise} - * @memberof IApiMDControlController - */ - goToLastPage(): Promise; +export interface IApiChartExpBarState extends IApiExpBarControlState { } /** - * @description 表格控制器接口 + * @description 图表部件状态接口 * @export - * @interface IApiGridController - * @extends {IApiMDControlController} - * @template T - * @template S + * @interface IApiChartState + * @extends {IApiMDControlState} */ -export interface IApiGridController< - T extends IDEGrid = IDEGrid, - S extends IApiGridState = IApiGridState, -> extends IApiMDControlController { - /** - * @description 新建行 - * @returns {*} {Promise} - * @memberof IApiGridController - */ - newRow(): Promise; - /** - * @description 保存单条数据 - * @param {IApiData} data - * @returns {*} {Promise} - * @memberof IApiGridController - */ - save(data: IApiData): Promise; - /** - * @description 保存表格所有数据 - * @returns {*} {Promise} - * @memberof IApiGridController - */ - saveAll(): Promise; - /** - * @description 切换表格的行编辑开启关闭状态 - * @memberof IApiGridController - */ - toggleRowEdit(): void; +export interface IApiChartState extends IApiMDControlState { + /** + * @description 是否开启图表表格 + * @type {boolean} + * @memberof IApiChartState + */ + showGrid: boolean; + /** + * @description 表格所在方位 + * @type {string} + * @memberof IApiChartState + */ + gridPosition: string; } /** - * @description 视图，部件控制器基类 + * @description 图表数据格式接口 * @export - * @interface IApiController - * @extends {IApiEnforceableController} - * @template T - * @template S + * @interface IApiChartData */ -export interface IApiController< - T extends object = object, - S extends object = object, -> extends IApiEnforceableController { - /** - * @description 控制器实例的唯一标识,创建时自动生成 - * @type {string} - * @memberof IApiController - */ - readonly id: string; - /** - * @description UI状态 - * @type {S} - * @memberof IApiController - */ - state: S; - /** - * @description 模型对象 - * @type {T} - * @memberof IApiController - */ - readonly model: T; - /** - * @description 视图上下文 - * @type {IApiContext} - * @memberof IApiController - */ - readonly context: IApiContext; - /** - * @description 视图参数 - * @type {IApiParams} - * @memberof IApiController - */ - readonly params: IApiParams; - /** - * @description 视图布局面板控制器 - * @type {(IApiViewLayoutPanelController & IApiData)} - * @memberof IApiController - */ - layoutPanel?: IApiViewLayoutPanelController & IApiData; +export interface IApiChartData { + /** + * 序列模型id + * + */ + _seriesModelId?: string; + /** + * 分组名称 + * + */ + _groupName?: string; + /** + * 分类值 + * + */ + _catalog?: string; } /** - * @description 简洁确认框参数 + * @description 上下文菜单UI状态接口 * @export - * @interface IApiModalParams + * @interface IApiContextMenuState + * @extends {IApiToolbarState} */ -export interface IApiModalParams { - /** - * @description 标题 - * @type {string} - * @memberof IApiModalParams - */ - title: string; - /** - * @description 描述 - * @type {string} - * @memberof IApiModalParams - */ - desc?: string; - /** - * @description 显示确认按钮（默认显示） - * @type {boolean} - * @memberof IApiModalParams - */ - showConfirmButton?: boolean; - /** - * @description 是否显示取消按钮 - * @type {boolean} - * @memberof IApiModalParams - */ - showCancelButton?: boolean; - /** - * @description 确认按钮显示文本 - * @type {string} - * @memberof IApiModalParams - */ - confirmButtonText?: string; - /** - * @description 取消按钮显示文本 - * @type {string} - * @memberof IApiModalParams - */ - cancelButtonText?: string; - /** - * @description 消息类型 - * @type {('success' | 'info' | 'warning' | 'error')} - * @memberof IApiModalParams - */ - type?: 'success' | 'info' | 'warning' | 'error'; - /** - * @description 传递额外参数，详情参见：https://element-plus.org/zh-CN/component/message-box.html#%E9%85%8D%E7%BD%AE%E9%A1%B9 - * @type {IApiParams} - * @memberof IApiModalParams - */ - options?: IApiParams; +export interface IApiContextMenuState extends IApiToolbarState { } /** - * @description 消息提示，当用户进行操作时会被触发，该对话框中断用户操作，直到用户确认知晓后才可关闭。 + * @description 数据看板部件状态接口 * @export - * @interface IApiModalUtil + * @interface IApiDashboardState + * @extends {IApiControlState} */ -export interface IApiModalUtil { - /** - * @description 弹出普通信息 - * @param {IApiModalParams} params - * @returns {*} {Promise} - * @memberof IApiModalUtil - */ - info(params: IApiModalParams): Promise; - /** - * @description 弹出成功信息 - * @param {IApiModalParams} params - * @returns {*} {Promise} - * @memberof IApiModalUtil - */ - success(params: IApiModalParams): Promise; - /** - * @description 弹出警告信息 - * @param {IApiModalParams} params - * @returns {*} {Promise} - * @memberof IApiModalUtil - */ - warning(params: IApiModalParams): Promise; - /** - * @description 弹出错误信息 - * @param {IApiModalParams} params - * @returns {*} {Promise} - * @memberof IApiModalUtil - */ - error(params: IApiModalParams): Promise; - /** - * @description 弹出确认操作 - * @param {IApiModalParams} params - * @returns {*} {Promise} - * @memberof IApiModalUtil - */ - confirm(params: IApiModalParams): Promise; +export interface IApiDashboardState extends IApiControlState { } /** - * @description 确认框参数 + * @description 数据视图（卡片）部件状态接口 * @export - * @interface IApiConfirmParams + * @interface IApiDataViewControlState + * @extends {IApiMDControlState} */ -export interface IApiConfirmParams { - /** - * @description 标题 - * @type {string} - * @memberof IApiConfirmParams - */ - title: string; - /** - * @description 描述 - * @type {string} - * @memberof IApiConfirmParams - */ - desc?: string; - /** - * @description 传递额外参数，详情参见：https://element-plus.org/zh-CN/component/message-box.html#%E9%85%8D%E7%BD%AE%E9%A1%B9 - * @type {IApiParams} - * @memberof IApiConfirmParams - */ - options?: IApiParams; +export interface IApiDataViewControlState extends IApiMDControlState { + /** + * @description 排序栏项集合 + * @type {IApiSortItem[]} + * @memberof IApiDataViewControlState + */ + sortItems: IApiSortItem[]; + /** + * @description 是否支持分页栏 + * @type {boolean} + * @memberof IApiDataViewControlState + */ + enablePagingBar?: boolean; + /** + * @description 折叠分组 + * @type {string[]} + * @memberof IApiDataViewControlState + */ + collapseKeys: string[]; } /** - * @description 确认消息，提示用户确认其已经触发的动作，并询问是否进行此操作时会用到此对话框。 + * @description 关系栏项状态接口 * @export - * @interface IApiConfirmUtil + * @interface IApiDRBarItemsState */ -export interface IApiConfirmUtil { - /** - * @description 弹出普通信息 - * @param {IApiConfirmParams} params - * @returns {*} {Promise} - * @memberof IApiConfirmUtil - */ - info(params: IApiConfirmParams): Promise; - /** - * @description 弹出成功信息 - * @param {IApiConfirmParams} params - * @returns {*} {Promise} - * @memberof IApiConfirmUtil - */ - success(params: IApiConfirmParams): Promise; - /** - * @description 弹出警告信息 - * @param {IApiConfirmParams} params - * @returns {*} {Promise} - * @memberof IApiConfirmUtil - */ - warning(params: IApiConfirmParams): Promise; - /** - * @description 弹出错误信息 - * @param {IApiConfirmParams} params - * @returns {*} {Promise} - * @memberof IApiConfirmUtil - */ - error(params: IApiConfirmParams): Promise; +export interface IApiDRBarItemsState { + /** + * @description 项标识 + * @type {string} + * @memberof IApiDRBarItemsState + */ + tag: string; + /** + * @description 项标题 + * @type {string} + * @memberof IApiDRBarItemsState + */ + caption?: string; + /** + * @description 是否禁用 + * @type {boolean} + * @memberof IApiDRBarItemsState + */ + disabled?: boolean; + /** + * @description 是否展示 + * @type {boolean} + * @memberof IApiDRBarItemsState + */ + visible?: boolean; + /** + * @description 标识 + * @type {string} + * @memberof IApiDRBarItemsState + */ + dataAccessAction?: string; + /** + * @description 图片资源 + * @type {ISysImage} + * @memberof IApiDRBarItemsState + */ + sysImage?: ISysImage; + /** + * + * @description 子成员 + * @type {IDRBarItemsState[]} + * @memberof IApiDRBarItemsState + */ + children?: IApiDRBarItemsState[]; + /** + * @description 全路径 + * @type {string} + * @memberof IApiDRBarItemsState + */ + fullPath?: string; + /** + * @description 计数器标识 + * @type {string} + * @memberof IApiDRBarItemsState + */ + counterId?: string; + /** + * @description 启用模式 + * @type {string} + * @memberof IApiDRBarItemsState + */ + enableMode?: string; + /** + * @description 实体逻辑 + * @type {string} + * @memberof IApiDRBarItemsState + */ + testAppDELogicId?: string; + /** + * @description 脚本代码 + * @type {string} + * @memberof IApiDRBarItemsState + */ + testScriptCode?: string; + /** + * @description 计数器模式 + * @type {number} + * @memberof IApiDRBarItemsState + */ + counterMode?: number; } /** - * @description 消息提示参数接口 + * @description 关系栏状态接口 * @export - * @interface IApiMessageParams + * @interface IApiDrBarState + * @extends {IApiControlState} */ -export interface IApiMessageParams { - /** - * @description 类型（默认info） - * @type {('success' | 'info' | 'warning' | 'error')} - * @memberof IApiMessageParams - */ - type?: 'success' | 'info' | 'warning' | 'error'; - /** - * @description 消息内容 - * @type {string} - * @memberof IApiMessageParams - */ - message: string; - /** - * @description 持续时间，单位：秒，默认：1.5 - * @type {number} - * @memberof IApiMessageParams - */ - duration?: number; - /** - * @description 显示关闭按钮，默认：false - * @type {boolean} - * @memberof IApiMessageParams - */ - showClose?: boolean; - /** - * @description 预置的样式类型 - * @type {'alert'} - * @memberof IApiMessageParams - */ - styleType?: 'alert'; +export interface IApiDRBarState extends IApiControlState { + /** + * @description 默认显示的项的id + * @type {string} + * @memberof IApiDrBarState + */ + defaultItem: string; + /** + * @description 选中的项的id + * @type {string} + * @memberof IApiDrBarState + */ + selectedItem: string; + /** + * @description 隐藏编辑项 + * @type {boolean} + * @memberof IApiDrBarState + */ + hideEditItem?: boolean; + /** + * @description 导航数据 + * @type {string} + * @memberof IApiDrBarState + */ + srfnav: string; + /** + * @description 关系项集合 + * @type {IApiDRBarItemsState[]} + * @memberof IApiDrBarState + */ + drBarItems: IApiDRBarItemsState[]; + /** + * @description 是否已计算项权限 + * @type {boolean} + * @memberof IApiDrBarState + */ + isCalculatedPermission?: boolean; } /** - * @description 主动操作后的反馈提示，顶部居中显示，并自动消失 + * @description 关系分页项状态接口 * @export - * @interface IApiMessageUtil + * @interface IApiDRTabPagesState */ -export interface IApiMessageUtil { - /** - * @description 弹出普通消息 - * @param {string} msg 消息内容 - * @param {number} [duration] 持续时间，单位：秒，默认：1.5 - * @param {boolean} [closable] 显示关闭按钮，默认：false - * @memberof IApiMessageUtil - */ - info(msg: string, duration?: number, closable?: boolean): void; - /** - * @description 弹出成功消息 - * @param {string} msg 消息内容 - * @param {number} [duration] 持续时间，单位：秒，默认：1.5 - * @param {boolean} [closable] 显示关闭按钮，默认：false - * @memberof IApiMessageUtil - */ - success(msg: string, duration?: number, closable?: boolean): void; - /** - * @description 弹出警告消息 - * @param {string} msg 消息内容 - * @param {number} [duration] 持续时间，单位：秒，默认：1.5 - * @param {boolean} [closable] 显示关闭按钮，默认：false - * @memberof IApiMessageUtil - */ - warning(msg: string, duration?: number, closable?: boolean): void; - /** - * @description 弹出错误消息 - * @param {string} msg 消息内容 - * @param {number} [duration] 持续时间，单位：秒，默认：1.5 - * @param {boolean} [closable] 显示关闭按钮，默认：false - * @memberof IApiMessageUtil - */ - error(msg: string, duration?: number, closable?: boolean): void; - /** - * @description 通用消息方法 - * @param {IApiData} params 配置详细的参数，详情参见：https://element-plus.org/zh-CN/component/message.html#message-%E9%85%8D%E7%BD%AE%E9%A1%B9 - * @memberof IApiMessageUtil - */ - notice(params: IApiData): void; +export interface IApiDRTabPagesState { + /** + * @description 项标识 + * @type {string} + * @memberof IApiDRTabPagesState + */ + tag: string; + /** + * @description 是否隐藏 + * @type {boolean} + * @memberof IApiDRTabPagesState + */ + hidden: boolean; + /** + * @description 项标题 + * @type {string} + * @memberof IApiDRTabPagesState + */ + caption?: string; + /** + * @description 是否禁用 + * @type {boolean} + * @memberof IApiDRTabPagesState + */ + disabled?: boolean; + /** + * @description 图片资源 + * @type {ISysImage} + * @memberof IApiDRTabPagesState + */ + sysImage?: ISysImage; + /** + * @description 全路径 + * @type {string} + * @memberof IApiDRTabPagesState + */ + fullPath?: string; + /** + * @description 计数器标识 + * @type {string} + * @memberof IApiDRTabPagesState + */ + counterId?: string; + /** + * @description 实体数据操作标识 + * @type {string} + * @memberof IApiDRTabPagesState + */ + dataAccessAction?: string; + /** + * @description 启用模式 + * @type {string} + * @memberof IApiDRTabPagesState + */ + enableMode?: string; + /** + * @description 实体逻辑 + * @type {string} + * @memberof IApiDRTabPagesState + */ + testAppDELogicId?: string; + /** + * @description 脚本代码 + * @type {string} + * @memberof IApiDRTabPagesState + */ + testScriptCode?: string; + /** + * @description 计数器模式 + * @type {number} + * @memberof IApiDRTabPagesState + */ + counterMode?: number; } /** - * @description 全局通知参数 + * @description 数据关系分页UI状态接口 * @export - * @interface IApiNotificationParams + * @interface IApiDRTabState + * @extends {IApiControlState} */ -export interface IApiNotificationParams { - /** - * @description 标题 - * @type {string} - * @memberof IApiNotificationParams - */ - title?: string; - /** - * @description 描述 - * @type {string} - * @memberof IApiNotificationParams - */ - desc?: string; - /** - * @description 描述是否是html字符串 - * @type {boolean} - * @memberof IApiNotificationParams - */ - isHtmlDesc?: boolean; - /** - * @description 自动关闭的延时，单位秒，不关闭可以写 0 - * @type {number} - * @memberof IApiNotificationParams - */ - duration?: number; - /** - * @description 位置 - * @type {('top-right' | 'top-left' | 'bottom-right' | 'bottom-left')} - * @memberof IApiNotificationParams - */ - position?: 'top-right' | 'top-left' | 'bottom-right' | 'bottom-left'; - /** - * @description 自定义类名 - * @type {string} - * @memberof IApiNotificationParams - */ - class?: string; - /** - * @description 点击事件回调 - * @memberof IApiNotificationParams - */ - onClick?: () => void; +export interface IApiDRTabState extends IApiControlState { + /** + * @description 关系分页数据 + * @type {IApiDRTabPagesState[]} + * @memberof IApiDRTabState + */ + drTabPages: IApiDRTabPagesState[]; + /** + * @description 激活分页标识 + * @type {string} + * @memberof IApiDRTabState + */ + activeName: string; + /** + * @description 默认分页标识（如果有表单的话默认是空字符串） + * @type {string} + * @memberof IApiDRTabState + */ + defaultName: string; + /** + * @description 是否已计算项权限 + * @type {boolean} + * @memberof IApiDRTabState + */ + isCalculatedPermission?: boolean; + /** + * @description 显示更多 + * @type {boolean} + * @memberof IApiDRTabState + */ + showMore: boolean; + /** + * @description 隐藏编辑项 + * @type {boolean} + * @memberof IApiDRTabState + */ + hideEditItem?: boolean; } /** - * @description 悬浮出现在界面右上角，显示全局的通知 + * @description 看板部件（kanban）部件状态接口 * @export - * @interface IApiNotificationUtil + * @interface IApiKanbanState + * @extends {IApiDataViewControlState} */ -export interface IApiNotificationUtil { - /** - * @description 弹出默认通知 - * @param {IApiNotificationParams} params - * @memberof IApiNotificationUtil - */ - default(params: IApiNotificationParams): void; - /** - * @description 弹出普通通知 - * @param {IApiNotificationParams} params - * @memberof IApiNotificationUtil - */ - info(params: IApiNotificationParams): void; - /** - * @description 弹出成功通知 - * @param {IApiNotificationParams} params - * @memberof IApiNotificationUtil - */ - success(params: IApiNotificationParams): void; - /** - * @description 弹出警告通知 - * @param {IApiNotificationParams} params - * @memberof IApiNotificationUtil - */ - warning(params: IApiNotificationParams): void; - /** - * @description 弹出失败通知 - * @param {IApiNotificationParams} params - * @memberof IApiNotificationUtil - */ - error(params: IApiNotificationParams): void; +export interface IApiKanbanState extends IApiDataViewControlState { + /** + * @description 是否可拖拽 + * @type {boolean} + * @memberof IApiKanbanState + */ + draggable: boolean; + /** + * @description 是否只读 + * @type {boolean} + * @memberof IApiKanbanState + */ + readonly: boolean; + /** + * @description 是否正在更新 + * @type {boolean} + * @memberof IApiKanbanState + */ + updating: boolean; + /** + * @description 是否正在批操作 + * @type {boolean} + * @memberof IApiKanbanState + */ + batching: boolean; + /** + * @description 分组数据 + * @type {IApiKanbanGroupState[]} + * @memberof IApiKanbanState + */ + groups: IApiKanbanGroupState[]; + /** + * @description 选中分组标识 + * @type {(string | number)} + * @memberof IApiKanbanState + */ + selectGroupKey: string | number; } /** - * @description 打开视图工具类 + * @description 看板分组状态 * @export - * @interface IApiOpenViewUtil + * @interface IApiKanbanGroupState + * @extends {IApiMDControlGroupState} */ -export interface IApiOpenViewUtil { - /** - * @description 直接路径打开视图 - * @param {string} path - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - push(path: string): Promise; - /** - * @description 打开顶级视图(一般为路由打开) - * @param {string} appViewId - * @param {IApiContext} context - * @param {IApiParams} [params] - * @param {IApiData} [modalOptions] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - root( - appViewId: string, - context: IApiContext, - params?: IApiParams, - modalOptions?: IApiData, - ): Promise; - /** - * @description 打开顶级视图(模态方式打开) - * @param {string} appViewId - * @param {IApiContext} context - * @param {IApiParams} [params] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - rootByModal( - appViewId: string, - context: IApiContext, - params?: IApiParams, - ): Promise; - /** - * @description 打开模态视图 - * @param {string} appViewId - * @param {IApiContext} context - * @param {IApiParams} [params] - * @param {IApiOverlayContainerOptions} [options] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - modal( - appViewId: string, - context: IApiContext, - params?: IApiParams, - options?: IApiOverlayContainerOptions, - ): Promise; - /** - * @description 气泡模式打开 - * @param {string} appViewId - * @param {MouseEvent} event - * @param {IApiContext} context - * @param {IApiParams} [params] - * @param {(IApiPopoverOptions & IApiOverlayContainerOptions)} [options] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - popover( - appViewId: string, - event: MouseEvent, - context: IApiContext, - params?: IApiParams, - options?: IApiPopoverOptions & IApiOverlayContainerOptions, - ): Promise; - /** - * @description 抽屉模式打开 - * @param {string} appViewId - * @param {IApiContext} context - * @param {IApiParams} [params] - * @param {IApiOverlayContainerOptions} [options] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - drawer( - appViewId: string, - context: IApiContext, - params?: IApiParams, - options?: IApiOverlayContainerOptions, - ): Promise; - /** - * @description 自定义打开方式 - * @param {string} appViewId - * @param {IApiContext} context - * @param {IApiParams} [params] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - custom( - appViewId: string, - context: IApiContext, - params?: IApiParams, - ): Promise; - /** - * @description 独立程序打开 - * @param {string} appViewId - * @param {IApiContext} context - * @param {IApiParams} [params] - * @returns {*} {Promise} - * @memberof IApiOpenViewUtil - */ - popupApp( - appViewId: string, - context: IApiContext, - params?: IApiParams, - ): Promise; +export interface IApiKanbanGroupState extends IApiMDControlGroupState { + /** + * @description 颜色 + * @type {string} + * @memberof IApiKanbanGroupState + */ + color?: string; + /** + * @description 快速工具栏控制器 + * @type {IApiToolbarController} + * @memberof IApiKanbanGroupState + */ + quickToolbarController?: IApiToolbarController; + /** + * @description 批操作工具栏控制器 + * @type {IApiToolbarController} + * @memberof IApiKanbanGroupState + */ + batchToolbarController?: IApiToolbarController; } /** - * @description 全屏工具类 + * @description 列表部件状态接口 * @export - * @interface IApiFullscreenUtil + * @interface IApiListState + * @extends {IApiMDControlState} */ -export interface IApiFullscreenUtil { - /** - * @description 指定元素全屏 - * @param {HTMLDivElement} div - * @param {IApiData} [data] - * @memberof IApiFullscreenUtil - */ - openElementFullscreen(div: HTMLDivElement, data?: IApiData): void; - /** - * @description 退出全屏 - * @memberof IApiFullscreenUtil - */ - closeElementFullscreen(): void; +export interface IApiListState extends IApiMDControlState { + /** + * @description 是否支持分页栏 + * @type {boolean} + * @memberof IApiListState + */ + enablePagingBar?: boolean; + /** + * @description 展开key集合 + * @type {string[]} + * @memberof IApiListState + */ + expandedKeys: string[]; } /** - * @description 二维码工具 + * @description 地图部件状态接口 * @export - * @interface IApiQrcodeUtil + * @interface IMapState + * @extends {IApiMDControlState} */ -export interface IApiQrcodeUtil { - /** - * @description 扫描二维码 - * @param {(IApiParams | undefined)} [options] 创建二维码参数配置 - * @returns {*} {Promise} - * @memberof IApiQrcodeUtil - */ - scanQrcode(options?: IApiParams | undefined): Promise; - /** - * @description 创建二维码 - * @param {string} value 创建二维码需要的文本值 - * @param {(IApiParams | undefined)} [options] 创建二维码参数配置 - * @returns {*} {IApiParams} - * @memberof IApiQrcodeUtil - */ - createQrcode(value: string, options?: IApiParams | undefined): IApiParams; +export interface IApiMapState extends IApiMDControlState { + /** + * @description 地图数据 + * @type {IMapData[]} + * @memberof IMapState + */ + items: IApiMapData[]; + /** + * @description 点的数据 + * @type {IMapData[]} + * @memberof IMapState + */ + pointData: IApiMapData[]; + /** + * @description 区域的数据 + * @type {IMapData[]} + * @memberof IMapState + */ + areaData: IApiMapData[]; + /** + * @description 区域编码是否是字符串 + * @type {boolean} + * @memberof IMapState + */ + strAreaCode: boolean; + /** + * @description 默认显示的区域代码 + * @type {(string | number)} + * @memberof IMapState + */ + defaultAreaCode: string | number; + /** + * @description 当前区域代码 + * @type {(string | number)} + * @memberof IMapState + */ + areaCode: string | number; + /** + * @description 地图json数据基础路径 + * @type {string} + * @memberof IMapState + */ + jsonBaseUrl?: string; + /** + * @description 地图信息 + * @type {IApiData} + * @memberof IMapState + */ + mapInfo: IApiData; } /** - * @description 运行时总集 + * @description 地图数据格式接口 * @export - * @interface IApiRuntimeIbizsys + * @interface IApiMapData */ -export interface IApiRuntimeIbizsys { - /** - * @description 应用中心服务 - * @type {IApiAppHubService} - * @memberof IApiRuntimeIbizsys - */ - hub: IApiAppHubService; - /** - * @description 全局配置 - * @type {IApiGlobalConfig} - * @memberof IApiRuntimeIbizsys - */ - config: IApiGlobalConfig; - /** - * @description 消息提示服务 - * @type {IApiModalUtil} - * @memberof IApiRuntimeIbizsys - */ - modal: IApiModalUtil; - /** - * @description 确认消息服务 - * @type {IApiConfirmUtil} - * @memberof IApiRuntimeIbizsys - */ - confirm: IApiConfirmUtil; - /** - * @description 顶部居中显示反馈提示服务 - * @type {IApiMessageUtil} - * @memberof IApiRuntimeIbizsys - */ - message: IApiMessageUtil; - /** - * @description 全局通知服务 - * @type {IApiNotificationUtil} - * @memberof IApiRuntimeIbizsys - */ - notification: IApiNotificationUtil; - /** - * @description 打开视图服务 - * @type {IApiOpenViewUtil} - * @memberof IApiRuntimeIbizsys - */ - openView: IApiOpenViewUtil; - /** - * @description 全屏工具服务 - * @type {IApiFullscreenUtil} - * @memberof IApiRuntimeIbizsys - */ - fullscreenUtil: IApiFullscreenUtil; - /** - * @description 二维码工具服务 - * @type {IApiQrcodeUtil} - * @memberof IApiRuntimeIbizsys - */ - qrcodeUtil: IApiQrcodeUtil; +export interface IApiMapData { + /** + * @description 唯一标识 + * @type {string} + * @memberof IApiMapData + */ + _id: string; + /** + * @description 呈现样式 + * @type {string} + * @memberof IApiMapData + */ + _itemStyle: string; + /** + * @description 地图项id + * @type {string} + * @memberof IApiMapData + */ + _mapItemId: string; + /** + * @description 经度 + * @type {string} + * @memberof IApiMapData + */ + _longitude?: string; + /** + * @description 纬度 + * @type {string} + * @memberof IApiMapData + */ + _latitude?: string; + /** + * @description 区域标识 + * @type {string} + * @memberof IApiMapData + */ + _areaCode?: string; + /** + * @description 提示信息 + * @type {string} + * @memberof IApiMapData + */ + _tooltip?: string; + /** + * @description 统计数据值 + * @type {number} + * @memberof IApiMapData + */ + _value?: number; + /** + * @description 文本值 + * @type {string} + * @memberof IApiMapData + */ + _text?: string; + /** + * @description 图标 + * @type {string} + * @memberof IApiMapData + */ + _symbol?: string; } - /** - * @description 环境变量配置接口 + * @description 多编辑视图面板部件状态接口 * @export - * @interface IApiEnvGlobalConfig + * @interface IMEditViewPanelState + * @extends {IApiMDControlState} */ -export interface IApiEnvGlobalConfig { - /** - * @description 全局配置 - * @type {IApiGlobalConfig} - */ - globalConfig: IApiGlobalConfig; +export interface IApiMEditViewPanelState extends IApiMDControlState { + /** + * @description 编辑视图面板部件UI数据集合 + * @type {IApiPanelUiItem[]} + * @memberof IApiMEditViewPanelState + */ + panelUiItems: IApiPanelUiItem[]; + /** + * @description 当前激活分页（上分页时启用） + * @type {string} + * @memberof IMEditViewPanelState + */ + activeTab: string; } - /** - * @description 应用工具接口 + * @description 面板UI项接口 * @export - * @interface IApiUtil + * @interface IApiPanelUiItem */ -export interface IApiUtil { - /** - * @description 消息通知服务 - * @type {IApiMessageUtil} - */ - message: IApiMessageUtil; - /** - * @description 简洁信息提示服务 - * @type {IApiModalUtil} - */ - modal: IApiModalUtil; - /** - * @description 确认操作弹窗服务 - * @type {IApiConfirmUtil} - */ - confirm: IApiConfirmUtil; - /** - * @description 打开视图工具 - * @type {IApiOpenViewUtil} - */ - openView: IApiOpenViewUtil; -}; +export interface IApiPanelUiItem { + /** + * @description 唯一主键 + * @type {string} + * @memberof IApiPanelUiItem + */ + id: string; + /** + * @description 视图上下文 + * @type {IApiData} + * @memberof IApiPanelUiItem + */ + context: IApiData; + /** + * @description 视图参数 + * @type {IApiData} + * @memberof IApiPanelUiItem + */ + params: IApiData; + /** + * @description 该项数据 + * @type {IApiData} + * @memberof IApiPanelUiItem + */ + data: IApiData; + /** + * @description 主信息 + * @type {string} + * @memberof IApiPanelUiItem + */ + srfmajortext: string; +} +/** + * @description 多数据视图行状态接口 + * @export + * @interface IApiMobMDCtrlRowState + */ +export interface IApiMobMDCtrlRowState { + /** + * @description 界面行为状态 + * @type {{ [p: string]: IApiButtonContainerState }} + * @memberof IApiMobMDCtrlRowState + */ + uaColStates: { + [p: string]: IApiButtonContainerState; + }; + /** + * @description 行数据 + * @type {IApiData} + * @memberof IApiMobMDCtrlRowState + */ + data: IApiData; + /** + * @description 多数据部件控制器 + * @type {IApiMobMDCtrlController} + * @memberof IApiMobMDCtrlRowState + */ + controller: IApiMobMDCtrlController; +} +/** + * @description 移动端多数据部件状态接口 + * @export + * @interface IApiMobMdCtrlState + * @extends {IApiListState} + */ +export interface IApiMobMdCtrlState extends IApiListState { + /** + * @description 多数据视图行数据 + * @type {IApiMobMDCtrlRowState[]} + * @memberof IApiMobMdCtrlState + */ + rows: IApiMobMDCtrlRowState[]; +} +/** + * @description 选择视图面板状态接口 + * @export + * @interface IApiPickupViewPanelState + * @extends {IApiControlState} + */ +export interface IApiPickupViewPanelState extends IApiControlState { + /** + * @description 单选 + * @type {boolean} + * @memberof IApiPickupViewPanelState + */ + singleSelect: boolean; + /** + * @description 多数据部件激活模式 + * @type {(number | 0 | 1 | 2)} 值模式 [应用表格数据激活模式] {0：无、 1：单击、 2：双击 } + * @memberof IApiPickupViewPanelState + */ + mdctrlActiveMode: number | 0 | 1 | 2; + /** + * @description 嵌入选择视图的上下文 + * @type {IApiContext} + * @memberof IApiPickupViewPanelState + */ + context: IApiContext; + /** + * @description 嵌入选择视图的视图参数 + * @type {IApiParams} + * @memberof IApiPickupViewPanelState + */ + params: IApiParams; +} +/** + * @description 报表部件状态接口 + * @export + * @interface IApiReportPanelState + * @extends {IApiControlState} + */ +export interface IApiReportPanelState extends IApiControlState { + /** + * @description 是否加载完成 + * @type {boolean} + * @memberof IApiReportPanelState + */ + isLoaded: boolean; + /** + * @description 搜索部件的查询参数 + * @type {IApiParams} + * @memberof IApiReportPanelState + */ + searchParams: IApiParams; + /** + * @description 报表数据 + * @type {(IApiData | IApiData[])} + * @memberof IApiReportPanelState + */ + data: IApiData | IApiData[]; + /** + * @description 是否正在处理中 + * @type {boolean} + * @memberof IApiReportPanelState + */ + processing: boolean; + /** + * @description 报表类型 + * @type {string} + * @memberof IApiReportPanelState + */ + reportType: string; +} +/** + * @description 存储的过滤条件项接口 + * @export + * @interface IApiStoredFilter + */ +export interface IApiStoredFilter { + /** + * @description 标题 + * @type {string} + * @memberof IApiStoredFilter + */ + name: string; + /** + * @description 搜索条件的数据 + * @type {IApiData} + * @memberof IApiStoredFilter + */ + data: IApiData; +} +/** + * @description 搜索表单状态接口 + * @export + * @interface IApiSearchFormState + * @extends {IApiFormState} + */ +export interface IApiSearchFormState extends IApiFormState { + /** + * @description 存储的过滤条件集合 + * @type {IApiStoredFilter[]} + * @memberof IApiSearchFormState + */ + storedFilters: IApiStoredFilter[]; +} +/** + * @description 分页状态接口 + * @export + * @interface IApiTabExpPanelPagesState + */ +export interface IApiTabExpPanelPagesState { + /** + * @description 分页标识 + * @type {string} + * @memberof IApiTabExpPanelPagesState + */ + tabTag: string; + /** + * @description 分页标题 + * @type {string} + * @memberof IApiTabExpPanelPagesState + */ + caption: string; + /** + * @description 当前分页缓存的全路径 + * @type {string} + * @memberof IApiTabExpPanelPagesState + */ + fullPath?: string; + /** + * @description 类名集合 + * @type {string[]} + * @memberof IApiTabExpPanelPagesState + */ + class: string[]; + /** + * @description 标题图标 + * @type {ISysImage} + * @memberof IApiTabExpPanelPagesState + */ + sysImage?: ISysImage; +} +/** + * @description 分页导航面板状态接口 + * @export + * @interface IApiTabExpPanelState + * @extends {IApiControlState} + */ +export interface IApiTabExpPanelState extends IApiControlState { + /** + * @description 分页数据 + * @type {ITabExpPanelPagesState[]} + * @memberof IApiTabExpPanelState + */ + tabPages: IApiTabExpPanelPagesState[]; + /** + * @description 激活分页标识 + * @type {string} + * @memberof IApiTabExpPanelState + */ + activeName: string; + /** + * @description 默认导航分页标识 + * @type {string} + * @memberof IApiTabExpPanelState + */ + defaultTabName: string; + /** + * @description 给导航的视图附加的视图参数 + * @type {IApiParams} + * @memberof IApiTabExpPanelState + */ + expViewParams: IApiParams; +} +/** + * @description 树导航栏状态接口 + * @export + * @interface IApiTreeExpBarState + * @extends {IApiExpBarControlState} + */ +export interface IApiTreeExpBarState extends IApiExpBarControlState { +} +/** + * @description 向导面板状态 + * @export + * @interface IApiWizardPanelState + * @extends {IApiControlState} + */ +export interface IApiWizardPanelState extends IApiControlState { + /** + * @description 当前激活的向导表单的表单标识 + * @type {string} + * @memberof IApiWizardPanelState + */ + activeFormTag: string; +} +/** + * @description 树节点数据格式 + * @export + * @interface IApiTreeNodeData + */ +export interface IApiTreeNodeData { + /** + * @description 节点数据的唯一标识（创建的时候自动生成） + * @type {string} + * @memberof IApiTreeNodeData + */ + _uuid: string; + /** + * @description 节点类型 + * @type {string} + * @memberof IApiTreeNodeData + */ + _nodeType?: string; + /** + * @description 节点标识(对应节点模型的id) + * @type {string} + * @memberof IApiTreeNodeData + */ + _nodeId: string; + /** + * @description 节点唯一标识，在父的id上加上自身的唯一标识，用>分隔;如：staticNode1>14>84847aa970ba3db7bbe00754aed3888d + * @type {string} + * @memberof IApiTreeNodeData + */ + _id: string; + /** + * @description 节点唯一标识，等同_id，树选择视图回显用 + * @type {string} + * @memberof IApiTreeNodeData + */ + srfnodeid: string; + /** + * @description 节点的值(可能是自己的主键，也可能是沿用父的值),静态节点可能没有节点值 + * @type {string} + * @memberof IApiTreeNodeData + */ + _value?: string; + /** + * @description 节点显示名称 + * @type {string} + * @memberof IApiTreeNodeData + */ + _text: string; + /** + * @description 是否是叶子节点（没有子节点的节点） + * @type {boolean} + * @memberof IApiTreeNodeData + */ + _leaf: boolean; + /** + * @description 资源路径相关上下文参数 + * 根据节点展开的主从关系，在父的基础上附加自身的实体主键 + * 附加关系上转换的导航上下文 + * @type {IApiParams} + * @memberof IApiTreeNodeData + */ + _context?: IApiParams; + /** + * @description 关系上转换的视图参数 + * @type {IApiParams} + * @memberof IApiTreeNodeData + */ + _params?: IApiParams; + /** + * @description 子节点集合（没有子节点则不存在） + * @type {IApiTreeNodeData[]} + * @memberof IApiTreeNodeData + */ + _children?: IApiTreeNodeData[]; + /** + * @description 父节点数据对象 + * @type {IApiTreeNodeData} + * @memberof IApiTreeNodeData + */ + _parent?: IApiTreeNodeData; + /** + * @description 实体数据 + * @type {IApiData} + * @memberof IApiTreeNodeData + */ + _deData?: IApiData; + /** + * @description 图标 + * @type {IApiData} + * @memberof IApiTreeNodeData + */ + _icon?: IApiData; + /** + * @description 节点文本的html显示 + * @type {string} + * @memberof IApiTreeNodeData + */ + _textHtml?: string; + /** + * @description 是否禁止选择 + * @type {boolean} + * @memberof IApiTreeNodeData + */ + _disableSelect?: boolean; + /** + * @description 作为实体数据时的主键 + * @type {string} + * @memberof IApiTreeNodeData + */ + srfkey?: string; + /** + * @description 作为实体数据时的主信息 + * @type {string} + * @memberof IApiTreeNodeData + */ + srfmajortext?: string; +} +/** + * @description 树部件状态 + * @export + * @interface IApiTreeState + * @extends {IApiMDControlState} + */ +export interface IApiTreeState extends IApiMDControlState { + /** + * @description 树节点集合 + * @type {IApiTreeNodeData[]} + * @memberof IApiTreeState + */ + items: IApiTreeNodeData[]; + /** + * @description 选中节点集合 + * @type {IApiTreeNodeData[]} + * @memberof IApiTreeState + */ + selectedData: IApiTreeNodeData[]; + /** + * @description 树的根节点 + * @type {IApiTreeNodeData[]} + * @memberof IApiTreeState + */ + rootNodes: IApiTreeNodeData[]; + /** + * @description 实际默认展开节点标识集合 + * @type {string[]} + * @memberof IApiTreeState + */ + expandedKeys: string[]; + /** + * @description 查询条件 + * @type {string} + * @memberof IApiTreeState + */ + query: string; + /** + * @description 快速搜索占位符 + * @type {string} + * @memberof IApiTreeState + */ + placeHolder: string; +} +/** + * @description 树表格部件状态 + * @export + * @interface IApiTreeGridState + * @extends {IApiGridState} + */ +export interface IApiTreeGridState extends IApiGridState { + /** + * @description 树表格是否显示树形结构(默认为true) + * @type {boolean} + * @memberof IApiTreeGridState + */ + showTreeGrid: boolean; + /** + * @description 树表格数据 + * @type {IApiData[]} + * @memberof IApiTreeGridState + */ + treeGirdData: IApiData[]; +} +/** + * @description 树表格(增强)部件状态 + * @export + * @interface IApiTreeGridExState + * @extends {IApiTreeState} + */ +export interface IApiTreeGridExState extends IApiTreeState { + /** + * @description 开启表格行编辑 + * @type {boolean} + * @memberof IApiTreeGridExState + */ + rowEditOpen: boolean; +} +export interface IApiTreeGridExRowState { + /** + * @description 行数据（一般是树节点的数据） + * @type {IApiTreeNodeData} + * @memberof IApiTreeGridExRowState + */ + data: IApiTreeNodeData; + /** + * @description 可能是以下两种类型状态 + * - 操作列按钮状态（p是操作列的标识） + * - 属性列的内置界面行为组状态(p是属性列的标识) + * @type {{ [p: string]: IApiButtonContainerState }} + * @memberof IApiTreeGridExRowState + */ + columnActionsStates: { + [p: string]: IApiButtonContainerState; + }; + /** + * @description 是否显示行编辑 + * @type {boolean} + * @memberof IApiTreeGridExRowState + */ + showRowEdit: boolean; +} +/** + * @description 甘特图部件状态 + * @export + * @interface IApiGanttState + * @extends {IApiTreeGridExState} + */ +export interface IApiGanttState extends IApiTreeGridExState { + /** + * @description 甘特图样式 + * @type {IGanttStyle} + * @memberof IApiGanttState + */ + ganttStyle: IApiGanttStyle; + /** + * @description 是否开启滑块拖拽 + * @type {boolean} + * @memberof IApiGanttState + */ + sliderDraggable: boolean; +} +/** + * @description 甘特图样式 + * @export + * @interface IApiGanttStyle + */ +export interface IApiGanttStyle { + /** + * @description 主题色 + * @type {string} + * @memberof IApiGanttStyle + */ + primaryColor?: string; + /** + * @description 文本色 + * @type {string} + * @memberof IApiGanttStyle + */ + textColor?: string; +} +/** + * @description 甘特节点数据 + * @export + * @interface IApiGanttNodeData + * @extends {IApiTreeNodeData} + */ +export interface IApiGanttNodeData extends IApiTreeNodeData { + /** + * @description 开始时间 + * @type {string} + * @memberof IApiGanttNodeData + */ + _beginDataItemValue: string; + /** + * @description 结束时间 + * @type {string} + * @memberof IApiGanttNodeData + */ + _endDataItemValue: string; + /** + * @description 前置数据 + * @type {(string | number)} + * @memberof IApiGanttNodeData + */ + _prevDataItemValue: string | number; + /** + * @description 完成量数据 + * @type {(string | number)} + * @memberof IApiGanttNodeData + */ + _finishDataItemValue: string | number; + /** + * @description 总量数据项 + * @type {(string | number)} + * @memberof IApiGanttNodeData + */ + _totalDataItemValue: string | number; + /** + * @description 子数据 + * @type {(IApiGanttNodeData[] | undefined)} + * @memberof IApiGanttNodeData + */ + _children?: IApiGanttNodeData[] | undefined; + /** + * @description 父节点数据对象 + * @type {IApiGanttNodeData} + * @memberof IApiGanttNodeData + */ + _parent?: IApiGanttNodeData; +} +/** + * @description 视图会话共享变量接口 + * @export + * @interface IApiViewSession + */ +export interface IApiViewSession { + /** + * @description 当前视图的数据 + * @type {(IApiData | null)} + * @memberof IApiViewSession + */ + srfactiveviewdata: IApiData | null; +} +/** + * @description 视图UI状态接口 + * @export + * @interface IApiViewState + * @extends {IApiControllerState} + * @extends {IApiViewSession} + */ +export interface IApiViewState extends IApiControllerState, IApiViewSession { + /** + * @description 当前视图是否为激活状态(缓存下的激活状态，一般与框架的生命周期相同) + * @type {boolean} + * @memberof IApiViewState + */ + activated: boolean; + /** + * @description 视图标题 + * @type {string} + * @memberof IApiViewState + */ + caption: string; + /** + * @description 视图是否正在加载 + * @type {boolean} + * @memberof IApiViewState + */ + isLoading: boolean; + /** + * @description 默认不加载 + * @type {boolean} + * @memberof IApiViewState + */ + noLoadDefault: boolean; + /** + * @description 当前视图是否出现错误 + * @type {boolean} + * @memberof IApiViewState + */ + hasError: boolean; + /** + * @description 关闭视图时返回给外面的状态 + * @type {boolean} + * @memberof IApiViewState + */ + closeOK?: boolean; + /** + * @description 视图正在关闭（用于阻止一些视图关闭后仍在继续的逻辑，比如表单保存时的通知） + * @type {boolean} + * @memberof IApiViewState + */ + isClosing: boolean; +} +/** + * @description 多数据视图UI状态 + * @export + * @interface IApiMDViewState + * @extends {IApiViewState} + */ +export interface IApiMDViewState extends IApiViewState { +} +/** + * @description 表格视图UI状态 + * @export + * @interface IApiGridViewState + * @extends {IApiMDViewState} + */ +export interface IApiGridViewState extends IApiMDViewState { +} +/** + * @description 应用数据导入视图UI状态 + * @export + * @interface IApiAppDataUploadViewState + * @extends {IApiViewState} + */ +export interface IApiAppDataUploadViewState extends IApiViewState { +} +/** + * @description 应用登录视图UI状态 + * @export + * @interface IApiAppLoginViewState + * @extends {IApiViewState} + */ +export interface IApiAppLoginViewState extends IApiViewState { +} +/** + * @description 实体看板视图UI状态 + * @export + * @interface IApiPortalViewState + * @extends {IApiViewState} + */ +export interface IApiPortalViewState extends IApiViewState { +} +/** + * @description 应用看板视图UI状态 + * @export + * @interface IApiAppPortalViewState + * @extends {IApiPortalViewState} + */ +export interface IApiAppPortalViewState extends IApiPortalViewState { +} +/** + * @description 导航视图UI状态 + * @export + * @interface IApiExpViewState + * @extends {IApiViewState} + */ +export interface IApiExpViewState extends IApiViewState { +} +/** + * @description 实体日历导航视图UI状态 + * @export + * @interface IApiCalendarExpViewState + * @extends {IApiExpViewState} + */ +export interface IApiCalendarExpViewState extends IApiExpViewState { +} +/** + * @description 实体日历视图UI状态 + * @export + * @interface IApiCalendarViewState + * @extends {IApiMDViewState} + */ +export interface IApiCalendarViewState extends IApiMDViewState { +} +/** + * @description 实体图表导航视图UI状态 + * @export + * @interface IApiChartExpViewState + * @extends {IApiExpViewState} + */ +export interface IApiChartExpViewState extends IApiExpViewState { +} +/** + * @description 实体图表视图UI状态 + * @export + * @interface IApiChartViewState + * @extends {IApiMDViewState} + */ +export interface IApiChartViewState extends IApiMDViewState { +} +/** + * @description 实体卡片视图导航视图UI状态 + * @export + * @interface IApiDataViewExpViewState + * @extends {IApiExpViewState} + */ +export interface IApiDataViewExpViewState extends IApiExpViewState { +} +/** + * @description 实体数据视图UI状态 + * @export + * @interface IApiDataViewState + * @extends {IApiMDViewState} + */ +export interface IApiDataViewState extends IApiMDViewState { +} +/** + * @description 实体首页视图UI状态 + * @export + * @interface IApiDEIndexViewState + * @extends {IApiViewState} + */ +export interface IApiDEIndexViewState extends IApiViewState { +} +/** + * @description 实体数据看板视图UI状态 + * @export + * @interface IApiDEPortalViewState + * @extends {IApiPortalViewState} + */ +export interface IApiDEPortalViewState extends IApiPortalViewState { +} +/** + * @description 实体编辑视图UI状态 + * @export + * @interface IApiEditViewState + * @extends {IApiViewState} + */ +export interface IApiEditViewState extends IApiViewState { +} +/** + * @description 实体编辑视图（左右关系）UI状态 + * @export + * @interface IApiEditView2State + * @extends {IApiEditViewState} + */ +export interface IApiEditView2State extends IApiEditViewState { +} +/** + * @description 实体编辑视图（分页关系）UI状态 + * @export + * @interface IApiEditView3State + * @extends {IApiEditViewState} + */ +export interface IApiEditView3State extends IApiEditViewState { +} +/** + * @description 实体编辑视图（上下关系）UI状态 + * @export + * @interface IApiEditView4State + * @extends {IApiEditViewState} + */ +export interface IApiEditView4State extends IApiEditViewState { +} +/** + * @description 实体选择数据视图（部件视图）UI状态 + * @export + * @interface IApiPickupDataViewState + * @extends {IApiDataViewState} + */ +export interface IApiPickupDataViewState extends IApiDataViewState { +} +/** + * @description 实体表单选择数据视图（部件视图）UI状态 + * @export + * @interface IApiFormPickupDataViewState + * @extends {IApiPickupDataViewState} + */ +export interface IApiFormPickupDataViewState extends IApiPickupDataViewState { +} +/** + * @description 实体甘特视图UI状态 + * @export + * @interface IApiGanttViewState + * @extends {IApiMDViewState} + */ +export interface IApiGanttViewState extends IApiMDViewState { +} +/** + * @description 实体表格导航视图UI状态 + * @export + * @interface IApiGridExpViewState + * @extends {IApiExpViewState} + */ +export interface IApiGridExpViewState extends IApiExpViewState { +} +/** + * @description 应用首页视图UI状态 + * @export + * @interface IApiIndexViewState + * @extends {IApiViewState} + */ +export interface IApiIndexViewState extends IApiViewState { +} +/** + * @description 实体看板视图UI状态 + * @export + * @interface IApiKanbanViewState + * @extends {IApiMDViewState} + */ +export interface IApiKanbanViewState extends IApiMDViewState { +} +/** + * @description 实体列表导航视图UI状态 + * @export + * @interface IApiListExpViewState + * @extends {IApiExpViewState} + */ +export interface IApiListExpViewState extends IApiExpViewState { +} +/** + * @description 实体列表视图UI状态 + * @export + * @interface IApiListViewState + * @extends {IApiMDViewState} + */ +export interface IApiListViewState extends IApiMDViewState { +} +/** + * @description 实体地图视图UI状态 + * @export + * @interface IApiMapViewState + * @extends {IApiMDViewState} + */ +export interface IApiMapViewState extends IApiMDViewState { +} +/** + * @description 实体多表单编辑视图（部件视图）UI状态 + * @export + * @interface IApiMEditView9State + * @extends {IApiMDViewState} + */ +export interface IApiMEditView9State extends IApiMDViewState { +} +/** + * @description 实体数据多项选择视图UI状态 + * @export + * @interface IApiMPickupViewState + * @extends {IApiViewState} + */ +export interface IApiMPickupViewState extends IApiViewState { +} +/** + * @description 实体选项操作视图UI状态 + * @export + * @interface IApiOptViewState + * @extends {IApiViewState} + */ +export interface IApiOptViewState extends IApiViewState { +} +/** + * @description 实体面板视图UI状态 + * @export + * @interface IApiPanelViewState + * @extends {IApiViewState} + */ +export interface IApiPanelViewState extends IApiViewState { +} +/** + * @description 实体选择表格视图（部件视图）UI状态 + * @export + * @interface IApiPickupGridViewState + * @extends {IApiGridViewState} + */ +export interface IApiPickupGridViewState extends IApiGridViewState { +} +/** + * @description 选择多数据视图UI状态 + * @export + * @interface IApiPickupMDViewState + * @extends {IApiMDViewState} + */ +export interface IApiPickupMDViewState extends IApiMDViewState { +} +/** + * @description 实体树视图UI状态 + * @export + * @interface IApiTreeViewState + * @extends {IApiMDViewState} + */ +export interface IApiTreeViewState extends IApiMDViewState { +} +/** + * @description 实体选择树视图（部件视图）UI状态 + * @export + * @interface IApiPickupTreeViewState + * @extends {IApiTreeViewState} + */ +export interface IApiPickupTreeViewState extends IApiTreeViewState { +} +/** + * @description 实体数据选择视图UI状态 + * @export + * @interface IApiPickupViewState + * @extends {IApiViewState} + */ +export interface IApiPickupViewState extends IApiViewState { +} +/** + * @description 实体报表视图UI状态 + * @export + * @interface IApiReportViewState + * @extends {IApiViewState} + */ +export interface IApiReportViewState extends IApiViewState { +} +/** + * @description 实体子应用引用视图UI状态 + * @export + * @interface IApiSubAppRefViewState + * @extends {IApiViewState} + */ +export interface IApiSubAppRefViewState extends IApiViewState { +} +/** + * @description 实体分页导航视图UI状态 + * @export + * @interface IApiTabExpViewState + * @extends {IApiViewState} + */ +export interface IApiTabExpViewState extends IApiViewState { +} +/** + * @description 实体分页搜索视图UI状态 + * @export + * @interface IApiTabSearchViewState + * @extends {IApiViewState} + */ +export interface IApiTabSearchViewState extends IApiViewState { +} +/** + * @description 实体树导航视图UI状态 + * @export + * @interface IApiTreeExpViewState + * @extends {IApiMDViewState} + */ +export interface IApiTreeExpViewState extends IApiMDViewState { +} +/** + * @description 实体树表格视图（增强）UI状态 + * @export + * @interface IApiTreeGridExViewState + * @extends {IApiMDViewState} + */ +export interface IApiTreeGridExViewState extends IApiMDViewState { +} +/** + * @description 实体树表格视图UI状态 + * @export + * @interface IApiTreeGridViewState + * @extends {IApiMDViewState} + */ +export interface IApiTreeGridViewState extends IApiMDViewState { +} +/** + * @description 实体工作流编辑视图UI状态 + * @export + * @interface IApiWFEditViewState + * @extends {IApiViewState} + */ +export interface IApiWFEditViewState extends IApiViewState { +} +/** + * @description 实体工作流动态编辑视图UI状态 + * @export + * @interface IApiWFDynaEditViewState + * @extends {IApiWFEditViewState} + */ +export interface IApiWFDynaEditViewState extends IApiWFEditViewState { +} +/** + * @description 实体工作流动态操作视图UI状态 + * @export + * @interface IApiWFDynaActionViewState + * @extends {IApiWFDynaEditViewState} + */ +export interface IApiWFDynaActionViewState extends IApiWFDynaEditViewState { +} +/** + * @description 实体工作流动态视图（分页关系）UI状态 + * @export + * @interface IApiWFDynaEditView3State + * @extends {IApiWFDynaEditViewState} + */ +export interface IApiWFDynaEditView3State extends IApiWFDynaEditViewState { +} +/** + * @description 实体工作流动态启动视图UI状态 + * @export + * @interface IApiWFDynaStartViewState + * @extends {IApiWFEditViewState} + */ +export interface IApiWFDynaStartViewState extends IApiWFEditViewState { +} +/** + * @description 应用流程跟踪视图UI状态 + * @export + * @interface IApiWFStepTraceViewState + * @extends {IApiViewState} + */ +export interface IApiWFStepTraceViewState extends IApiViewState { +} +/** + * @description 实体向导视图UI状态 + * @export + * @interface IApiWizardViewState + * @extends {IApiViewState} + */ +export interface IApiWizardViewState extends IApiViewState { +} +/** + * @description 视图控制器接口 + * @export + * @interface IApiViewController + * @extends {IApiController} + * @template T + * @template S + */ +export interface IApiViewController extends IApiController { + /** + * @description 视图级共享数据对象 + * @type {IApiData} + * @memberof IApiViewController + */ + session: IApiData; + /** + * @description 视图错误信息 + * @type {IApiData} + * @memberof IApiViewController + */ + error: IApiData; + /** + * @description 上层视图控制器对象，顶层视图没有父 + * @type {((IApiViewController & IApiData) | undefined)} + * @memberof IApiViewController + */ + readonly parentView: (IApiViewController & IApiData) | undefined; + /** + * @description 视图是否处于激活状态 + * @type {boolean} + * @memberof IApiViewController + */ + readonly isActive: boolean; + /** + * @description 视图布局面板 + * @type {(IApiViewLayoutPanelController & IApiData)} + * @memberof IApiViewController + */ + layoutPanel?: IApiViewLayoutPanelController & IApiData; + /** + * @description 关闭视图 + * @param {IApiModalData} [modalData] + * @returns {*} {Promise} + * @memberof IApiViewController + */ + closeView(modalData?: IApiModalData): Promise; + /** + * @description 重绘视图 + * @param {IRedrawData} redrawData + * @memberof IApiViewController + */ + redrawView(redrawData: IApiRedrawData): void; + /** + * @description 执行视图的能力 + * @template A + * @param {string} key 视图能力的唯一标识 + * @param {A} [args] 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiViewController + */ + call(key: string, args?: any): Promise; + /** + * @description 开启视图loading + * @memberof IApiViewController + */ + startLoading(): void; + /** + * @description 关闭视图loading + * @memberof IApiViewController + */ + endLoading(): void; + /** + * @description 获取当前实例 + * @template K + * @param {K} type 视图类型 + * @returns {*} {IApiViewMapping[K]} + * @memberof IApiViewController + */ + getCurrentInstance(type: K): IApiViewMapping[K]; + /** + * @description 获取部件 + * @template K + * @param {K} type 部件类型 + * @param {string} name 部件名称 + * @param {boolean} [traceRoot] 是否跨越视图作用域，一路向根上找 + * @returns {*} {IApiControlMapping[K]} + * @memberof IApiViewController + */ + getCtrl(type: K, name: string, traceRoot?: boolean): IApiControlMapping[K]; +} +/** + * @description 移动端视图控制器接口 + * @export + * @interface IApiMobViewController + * @extends {IApiViewController} + * @template T + */ +export interface IApiMobViewController extends IApiViewController { +} +/** + * @description 视图能力 + * @export + * @interface IApiViewCall + */ +export interface IApiViewCall { + /** + * @description 获取数据（多数据指选中数据） + * @type {{ + * args: undefined; + * }} + * @memberof IApiViewCall + */ + GetData: { + args: undefined; + }; + /** + * @description 拷贝路径 + * @type {{ + * args: undefined; + * }} + * @memberof IApiViewCall + */ + CopyPath: { + args: undefined; + }; + /** + * @description 快捷方式(最小化) + * @type {{ + * args: { data: IApiData[] }; + * }} + * @memberof IApiViewCall + */ + ShortCut: { + args: { + data: IApiData[]; + }; + }; + /** + * @description 切换搜索表单显示 + * @type {{ + * args: undefined; + * }} + * @memberof IApiViewCall + */ + ToggleFilter: { + args: undefined; + }; + /** + * @description 搜索 + * @type {{ + * args: undefined; + * }} + * @memberof IApiViewCall + */ + Search: { + args: undefined; + }; + /** + * @description 重置 + * @type {{ + * args: undefined; + * }} + * @memberof IApiViewCall + */ + Reset: { + args: undefined; + }; +} +/** + * @description 实体自定义视图能力 + * @export + * @interface IApiCustomViewCall + * @extends {IApiViewCall} + */ +export interface IApiCustomViewCall extends IApiViewCall { + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiCustomViewCall + */ + Refresh: { + args: undefined; + }; +} +/** + * @description 多数据视图能力 + * @export + * @interface IApiMDViewCall + * @extends {IApiViewCall} + */ +export interface IApiMDViewCall extends IApiViewCall { + /** + * @description 打开编辑数据视图 + * @type {{ + * args: { + * data: IApiData[]; + * event?: MouseEvent; + * context?: IApiContext; + * params?: IApiParams; + * }; + * }} + * @memberof IApiMDViewCall + */ + Edit: { + args: { + data: IApiData[]; + event?: MouseEvent; + context?: IApiContext; + params?: IApiParams; + }; + }; + /** + * @description 查看 + * @type {{ + * args: { + * data: IApiData[]; + * event?: MouseEvent; + * context?: IApiContext; + * params?: IApiParams; + * }; + * }} + * @memberof IApiMDViewCall + */ + View: { + args: { + data: IApiData[]; + event?: MouseEvent; + context?: IApiContext; + params?: IApiParams; + }; + }; + /** + * @description 打开新建数据视图 + * @type {{ + * args: { + * data: IApiData[]; + * event?: MouseEvent; + * copyMode?: boolean; + * }; + * }} + * @memberof IApiMDViewCall + */ + New: { + args: { + data: IApiData[]; + event?: MouseEvent; + copyMode?: boolean; + }; + }; + /** + * @description 删除 + * @type {{ + * args?: IApiMDCtrlRemoveParams; + * }} + * @memberof IApiMDViewCall + */ + Remove: { + args?: IApiMDCtrlRemoveParams; + }; + /** + * @description 数据导入 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMDViewCall + */ + Import: { + args: undefined; + }; + /** + * @description 视图刷新 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMDViewCall + */ + Refresh: { + args: undefined; + }; + /** + * @description 数据导出 + * @type {{ + * args: { event: MouseEvent }; + * }} + * @memberof IApiMDViewCall + */ + ExportExcel: { + args: { + event: MouseEvent; + }; + }; + /** + * @description 拷贝 + * @type {{ + * args: { data: IApiData[]; event?: MouseEvent }; + * }} + * @memberof IApiMDViewCall + */ + Copy: { + args: { + data: IApiData[]; + event?: MouseEvent; + }; + }; + /** + * @description 视图加载（特指初始化加载） + * @type {{ + * args: IApiMDCtrlLoadParams; + * }} + * @memberof IApiMDViewCall + */ + Load: { + args: IApiMDCtrlLoadParams; + }; + /** + * @description 获取所有数据（多数据专用，获取全部数据） + * @type {{ + * args: undefined; + * }} + * @memberof IApiMDViewCall + */ + GetAllData: { + args: undefined; + }; +} +/** + * @description 实体数据视图能力 + * @export + * @interface IApiDataViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiDataViewCall extends IApiMDViewCall { + /** + * @description 展开 + * @type {{ + * args: { params: { srfcollapsetag?: string; srfgroup?: string } }; + * }} + * @memberof IApiDataViewCall + */ + Expand: { + args: { + params: { + srfcollapsetag?: string; + srfgroup?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { params: { srfcollapsetag?: string; srfgroup?: string } }; + * }} + * @memberof IApiDataViewCall + */ + Collapse: { + args: { + params: { + srfcollapsetag?: string; + srfgroup?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiDataViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiDataViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体编辑视图能力 + * @export + * @interface IApiEditViewCall + * @extends {IApiViewCall} + */ +export interface IApiEditViewCall extends IApiViewCall { + /** + * @description 保存 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + Save: { + args: undefined; + }; + /** + * @description 保存并关闭 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + SaveAndExit: { + args: undefined; + }; + /** + * @description 删除并关闭 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + RemoveAndExit: { + args: undefined; + }; + /** + * @description 保存并新建 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + SaveAndNew: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + Refresh: { + args: undefined; + }; + /** + * @description 工作流启动 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + SaveAndStart: { + args: undefined; + }; + /** + * @description 第一个记录 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + FirstRecord: { + args: undefined; + }; + /** + * @description 最后一个记录 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + LastRecord: { + args: undefined; + }; + /** + * @description 上一个记录 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + PrevRecord: { + args: undefined; + }; + /** + * @description 下一个记录 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + NextRecord: { + args: undefined; + }; + /** + * @description 工作流提交 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + ViewWFStep: { + args: undefined; + }; + /** + * @description 视图加载（特指初始化加载） + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + Load: { + args: undefined; + }; + /** + * @description 校验数据（编辑视图才用） + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + Validate: { + args: undefined; + }; + /** + * @description 流程撤回 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + WFWithdraw: { + args: undefined; + }; + /** + * @description 展开 + * @type {{ + * args: { params: { srfcollapsetag?: string; srfgroupid?: string } }; + * }} + * @memberof IApiEditViewCall + */ + Expand: { + args: { + params: { + srfcollapsetag?: string; + srfgroupid?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { params: { srfcollapsetag?: string; srfgroupid?: string } }; + * }} + * @memberof IApiEditViewCall + */ + Collapse: { + args: { + params: { + srfcollapsetag?: string; + srfgroupid?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiEditViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体选择数据视图（部件视图）能力 + * @export + * @interface IApiPickupDataViewCall + * @extends {IApiDataViewCall} + */ +export interface IApiPickupDataViewCall extends IApiDataViewCall { + /** + * @description 获取所有数据（多数据专用，获取全部数据） + * @type {{ + * args: undefined; + * }} + * @memberof IApiPickupDataViewCall + */ + GetAllData: { + args: undefined; + }; +} +/** + * @description 实体甘特视图能力 + * @export + * @interface IApiGanttViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiGanttViewCall extends IApiMDViewCall { + /** + * @description 新建行 + * @type {{ + * args?: IApiMDCtrlLoadParams; + * }} + * @memberof IApiGanttViewCall + */ + NewRow: { + args?: IApiMDCtrlLoadParams; + }; + /** + * @description 行编辑 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGanttViewCall + */ + ToggleRowEdit: { + args: undefined; + }; + /** + * @description 保存行 + * @type {{ + * args: { data: IApiData[] }; + * }} + * @memberof IApiGanttViewCall + */ + SaveRow: { + args: { + data: IApiData[]; + }; + }; + /** + * @description 保存 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGanttViewCall + */ + Save: { + args: undefined; + }; + /** + * @description 展开 + * @type {{ + * args: { params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiGanttViewCall + */ + Expand: { + args: { + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiGanttViewCall + */ + Collapse: { + args: { + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGanttViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGanttViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体表格视图能力 + * @export + * @interface IApiGridViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiGridViewCall extends IApiMDViewCall { + /** + * @description 新建行 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGridViewCall + */ + NewRow: { + args: undefined; + }; + /** + * @description 行编辑 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGridViewCall + */ + ToggleRowEdit: { + args: undefined; + }; + /** + * @description 保存 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGridViewCall + */ + Save: { + args: undefined; + }; + /** + * @description 保存行 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGridViewCall + */ + SaveRow: { + args: undefined; + }; + /** + * @description 展开 + * @type {{ + * args: { params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiGridViewCall + */ + Expand: { + args: { + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiGridViewCall + */ + Collapse: { + args: { + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGridViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiGridViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体列表视图能力 + * @export + * @interface IApiListViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiListViewCall extends IApiMDViewCall { + /** + * @description 展开 + * @type {{ + * args: { params: { srfcollapsetag?: string; srfgroup?: string } }; + * }} + * @memberof IApiListViewCall + */ + Expand: { + args: { + params: { + srfcollapsetag?: string; + srfgroup?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { params: { srfcollapsetag?: string; srfgroup?: string } }; + * }} + * @memberof IApiListViewCall + */ + Collapse: { + args: { + params: { + srfcollapsetag?: string; + srfgroup?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiListViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiListViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 应用登录视图能力 + * @export + * @interface IApiLoginViewCall + * @extends {IApiViewCall} + */ +export interface IApiLoginViewCall extends IApiViewCall { + /** + * @description 登录 + * @type {{ + * args: { data: IApiData[]; params: { panelDataParent: string } }; + * }} + * @memberof IApiLoginViewCall + */ + Login: { + args: { + data: IApiData[]; + params: { + panelDataParent: string; + }; + }; + }; + /** + * @description 取消变更 + * @type {{ + * args: undefined + * }} + * @memberof IApiLoginViewCall + */ + CancelChanges: { + args: undefined; + }; +} +/** + * @description 实体多表单编辑视图（部件视图）能力 + * @export + * @interface IApiMEditView9Call + * @extends {Omit} + */ +export interface IApiMEditView9Call extends Omit { + /** + * @description 打开新建数据视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMEditView9Call + */ + New: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMEditView9Call + */ + Refresh: { + args: undefined; + }; +} +/** + * @description 实体数据选择视图能力 + * @export + * @interface IApiPickupViewCall + * @extends {IApiViewCall} + */ +export interface IApiPickupViewCall extends IApiViewCall { + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiPickupViewCall + */ + Cancel: { + args: undefined; + }; + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiPickupViewCall + */ + Ok: { + args: undefined; + }; +} +/** + * @description 实体数据多项选择视图能力 + * @export + * @interface IApiMPickupViewCall + * @extends {IApiPickupViewCall} + */ +export interface IApiMPickupViewCall extends IApiPickupViewCall { + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMPickupViewCall + */ + Cancel: { + args: undefined; + }; + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMPickupViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 添加选中 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMPickupViewCall + */ + AddSelection: { + args: undefined; + }; + /** + * @description 添加全部 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMPickupViewCall + */ + AddAll: { + args: undefined; + }; + /** + * @description 移出全部 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMPickupViewCall + */ + RemoveAll: { + args: undefined; + }; + /** + * @description 移出选中 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMPickupViewCall + */ + RemoveSelection: { + args: undefined; + }; +} +/** + * @description 实体选项操作视图能力 + * @export + * @interface IApiOptViewCall + * @extends {IApiViewCall} + */ +export interface IApiOptViewCall extends IApiViewCall { + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiOptViewCall + */ + Cancel: { + args: undefined; + }; + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiOptViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 视图加载（特指初始化加载） + * @type {{ + * args: undefined; + * }} + * @memberof IApiOptViewCall + */ + Load: { + args: undefined; + }; + /** + * @description 校验数据（编辑视图才用） + * @type {{ + * args: undefined; + * }} + * @memberof IApiOptViewCall + */ + Validate: { + args: undefined; + }; +} +/** + * @description 实体选择表格视图（部件视图）能力 + * @export + * @interface IApiPickupGridViewCall + * @extends {IApiGridViewCall} + */ +export interface IApiPickupGridViewCall extends IApiGridViewCall { + /** + * @description 获取所有数据（多数据专用，获取全部数据） + * @type {{ + * args: undefined; + * }} + * @memberof IApiPickupGridViewCall + */ + GetAllData: { + args: undefined; + }; +} +/** + * @description 实体树视图能力 + * @export + * @interface IApiTreeViewCall + * @extends {Omit} + */ +export interface IApiTreeViewCall extends Omit { + /** + * @description 树界面_刷新全部操作 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeViewCall + */ + RefreshAll: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args?: { data?: (IApiTreeNodeData | IApiData)[] }; + * }} + * @memberof IApiTreeViewCall + */ + Refresh: { + args?: { + data?: (IApiTreeNodeData | IApiData)[]; + }; + }; + /** + * @description 树界面_刷新父节点操作 + * @type {{ + * args: { data: (IApiTreeNodeData | IApiData)[] }; + * }} + * @memberof IApiTreeViewCall + */ + RefreshParent: { + args: { + data: (IApiTreeNodeData | IApiData)[]; + }; + }; + /** + * @description 展开 + * @type {{ + * args: { data?: IApiData[]; params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiTreeViewCall + */ + Expand: { + args: { + data?: IApiData[]; + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { data?: IApiData[]; params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiTreeViewCall + */ + Collapse: { + args: { + data?: IApiData[]; + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体选择树视图（部件视图）能力 + * @export + * @interface IApiPickupTreeViewCall + * @extends {IApiTreeViewCall} + */ +export interface IApiPickupTreeViewCall extends IApiTreeViewCall { + /** + * @description 获取所有数据（多数据专用，获取全部数据） + * @type {{ + * args: undefined; + * }} + * @memberof IApiPickupTreeViewCall + */ + GetAllData: { + args: undefined; + }; +} +/** + * @description 实体报表视图能力 + * @export + * @interface IApiReportViewCall + * @extends {IApiViewCall} + */ +export interface IApiReportViewCall extends IApiViewCall { + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiReportViewCall + */ + Refresh: { + args: undefined; + }; + /** + * @description 搜索 + * @type {{ + * args: undefined; + * }} + * @memberof IApiReportViewCall + */ + Search: { + args: undefined; + }; + /** + * @description 重置 + * @type {{ + * args: undefined; + * }} + * @memberof IApiReportViewCall + */ + Reset: { + args: undefined; + }; +} +/** + * @description 实体分页导航视图能力 + * @export + * @interface IApiTabExpViewCall + * @extends {IApiViewCall} + */ +export interface IApiTabExpViewCall extends IApiViewCall { + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTabExpViewCall + */ + Refresh: { + args: undefined; + }; +} +/** + * @description 实体分页搜索视图能力 + * @export + * @interface IApiTabSearchViewCall + * @extends {IApiTabExpViewCall} + */ +export interface IApiTabSearchViewCall extends IApiTabExpViewCall { + /** + * @description 搜索 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTabSearchViewCall + */ + Search: { + args: undefined; + }; + /** + * @description 重置 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTabSearchViewCall + */ + Reset: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTabSearchViewCall + */ + Refresh: { + args: undefined; + }; +} +/** + * @description 实体树导航视图能力 + * @export + * @interface IApiTreeExpViewCall + * @extends {Omit} + */ +export interface IApiTreeExpViewCall extends Omit { + /** + * @description 树界面_刷新全部操作 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeExpViewCall + */ + RefreshAll: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args?: { data?: (IApiTreeNodeData | IApiData)[] }; + * }} + * @memberof IApiTreeExpViewCall + */ + Refresh: { + args?: { + data?: (IApiTreeNodeData | IApiData)[]; + }; + }; + /** + * @description 树界面_刷新父节点操作 + * @type {{ + * args: { data: (IApiTreeNodeData | IApiData)[] }; + * }} + * @memberof IApiTreeExpViewCall + */ + RefreshParent: { + args: { + data: (IApiTreeNodeData | IApiData)[]; + }; + }; + /** + * @description 展开 + * @type {{ + * args: { data?: IApiData[]; params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiTreeExpViewCall + */ + Expand: { + args: { + data?: IApiData[]; + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { data?: IApiData[]; params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiTreeExpViewCall + */ + Collapse: { + args: { + data?: IApiData[]; + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeExpViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeExpViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体树表格视图（增强）能力 + * @export + * @interface IApiTreeGridExViewCall + * @extends {IApiTreeViewCall} + */ +export interface IApiTreeGridExViewCall extends IApiTreeViewCall { + /** + * @description 行编辑 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeGridExViewCall + */ + ToggleRowEdit: { + args: undefined; + }; + /** + * @description 保存行 + * @type {{ + * args: { data: IApiTreeNodeData[] }; + * }} + * @memberof IApiTreeGridExViewCall + */ + SaveRow: { + args: { + data: IApiTreeNodeData[]; + }; + }; + /** + * @description 保存 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeGridExViewCall + */ + Save: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeGridExViewCall + */ + Refresh: { + args: undefined; + }; +} +/** + * @description 实体树表格视图能力 + * @export + * @interface IApiTreeGridViewCall + * @extends {IApiGridViewCall} + */ +export interface IApiTreeGridViewCall extends IApiGridViewCall { + /** + * @description 展开 + * @type {{ + * args: { data?: IApiData[]; params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiTreeGridViewCall + */ + Expand: { + args: { + data?: IApiData[]; + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 折叠 + * @type {{ + * args: { data?: IApiData[]; params?: { srfcollapsetag?: string } }; + * }} + * @memberof IApiTreeGridViewCall + */ + Collapse: { + args: { + data?: IApiData[]; + params?: { + srfcollapsetag?: string; + }; + }; + }; + /** + * @description 全部展开 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeGridViewCall + */ + ExpandAll: { + args: undefined; + }; + /** + * @description 全部收缩 + * @type {{ + * args: undefined; + * }} + * @memberof IApiTreeGridViewCall + */ + CollapseAll: { + args: undefined; + }; +} +/** + * @description 实体工作流动态操作视图能力 + * @export + * @interface IApiWFDynaActionViewCall + * @extends {IApiEditViewCall} + */ +export interface IApiWFDynaActionViewCall extends IApiEditViewCall { + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiWFDynaActionViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiWFDynaActionViewCall + */ + Cancel: { + args: undefined; + }; +} +/** + * @description 实体工作流动态启动视图能力 + * @export + * @interface IApiWFDynaStartViewCall + * @extends {IApiEditViewCall} + */ +export interface IApiWFDynaStartViewCall extends IApiEditViewCall { + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiWFDynaStartViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiWFDynaStartViewCall + */ + Cancel: { + args: undefined; + }; +} +/** + * @description 实体移动端卡片视图能力 + * @export + * @interface IApiMobDataViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiMobDataViewCall extends IApiMDViewCall { + /** + * @description 加载更多 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobDataViewCall + */ + LoadMore: { + args: undefined; + }; +} +/** + * @description 实体移动端编辑视图能力 + * @export + * @interface IApiMobEditViewCall + * @extends {IApiViewCall} + */ +export interface IApiMobEditViewCall extends IApiViewCall { + /** + * @description 保存 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + Save: { + args: undefined; + }; + /** + * @description 保存并关闭 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + SaveAndExit: { + args: undefined; + }; + /** + * @description 删除并关闭 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + RemoveAndExit: { + args: undefined; + }; + /** + * @description 保存并新建 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + SaveAndNew: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + Refresh: { + args: undefined; + }; + /** + * @description 工作流启动 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + SaveAndStart: { + args: undefined; + }; + /** + * @description 工作流提交 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + ViewWFStep: { + args: undefined; + }; + /** + * @description 流程撤回 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobEditViewCall + */ + WFWithdraw: { + args: undefined; + }; +} +/** + * @description 实体移动端多数据视图能力 + * @export + * @interface IApiMobMDViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiMobMDViewCall extends IApiMDViewCall { + /** + * @description 加载更多 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobMDViewCall + */ + LoadMore: { + args: undefined; + }; +} +/** + * @description 实体移动端数据选择视图能力 + * @export + * @interface IApiMobPickupViewCall + * @extends {IApiViewCall} + */ +export interface IApiMobPickupViewCall extends IApiViewCall { + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobPickupViewCall + */ + Cancel: { + args: undefined; + }; + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobPickupViewCall + */ + Ok: { + args: undefined; + }; +} +/** + * @description 实体移动端多数据选择视图能力 + * @export + * @interface IApiMobMPickupViewCall + * @extends {IApiMobPickupViewCall} + */ +export interface IApiMobMPickupViewCall extends IApiMobPickupViewCall { + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobMPickupViewCall + */ + Cancel: { + args: undefined; + }; + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobMPickupViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 添加全部 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobMPickupViewCall + */ + AddAll: { + args: undefined; + }; + /** + * @description 移出全部 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobMPickupViewCall + */ + RemoveAll: { + args: undefined; + }; + /** + * @description 添加选中 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobMPickupViewCall + */ + AddSelection: { + args: undefined; + }; +} +/** + * @description 实体移动端选项操作视图能力 + * @export + * @interface IApiMobOptViewCall + * @extends {IApiMobEditViewCall} + */ +export interface IApiMobOptViewCall extends IApiMobEditViewCall { + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobOptViewCall + */ + Cancel: { + args: undefined; + }; + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobOptViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 视图加载（特指初始化加载） + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobOptViewCall + */ + Load: { + args: undefined; + }; + /** + * @description 校验数据（编辑视图才用） + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobOptViewCall + */ + Validate: { + args: undefined; + }; +} +/** + * @description 实体移动端选择多数据视图（部件视图）能力 + * @export + * @interface IApiMobPickupMDViewCall + * @extends {IApiMDViewCall} + */ +export interface IApiMobPickupMDViewCall extends IApiMDViewCall { + /** + * @description 获取所有数据（多数据专用，获取全部数据） + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobPickupMDViewCall + */ + GetAllData: { + args: undefined; + }; +} +/** + * @description 实体移动端分页搜索视图能力 + * @export + * @interface IApiMobTabSearchViewCall + * @extends {IApiViewCall} + */ +export interface IApiMobTabSearchViewCall extends IApiViewCall { + /** + * @description 搜索 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobTabSearchViewCall + */ + Search: { + args: undefined; + }; + /** + * @description 重置 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobTabSearchViewCall + */ + Reset: { + args: undefined; + }; + /** + * @description 刷新视图 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobTabSearchViewCall + */ + Refresh: { + args: undefined; + }; +} +/** + * @description 实体移动端工作流动态编辑视图能力 + * @export + * @interface IApiMobWFDynaEditViewCall + * @extends {IApiMobEditViewCall} + */ +export interface IApiMobWFDynaEditViewCall extends IApiMobEditViewCall { + /** + * @description 工作流启动 + * @type {{ + * args: { id: string }; + * }} + * @memberof IApiMobWFDynaEditViewCall + */ + WFAction: { + args: { + id: string; + }; + }; +} +/** + * @description 实体移动端工作流动态操作视图能力 + * @export + * @interface IApiMobWFDynaActionViewCall + * @extends {IApiMobWFDynaEditViewCall} + */ +export interface IApiMobWFDynaActionViewCall extends IApiMobWFDynaEditViewCall { + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobWFDynaActionViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobWFDynaActionViewCall + */ + Cancel: { + args: undefined; + }; +} +/** + * @description 实体移动端工作流动态启动视图能力 + * @export + * @interface IApiMobWFDynaStartViewCall + * @extends {IApiMobWFDynaEditViewCall} + */ +export interface IApiMobWFDynaStartViewCall extends IApiMobWFDynaEditViewCall { + /** + * @description 确定 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobWFDynaStartViewCall + */ + Ok: { + args: undefined; + }; + /** + * @description 取消 + * @type {{ + * args: undefined; + * }} + * @memberof IApiMobWFDynaStartViewCall + */ + Cancel: { + args: undefined; + }; +} +/** + * @description 应用数据导入视图控制器接口 + * @export + * @interface IApiAppDataUploadViewController + * @extends {IApiViewController} + */ +export interface IApiAppDataUploadViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiAppDataUploadViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体日历导航视图控制器接口 + * @export + * @interface IApiCalendarExpViewController + * @extends {IApiViewController} + */ +export interface IApiCalendarExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiCalendarExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体日历视图控制器接口 + * @export + * @interface IApiCalendarViewController + * @extends {IApiViewController} + */ +export interface IApiCalendarViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiCalendarViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体图表导航视图控制器接口 + * @export + * @interface IApiChartExpViewController + * @extends {IApiViewController} + */ +export interface IApiChartExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiChartExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体图表视图控制器接口 + * @export + * @interface IApiChartViewController + * @extends {IApiViewController} + */ +export interface IApiChartViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args + * @returns {*} {Promise} 视图能力需要的参数 + * @memberof IApiChartViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体自定义视图控制器接口 + * @export + * @interface IApiCustomViewController + * @extends {IApiViewController} + */ +export interface IApiCustomViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiCustomViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体卡片视图导航视图控制器接口 + * @export + * @interface IApiDataViewExpViewController + * @extends {IApiViewController} + */ +export interface IApiDataViewExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiDataViewExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体数据视图控制器接口 + * @export + * @interface IApiDataViewController + * @extends {IApiViewController} + */ +export interface IApiDataViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiDataViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体首页视图控制器接口 + * @export + * @interface IApiDEIndexViewController + * @extends {IApiViewController} + */ +export interface IApiDEIndexViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiDEIndexViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体编辑视图控制器接口 + * @export + * @interface IApiEditViewController + * @extends {IApiViewController} + */ +export interface IApiEditViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiEditViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体编辑视图（左右关系）控制器接口 + * @export + * @interface IApiEditView2Controller + * @extends {IApiViewController} + */ +export interface IApiEditView2Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiEditView2Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体编辑视图（分页关系）控制器接口 + * @export + * @interface IApiEditView3Controller + * @extends {IApiViewController} + */ +export interface IApiEditView3Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiEditView3Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体编辑视图（上下关系）控制器接口 + * @export + * @interface IApiEditView4Controller + * @extends {IApiViewController} + */ +export interface IApiEditView4Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiEditView4Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 导航视图控制器接口 + * @export + * @interface IApiExpViewController + * @extends {IApiViewController} + */ +export interface IApiExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体表单选择数据视图（部件视图）控制器接口 + * @export + * @interface IApiFormPickupDataViewController + * @extends {IApiViewController} + */ +export interface IApiFormPickupDataViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiFormPickupDataViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体甘特视图控制器接口 + * @export + * @interface IApiGanttViewController + * @extends {IApiViewController} + */ +export interface IApiGanttViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiGanttViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体表格导航视图控制器接口 + * @export + * @interface IApiGridExpViewController + * @extends {IApiViewController} + */ +export interface IApiGridExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiGridExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体表格视图控制器接口 + * @export + * @interface IApiGridViewController + * @extends {IApiViewController} + */ +export interface IApiGridViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiGridViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 应用首页视图控制器接口 + * @export + * @interface IApiIndexViewController + * @extends {IApiViewController} + */ +export interface IApiIndexViewController extends IApiViewController { +} +/** + * @description 实体看板视图控制器接口 + * @export + * @interface IApiKanbanViewController + * @extends {IApiViewController} + */ +export interface IApiKanbanViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiKanbanViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体列表导航视图控制器接口 + * @export + * @interface IApiListExpViewController + * @extends {IApiViewController} + */ +export interface IApiListExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiListExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体列表视图控制器接口 + * @export + * @interface IApiListViewController + * @extends {IApiViewController} + */ +export interface IApiListViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiListViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 应用登录视图控制器接口 + * @export + * @interface IApiLoginViewController + * @extends {IApiViewController} + */ +export interface IApiLoginViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiLoginViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体地图视图控制器接口 + * @export + * @interface IApiMapViewController + * @extends {IApiViewController} + */ +export interface IApiMapViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMapViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体多表单编辑视图（部件视图）控制器接口 + * @export + * @interface IApiMEditView9Controller + * @extends {IApiViewController} + */ +export interface IApiMEditView9Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMEditView9Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体数据多项选择视图控制器接口 + * @export + * @interface IApiMPickupViewController + * @extends {IApiViewController} + */ +export interface IApiMPickupViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMPickupViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体多项数据选择视图（左右关系）控制器接口 + * @export + * @interface IApiMPickupView2Controller + * @extends {IApiViewController} + */ +export interface IApiMPickupView2Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMPickupView2Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体选项操作视图控制器接口 + * @export + * @interface IApiOptViewController + * @extends {IApiViewController} + */ +export interface IApiOptViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiOptViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体面板视图控制器接口 + * @export + * @interface IApiPanelViewController + * @extends {IApiViewController} + */ +export interface IApiPanelViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPanelViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体选择数据视图（部件视图）控制器接口 + * @export + * @interface IApiPickupDataViewController + * @extends {IApiViewController} + */ +export interface IApiPickupDataViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPickupDataViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体选择表格视图（部件视图）控制器接口 + * @export + * @interface IApiPickupGridViewController + * @extends {IApiViewController} + */ +export interface IApiPickupGridViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPickupGridViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体选择树视图（部件视图）控制器接口 + * @export + * @interface IApiPickupTreeViewController + * @extends {IApiViewController} + */ +export interface IApiPickupTreeViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPickupTreeViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体数据选择视图控制器接口 + * @export + * @interface IApiPickupViewController + * @extends {IApiViewController} + */ +export interface IApiPickupViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPickupViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体数据选择视图（左右关系）控制器接口 + * @export + * @interface IApiPickupView2Controller + * @extends {IApiViewController} + */ +export interface IApiPickupView2Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPickupView2Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体数据看板视图控制器接口 + * @export + * @interface IApiPortalViewController + * @extends {IApiViewController} + */ +export interface IApiPortalViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiPortalViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体报表视图控制器接口 + * @export + * @interface IApiReportViewController + * @extends {IApiViewController} + */ +export interface IApiReportViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiReportViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体子应用引用视图控制器接口 + * @export + * @interface IApiSubAppRefViewController + * @extends {IApiViewController} + */ +export interface IApiSubAppRefViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiSubAppRefViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体分页导航视图控制器接口 + * @export + * @interface IApiTabExpViewController + * @extends {IApiViewController} + */ +export interface IApiTabExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiTabExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体分页搜索视图控制器接口 + * @export + * @interface IApiTabSearchViewController + * @extends {IApiViewController} + */ +export interface IApiTabSearchViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiTabSearchViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体树导航视图控制器接口 + * @export + * @interface IApiTreeExpViewController + * @extends {IApiViewController} + */ +export interface IApiTreeExpViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiTreeExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体树表格视图（增强）控制器接口 + * @export + * @interface IApiTreeGridExViewController + * @extends {IApiViewController} + */ +export interface IApiTreeGridExViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiTreeGridExViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体树表格视图控制器接口 + * @export + * @interface IApiTreeGridViewController + * @extends {IApiViewController} + */ +export interface IApiTreeGridViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiTreeGridViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体树视图控制器接口 + * @export + * @interface IApiTreeViewController + * @extends {IApiViewController} + */ +export interface IApiTreeViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiTreeViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体工作流动态操作视图控制器接口 + * @export + * @interface IApiWFDynaActionViewController + * @extends {IApiViewController} + */ +export interface IApiWFDynaActionViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWFDynaActionViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体工作流动态编辑视图控制器接口 + * @export + * @interface IApiWFDynaEditViewController + * @extends {IApiViewController} + */ +export interface IApiWFDynaEditViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWFDynaEditViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体工作流动态视图（分页关系）控制器接口 + * @export + * @interface IApiWFDynaEditView3Controller + * @extends {IApiViewController} + */ +export interface IApiWFDynaEditView3Controller extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWFDynaEditView3Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体工作流动态启动视图控制器接口 + * @export + * @interface IApiWFDynaStartViewController + * @extends {IApiViewController} + */ +export interface IApiWFDynaStartViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWFDynaStartViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 应用流程处理记录视图控制器接口 + * @export + * @interface IApiWFStepDataViewController + * @extends {IApiViewController} + */ +export interface IApiWFStepDataViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWFStepDataViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体向导视图控制器接口 + * @export + * @interface IApiWizardViewController + * @extends {IApiViewController} + */ +export interface IApiWizardViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWizardViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端日历视图控制器接口 + * @export + * @interface IApiMobCalendarViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobCalendarViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobCalendarViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端图表视图控制器接口 + * @export + * @interface IApiMobChartViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobChartViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobChartViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端自定义视图控制器接口 + * @export + * @interface IApiMobCustomViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobCustomViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobCustomViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端卡片视图控制器接口 + * @export + * @interface IApiMobDataViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobDataViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobDataViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端编辑视图控制器接口 + * @export + * @interface IApiMobEditViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobEditViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobEditViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端编辑视图（分页关系）控制器接口 + * @export + * @interface IApiMobEditView3Controller + * @extends {IApiMobViewController} + */ +export interface IApiMobEditView3Controller extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobEditView3Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端多数据视图控制器接口 + * @export + * @interface IApiMobMDViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobMDViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobMDViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端多数据选择视图控制器接口 + * @export + * @interface IApiMobMPickupViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobMPickupViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobMPickupViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端选项操作视图控制器接口 + * @export + * @interface IApiMobOptViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobOptViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobOptViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端选择多数据视图（部件视图）控制器接口 + * @export + * @interface IApiMobPickupMDViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobPickupMDViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobPickupMDViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端选择树视图（部件视图）控制器接口 + * @export + * @interface IApiMobPickupTreeViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobPickupTreeViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobPickupTreeViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端数据选择视图控制器接口 + * @export + * @interface IApiMobPickupViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobPickupViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobPickupViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端分页导航视图控制器接口 + * @export + * @interface IApiMobTabExpViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobTabExpViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobTabExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端分页搜索视图控制器接口 + * @export + * @interface IApiMobTabSearchViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobTabSearchViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobTabSearchViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端树导航视图控制器接口 + * @export + * @interface IApiMobTreeExpViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobTreeExpViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobTreeExpViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端树视图控制器接口 + * @export + * @interface IApiMobTreeViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobTreeViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobTreeViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端工作流动态操作视图控制器接口 + * @export + * @interface IApiMobWFDynaActionViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobWFDynaActionViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobWFDynaActionViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端工作流动态编辑视图控制器接口 + * @export + * @interface IApiMobWFDynaEditViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobWFDynaEditViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobWFDynaEditViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端工作流动态编辑视图（分页关系）控制器接口 + * @export + * @interface IApiMobWFDynaEditView3Controller + * @extends {IApiMobViewController} + */ +export interface IApiMobWFDynaEditView3Controller extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobWFDynaEditView3Controller + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端工作流动态启动视图控制器接口 + * @export + * @interface IApiMobWFDynaStartViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobWFDynaStartViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobWFDynaStartViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 实体移动端向导视图控制器接口 + * @export + * @interface IApiMobWizardViewController + * @extends {IApiMobViewController} + */ +export interface IApiMobWizardViewController extends IApiMobViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiMobWizardViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 应用流程跟踪视图控制器接口 + * @export + * @interface IApiWFStepTraceViewController + * @extends {IApiViewController} + */ +export interface IApiWFStepTraceViewController extends IApiViewController { + /** + * @description 执行视图的能力 + * @template T + * @template K + * @param {K} key 视图能力的唯一标识 + * @param {...T[K] extends { args: infer A } + * ? A extends undefined + * ? [] + * : [A] + * : T[K] extends { args?: infer A } + * ? A extends undefined + * ? [] + * : [A?] + * : []} args 视图能力需要的参数 + * @returns {*} {Promise} + * @memberof IApiWFStepTraceViewController + */ + call(key: K, ...args: T[K] extends { + args: infer A; + } ? A extends undefined ? [ + ] : [ + A + ] : T[K] extends { + args?: infer A; + } ? A extends undefined ? [ + ] : [ + A? + ] : [ + ]): Promise; +} +/** + * @description 视图布局面板控制器接口 + * @export + * @interface IApiViewLayoutPanelController + * @extends {IApiPanelController} + */ +export interface IApiViewLayoutPanelController extends IApiPanelController { +} +/** + * @description 部件控制器 + * @export + * @interface IApiControlController + * @extends {IApiController} + * @template T + * @template S + */ +export interface IApiControlController extends IApiController { + /** + * @description 当前上下文环境的视图控制器 + * @type {(IApiViewController & IApiData)} + * @memberof IApiControlController + */ + view: IApiViewController & IApiData; + /** + * 部件标识 + * + * @author tony001 + * @date 2024-07-15 13:07:49 + * @type {string} + */ + ctrlId: string; + /** + * 部件参数 + * + * @author tony001 + * @date 2024-07-23 22:07:34 + * @type {IApiParams} + */ + controlParams: IApiParams; + /** + * @description 部件布局面板控制器 + * @type {(IApiViewLayoutPanelController & IApiData)} + * @memberof IApiControlController + */ + layoutPanel?: IApiViewLayoutPanelController & IApiData; + /** + * 运行模式 + * + * @type {('DESIGN' | 'RUNTIME')} （设计模式 | 运行时） + * @memberof IControlController + */ + runMode: "DESIGN" | "RUNTIME"; + /** + * 开始加载 + * + * @author lxm + * @date 2022-09-19 14:09:00 + */ + startLoading(): Promise; + /** + * 加载完毕 + * + * @author lxm + * @date 2022-09-19 14:09:09 + */ + endLoading(): Promise; +} +/** + * @description 面板控制器 + * @export + * @interface IApiPanelController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiPanelController extends IApiControlController { + /** + * @description 所有面板成员的控制器 + * @type {{ [key: string]: IApiPanelItemController }} + * @memberof IApiPanelController + */ + panelItems: { + [key: string]: IApiPanelItemController; + }; + /** + * @description 面板数据 + * @type {IApiData} + * @memberof IApiPanelController + */ + data: IApiData; + /** + * @description 容器控制器（可能是视图控制器，也可能是部件控制器） + * @type {IApiController} + * @memberof IApiPanelController + */ + container?: IApiController; + /** + * @description 设置面板数据的值 + * @param {string} name 要设置的数据的属性名称 + * @param {unknown} value 要设置的值 + * @returns {*} {Promise} + * @memberof IApiPanelController + */ + setDataValue(name: string, value: unknown): Promise; + /** + * @description 加载数据 + * @returns {*} {Promise} + * @memberof IApiPanelController + */ + load(): Promise; + /** + * @description 获取面板成员控制器 + * @param {string} name 面板成员名称 + * @returns {*} {(IApiPanelItemController | undefined)} + * @memberof IApiPanelController + */ + findPanelItemByName(name: string): IApiPanelItemController | undefined; +} +/** + * @description 面板成员控制器接口 + * @export + * @interface IApiPanelItemController + */ +export interface IApiPanelItemController { + /** + * @description 成员模型 + * @type {IPanelItem} + * @memberof IApiPanelItemController + */ + model: IPanelItem; + /** + * @description 面板控制器 + * @type {IApiPanelController} + * @memberof IApiPanelItemController + */ + panel: IApiPanelController; + /** + * @description 父容器控制器(除了根成员都存在) + * @type {IApiPanelItemContainerController} + * @memberof IApiPanelItemController + */ + parent?: IApiPanelItemContainerController; + /** + * @description 成员状态 + * @type {IApiPanelItemState} + * @memberof IApiPanelItemController + */ + state: IApiPanelItemState; + /** + * @description 数据对象 + * @type {IApiData} + * @memberof IApiPanelItemController + */ + data: IApiData; +} +/** + * @description 容器类面板成员控制器接口 + * @export + * @interface IApiPanelItemContainerController + * @extends {IApiPanelItemController} + */ +export interface IApiPanelItemContainerController extends IApiPanelItemController { + /** + * @description 是否是数据父容器 + * @type {true} + * @memberof IApiPanelItemContainerController + */ + isDataContainer?: true; +} +/** + * @description 表单控制器 + * @export + * @interface IApiFormController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiFormController extends IApiControlController { + /** + * @description 表单成员控制器 + * @type {{ [key: string]: IApiFormDetailController }} + * @memberof IApiFormController + */ + details: { + [key: string]: IApiFormDetailController; + }; + /** + * @description 获取表单数据 + * @returns {*} {IApiData[]} + * @memberof IApiFormController + */ + getData(): IApiData[]; + /** + * @description 刷新 + * @returns {*} {Promise} + * @memberof IApiFormController + */ + refresh(): Promise; + /** + * @description 切换折叠 + * @param {IApiData} [params] + * @memberof IApiFormController + */ + changeCollapse(params?: IApiData): void; + /** + * @description 设置表单激活分页 + * @param {string} name + * @memberof IApiFormController + */ + setActiveTab(name: string): void; + /** + * @description 设置表单数据 + * @param {string} name 表单项名称 + * @param {unknown} value 值 + * @param {boolean} [ignore] 是否忽略脏值检查 + * @returns {*} {Promise} + * @memberof IApiFormController + */ + setDataValue(name: string, value: unknown, ignore?: boolean): Promise; + /** + * @description 设置指定项错误提示 + * @param {string} name 表单项名称 + * @param {string} message 错误信息 + * @memberof IApiFormController + */ + setDetailError(name: string, message: string): void; + /** + * @description 表单校验 + * @returns {*} {Promise} + * @memberof IApiFormController + */ + validate(): Promise; + /** + * @description 表单静默校验 + * @returns {*} {Promise} + * @memberof IApiFormController + */ + silentValidate(): Promise; +} +/** + * @description 表单成员控制器 + * @export + * @interface IApiFormDetailController + * @extends {IApiEnforceableController} + */ +export interface IApiFormDetailController extends IApiEnforceableController { + /** + * @description 表单成员状态 + * @type {IApiFormState} + * @memberof IApiFormDetailController + */ + state: IApiFormDetailState; + /** + * @description 表单控制器 + * @type {IApiFormController} + * @memberof IApiFormDetailController + */ + form: IApiFormController; + /** + * @description 父容器控制器(除了表单分页都存在) + * @type {IApiFormDetailContainerController} + * @memberof IApiFormDetailController + */ + parent?: IApiFormDetailContainerController; + /** + * @description 点击事件 + * @returns {*} {Promise} + * @memberof IApiFormDetailController + */ + onClick(event?: MouseEvent): Promise; +} +/** + * @description 表单容器类型成员控制器 + * @export + * @interface IApiFormDetailContainerController + * @extends {IApiFormDetailController} + */ +export interface IApiFormDetailContainerController extends IApiFormDetailController { + /** + * @description 表单容器类型成员控制器状态 + * @type {IApiFormDetailContainerState} + * @memberof IApiFormDetailContainerController + */ + state: IApiFormDetailContainerState; +} +/** + * @description 表单多数据部件控制器接口 + * @export + * @interface IApiFormMDCtrlController + * @extends {IApiFormDetailController} + */ +export interface IApiFormMDCtrlController extends IApiFormDetailController { + /** + * @description 名称 + * @type {string} + * @memberof IApiFormMDCtrlController + */ + name: string; + /** + * @description 是否允许新建 + * @type {boolean} + * @memberof IApiFormMDCtrlController + */ + enableCreate: boolean; + /** + * @description 是否允许更新 + * @type {boolean} + * @memberof IApiFormMDCtrlController + */ + enableUpdate: boolean; + /** + * @description 是否允许删除 + * @type {boolean} + * @memberof IApiFormMDCtrlController + */ + enableDelete: boolean; + /** + * @description 刷新 + * @memberof IApiFormMDCtrlController + */ + refresh(): void; + /** + * @description 保存 + * @memberof IApiFormMDCtrlController + */ + save(): Promise; +} +/** + * @description 表单保存参数接口 + * @export + * @interface IApiFormSaveParams + * @extends {IApiDataAbilityParams} + */ +export interface IApiFormSaveParams extends IApiDataAbilityParams { + /** + * @description 保存之后是否不合并后台回来的数据 + * @type {boolean} + * @memberof IApiFormSaveParams + */ + noFillBack?: boolean; + /** + * @description 是否静默校验 + * @type {boolean} + * @memberof IApiFormSaveParams + */ + silentVerify?: boolean; +} +/** + * @description 编辑表单控制器 + * @export + * @interface IApiEditFormController + * @extends {IApiFormController} + * @template T + * @template S + */ +export interface IApiEditFormController extends IApiFormController { + /** + * @description 加载草稿数据 + * @param {IApiDataAbilityParams} [args] + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + loadDraft(args?: IApiDataAbilityParams): Promise; + /** + * @description 加载数据 + * @param {IApiDataAbilityParams} [args] + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + load(args?: IApiDataAbilityParams): Promise; + /** + * @description 保存表单数据 + * @param {IApiFormSaveParams} [args] + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + save(args?: IApiFormSaveParams): Promise; + /** + * @description 删除表单数据 + * @param {IApiDataAbilityParams} [args] + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + remove(args?: IApiDataAbilityParams): Promise; + /** + * @description 工作流提交(调用前先确保调用保存) + * @param {IApiDataAbilityParams} [args] 不走工作流操作视图时使用 + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + wfSubmit(args?: IApiDataAbilityParams): Promise; + /** + * @description 工作流启动(调用前先确保调用保存) + * @param {IApiDataAbilityParams} [args] 不走工作流启动视图时使用 + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + wfStart(args?: IApiDataAbilityParams): Promise; + /** + * @description 过滤成员，与表单成员标题包含匹配，满足条件则显示，不满足条件则隐藏 + * @param {string} filter 过滤字符 + * @memberof IApiEditFormController + */ + filterDetail(filter: string): void; + /** + * @description 执行更新表单项 + * @param {string} formItemUpdateId 表单项更新标识 + * @returns {*} {Promise} + * @memberof IApiEditFormController + */ + updateFormItem(formItemUpdateId: string): Promise; +} +/** + * @description 表单多数据部件（表单）控制器接口 + * @export + * @interface IApiFormMDCtrlFormController + * @extends {IApiFormMDCtrlController} + */ +export interface IApiFormMDCtrlFormController extends IApiFormMDCtrlController { + /** + * @description 表单控制器Map + * @type {Map} + * @memberof IApiFormMDCtrlFormController + */ + formMap: Map; + /** + * @description 实体上下文主键标识 + * @type {string} + * @memberof IApiFormMDCtrlFormController + */ + deName: string; + /** + * @description 编辑表单服务 + * @type {IApiData} + * @memberof IApiFormMDCtrlFormController + */ + service: IApiData; + /** + * @description 数据集合 + * @type {IApiData[]} + * @memberof IApiFormMDCtrlFormController + */ + items: IApiData[]; + /** + * @description 加载实体的数据 + * @returns {*} {Promise} + * @memberof IApiFormMDCtrlFormController + */ + fetchData(): Promise; + /** + * @description 更新数据,仅支持更新临时数据 + * @returns {*} {Promise} + * @memberof IApiFormMDCtrlFormController + */ + updateData(): Promise; +} +/** + * @description 表单多数据部件(重复器)控制器接口 + * @export + * @interface IApiFormMDCtrlRepeaterController + * @extends {IApiFormMDCtrlController} + */ +export interface IApiFormMDCtrlRepeaterController extends IApiFormMDCtrlController { + /** + * @description 多数据重复器对应的表单里的值 + * @type {(IApiData[] | IApiData | null)} + * @memberof IApiFormMDCtrlRepeaterController + */ + value: IApiData[] | IApiData | null; + /** + * @description 是否允许排序 + * @type {boolean} + * @memberof IApiFormMDCtrlRepeaterController + */ + enableSort: boolean; + /** + * @description 重复表单 + * @type {IDEForm} + * @memberof IApiFormMDCtrlRepeaterController + */ + repeatedForm: IDEForm; + /** + * @description 重复器map + * @type {Map} + * @memberof IApiFormMDCtrlRepeaterController + */ + repeaterMap: Map; + /** + * @description 删除数据 + * @param {number} [index] 下标 + * @memberof IApiFormMDCtrlRepeaterController + */ + remove(index?: number): void; +} +/** + * @description 多数据部件控制器加载参数 + * @export + * @interface IApiMDCtrlLoadParams + * @extends {IApiDataAbilityParams} + */ +export interface IApiMDCtrlLoadParams extends IApiDataAbilityParams { + /** + * @description 是否是初始加载 + * @type {boolean} + * @memberof IApiMDCtrlLoadParams + */ + isInitialLoad?: boolean; + /** + * @description 是否加载更多 + * @type {boolean} + * @memberof IApiMDCtrlLoadParams + */ + isLoadMore?: boolean; + /** + * @description 触发源 + * @type {('DEFAULT' | 'REFRESH' | string)} + * @memberof IApiMDCtrlLoadParams + */ + triggerSource?: "DEFAULT" | "REFRESH" | string; +} +/** + * @description 多数据部件控制器删除参数 + * @export + * @interface IApiMDCtrlRemoveParams + * @extends {IApiDataAbilityParams} + */ +export interface IApiMDCtrlRemoveParams extends IApiDataAbilityParams { + /** + * @description 是否不需要刷新(默认为否，如果不需要刷新传true) + * @type {boolean} + * @memberof IApiMDCtrlRemoveParams + */ + notRefresh?: boolean; +} +/** + * @description 多数据部件控制器 + * @export + * @interface IApiMDControlController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiMDControlController extends IApiControlController { + /** + * @description 加载数据 + * @param {IApiMDCtrlLoadParams} [args] + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + load(args?: IApiMDCtrlLoadParams): Promise; + /** + * @description 删除数据 + * @param {IApiMDCtrlRemoveParams} [args] + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + remove(args?: IApiMDCtrlRemoveParams): Promise; + /** + * @description 刷新数据 + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + refresh(): Promise; + /** + * @description 导入数据 + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + importData(): Promise; + /** + * @description 导出数据 + * @param {{ event: MouseEvent }} _args + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + exportData(_args: { + event: MouseEvent; + }): Promise; + /** + * @description 获取选中数据 + * @returns {*} {IApiData[]} + * @memberof IApiMDControlController + */ + getData(): IApiData[]; + /** + * @description 设置选中数据,会触发onSelectionChange事件,设置的数据和已经选中的一样时不会触发onSelectionChange事件 + * @param {IApiData[]} selection + * @memberof IApiMDControlController + */ + setSelection(selection: IApiData[]): void; + /** + * @description 设置激活数据 + * @param {IApiData} data + * @param {(MouseEvent | undefined)} [event] + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + setActive(data: IApiData, event?: MouseEvent | undefined): Promise; + /** + * @description + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + goToFirstPage(): Promise; + /** + * @description 获取上一页数据 + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + goToPreviousPage(): Promise; + /** + * @description 获取下一页数据 + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + goToNextPage(): Promise; + /** + * @description 获取最后一页数据 + * @returns {*} {Promise} + * @memberof IApiMDControlController + */ + goToLastPage(): Promise; +} +/** + * @description 表单多数据部件(引用实体多数据部件模型)控制器 (类型是列表，卡片，表格时) + * @export + * @interface IApiFormMDCtrlMDController + * @extends {IApiFormMDCtrlController} + */ +export interface IApiFormMDCtrlMDController extends IApiFormMDCtrlController { + /** + * @description 多数据部件控制器 + * @type {IApiMDControlController} + * @memberof IApiFormMDCtrlMDController + */ + mdController: IApiMDControlController; + /** + * @description 删除多数据选中的数据 + * @returns {*} {Promise} + * @memberof IApiFormMDCtrlMDController + */ + remove(): void; + /** + * @description 新建一条数据 + * @memberof IApiFormMDCtrlMDController + */ + create(): void; +} +/** + * @description 表单关系界面控制器 + * @export + * @interface IApiFormDruipartController + * @extends {IApiFormDetailController} + */ +export interface IApiFormDruipartController extends IApiFormDetailController { + /** + * @description 嵌入视图控制器 + * @type {(IApiViewController | undefined)} + * @memberof IApiFormDruipartController + */ + embedView: IApiViewController | undefined; +} +/** + * @description 门户部件容器控制器接口 + * @export + * @interface IApiPortletContainerController + */ +export interface IApiPortletContainerController { +} +/** + * @description 数据看板控制器接口 + * @export + * @interface IApiDashboardController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiDashboardController extends IApiControlController { + /** + * @description 门户控制器 + * @type {{ [key: string]: IApiPortletController }} + * @memberof IApiDashboardController + */ + portlets: { + [key: string]: IApiPortletController; + }; + /** + * @description 刷新数据 + * @returns {*} {Promise} + * @memberof IApiDashboardController + */ + refresh(): Promise; +} +/** + * @description 门户控制器接口 + * @export + * @interface IApiPortletController + */ +export interface IApiPortletController { + /** + * @description 数据看板控制器 + * @type {IApiDashboardController} + * @memberof IApiPortletController + */ + dashboard: IApiDashboardController; + /** + * @description 父容器控制器(除了根成员都存在) + * @type {IApiPortletContainerController} + * @memberof IApiPortletController + */ + parent?: IApiPortletContainerController; + /** + * @description 成员状态 + * @type {IApiPortletState} + * @memberof IApiPortletController + */ + state: IApiPortletState; + /** + * @description 视图参数 + * @type {IApiParams} + * @memberof IApiPortletController + */ + params: IApiParams; + /** + * @description 门户配置 + * @type {IApiData} + * @memberof IApiPortletController + */ + config: IApiData; + /** + * @description 原始模型 + * @type {IModel} + * @memberof IApiPortletController + */ + model: IModel; + /** + * @description 重置自定义配置 + * @memberof IApiPortletController + */ + resetConfig(): void; + /** + * @description 刷新 + * @returns {*} {Promise} + * @memberof IApiPortletController + */ + refresh(): Promise; + /** + * @description 高亮 + * @memberof IApiPortletController + */ + hightLight(): void; +} +/** + * @description 表格控制器接口 + * @export + * @interface IApiGridController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiGridController extends IApiMDControlController { + /** + * @description 新建行 + * @returns {*} {Promise} + * @memberof IApiGridController + */ + newRow(): Promise; + /** + * @description 保存单条数据 + * @param {IApiData} data + * @returns {*} {Promise} + * @memberof IApiGridController + */ + save(data: IApiData): Promise; + /** + * @description 保存表格所有数据 + * @returns {*} {Promise} + * @memberof IApiGridController + */ + saveAll(): Promise; + /** + * @description 切换表格的行编辑开启关闭状态 + * @memberof IApiGridController + */ + toggleRowEdit(): void; +} +/** + * @description 菜单控制器接口 + * @export + * @interface IApiMenuController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiMenuController extends IApiControlController { + /** + * @description 所有菜单项 + * @type {IAppMenuItem[]} + * @memberof IApiMenuController + */ + allAppMenuItems: IAppMenuItem[]; +} +/** + * @description 工具栏控制器接口 + * @export + * @interface IApiToolbarController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiToolbarController extends IApiControlController { +} +/** + * @description 导航栏控制器接口 + * @export + * @interface IApiExpBarControlController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiExpBarControlController extends IApiControlController { + /** + * @description 多数据部件控制器 + * @type {IMDControlController} + * @memberof IApiExpBarControlController + */ + xDataController: IApiMDControlController; + /** + * @description 工具栏控制器 + * @type {(IToolbarController | undefined)} + * @memberof IApiExpBarControlController + */ + toolbarController: IApiToolbarController | undefined; + /** + * @description 导航栏加载 + * @returns {*} {Promise} + * @memberof IApiExpBarControlController + */ + load(): Promise; +} +/** + * @description 列表控制器接口 + * @export + * @interface IApiListController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiListController extends IApiMDControlController { + /** + * @description 获取列表全部数据 + * @returns {*} {IApiData[]} + * @memberof IApiListController + */ + getAllData(): IApiData[]; + /** + * @description 加载更多 + * @returns {*} {Promise} + * @memberof IApiListController + */ + loadMore(): Promise; + /** + * @description 切换折叠 + * @param {IApiData} [params] + * @memberof IApiListController + */ + changeCollapse(params?: IApiData): void; +} +/** + * @description 移动端多数据部件控制器接口 + * @export + * @interface IApiMobMDCtrlController + * @extends {IApiListController} + * @template T + * @template S + */ +export interface IApiMobMDCtrlController extends IApiListController { +} +/** + * @description 日历导航栏部件控制器接口 + * @export + * @interface IApiCalendarExpBarController + * @extends {IApiExpBarControlController} + * @template T + * @template S + */ +export interface IApiCalendarExpBarController extends IApiExpBarControlController { +} +/** + * @description 日历部件控制器接口 + * @export + * @interface ICalendarController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiCalendarController extends IApiMDControlController { + /** + * @description 设置选中日期 + * @param {Date} date + * @memberof IApiCalendarController + */ + setSelectDate(date: Date): void; +} +/** + * @description 标题栏控制器接口 + * @export + * @interface IApiCaptionBarController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiCaptionBarController extends IApiControlController { + /** + * @description 设置浏览器标签页标题 + * @memberof IApiCaptionBarController + */ + setBrowserTabTitle(): void; +} +/** + * @description 图表导航栏控制器接口 + * @export + * @interface IApiChartExpBarController + * @extends {IApiExpBarControlController} + * @template T + * @template S + */ +export interface IApiChartExpBarController extends IApiExpBarControlController { +} +/** + * @description 图表部件控制器接口 + * @export + * @interface IApiChartController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiChartController extends IApiMDControlController { + /** + * @description 刷新图表的大小 + * @memberof IApiChartController + */ + resizeChart(): void; +} +/** + * @description 上下文菜单接口 + * @export + * @interface IContextMenuController + * @extends {IApiToolbarController} + * @template T + * @template S + */ +export interface IApiContextMenuController extends IApiToolbarController { +} +/** + * @description 数据视图（卡片）控制器接口 + * @export + * @interface IApiDataViewControlController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiDataViewControlController extends IApiMDControlController { + /** + * @description 切换折叠状态 + * @param {IApiData} [params] + * @memberof IApiDataViewControlController + */ + changeCollapse(params?: IApiData): void; +} +/** + * @description 数据关系栏控制器接口 + * @export + * @interface IDRBarController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiDRBarController extends IApiControlController { + /** + * @description 获取数据 + * @returns {*} {IApiData[]} + * @memberof IApiDRBarController + */ + getData(): IApiData[]; +} +/** + * @description 数据关系分页控制器接口 + * @export + * @interface IDRTabController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiDRTabController extends IApiControlController { + /** + * @description 获取数据 + * @returns {*} {IApiData[]} + * @memberof IApiDRTabController + */ + getData(): IApiData[]; +} +/** + * @description 看板部件控制器接口 + * @export + * @interface IApiKanbanController + * @extends {IApiDataViewControlController} + * @template T + * @template S + */ +export interface IApiKanbanController extends IApiDataViewControlController { + /** + * @description 全屏 + * @param {IApiData} container + * @returns {*} {boolean} + * @memberof IApiKanbanController + */ + onFullScreen(container: IApiData): boolean; +} +/** + * @description 地图控制器接口 + * @export + * @interface IMapController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiMapController extends IApiMDControlController { +} +/** + * @description 多编辑视图面板控制器接口 + * @export + * @interface IApiMEditViewPanelController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiMEditViewPanelController extends IApiMDControlController { +} +/** + * @description 选择视图面板控制器接口 + * @export + * @interface IApiPickupViewPanelController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiPickupViewPanelController extends IApiControlController { + /** + * @description 选择视图嵌入视图控制器 + * @type {IApiViewController} + * @memberof IApiPickupViewPanelController + */ + embedView: IApiViewController; + /** + * @description 获取选中数据 + * @returns {*} {Promise} + * @memberof IApiPickupViewPanelController + */ + getSelectedData(): Promise; + /** + * @description 获取所有数据 + * @returns {*} {Promise} + * @memberof IApiPickupViewPanelController + */ + getAllData(): Promise; +} +/** + * @description 报表部件控制器接口 + * @export + * @interface IReportPanelController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiReportPanelController extends IApiControlController { + /** + * @description 报表生成器对象 + * @type {IApiData} + * @memberof IApiReportPanelController + */ + generator: IApiData; + /** + * @description 加载数据 + * @param {IApiMDCtrlLoadParams} [args] + * @returns {*} {Promise} + * @memberof IApiReportPanelController + */ + load(args?: IApiMDCtrlLoadParams): Promise; + /** + * @description 获取表单数据 + * @returns {*} {IApiData[]} + * @memberof IApiReportPanelController + */ + getData(): IApiData[]; + /** + * @description 刷新 + * @returns {*} {Promise} + * @memberof IApiReportPanelController + */ + refresh(): Promise; +} +/** + * @description 搜索栏控制器接口 + * @export + * @interface IApiSearchBarController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiSearchBarController extends IApiControlController { + /** + * @description 获取搜索栏的过滤参数 + * @returns {*} {IApiParams} + * @memberof IApiSearchBarController + */ + getFilterParams(): IApiParams; +} +/** + * @description 搜索表单控制器接口 + * @export + * @interface IApiSearchFormController + * @extends {IApiFormController} + * @template T + * @template S + */ +export interface IApiSearchFormController extends IApiFormController { + /** + * @description 加载数据 + * @returns {*} {Promise} + * @memberof IApiSearchFormController + */ + load(): Promise; + /** + * @description 获取搜索表单的过滤参数 + * @returns {*} {IApiParams} + * @memberof IApiSearchFormController + */ + getFilterParams(): IApiParams; + /** + * @description 执行搜索行为 + * @returns {*} {Promise} + * @memberof IApiSearchFormController + */ + search(): Promise; + /** + * @description 重置 + * @returns {*} {Promise} + * @memberof IApiSearchFormController + */ + reset(): Promise; +} +/** + * @description 分页导航面板控制器接口 + * @export + * @interface IApiTabExpPanelController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiTabExpPanelController extends IApiControlController { + /** + * @description 刷新当前页面（会重新计算相关视图参数和上下文） + * @memberof IApiTabExpPanelController + */ + refresh(): void; +} +/** + * @description 向导面板控制器 + * @export + * @interface IApiWizardPanelController + * @extends {IApiControlController} + * @template T + * @template S + */ +export interface IApiWizardPanelController extends IApiControlController { + /** + * @description 当前激活向导表单 + * @type {(IDEWizardForm | undefined)} + * @memberof IApiWizardPanelController + */ + activeWizardForm: IDEWizardForm | undefined; +} +/** + * @description 树表格部件控制器 + * @export + * @interface IApiTreeGridController + * @extends {IApiGridController} + * @template T + * @template S + */ +export interface IApiTreeGridController extends IApiGridController { + /** + * @description 切换树表格显示 + * @memberof IApiTreeGridController + */ + switchTreeGridShow(): void; + /** + * @description 数据导出 + * @param {{ event: MouseEvent; params: IApiData }} _args + * @returns {*} {Promise} + * @memberof IApiTreeGridController + */ + exportData(_args: { + event: MouseEvent; + params: IApiData; + }): Promise; + /** + * @description 保存单条数据 + * @param {IApiData} data + * @returns {*} {Promise} + * @memberof ITreeGridController + */ + save(data: IApiData): Promise; +} +/** + * @description 树表格(增强)部件控制器 + * @export + * @interface IApiGanttController + * @extends {IApiGridController} + * @template T + * @template S + */ +export interface IApiGanttController extends IApiMDControlController { + /** + * @description 保存数据 + * @param {IApiGanttNodeData} data + * @returns {*} {Promise} + * @memberof IApiGanttController + */ + save(data: IApiGanttNodeData): Promise; + /** + * @description 保存甘特图所有数据 + * @returns {*} {Promise} + * @memberof IApiGanttController + */ + saveAll(): Promise; + /** + * @description 切换甘特图的行编辑开启关闭状态 + * @memberof IApiGanttController + */ + toggleRowEdit(): void; + /** + * @description 新建行 + * @param {IApiMDCtrlLoadParams} [args] + * @returns {*} {Promise} + * @memberof IApiGanttController + */ + newRow(args?: IApiMDCtrlLoadParams): Promise; + /** + * @description 切换折叠 + * @param {IApiData} [params] + * @memberof IApiGanttController + */ + changeCollapse(params?: IApiData): void; +} +/** + * @description 树部件控制器 + * @export + * @interface IApiTreeController + * @extends {IApiMDControlController} + * @template T + * @template S + */ +export interface IApiTreeController extends IApiMDControlController { + /** + * 刷新指定树节点的子节点数据 + * @author lxm + * @date 2023-08-23 08:23:59 + * @param {(ITreeNodeData | IApiData)} nodeData 指定树节点数据，可以是节点数据，也可以是对应的实体数据 + * @param {boolean} [refreshParent=false] 是否是刷新给定节点数据的父节点的子节点数据 + * @return {*} {Promise} + */ + refreshNodeChildren(nodeData: IApiTreeNodeData | IApiData, refreshParent?: boolean): Promise; + /** + * 展开并加载节点 + * @author lxm + * @date 2023-11-07 03:00:54 + * @param {string[]} expandedKeys 要展开的节点标识集合 + * @return {*} {Promise} + */ + expandNodeByKey(expandedKeys: string[]): Promise; + /** + * @description 展开/收缩节点 + * @param {IApiData} [params] + * @memberof ITreeController + */ + changeCollapse(params?: IApiData): void; +} +/** + * @description 树表格(增强)部件控制器 + * @export + * @interface IApiTreeGridEXController + * @extends {IApiGridController} + * @template T + * @template S + */ +export interface IApiTreeGridEXController extends IApiGridController { + /** + * @description 切换树表格显示 + * @memberof IApiTreeGridEXController + */ + switchTreeGridShow(): void; + /** + * @description 数据导出 + * @param {{ event: MouseEvent; params: IApiData }} _args + * @returns {*} {Promise} + * @memberof IApiTreeGridEXController + */ + exportData(_args: { + event: MouseEvent; + params: IApiData; + }): Promise; + /** + * @description 保存单条数据 + * @param {IApiData} data + * @returns {*} {Promise} + * @memberof IApiTreeGridEXController + */ + save(data: IApiData): Promise; +} +/** + * @description 视图，部件控制器基类 + * @export + * @interface IApiController + * @extends {IApiEnforceableController} + * @template T + * @template S + */ +export interface IApiController extends IApiEnforceableController { + /** + * @description 控制器实例的唯一标识,创建时自动生成 + * @type {string} + * @memberof IApiController + */ + readonly id: string; + /** + * @description UI状态 + * @type {S} + * @memberof IApiController + */ + state: S; + /** + * @description 模型对象 + * @type {T} + * @memberof IApiController + */ + readonly model: T; + /** + * @description 视图上下文 + * @type {IApiContext} + * @memberof IApiController + */ + readonly context: IApiContext; + /** + * @description 视图参数 + * @type {IApiParams} + * @memberof IApiController + */ + readonly params: IApiParams; + /** + * @description 视图布局面板控制器 + * @type {(IApiViewLayoutPanelController & IApiData)} + * @memberof IApiController + */ + layoutPanel?: IApiViewLayoutPanelController & IApiData; +} +/** + * @description 部件类型映射 + * @export + * @interface IApiControlMapping + */ +export interface IApiControlMapping { + /** + * @description 应用菜单 + * @type {IApiMenuController} + * @memberof IApiControlMapping + */ + APPMENU: IApiMenuController; + /** + * @description 日历视图导航栏 + * @type {IApiCalendarExpBarController} + * @memberof IApiControlMapping + */ + CALENDAREXPBAR: IApiCalendarExpBarController; + /** + * @description 日历部件 + * @type {IApiCalendarController} + * @memberof IApiControlMapping + */ + CALENDAR: IApiCalendarController; + /** + * @description 标题栏 + * @type {IApiCaptionBarController} + * @memberof IApiControlMapping + */ + CAPTIONBAR: IApiCaptionBarController; + /** + * @description 图表视图导航栏 + * @type {IApiChartExpBarController} + * @memberof IApiControlMapping + */ + CHARTEXPBAR: IApiChartExpBarController; + /** + * @description 数据图表 + * @type {IApiChartController} + * @memberof IApiControlMapping + */ + CHART: IApiChartController; + /** + * @description 上下文菜单 + * @type {IApiContextMenuController} + * @memberof IApiControlMapping + */ + CONTEXTMENU: IApiContextMenuController; + /** + * @description 数据看板 + * @type {IApiDashboardController} + * @memberof IApiControlMapping + */ + DASHBOARD: IApiDashboardController; + /** + * @description 数据视图 + * @type {IApiDataViewControlController} + * @memberof IApiControlMapping + */ + DATAVIEW: IApiDataViewControlController; + /** + * @description 数据关系栏 + * @type {IApiDRBarController} + * @memberof IApiControlMapping + */ + DRBAR: IApiDRBarController; + /** + * @description 数据关系分页部件 + * @type {IApiDRTabController} + * @memberof IApiControlMapping + */ + DRTAB: IApiDRTabController; + /** + * @description 编辑表单 + * @type {IApiEditFormController} + * @memberof IApiControlMapping + */ + FORM: IApiEditFormController; + /** + * @description 甘特部件 + * @type {IApiGanttController} + * @memberof IApiControlMapping + */ + GANTT: IApiGanttController; + /** + * @description 数据表格 + * @type {IApiGridController} + * @memberof IApiControlMapping + */ + GRID: IApiGridController; + /** + * @description 看板 + * @type {IApiKanbanController} + * @memberof IApiControlMapping + */ + KANBAN: IApiKanbanController; + /** + * @description 列表 + * @type {IApiListController} + * @memberof IApiControlMapping + */ + LIST: IApiListController; + /** + * @description 地图部件 + * @type {IApiMapController} + * @memberof IApiControlMapping + */ + MAP: IApiMapController; + /** + * @description 多编辑视图面板 + * @type {IApiMEditViewPanelController} + * @memberof IApiControlMapping + */ + MULTIEDITVIEWPANEL: IApiMEditViewPanelController; + /** + * @description 移动端多数据视图 + * @type {IApiMobMDCtrlController} + * @memberof IApiControlMapping + */ + MOBMDCTRL: IApiMobMDCtrlController; + /** + * @description 面板部件 + * @type {IApiPanelController} + * @memberof IApiControlMapping + */ + PANEL: IApiPanelController; + /** + * @description 选择视图面板 + * @type {IApiPickupViewPanelController} + * @memberof IApiControlMapping + */ + PICKUPVIEWPANEL: IApiPickupViewPanelController; + /** + * @description 报表面板 + * @type {IApiReportPanelController} + * @memberof IApiControlMapping + */ + REPORTPANEL: IApiReportPanelController; + /** + * @description 搜索栏 + * @type {IApiSearchBarController} + * @memberof IApiControlMapping + */ + SEARCHBAR: IApiSearchBarController; + /** + * @description 搜索表单 + * @type {IApiSearchFormController} + * @memberof IApiControlMapping + */ + SEARCHFORM: IApiSearchFormController; + /** + * @description 分页导航面板 + * @type {IApiTabExpPanelController} + * @memberof IApiControlMapping + */ + TABEXPPANEL: IApiTabExpPanelController; + /** + * @description 工具栏 + * @type {IApiToolbarController} + * @memberof IApiControlMapping + */ + TOOLBAR: IApiToolbarController; + /** + * @description 树表格（增强） + * @type {IApiTreeGridEXController} + * @memberof IApiControlMapping + */ + TREEGRIDEX: IApiTreeGridEXController; + /** + * @description 数据树表格 + * @type {IApiTreeGridController} + * @memberof IApiControlMapping + */ + TREEGRID: IApiTreeGridController; + /** + * @description 树视图 + * @type {IApiTreeController} + * @memberof IApiControlMapping + */ + TREEVIEW: IApiTreeController; + /** + * @description 视图布局面板部件 + * @type {IApiViewLayoutPanelController} + * @memberof IApiControlMapping + */ + VIEWLAYOUTPANEL: IApiViewLayoutPanelController; + /** + * @description 向导面板 + * @type {IApiWizardPanelController} + * @memberof IApiControlMapping + */ + WIZARDPANEL: IApiWizardPanelController; +} +/** + * @description 视图类型映射 + * @export + * @interface IApiViewMapping + */ +export interface IApiViewMapping { + /** + * @description 应用数据导入视图 + * @type {IApiAppDataUploadViewController} + * @memberof IApiViewMapping + */ + APPDATAUPLOADVIEW: IApiAppDataUploadViewController; + /** + * @description 实体日历导航视图 + * @type {IApiCalendarExpViewController} + * @memberof IApiViewMapping + */ + DECALENDAREXPVIEW: IApiCalendarExpViewController; + /** + * @description 实体日历视图 + * @type {IApiCalendarViewController} + * @memberof IApiViewMapping + */ + DECALENDARVIEW: IApiCalendarViewController; + /** + * @description 实体图表导航视图 + * @type {IApiChartExpViewController} + * @memberof IApiViewMapping + */ + DECHARTEXPVIEW: IApiChartExpViewController; + /** + * @description 实体图表视图 + * @type {IApiChartViewController} + * @memberof IApiViewMapping + */ + DECHARTVIEW: IApiChartViewController; + /** + * @description 实体自定义视图 + * @type {IApiCustomViewController} + * @memberof IApiViewMapping + */ + DECUSTOMVIEW: IApiCustomViewController; + /** + * @description 实体卡片视图导航视图 + * @type {IApiDataViewExpViewController} + * @memberof IApiViewMapping + */ + DEDATAVIEWEXPVIEW: IApiDataViewExpViewController; + /** + * @description 实体数据视图 + * @type {IApiDataViewController} + * @memberof IApiViewMapping + */ + DEDATAVIEW: IApiDataViewController; + /** + * @description 实体首页视图 + * @type {IApiDEIndexViewController} + * @memberof IApiViewMapping + */ + DEINDEXVIEW: IApiDEIndexViewController; + /** + * @description 实体编辑视图 + * @type {IApiEditViewController} + * @memberof IApiViewMapping + */ + DEEDITVIEW: IApiEditViewController; + /** + * @description 实体编辑视图（左右关系） + * @type {IApiEditView2Controller} + * @memberof IApiViewMapping + */ + DEEDITVIEW2: IApiEditView2Controller; + /** + * @description 实体编辑视图（分页关系） + * @type {IApiEditView3Controller} + * @memberof IApiViewMapping + */ + DEEDITVIEW3: IApiEditView3Controller; + /** + * @description 实体编辑视图（上下关系） + * @type {IApiEditView4Controller} + * @memberof IApiViewMapping + */ + DEEDITVIEW4: IApiEditView4Controller; + /** + * @description 实体表单选择数据视图（部件视图） + * @type {IApiFormPickupDataViewController} + * @memberof IApiViewMapping + */ + DEFORMPICKUPDATAVIEW: IApiFormPickupDataViewController; + /** + * @description 实体甘特视图 + * @type {IApiGanttViewController} + * @memberof IApiViewMapping + */ + DEGANTTVIEW: IApiGanttViewController; + /** + * @description 实体表格导航视图 + * @type {IApiGridExpViewController} + * @memberof IApiViewMapping + */ + DEGRIDEXPVIEW: IApiGridExpViewController; + /** + * @description 实体表格视图 + * @type {IApiGridViewController} + * @memberof IApiViewMapping + */ + DEGRIDVIEW: IApiGridViewController; + /** + * @description 应用首页视图 + * @type {IApiIndexViewController} + * @memberof IApiViewMapping + */ + APPINDEXVIEW: IApiIndexViewController; + /** + * @description 实体看板视图 + * @type {IApiKanbanViewController} + * @memberof IApiViewMapping + */ + DEKANBANVIEW: IApiKanbanViewController; + /** + * @description 实体列表导航视图 + * @type {IApiListExpViewController} + * @memberof IApiViewMapping + */ + DELISTEXPVIEW: IApiListExpViewController; + /** + * @description 实体列表视图 + * @type {IApiListViewController} + * @memberof IApiViewMapping + */ + DELISTVIEW: IApiListViewController; + /** + * @description 应用登录视图 + * @type {IApiLoginViewController} + * @memberof IApiViewMapping + */ + APPLOGINVIEW: IApiLoginViewController; + /** + * @description 实体地图视图 + * @type {IApiMapViewController} + * @memberof IApiViewMapping + */ + DEMAPVIEW: IApiMapViewController; + /** + * @description 实体多表单编辑视图（部件视图） + * @type {IApiMEditView9Controller} + * @memberof IApiViewMapping + */ + DEMEDITVIEW9: IApiMEditView9Controller; + /** + * @description 实体数据多项选择视图 + * @type {IApiMPickupViewController} + * @memberof IApiViewMapping + */ + DEMPICKUPVIEW: IApiMPickupViewController; + /** + * @description 实体多项数据选择视图（左右关系） + * @type {IApiMPickupView2Controller} + * @memberof IApiViewMapping + */ + DEMPICKUPVIEW2: IApiMPickupView2Controller; + /** + * @description 实体选项操作视图 + * @type {IApiOptViewController} + * @memberof IApiViewMapping + */ + DEOPTVIEW: IApiOptViewController; + /** + * @description 实体面板视图 + * @type {IApiPanelViewController} + * @memberof IApiViewMapping + */ + DEPANELVIEW: IApiPanelViewController; + /** + * @description 实体选择数据视图（部件视图） + * @type {IApiPickupDataViewController} + * @memberof IApiViewMapping + */ + DEPICKUPDATAVIEW: IApiPickupDataViewController; + /** + * @description 实体选择表格视图（部件视图） + * @type {IApiPickupGridViewController} + * @memberof IApiViewMapping + */ + DEPICKUPGRIDVIEW: IApiPickupGridViewController; + /** + * @description 实体选择树视图（部件视图） + * @type {IApiPickupTreeViewController} + * @memberof IApiViewMapping + */ + DEPICKUPTREEVIEW: IApiPickupTreeViewController; + /** + * @description 实体数据选择视图 + * @type {IApiPickupViewController} + * @memberof IApiViewMapping + */ + DEPICKUPVIEW: IApiPickupViewController; + /** + * @description 实体数据选择视图（左右关系） + * @type {IApiPickupView2Controller} + * @memberof IApiViewMapping + */ + DEPICKUPVIEW2: IApiPickupView2Controller; + /** + * @description 实体数据看板视图 + * @type {IApiPortalViewController} + * @memberof IApiViewMapping + */ + DEPORTALVIEW: IApiPortalViewController; + /** + * @description 实体报表视图 + * @type {IApiReportViewController} + * @memberof IApiViewMapping + */ + DEREPORTVIEW: IApiReportViewController; + /** + * @description 实体子应用引用视图 + * @type {IApiSubAppRefViewController} + * @memberof IApiViewMapping + */ + DESUBAPPREFVIEW: IApiSubAppRefViewController; + /** + * @description 实体分页导航视图 + * @type {IApiTabExpViewController} + * @memberof IApiViewMapping + */ + DETABEXPVIEW: IApiTabExpViewController; + /** + * @description 实体分页搜索视图 + * @type {IApiTabSearchViewController} + * @memberof IApiViewMapping + */ + DETABSEARCHVIEW: IApiTabSearchViewController; + /** + * @description 实体树导航视图 + * @type {IApiTreeExpViewController} + * @memberof IApiViewMapping + */ + DETREEEXPVIEW: IApiTreeExpViewController; + /** + * @description 实体树表格视图（增强） + * @type {IApiTreeGridExViewController} + * @memberof IApiViewMapping + */ + DETREEGRIDEXVIEW: IApiTreeGridExViewController; + /** + * @description 实体树表格视图 + * @type {IApiTreeGridViewController} + * @memberof IApiViewMapping + */ + DETREEGRIDVIEW: IApiTreeGridViewController; + /** + * @description 实体树视图 + * @type {IApiTreeViewController} + * @memberof IApiViewMapping + */ + DETREEVIEW: IApiTreeViewController; + /** + * @description 实体工作流动态操作视图 + * @type {IApiWFDynaActionViewController} + * @memberof IApiViewMapping + */ + DEWFDYNAACTIONVIEW: IApiWFDynaActionViewController; + /** + * @description 实体工作流动态编辑视图 + * @type {IApiWFDynaEditViewController} + * @memberof IApiViewMapping + */ + DEWFDYNAEDITVIEW: IApiWFDynaEditViewController; + /** + * @description 实体工作流动态视图（分页关系） + * @type {IApiWFDynaEditView3Controller} + * @memberof IApiViewMapping + */ + DEWFDYNAEDITVIEW3: IApiWFDynaEditView3Controller; + /** + * @description 实体工作流动态启动视图 + * @type {IApiWFDynaStartViewController} + * @memberof IApiViewMapping + */ + DEWFDYNASTARTVIEW: IApiWFDynaStartViewController; + /** + * @description 应用流程处理记录视图 + * @type {IApiWFStepDataViewController} + * @memberof IApiViewMapping + */ + APPWFSTEPDATAVIEW: IApiWFStepDataViewController; + /** + * @description 实体向导视图 + * @type {IApiWizardViewController} + * @memberof IApiViewMapping + */ + DEWIZARDVIEW: IApiWizardViewController; + /** + * @description 实体移动端日历视图 + * @type {IApiMobCalendarViewController} + * @memberof IApiViewMapping + */ + DEMOBCALENDARVIEW: IApiMobCalendarViewController; + /** + * @description 实体移动端图表视图 + * @type {IApiMobChartViewController} + * @memberof IApiViewMapping + */ + DEMOBCHARTVIEW: IApiMobChartViewController; + /** + * @description 实体移动端自定义视图 + * @type {IApiMobCustomViewController} + * @memberof IApiViewMapping + */ + DEMOBCUSTOMVIEW: IApiMobCustomViewController; + /** + * @description 实体移动端卡片视图 + * @type {IApiMobDataViewController} + * @memberof IApiViewMapping + */ + DEMOBDATAVIEW: IApiMobDataViewController; + /** + * @description 实体移动端编辑视图 + * @type {IApiMobEditViewController} + * @memberof IApiViewMapping + */ + DEMOBEDITVIEW: IApiMobEditViewController; + /** + * @description 实体移动端编辑视图（分页关系） + * @type {IApiMobEditView3Controller} + * @memberof IApiViewMapping + */ + DEMOBEDITVIEW3: IApiMobEditView3Controller; + /** + * @description 实体移动端多数据视图 + * @type {IApiMobMDViewController} + * @memberof IApiViewMapping + */ + DEMOBMDVIEW: IApiMobMDViewController; + /** + * @description 实体移动端多数据选择视图 + * @type {IApiMobMPickupViewController} + * @memberof IApiViewMapping + */ + DEMOBMPICKUPVIEW: IApiMobMPickupViewController; + /** + * @description 实体移动端选项操作视图 + * @type {IApiMobOptViewController} + * @memberof IApiViewMapping + */ + DEMOBOPTVIEW: IApiMobOptViewController; + /** + * @description 实体移动端选择多数据视图（部件视图） + * @type {IApiMobPickupMDViewController} + * @memberof IApiViewMapping + */ + DEMOBPICKUPMDVIEW: IApiMobPickupMDViewController; + /** + * @description 实体移动端选择树视图（部件视图） + * @type {IApiMobPickupTreeViewController} + * @memberof IApiViewMapping + */ + DEMOBPICKUPTREEVIEW: IApiMobPickupTreeViewController; + /** + * @description 实体移动端数据选择视图 + * @type {IApiMobPickupViewController} + * @memberof IApiViewMapping + */ + DEMOBPICKUPVIEW: IApiMobPickupViewController; + /** + * @description 实体移动端分页导航视图 + * @type {IApiMobTabExpViewController} + * @memberof IApiViewMapping + */ + DEMOBTABEXPVIEW: IApiMobTabExpViewController; + /** + * @description 实体移动端分页搜索视图 + * @type {IApiMobTabSearchViewController} + * @memberof IApiViewMapping + */ + DEMOBTABSEARCHVIEW: IApiMobTabSearchViewController; + /** + * @description 实体移动端树导航视图 + * @type {IApiMobTreeExpViewController} + * @memberof IApiViewMapping + */ + DEMOBTREEEXPVIEW: IApiMobTreeExpViewController; + /** + * @description 实体移动端树视图 + * @type {IApiMobTreeViewController} + * @memberof IApiViewMapping + */ + DEMOBTREEVIEW: IApiMobTreeViewController; + /** + * @description 实体移动端工作流动态操作视图 + * @type {IApiMobWFDynaActionViewController} + * @memberof IApiViewMapping + */ + DEMOBWFDYNAACTIONVIEW: IApiMobWFDynaActionViewController; + /** + * @description 实体移动端工作流动态编辑视图 + * @type {IApiMobWFDynaEditViewController} + * @memberof IApiViewMapping + */ + DEMOBWFDYNAEDITVIEW: IApiMobWFDynaEditViewController; + /** + * @description 实体移动端工作流动态编辑视图（分页关系） + * @type {IApiMobWFDynaEditView3Controller} + * @memberof IApiViewMapping + */ + DEMOBWFDYNAEDITVIEW3: IApiMobWFDynaEditView3Controller; + /** + * @description 实体移动端工作流动态启动视图 + * @type {IApiMobWFDynaStartViewController} + * @memberof IApiViewMapping + */ + DEMOBWFDYNASTARTVIEW: IApiMobWFDynaStartViewController; + /** + * @description 实体移动端向导视图 + * @type {IApiMobWizardViewController} + * @memberof IApiViewMapping + */ + DEMOBWIZARDVIEW: IApiMobWizardViewController; + /** + * @description 应用流程跟踪视图 + * @type {IApiWFStepTraceViewController} + * @memberof IApiViewMapping + */ + APPWFSTEPTRACEVIEW: IApiWFStepTraceViewController; +} +/** + * @description 简洁确认框参数 + * @export + * @interface IApiModalParams + */ +export interface IApiModalParams { + /** + * @description 标题 + * @type {string} + * @memberof IApiModalParams + */ + title: string; + /** + * @description 描述 + * @type {string} + * @memberof IApiModalParams + */ + desc?: string; + /** + * @description 显示确认按钮（默认显示） + * @type {boolean} + * @memberof IApiModalParams + */ + showConfirmButton?: boolean; + /** + * @description 是否显示取消按钮 + * @type {boolean} + * @memberof IApiModalParams + */ + showCancelButton?: boolean; + /** + * @description 确认按钮显示文本 + * @type {string} + * @memberof IApiModalParams + */ + confirmButtonText?: string; + /** + * @description 取消按钮显示文本 + * @type {string} + * @memberof IApiModalParams + */ + cancelButtonText?: string; + /** + * @description 消息类型 + * @type {('success' | 'info' | 'warning' | 'error')} + * @memberof IApiModalParams + */ + type?: "success" | "info" | "warning" | "error"; + /** + * @description 传递额外参数，详情参见：https://element-plus.org/zh-CN/component/message-box.html#%E9%85%8D%E7%BD%AE%E9%A1%B9 + * @type {IApiParams} + * @memberof IApiModalParams + */ + options?: IApiParams; +} +/** + * @description 消息提示，当用户进行操作时会被触发，该对话框中断用户操作，直到用户确认知晓后才可关闭。 + * @export + * @interface IApiModalUtil + */ +export interface IApiModalUtil { + /** + * @description 弹出普通信息 + * @param {IApiModalParams} params + * @returns {*} {Promise} + * @memberof IApiModalUtil + */ + info(params: IApiModalParams): Promise; + /** + * @description 弹出成功信息 + * @param {IApiModalParams} params + * @returns {*} {Promise} + * @memberof IApiModalUtil + */ + success(params: IApiModalParams): Promise; + /** + * @description 弹出警告信息 + * @param {IApiModalParams} params + * @returns {*} {Promise} + * @memberof IApiModalUtil + */ + warning(params: IApiModalParams): Promise; + /** + * @description 弹出错误信息 + * @param {IApiModalParams} params + * @returns {*} {Promise} + * @memberof IApiModalUtil + */ + error(params: IApiModalParams): Promise; + /** + * @description 弹出确认操作 + * @param {IApiModalParams} params + * @returns {*} {Promise} + * @memberof IApiModalUtil + */ + confirm(params: IApiModalParams): Promise; +} +/** + * @description 确认框参数 + * @export + * @interface IApiConfirmParams + */ +export interface IApiConfirmParams { + /** + * @description 标题 + * @type {string} + * @memberof IApiConfirmParams + */ + title: string; + /** + * @description 描述 + * @type {string} + * @memberof IApiConfirmParams + */ + desc?: string; + /** + * @description 传递额外参数，详情参见：https://element-plus.org/zh-CN/component/message-box.html#%E9%85%8D%E7%BD%AE%E9%A1%B9 + * @type {IApiParams} + * @memberof IApiConfirmParams + */ + options?: IApiParams; +} +/** + * @description 确认消息，提示用户确认其已经触发的动作，并询问是否进行此操作时会用到此对话框。 + * @export + * @interface IApiConfirmUtil + */ +export interface IApiConfirmUtil { + /** + * @description 弹出普通信息 + * @param {IApiConfirmParams} params + * @returns {*} {Promise} + * @memberof IApiConfirmUtil + */ + info(params: IApiConfirmParams): Promise; + /** + * @description 弹出成功信息 + * @param {IApiConfirmParams} params + * @returns {*} {Promise} + * @memberof IApiConfirmUtil + */ + success(params: IApiConfirmParams): Promise; + /** + * @description 弹出警告信息 + * @param {IApiConfirmParams} params + * @returns {*} {Promise} + * @memberof IApiConfirmUtil + */ + warning(params: IApiConfirmParams): Promise; + /** + * @description 弹出错误信息 + * @param {IApiConfirmParams} params + * @returns {*} {Promise} + * @memberof IApiConfirmUtil + */ + error(params: IApiConfirmParams): Promise; +} +/** + * @description 消息提示参数接口 + * @export + * @interface IApiMessageParams + */ +export interface IApiMessageParams { + /** + * @description 类型（默认info） + * @type {('success' | 'info' | 'warning' | 'error')} + * @memberof IApiMessageParams + */ + type?: "success" | "info" | "warning" | "error"; + /** + * @description 消息内容 + * @type {string} + * @memberof IApiMessageParams + */ + message: string; + /** + * @description 持续时间，单位：秒，默认：1.5 + * @type {number} + * @memberof IApiMessageParams + */ + duration?: number; + /** + * @description 显示关闭按钮，默认：false + * @type {boolean} + * @memberof IApiMessageParams + */ + showClose?: boolean; + /** + * @description 预置的样式类型 + * @type {'alert'} + * @memberof IApiMessageParams + */ + styleType?: "alert"; +} +/** + * @description 主动操作后的反馈提示，顶部居中显示，并自动消失 + * @export + * @interface IApiMessageUtil + */ +export interface IApiMessageUtil { + /** + * @description 弹出普通消息 + * @param {string} msg 消息内容 + * @param {number} [duration] 持续时间，单位：秒，默认：1.5 + * @param {boolean} [closable] 显示关闭按钮，默认：false + * @memberof IApiMessageUtil + */ + info(msg: string, duration?: number, closable?: boolean): void; + /** + * @description 弹出成功消息 + * @param {string} msg 消息内容 + * @param {number} [duration] 持续时间，单位：秒，默认：1.5 + * @param {boolean} [closable] 显示关闭按钮，默认：false + * @memberof IApiMessageUtil + */ + success(msg: string, duration?: number, closable?: boolean): void; + /** + * @description 弹出警告消息 + * @param {string} msg 消息内容 + * @param {number} [duration] 持续时间，单位：秒，默认：1.5 + * @param {boolean} [closable] 显示关闭按钮，默认：false + * @memberof IApiMessageUtil + */ + warning(msg: string, duration?: number, closable?: boolean): void; + /** + * @description 弹出错误消息 + * @param {string} msg 消息内容 + * @param {number} [duration] 持续时间，单位：秒，默认：1.5 + * @param {boolean} [closable] 显示关闭按钮，默认：false + * @memberof IApiMessageUtil + */ + error(msg: string, duration?: number, closable?: boolean): void; + /** + * @description 通用消息方法 + * @param {IApiData} params 配置详细的参数，详情参见：https://element-plus.org/zh-CN/component/message.html#message-%E9%85%8D%E7%BD%AE%E9%A1%B9 + * @memberof IApiMessageUtil + */ + notice(params: IApiData): void; +} +/** + * @description 全局通知参数 + * @export + * @interface IApiNotificationParams + */ +export interface IApiNotificationParams { + /** + * @description 标题 + * @type {string} + * @memberof IApiNotificationParams + */ + title?: string; + /** + * @description 描述 + * @type {string} + * @memberof IApiNotificationParams + */ + desc?: string; + /** + * @description 描述是否是html字符串 + * @type {boolean} + * @memberof IApiNotificationParams + */ + isHtmlDesc?: boolean; + /** + * @description 自动关闭的延时，单位秒，不关闭可以写 0 + * @type {number} + * @memberof IApiNotificationParams + */ + duration?: number; + /** + * @description 位置 + * @type {('top-right' | 'top-left' | 'bottom-right' | 'bottom-left')} + * @memberof IApiNotificationParams + */ + position?: "top-right" | "top-left" | "bottom-right" | "bottom-left"; + /** + * @description 自定义类名 + * @type {string} + * @memberof IApiNotificationParams + */ + class?: string; + /** + * @description 点击事件回调 + * @memberof IApiNotificationParams + */ + onClick?: () => void; +} +/** + * @description 悬浮出现在界面右上角，显示全局的通知 + * @export + * @interface IApiNotificationUtil + */ +export interface IApiNotificationUtil { + /** + * @description 弹出默认通知 + * @param {IApiNotificationParams} params + * @memberof IApiNotificationUtil + */ + default(params: IApiNotificationParams): void; + /** + * @description 弹出普通通知 + * @param {IApiNotificationParams} params + * @memberof IApiNotificationUtil + */ + info(params: IApiNotificationParams): void; + /** + * @description 弹出成功通知 + * @param {IApiNotificationParams} params + * @memberof IApiNotificationUtil + */ + success(params: IApiNotificationParams): void; + /** + * @description 弹出警告通知 + * @param {IApiNotificationParams} params + * @memberof IApiNotificationUtil + */ + warning(params: IApiNotificationParams): void; + /** + * @description 弹出失败通知 + * @param {IApiNotificationParams} params + * @memberof IApiNotificationUtil + */ + error(params: IApiNotificationParams): void; +} +/** + * @description 打开视图工具类 + * @export + * @interface IApiOpenViewUtil + */ +export interface IApiOpenViewUtil { + /** + * @description 直接路径打开视图 + * @param {string} path + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + push(path: string): Promise; + /** + * @description 打开顶级视图(一般为路由打开) + * @param {string} appViewId + * @param {IApiContext} context + * @param {IApiParams} [params] + * @param {IApiData} [modalOptions] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + root(appViewId: string, context: IApiContext, params?: IApiParams, modalOptions?: IApiData): Promise; + /** + * @description 打开顶级视图(模态方式打开) + * @param {string} appViewId + * @param {IApiContext} context + * @param {IApiParams} [params] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + rootByModal(appViewId: string, context: IApiContext, params?: IApiParams): Promise; + /** + * @description 打开模态视图 + * @param {string} appViewId + * @param {IApiContext} context + * @param {IApiParams} [params] + * @param {IApiOverlayContainerOptions} [options] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + modal(appViewId: string, context: IApiContext, params?: IApiParams, options?: IApiOverlayContainerOptions): Promise; + /** + * @description 气泡模式打开 + * @param {string} appViewId + * @param {MouseEvent} event + * @param {IApiContext} context + * @param {IApiParams} [params] + * @param {(IApiPopoverOptions & IApiOverlayContainerOptions)} [options] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + popover(appViewId: string, event: MouseEvent, context: IApiContext, params?: IApiParams, options?: IApiPopoverOptions & IApiOverlayContainerOptions): Promise; + /** + * @description 抽屉模式打开 + * @param {string} appViewId + * @param {IApiContext} context + * @param {IApiParams} [params] + * @param {IApiOverlayContainerOptions} [options] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + drawer(appViewId: string, context: IApiContext, params?: IApiParams, options?: IApiOverlayContainerOptions): Promise; + /** + * @description 自定义打开方式 + * @param {string} appViewId + * @param {IApiContext} context + * @param {IApiParams} [params] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + custom(appViewId: string, context: IApiContext, params?: IApiParams): Promise; + /** + * @description 独立程序打开 + * @param {string} appViewId + * @param {IApiContext} context + * @param {IApiParams} [params] + * @returns {*} {Promise} + * @memberof IApiOpenViewUtil + */ + popupApp(appViewId: string, context: IApiContext, params?: IApiParams): Promise; +} +/** + * @description 全屏工具类 + * @export + * @interface IApiFullscreenUtil + */ +export interface IApiFullscreenUtil { + /** + * @description 指定元素全屏 + * @param {HTMLDivElement} div + * @param {IApiData} [data] + * @memberof IApiFullscreenUtil + */ + openElementFullscreen(div: HTMLDivElement, data?: IApiData): void; + /** + * @description 退出全屏 + * @memberof IApiFullscreenUtil + */ + closeElementFullscreen(): void; +} +/** + * @description 二维码工具 + * @export + * @interface IApiQrcodeUtil + */ +export interface IApiQrcodeUtil { + /** + * @description 扫描二维码 + * @param {(IApiParams | undefined)} [options] 创建二维码参数配置 + * @returns {*} {Promise} + * @memberof IApiQrcodeUtil + */ + scanQrcode(options?: IApiParams | undefined): Promise; + /** + * @description 创建二维码 + * @param {string} value 创建二维码需要的文本值 + * @param {(IApiParams | undefined)} [options] 创建二维码参数配置 + * @returns {*} {IApiParams} + * @memberof IApiQrcodeUtil + */ + createQrcode(value: string, options?: IApiParams | undefined): IApiParams; +} +/** + * @description handlebars 渲染工具类 + * @export + * @interface IApiHandlebarsUtil + */ +export interface IApiHandlebarsUtil { + /** + * @description 异步绘制模板，返回渲染后的字符串 + * @param {string} template + * @param {IApiData} data + * @returns {*} {Promise} + * @memberof IApiHandlebarsUtil + */ + render(template: string, data: IApiData): Promise; + /** + * @description 同步绘制模板，返回渲染后的字符串 + * @param {string} template + * @param {IApiData} data + * @returns {*} {string} + * @memberof IApiHandlebarsUtil + */ + syncRender(template: string, data: IApiData): string; +} +/** + * @description 文本工具 + * @export + * @interface IApiTextUtil + */ +export interface IApiTextUtil { + /** + * @description 格式化文本，遵循excel格式化标准 + * @param {string} value 文本值 + * @param {string} format 格式 + * @returns {*} {string} + * @memberof IApiTextUtil + */ + format(value: string, format: string): string; + /** + * @description 拷贝文本到剪切板 + * @param {string} value 拷贝文本值 + * @returns {*} {boolean} + * @memberof IApiTextUtil + */ + copy(value: string): boolean; + /** + * @description 文本是否包含中文字符 + * @param {string} str 文本 + * @returns {*} {boolean} + * @memberof IApiTextUtil + */ + isChineseCharacter(str: string): boolean; + /** + * @description 文本是否包含中文和英文字符 + * @param {string} str 文本 + * @returns {*} {boolean} + * @memberof IApiTextUtil + */ + hasChineseAndEnglish(str: string): boolean; + /** + * @description 文本转十六进制颜色 + * @param {string} text 颜色字符串 + * @returns {*} {string} + * @memberof IApiTextUtil + */ + stringToHexColor(text: string): string; +} +/** + * @description 主题工具 + * @export + * @interface IApiThemeUtil + */ +export interface IApiThemeUtil { + /** + * @description 设置主题 + * @param {string} tag 主题标识 + * @memberof IApiThemeUtil + */ + setTheme(tag: string): void; + /** + * @description 获取当前主题标识 + * @returns {*} {string} + * @memberof IApiThemeUtil + */ + getTheme(): string; + /** + * @description 打开自定义主题配置面板 + * @memberof IApiThemeUtil + */ + customTheme(): void; +} +/** + * @description 直接值工具 + * @export + * @interface IApiRawValueUtil + */ +export interface IApiRawValueUtil { + /** + * @description 字符串是否完全由整数/浮点数组成 + * @param {string} str + * @returns {*} {boolean} + * @memberof IApiRawValueUtil + */ + isNumber(str: string): boolean; + /** + * @description 转换直接值 + * @param {(string | undefined)} val + * @returns {*} {(number | boolean | string | undefined)} + * @memberof IApiRawValueUtil + */ + format(val: string | undefined): number | boolean | string | undefined; +} +/** + * @description 快捷方式数据 + * @export + * @interface IApiShortCutData + */ +export interface IApiShortCutData { + /** + * @description 唯一标识 + * @type {string} + * @memberof IApiShortCutData + */ + key: string; + /** + * @description 快捷方式标题 + * @type {string} + * @memberof IApiShortCutData + */ + caption: string; + /** + * @description 视图标识 + * @type {string} + * @memberof IApiShortCutData + */ + appViewId: string; + /** + * @description 上下文 + * @type {IApiContext} + * @memberof IApiShortCutData + */ + context: IApiContext; + /** + * @description 视图参数 + * @type {IApiParams} + * @memberof IApiShortCutData + */ + params: IApiParams; + /** + * @description 打开方式 + * @type {string} + * @memberof IApiShortCutData + */ + openMode: string; + /** + * @description 全路径 + * @type {string} + * @memberof IApiShortCutData + */ + fullPath: string; + /** + * @description 快捷图标 + * @type {ISysImage} + * @memberof IApiShortCutData + */ + icon?: ISysImage; +} +/** + * @description 最小化工具类 + * @export + * @interface IApiShortCutUtil + */ +export interface IApiShortCutUtil { + /** + * @description 快捷方式数据 + * @type {IApiShortCutData[]} + * @memberof IApiShortCutUtil + */ + data: IApiShortCutData[]; + /** + * @description 快捷方式模式 + * @type {('horizontal' | 'vertical')} + * @memberof IApiShortCutUtil + */ + mode: "horizontal" | "vertical"; + /** + * @description 设置快捷方式模式 + * @param {('horizontal' | 'vertical')} mode + * @memberof IApiShortCutUtil + */ + setShortCutMode(mode: "horizontal" | "vertical"): void; + /** + * @description 订阅数据改变事件 + * @param {(data: IApiShortCutData[]) => void} callback + * @memberof IApiShortCutUtil + */ + onChange(callback: (data: IApiShortCutData[]) => void): void; + /** + * @description 取消订阅数据改变事件 + * @param {(data: IApiShortCutData[]) => void} callback + * @memberof IApiShortCutUtil + */ + offChange(callback: (data: IApiShortCutData[]) => void): void; + /** + * @description 添加快捷方式 + * @param {IApiShortCutData} shortCut + * @memberof IApiShortCutUtil + */ + addShortCut(shortCut: IApiShortCutData): void; + /** + * @description 删除快捷方式 + * @param {string} key + * @memberof IApiShortCutUtil + */ + removeShortCut(key: string): void; + /** + * @description 改变顺序 + * @param {number} newIndex + * @param {number} oldIndex + * @memberof IApiShortCutUtil + */ + changeIndex(newIndex: number, oldIndex: number): void; + /** + * @description 是否存在最小化 + * @param {string} key + * @returns {*} {boolean} + * @memberof IApiShortCutUtil + */ + isExist(key: string): boolean; +} +/** + * @description 文件工具类 + * @export + * @interface IApiFileUtil + */ +export interface IApiFileUtil { + /** + * @description 文件下载 + * @param {string} url + * @param {string} [name] + * @returns {*} {Promise} + * @memberof IApiFileUtil + */ + fileDownload(url: string, name?: string): Promise; + /** + * @description 文件上传 + * @param {string} uploadUrl + * @param {Blob} file + * @param {IApiData} headers + * @returns {*} {Promise} + * @memberof IApiFileUtil + */ + fileUpload(uploadUrl: string, file: Blob, headers: IApiData): Promise; + /** + * @description 选择并上传文件 + * @param {IApiContext} context + * @param {IApiParams} params + * @param {IApiData} data + * @param {IApiData} [option={}] + * @returns {*} {Promise} + * @memberof IApiFileUtil + */ + chooseFileAndUpload(context: IApiContext, params: IApiParams, data: IApiData, option?: IApiData): Promise; + /** + * @description 选择文件 + * @param {string} [accept] + * @param {boolean} [multiple] 默认为false + * @returns {*} {Promise} + * @memberof IApiFileUtil + */ + chooseFile(accept: string, multiple?: boolean): Promise; +} +/** + * @description html2canvas配置项 + * @export + * @interface IApiHtml2canvasOption + */ +export interface IApiHtml2canvasOption { + /** + * @description 导出文件名称 + * @type {string} + * @memberof IApiHtml2canvasOption + */ + fileName?: string; + /** + * @description 是否允许不同源的图片污染画布 + * @type {boolean} + * @memberof IApiHtml2canvasOption + */ + allowTaint?: boolean; + /** + * @description 画布背景颜色，如果 DOM 中没有指定，则默认为白色。设置 null 则为透明 + * @type {string} + * @memberof IApiHtml2canvasOption + */ + backgroudColor?: string; + /** + * @description现有的 canvas 元素，用作绘图的基础 + * @type {(HTMLCanvasElement)} + * @memberof IApiHtml2canvasOption + */ + canvas?: HTMLCanvasElement; + /** + * @description 如果浏览器支持 ForeignObject rendering，是否使用它 + * @type {boolean} + * @memberof IApiHtml2canvasOption + */ + foreignObjectRendering?: boolean; + /** + * @description 加载图片超时（毫秒）。设置 0 关闭超时 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + imageTimeout?: number; + /** + * @description 布尔函数，用于从渲染中删除匹配元素。 + * @memberof IApiHtml2canvasOption + */ + ignoreElements?: (element: Element) => boolean; + /** + * @description 启用日志记录以进行调试 + * @type {boolean} + * @memberof IApiHtml2canvasOption + */ + logging?: boolean; + /** + * @description 在克隆文档流进行渲染时调用的回调函数，可用于修改将在不影响原始源文档流的情况下呈现的内容 + * @memberof IApiHtml2canvasOption + */ + onclone?: () => IApiData | null; + /** + * @description Url 到代理，用于加载跨域图片资源。如果留空，则不会加载跨域图片。 + * @type {(string)} + * @memberof IApiHtml2canvasOption + */ + proxy?: string; + /** + * @description 是否清理克隆的 DOM 元素，html2canvas 暂时创建。 + * @type {boolean} + * @memberof IApiHtml2canvasOption + */ + removeContainer?: boolean; + /** + * @description 用于渲染的比例，默认为浏览器设备像素比率。 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + scale?: number; + /** + * @description 是否尝试使用 CORS 从服务器加载图片 + * @type {boolean} + * @memberof IApiHtml2canvasOption + */ + useCORS?: boolean; + /** + * @description canvas 画布宽度 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + width?: number; + /** + * @description canvas 画布高度 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + height?: number; + /** + * @description 裁剪画布 x 坐标 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + x?: number; + /** + * @description 裁剪画布 y 坐标 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + y?: number; + /** + * @description 渲染元素时使用的 X 滚动位置（比如元素使用 position: fixed） + * @type {number} + * @memberof IApiHtml2canvasOption + */ + scrollX?: number; + /** + * @description 渲染元素时使用的 Y 滚动位置（比如元素使用 position: fixed） + * @type {number} + * @memberof IApiHtml2canvasOption + */ + scrollY?: number; + /** + * @description 渲染 Element 时要使用的窗口宽度，这可能会影响媒体查询等内容 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + windowWidth?: number; + /** + * @description 渲染 Element 时要使用的窗口高度，这可能会影响媒体查询等内容 + * @type {number} + * @memberof IApiHtml2canvasOption + */ + windowHeight?: number; +} +/** + * @description html2canvas工具类 + * @export + * @interface IApiHtml2canvasUtil + */ +export interface IApiHtml2canvasUtil { + /** + * @description 导出canvas + * @param {HTMLElement} dom + * @param {IApiHtml2canvasOption} [option] + * @returns {*} {Promise} + * @memberof IApiHtml2canvasUtil + */ + exportCanvas(dom: HTMLElement, option?: IApiHtml2canvasOption): Promise; + /** + * @description 获取节点转化的canvas + * @param {HTMLElement} dom + * @param {IApiHtml2canvasOption} [option] + * @returns {*} {Promise} + * @memberof IApiHtml2canvasUtil + */ + getCanvas(dom: HTMLElement, option?: IApiHtml2canvasOption): Promise; +} +/** + * @description 语音工具类 + * @export + * @interface IApiVoiceUtil + */ +export interface IApiVoiceUtil { + /** + * @description 文字转语音 + * @param {string} text + * @param {IApiParams} [options] + * @returns {*} {Promise} + * @memberof IApiVoiceUtil + */ + textToSpeech(text: string, options?: IApiParams): Promise; +} +/** + * @description 全局工具接口 + * @export + * @interface IApiGlobalUtil + */ +export interface IApiGlobalUtil { + /** + * @description 主题工具 + * @type {IApiThemeUtil} + * @memberof IApiGlobalUtil + */ + readonly theme: IApiThemeUtil; + /** + * @description 文本工具 + * @type {IApiTextUtil} + * @memberof IApiGlobalUtil + */ + readonly text: IApiTextUtil; + /** + * @description handlebars 工具 + * @type {IApiHandlebarsUtil} + * @memberof IApiGlobalUtil + */ + readonly hbs: IApiHandlebarsUtil; + /** + * @description base64 工具 + * @type {typeof Base64} + * @memberof IApiGlobalUtil + */ + readonly base64: typeof Base64; + /** + * @description 直接值工具 + * @type {IApiRawValueUtil} + * @memberof IApiGlobalUtil + */ + readonly rawValue: IApiRawValueUtil; + /** + * @description 最小化工具类 + * @type {IApiShortCutUtil} + * @memberof IApiGlobalUtil + */ + readonly shortCut: IApiShortCutUtil; + /** + * @description 文件工具类 + * @type {IApiFileUtil} + * @memberof IApiGlobalUtil + */ + readonly file: IApiFileUtil; + /** + * @description Html2Canvas工具类 + * @type {IApiHtml2canvasUtil} + * @memberof IApiGlobalUtil + */ + readonly html2canvas: IApiHtml2canvasUtil; + /** + * @description 语音工具类 + * @type {IApiVoiceUtil} + * @memberof IApiGlobalUtil + */ + readonly voice: IApiVoiceUtil; + /** + * @description 设置浏览器标题 + * @param {string} title + * @memberof IApiGlobalUtil + */ + setBrowserTitle(title: string): void; +} +/** + * @description 运行时总集 + * @export + * @interface IApiRuntimeIbizsys + */ +export interface IApiRuntimeIbizsys { + /** + * @description 应用中心服务 + * @type {IApiAppHubService} + * @memberof IApiRuntimeIbizsys + */ + hub: IApiAppHubService; + /** + * @description 全局配置 + * @type {IApiGlobalConfig} + * @memberof IApiRuntimeIbizsys + */ + config: IApiGlobalConfig; + /** + * @description 消息提示服务 + * @type {IApiModalUtil} + * @memberof IApiRuntimeIbizsys + */ + modal: IApiModalUtil; + /** + * @description 确认消息服务 + * @type {IApiConfirmUtil} + * @memberof IApiRuntimeIbizsys + */ + confirm: IApiConfirmUtil; + /** + * @description 顶部居中显示反馈提示服务 + * @type {IApiMessageUtil} + * @memberof IApiRuntimeIbizsys + */ + message: IApiMessageUtil; + /** + * @description 全局通知服务 + * @type {IApiNotificationUtil} + * @memberof IApiRuntimeIbizsys + */ + notification: IApiNotificationUtil; + /** + * @description 打开视图服务 + * @type {IApiOpenViewUtil} + * @memberof IApiRuntimeIbizsys + */ + openView: IApiOpenViewUtil; + /** + * @description 全局工具服务 + * @type {IApiGlobalUtil} + * @memberof IApiRuntimeIbizsys + */ + util: IApiGlobalUtil; + /** + * @description 全屏工具服务 + * @type {IApiFullscreenUtil} + * @memberof IApiRuntimeIbizsys + */ + fullscreenUtil: IApiFullscreenUtil; + /** + * @description 二维码工具服务 + * @type {IApiQrcodeUtil} + * @memberof IApiRuntimeIbizsys + */ + qrcodeUtil: IApiQrcodeUtil; +} + + +/** + * @description 环境变量配置接口 + * @export + * @interface IApiEnvGlobalConfig + */ +export interface IApiEnvGlobalConfig { + /** + * @description 全局配置 + * @type {IApiGlobalConfig} + */ + globalConfig: IApiGlobalConfig; +} + +/** + * @description 应用工具接口 + * @export + * @interface IApiUtil + */ +export interface IApiUtil { + /** + * @description 消息通知服务 + * @type {IApiMessageUtil} + */ + message: IApiMessageUtil; + /** + * @description 简洁信息提示服务 + * @type {IApiModalUtil} + */ + modal: IApiModalUtil; + /** + * @description 确认操作弹窗服务 + * @type {IApiConfirmUtil} + */ + confirm: IApiConfirmUtil; + /** + * @description 打开视图工具 + * @type {IApiOpenViewUtil} + */ + openView: IApiOpenViewUtil; +} export {}; -- Gitee