@ibiz-template/runtime 0.7.41-alpha.86 → 0.7.41-alpha.88

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/dist/index.esm.js +89 -37
  2. package/dist/index.system.min.js +1 -1
  3. package/out/config/global-config.js +2 -2
  4. package/out/controller/common/view/view.controller.js +2 -1
  5. package/out/controller/control/app-menu/app-menu.controller.d.ts.map +1 -1
  6. package/out/controller/control/app-menu/app-menu.controller.js +11 -12
  7. package/out/controller/control/data-view/data-view.controller.d.ts +1 -1
  8. package/out/controller/control/data-view/data-view.controller.js +1 -1
  9. package/out/controller/control/form/form/form.controller.d.ts +1 -1
  10. package/out/controller/control/form/form/form.controller.js +1 -1
  11. package/out/controller/control/form/form-detail/form-druipart/form-druipart.state.d.ts +2 -1
  12. package/out/controller/control/form/form-detail/form-druipart/form-druipart.state.d.ts.map +1 -1
  13. package/out/controller/control/gantt/gantt.controller.d.ts +1 -1
  14. package/out/controller/control/gantt/gantt.controller.js +1 -1
  15. package/out/controller/control/grid/grid/grid.controller.d.ts +1 -1
  16. package/out/controller/control/grid/grid/grid.controller.js +3 -2
  17. package/out/controller/control/list/list.controller.d.ts +1 -1
  18. package/out/controller/control/list/list.controller.js +1 -1
  19. package/out/controller/control/tab-exp-panel/tab-exp-panel.controller.d.ts +6 -0
  20. package/out/controller/control/tab-exp-panel/tab-exp-panel.controller.d.ts.map +1 -1
  21. package/out/controller/control/tab-exp-panel/tab-exp-panel.controller.js +13 -0
  22. package/out/controller/control/toolbar/toolbar.controller.d.ts.map +1 -1
  23. package/out/controller/control/toolbar/toolbar.controller.js +9 -7
  24. package/out/controller/control/tree/tree.controller.d.ts +1 -1
  25. package/out/controller/control/tree/tree.controller.js +1 -1
  26. package/out/controller/control/tree-grid/tree-grid.controller.d.ts +1 -1
  27. package/out/controller/control/tree-grid/tree-grid.controller.js +1 -1
  28. package/out/controller/control/tree-grid-ex/tree-grid-ex.controller.js +2 -1
  29. package/out/controller/control/wizard-panel/wizard-panel.controller.d.ts +6 -0
  30. package/out/controller/control/wizard-panel/wizard-panel.controller.d.ts.map +1 -1
  31. package/out/controller/control/wizard-panel/wizard-panel.controller.js +14 -0
  32. package/out/interface/api/app/i-api-app-hub-service.d.ts +7 -7
  33. package/out/interface/api/app/i-api-app-service.d.ts +1 -1
  34. package/out/interface/api/common/global-config/i-api-global-common-config.d.ts +4 -6
  35. package/out/interface/api/common/global-config/i-api-global-common-config.d.ts.map +1 -1
  36. package/out/interface/api/common/global-config/i-api-global-config.d.ts +15 -15
  37. package/out/interface/api/common/global-config/i-api-global-img-compress-config.d.ts +3 -3
  38. package/out/interface/api/common/global-config/i-api-global-mob-config.d.ts +4 -4
  39. package/out/interface/api/common/global-config/i-api-global-view-config.d.ts +5 -5
  40. package/out/interface/api/common/global-config/i-api-global-water-mark-config.d.ts +14 -14
  41. package/out/interface/api/common/i-api-data-ability-params.d.ts +4 -4
  42. package/out/interface/api/common/i-api-modal-data.d.ts +1 -1
  43. package/out/interface/api/common/i-api-ui-action-result.d.ts +1 -1
  44. package/out/interface/api/controller/common/i-api.controller.d.ts +2 -2
  45. package/out/interface/api/controller/control/form-detail/i-api-form-item.controller.d.ts +5 -5
  46. package/out/interface/api/controller/control/grid-column/i-api-grid-column.controller.d.ts +1 -1
  47. package/out/interface/api/controller/control/i-api-data-view-control.controller.d.ts +1 -1
  48. package/out/interface/api/controller/control/i-api-form.controller.d.ts +8 -7
  49. package/out/interface/api/controller/control/i-api-form.controller.d.ts.map +1 -1
  50. package/out/interface/api/controller/control/i-api-grid.controller.d.ts +6 -6
  51. package/out/interface/api/controller/control/i-api-list.controller.d.ts +1 -1
  52. package/out/interface/api/controller/control/i-api-md-control.controller.d.ts +1 -1
  53. package/out/interface/api/controller/control/i-api-tree.controller.d.ts +1 -1
  54. package/out/interface/api/controller/view/i-api-view.controller.d.ts +1 -1
  55. package/out/interface/api/i-api-runtime-ibizsys.d.ts +12 -12
  56. package/out/interface/api/service/i-api-code-list.service.d.ts +1 -1
  57. package/out/interface/api/service/i-api-de-service-util.d.ts +1 -1
  58. package/out/interface/api/state/common/i-api-button-container.state.d.ts +3 -3
  59. package/out/interface/api/state/common/i-api-button.state.d.ts +3 -3
  60. package/out/interface/api/state/control/i-api-form.state.d.ts +2 -2
  61. package/out/interface/api/state/control/i-api-grid.state.d.ts +2 -2
  62. package/out/interface/api/state/view/i-api-view-session.d.ts +1 -1
  63. package/out/interface/api/util/i-api-app-util.d.ts +7 -7
  64. package/out/interface/api/util/i-api-confirm-util.d.ts +4 -4
  65. package/out/interface/api/util/i-api-file-util.d.ts +6 -6
  66. package/out/interface/api/util/i-api-fullscreen-util.d.ts +2 -2
  67. package/out/interface/api/util/i-api-global-util.d.ts +11 -11
  68. package/out/interface/api/util/i-api-html2canvas-util.d.ts +2 -2
  69. package/out/interface/api/util/i-api-message-util.d.ts +5 -5
  70. package/out/interface/api/util/i-api-modal-util.d.ts +9 -9
  71. package/out/interface/api/util/i-api-notification-util.d.ts +5 -5
  72. package/out/interface/api/util/i-api-open-view-util.d.ts +7 -7
  73. package/out/interface/api/util/i-api-print-preview-util.d.ts +2 -2
  74. package/out/interface/api/util/i-api-qrcode-util.d.ts +4 -5
  75. package/out/interface/api/util/i-api-qrcode-util.d.ts.map +1 -1
  76. package/out/interface/api/util/i-api-raw-value-util.d.ts +2 -2
  77. package/out/interface/api/util/i-api-text-util.d.ts +6 -6
  78. package/out/interface/api/util/i-api-theme-util.d.ts +3 -3
  79. package/out/interface/api/util/i-api-ui-action-util.d.ts +3 -3
  80. package/out/interface/api/util/i-api-water-mark-util.d.ts +1 -1
  81. package/out/model/utils/util.d.ts.map +1 -1
  82. package/out/model/utils/util.js +7 -3
  83. package/out/ui-action/provider/sys-ui-action-provider.d.ts.map +1 -1
  84. package/out/ui-action/provider/sys-ui-action-provider.js +1 -3
  85. package/package.json +3 -3
@@ -5,7 +5,7 @@
5
5
  */
6
6
  export interface IApiGlobalImgCompressConfig {
7
7
  /**
8
- * @description 图片压缩范围(超过该范围进行压缩,单位kb)
8
+ * @description 图片压缩阈值(单位:KB);当图片大小超过该值时触发压缩
9
9
  * @type {number}
10
10
  * @default 1024
11
11
  * @platform mob
@@ -13,7 +13,7 @@ export interface IApiGlobalImgCompressConfig {
13
13
  */
14
14
  limit: number;
15
15
  /**
16
- * @description 图片压缩质量(范围0-1,为0时不压缩)
16
+ * @description 图片压缩质量(范围:0~1);值越小压缩率越高,0 表示不进行压缩
17
17
  * @type {number}
18
18
  * @default 0
19
19
  * @platform mob
@@ -21,7 +21,7 @@ export interface IApiGlobalImgCompressConfig {
21
21
  */
22
22
  quality: number;
23
23
  /**
24
- * @description 压缩图片最大宽度,单位px
24
+ * @description 压缩后图片允许的最大宽度(单位:px),超过时按比例缩放
25
25
  * @type {number}
26
26
  * @default 1280
27
27
  * @platform mob
@@ -5,7 +5,7 @@
5
5
  */
6
6
  export interface IApiGlobalMobConfig {
7
7
  /**
8
- * @description 移动端是否显示应用标题,为false时设置浏览器标题时只设置视图标题,不添加应用标题
8
+ * @description 是否在移动端页面标题中显示应用名称;为 false 时浏览器标题仅显示视图标题
9
9
  * @type {boolean}
10
10
  * @default true
11
11
  * @platform mob
@@ -44,7 +44,7 @@ export interface IApiGlobalMobConfig {
44
44
  */
45
45
  mobWeChatDebug: boolean;
46
46
  /**
47
- * @description 是否显示文件上传loading
47
+ * @description 文件上传过程中是否显示全局 loading 提示
48
48
  * @type {boolean}
49
49
  * @platform mob
50
50
  * @memberof IApiGlobalMobConfig
@@ -67,7 +67,7 @@ export interface IApiGlobalMobConfig {
67
67
  */
68
68
  mobEnableStoredQuery: boolean;
69
69
  /**
70
- * @description 移动端工具栏的显示模式,可选值包含IMMEDIATE(即时渲染模式)、COLLAPSIBLE(可折叠模式)
70
+ * @description 工具栏显示模式:IMMEDIATE 立即展示;COLLAPSIBLE 支持折叠展开
71
71
  * @type {('IMMEDIATE' | 'COLLAPSIBLE')}
72
72
  * @default IMMEDIATE
73
73
  * @platform mob
@@ -75,7 +75,7 @@ export interface IApiGlobalMobConfig {
75
75
  */
76
76
  toolbarShowMode: 'IMMEDIATE' | 'COLLAPSIBLE';
77
77
  /**
78
- * @description 移动端工具栏分组与行为组的展示模式,可选值包含DEFAULT(气泡模式,组内容以悬浮气泡形式展示)、ACTIONSHEET(行为列表模式,组内容以下拉抽屉形式展示)
78
+ * @description 工具栏分组展示方式:DEFAULT 气泡形式;ACTIONSHEET 抽屉列表形式
79
79
  * @type {('DEFAULT' | 'ACTIONSHEET')}
80
80
  * @default ACTIONSHEET
81
81
  * @platform mob
@@ -14,7 +14,7 @@ export interface IApiGlobalViewConfig {
14
14
  */
15
15
  enableDataInfoBar: boolean;
16
16
  /**
17
- * @description 用于控制全局哪些导航部件启用缓存,全大写。TABEXPPANEL:GRIDEXPBAR: - :分隔每个导航部件的缓存开关,必须用:结尾,如:TABEXPPANEL:开启表格导航部件缓存,GRIDEXPBAR:开启分页导航部件缓存。
17
+ * @description 导航部件缓存控制配置;使用 : 分隔(如:TABEXPPANEL:GRIDEXPBAR:),需以 : 结尾
18
18
  * @default TABEXPPANEL:
19
19
  * @type {string}
20
20
  * @platform web
@@ -23,7 +23,7 @@ export interface IApiGlobalViewConfig {
23
23
  */
24
24
  expCacheMode: string;
25
25
  /**
26
- * @description 是否禁用分页导航栏,该参数为true时首页不显示分页导航栏
26
+ * @description 是否禁用首页分页导航栏
27
27
  * @default false
28
28
  * @type {boolean}
29
29
  * @platform web
@@ -31,7 +31,7 @@ export interface IApiGlobalViewConfig {
31
31
  */
32
32
  disableHomeTabs: boolean;
33
33
  /**
34
- * @description 移动端是否展示返回按键
34
+ * @description 移动端是否显示系统返回按钮
35
35
  * @default true
36
36
  * @type {boolean}
37
37
  * @platform mob
@@ -39,7 +39,7 @@ export interface IApiGlobalViewConfig {
39
39
  */
40
40
  mobShowPresetBack: boolean;
41
41
  /**
42
- * @description 移动端是否显示视图头
42
+ * @description 移动端是否显示视图头部
43
43
  * @default true
44
44
  * @type {boolean}
45
45
  * @platform mob
@@ -73,7 +73,7 @@ export interface IApiGlobalViewConfig {
73
73
  */
74
74
  viewAccUserMode: 1 | 2 | 3 | 4;
75
75
  /**
76
- * @description 视图加载时的提示文本
76
+ * @description 视图加载过程中的提示文本
77
77
  * @type {string}
78
78
  * @platform web
79
79
  * @platform mob
@@ -5,7 +5,7 @@
5
5
  */
6
6
  export interface IApiGlobalWaterMarkConfig {
7
7
  /**
8
- * @description 是否启用
8
+ * @description 是否启用水印
9
9
  * @type {boolean}
10
10
  * @platform web
11
11
  * @platform mob
@@ -14,7 +14,7 @@ export interface IApiGlobalWaterMarkConfig {
14
14
  */
15
15
  enable: boolean;
16
16
  /**
17
- * @description 水印内容:字符串表示单行文本,数组表示多行文本
17
+ * @description 水印文本内容(支持多行)
18
18
  * @type {(string | string[])}
19
19
  * @platform web
20
20
  * @platform mob
@@ -22,7 +22,7 @@ export interface IApiGlobalWaterMarkConfig {
22
22
  */
23
23
  text: string | string[];
24
24
  /**
25
- * @description 字体大小(单位:CSS 像素)
25
+ * @description 字体大小(px)
26
26
  * @type {number}
27
27
  * @platform web
28
28
  * @platform mob
@@ -31,7 +31,7 @@ export interface IApiGlobalWaterMarkConfig {
31
31
  */
32
32
  fontSize: number;
33
33
  /**
34
- * @description 字体族(遵循 CSS 字体族语法)
34
+ * @description 字体族(遵循 CSS 规范)
35
35
  * @type {string}
36
36
  * @platform web
37
37
  * @platform mob
@@ -40,7 +40,7 @@ export interface IApiGlobalWaterMarkConfig {
40
40
  */
41
41
  fontFamily: string;
42
42
  /**
43
- * @description 字体粗细(遵循 CSS 字体粗细语法,如 'bold'、400
43
+ * @description 字体粗细(如:400 / bold)
44
44
  * @type {(string | number)}
45
45
  * @platform web
46
46
  * @platform mob
@@ -49,7 +49,7 @@ export interface IApiGlobalWaterMarkConfig {
49
49
  */
50
50
  fontWeight: string | number;
51
51
  /**
52
- * @description 字体样式,仅支持 'normal'(正常)、'italic'(斜体)、'oblique'(倾斜)
52
+ * @description 字体样式(normal / italic / oblique
53
53
  * @type {string}
54
54
  * @platform web
55
55
  * @platform mob
@@ -58,7 +58,7 @@ export interface IApiGlobalWaterMarkConfig {
58
58
  */
59
59
  fontStyle: string;
60
60
  /**
61
- * @description 字体颜色(支持 CSS 颜色格式,如 '#fff'、'rgba(0,0,0,0.5)')
61
+ * @description 字体颜色(支持 CSS 格式)
62
62
  * @type {string}
63
63
  * @platform web
64
64
  * @platform mob
@@ -67,7 +67,7 @@ export interface IApiGlobalWaterMarkConfig {
67
67
  */
68
68
  color: string;
69
69
  /**
70
- * @description 水印整体透明度(范围:0 - 1,0 完全透明,1 完全不透明)
70
+ * @description 水印透明度(0~1
71
71
  * @type {number}
72
72
  * @platform web
73
73
  * @platform mob
@@ -76,7 +76,7 @@ export interface IApiGlobalWaterMarkConfig {
76
76
  */
77
77
  opacity: number;
78
78
  /**
79
- * @description 水印顺时针旋转角度,负数即为逆时针(单位:度数)
79
+ * @description 旋转角度(单位:度,支持负值)
80
80
  * @type {number}
81
81
  * @platform web
82
82
  * @platform mob
@@ -85,7 +85,7 @@ export interface IApiGlobalWaterMarkConfig {
85
85
  */
86
86
  rotate: number;
87
87
  /**
88
- * @description 水印平铺时 x、y 方向的间距(单位:CSS 像素),数组第一项为 x 方向,第二项为 y 方向
88
+ * @description 平铺间距(x / y
89
89
  * @type {[number, number]}
90
90
  * @platform web
91
91
  * @platform mob
@@ -94,7 +94,7 @@ export interface IApiGlobalWaterMarkConfig {
94
94
  */
95
95
  gap: [number, number];
96
96
  /**
97
- * @description 水印背景的偏移量(单位:CSS 像素),数组第一项为 x 方向偏移,第二项为 y 方向偏移
97
+ * @description 偏移量(x / y
98
98
  * @type {[number, number]}
99
99
  * @platform web
100
100
  * @platform mob
@@ -103,7 +103,7 @@ export interface IApiGlobalWaterMarkConfig {
103
103
  */
104
104
  offset: [number, number];
105
105
  /**
106
- * @description 水印图块大小(单位:CSS 像素):未设置时根据文本自适应;设置时按指定宽高固定图块尺寸,(0 表示自适应)
106
+ * @description 单个水印块尺寸(0 表示自适应)
107
107
  * @type {{ width: number; height: number }}
108
108
  * @platform web
109
109
  * @platform mob
@@ -115,7 +115,7 @@ export interface IApiGlobalWaterMarkConfig {
115
115
  height: number;
116
116
  };
117
117
  /**
118
- * @description 水印层的 z-index 值(控制层级显示顺序)
118
+ * @description 水印层级控制
119
119
  * @type {number}
120
120
  * @platform web
121
121
  * @platform mob
@@ -142,7 +142,7 @@ export interface IApiGlobalWaterMarkConfig {
142
142
  */
143
143
  protect: boolean;
144
144
  /**
145
- * @description 是否允许文本选择穿透水印层
145
+ * @description 是否允许鼠标穿透选择文本
146
146
  * @type {boolean}
147
147
  * @platform web
148
148
  * @platform mob
@@ -6,25 +6,25 @@ import { IApiContext, IApiData, IApiParams } from '@ibiz-template/core';
6
6
  */
7
7
  export interface IApiDataAbilityParams {
8
8
  /**
9
- * @description 当前这次操作附加的上下文参数
9
+ * @description 额外传入的上下文参数(会与当前上下文合并)
10
10
  * @type {IApiContext}
11
11
  * @memberof IApiDataAbilityParams
12
12
  */
13
13
  context?: IApiContext;
14
14
  /**
15
- * @description 当前这次操作附加的视图参数
15
+ * @description 额外传入的视图参数(会覆盖默认视图参数)
16
16
  * @type {IApiParams}
17
17
  * @memberof IApiDataAbilityParams
18
18
  */
19
19
  viewParam?: IApiParams;
20
20
  /**
21
- * @description 执行能力使用的数据集合,没有则使用数据部件自身的数据或选中数据
21
+ * @description 指定执行的数据集合,若不传,则默认使用控件当前数据或选中数据
22
22
  * @type {(IApiData[] | IApiData)}
23
23
  * @memberof IApiDataAbilityParams
24
24
  */
25
25
  data?: IApiData[] | IApiData;
26
26
  /**
27
- * @description 是否静默执行,不出loading效果,不弹成功提示
27
+ * @description 是否静默执行,为true时不显示 loading,不弹出成功提示
28
28
  * @type {boolean}
29
29
  * @memberof IApiDataAbilityParams
30
30
  */
@@ -6,7 +6,7 @@ import { IApiData, IApiParams } from '@ibiz-template/core';
6
6
  */
7
7
  export interface IApiModalData {
8
8
  /**
9
- * @description 关闭视图是否操作成功
9
+ * @description 关闭视图成功标记,ok=true表示操作成功,信任data数据,ok=false表示操作失败,不信任data数据
10
10
  * @type {boolean}
11
11
  * @memberof IApiModalData
12
12
  */
@@ -12,7 +12,7 @@ export interface IApiUIActionResult {
12
12
  */
13
13
  refresh?: boolean;
14
14
  /**
15
- * @description 刷新引用视图模式,0:无、 1:引用视图或树节点、 2:引用树节点父节点、 3:引用树节点根节点,默认无刷新
15
+ * @description 刷新引用视图模式,0:无刷新(默认)、 1:引用视图或树节点、 2:引用树节点父节点、 3:引用树节点根节点,默认无刷新
16
16
  * @type {(number | 0 | 1 | 2 | 3)}
17
17
  * @memberof IApiUIActionResult
18
18
  */
@@ -17,13 +17,13 @@ export interface IApiController<T extends object = object, S extends object = ob
17
17
  */
18
18
  readonly id: string;
19
19
  /**
20
- * @description 状态对象,泛型
20
+ * @description 状态对象
21
21
  * @type {S}
22
22
  * @memberof IApiController
23
23
  */
24
24
  state: S;
25
25
  /**
26
- * @description 模型对象,泛型
26
+ * @description 模型对象
27
27
  * @type {T}
28
28
  * @memberof IApiController
29
29
  */
@@ -9,7 +9,7 @@ import { IApiFormDetailController } from './i-api-form-detail.controller';
9
9
  */
10
10
  export interface IApiFormItemController extends IApiFormDetailController {
11
11
  /**
12
- * @description 表单项状态
12
+ * @description 表单项状态对象(响应式),包含可见性、禁用状态、校验状态等
13
13
  * @type {IApiFormItemState}
14
14
  * @memberof IApiFormItemController
15
15
  */
@@ -33,19 +33,19 @@ export interface IApiFormItemController extends IApiFormDetailController {
33
33
  */
34
34
  readonly value: unknown;
35
35
  /**
36
- * @description 值项
36
+ * @description 值项名称(用于复杂控件绑定值)
37
37
  * @type {(string | undefined)}
38
38
  * @memberof IApiFormItemController
39
39
  */
40
40
  readonly valueItemName: string | undefined;
41
41
  /**
42
- * @description 标签标题
42
+ * @description 表单项标签显示文本
43
43
  * @type {(string | undefined)}
44
44
  * @memberof IApiFormItemController
45
45
  */
46
46
  readonly labelCaption: string | undefined;
47
47
  /**
48
- * @description 单位
48
+ * @description 单位名称(用于数值类字段显示)
49
49
  * @type {(string | undefined)}
50
50
  * @memberof IApiFormItemController
51
51
  */
@@ -63,7 +63,7 @@ export interface IApiFormItemController extends IApiFormDetailController {
63
63
  */
64
64
  readonly dataType: number | undefined;
65
65
  /**
66
- * @description 校验(如果表单项不显示则不校验直接返回true)
66
+ * @description 校验当前表单项(若不可见则自动跳过校验)
67
67
  * @returns {*} {Promise<boolean>}
68
68
  * @memberof IApiFormItemController
69
69
  */
@@ -15,7 +15,7 @@ export interface IApiGridColumnController {
15
15
  */
16
16
  readonly model: IDEGridColumn;
17
17
  /**
18
- * @description 表格控制器
18
+ * @description 所属表格控制器(反向引用)
19
19
  * @type {IApiGridController}
20
20
  * @memberof IApiGridColumnController
21
21
  */
@@ -18,7 +18,7 @@ import { IApiMDControlController } from './i-api-md-control.controller';
18
18
  */
19
19
  export interface IApiDataViewControlController<T extends IDEDataView = IDEDataView, S extends IApiDataViewControlState = IApiDataViewControlState> extends IApiMDControlController<T, S> {
20
20
  /**
21
- * @description 切换折叠,其中tag表示操作指定分组标识,若不传则操作当前卡片的所有分组展开状态,expand表示是否展开,若不传则以当前分组状态为基准切换
21
+ * @description 切换折叠,tag=指定分组标识(不传则全部),expand=目标状态(不传则反转)
22
22
  * @param {{ tag?: string; expand?: boolean }} [params] 切换折叠参数
23
23
  * @memberof IApiDataViewControlController
24
24
  */
@@ -6,6 +6,7 @@ import { IApiFormDetailController } from './form-detail/i-api-form-detail.contro
6
6
  import { IApiFormMDCtrlController } from './form-detail/i-api-form-mdctrl.controller';
7
7
  import { IApiFormDruipartController } from './form-detail/i-api-form-druipart.controller';
8
8
  import { IApiFormDetailMapping } from '../common';
9
+ import { IApiFormItemController } from './form-detail';
9
10
  /**
10
11
  * 表单
11
12
  * @primary
@@ -32,7 +33,7 @@ import { IApiFormDetailMapping } from '../common';
32
33
  */
33
34
  export interface IApiFormController<T extends IDEForm = IDEForm, S extends IApiFormState = IApiFormState> extends IApiControlController<T, S> {
34
35
  /**
35
- * @description 所有表单项成员的控制器
36
+ * @description 表单成员控件集合(key 为成员 id),包括:按钮、分组、分页、关系界面等
36
37
  * @type {{ [key: string]: IApiFormDetailController }}
37
38
  * @memberof IApiFormController
38
39
  */
@@ -41,12 +42,12 @@ export interface IApiFormController<T extends IDEForm = IDEForm, S extends IApiF
41
42
  };
42
43
  /**
43
44
  * @description 表单项控制器集合
44
- * @type {IApiFormDetailController[]}
45
+ * @type {IApiFormItemController[]}
45
46
  * @memberof IApiFormController
46
47
  */
47
- formItems: IApiFormDetailController[];
48
+ formItems: IApiFormItemController[];
48
49
  /**
49
- * @description 表单多数据部件控制器集合
50
+ * @description 表单关系界面控制器集合(嵌入视图)
50
51
  * @type {IApiFormMDCtrlController[]}
51
52
  * @memberof IApiFormController
52
53
  */
@@ -70,13 +71,13 @@ export interface IApiFormController<T extends IDEForm = IDEForm, S extends IApiF
70
71
  */
71
72
  getReal(): IApiData[];
72
73
  /**
73
- * @description 刷新当前部件
74
+ * @description 刷新表单数据(通常重新加载当前数据)
74
75
  * @returns {*} {Promise<void>}
75
76
  * @memberof IApiFormController
76
77
  */
77
78
  refresh(): Promise<void>;
78
79
  /**
79
- * @description 切换折叠,其中tag表示操作指定分组标识,若不传则操作当前表单的所有分组展开状态,expand表示是否展开,若不传则以当前分组状态为基准切换
80
+ * @description 切换折叠,tag=指定分组标识(不传则全部),expand=目标状态(不传则反转)
80
81
  * @param {{ tag: string; expand: boolean }} [params] 切换折叠参数
81
82
  * @memberof IApiFormController
82
83
  */
@@ -91,7 +92,7 @@ export interface IApiFormController<T extends IDEForm = IDEForm, S extends IApiF
91
92
  */
92
93
  setActiveTab(name: string): void;
93
94
  /**
94
- * @description 设置表单数据
95
+ * @description 设置指定表单项的数据值(name 为字段标识)
95
96
  * @param {string} name 表单项名称
96
97
  * @param {unknown} value 值
97
98
  * @param {boolean} [ignore] 是否忽略脏值检查
@@ -1 +1 @@
1
- {"version":3,"file":"i-api-form.controller.d.ts","sourceRoot":"","sources":["../../../../../src/interface/api/controller/control/i-api-form.controller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC3B,CAAC,SAAS,aAAa,GAAG,aAAa,CACvC,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC;;;;OAIG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,CAAC;IAErD;;;;OAIG;IACH,SAAS,EAAE,wBAAwB,EAAE,CAAC;IAEtC;;;;OAIG;IACH,WAAW,EAAE,wBAAwB,EAAE,CAAC;IAExC;;;;OAIG;IACH,YAAY,EAAE,0BAA0B,EAAE,CAAC;IAE3C;;;;OAIG;IACH,OAAO,IAAI,QAAQ,EAAE,CAAC;IAEtB;;;;OAIG;IACH,OAAO,IAAI,QAAQ,EAAE,CAAC;IAEtB;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpD;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;;OAOG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,qBAAqB,EACjD,IAAI,EAAE,CAAC,EACP,EAAE,EAAE,MAAM,GACT,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,CAAC;CAC9B"}
1
+ {"version":3,"file":"i-api-form.controller.d.ts","sourceRoot":"","sources":["../../../../../src/interface/api/controller/control/i-api-form.controller.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC3C,OAAO,EAAE,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAC/C,OAAO,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC5C,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC;AACnE,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,wBAAwB,EAAE,MAAM,4CAA4C,CAAC;AACtF,OAAO,EAAE,0BAA0B,EAAE,MAAM,8CAA8C,CAAC;AAC1F,OAAO,EAAE,qBAAqB,EAAE,MAAM,WAAW,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AAEvD;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,kBAAkB,CACjC,CAAC,SAAS,OAAO,GAAG,OAAO,EAC3B,CAAC,SAAS,aAAa,GAAG,aAAa,CACvC,SAAQ,qBAAqB,CAAC,CAAC,EAAE,CAAC,CAAC;IACnC;;;;OAIG;IACH,OAAO,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,wBAAwB,CAAA;KAAE,CAAC;IAErD;;;;OAIG;IACH,SAAS,EAAE,sBAAsB,EAAE,CAAC;IAEpC;;;;OAIG;IACH,WAAW,EAAE,wBAAwB,EAAE,CAAC;IAExC;;;;OAIG;IACH,YAAY,EAAE,0BAA0B,EAAE,CAAC;IAE3C;;;;OAIG;IACH,OAAO,IAAI,QAAQ,EAAE,CAAC;IAEtB;;;;OAIG;IACH,OAAO,IAAI,QAAQ,EAAE,CAAC;IAEtB;;;;OAIG;IACH,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,CAAC;IAEzB;;;;OAIG;IACH,cAAc,CAAC,MAAM,CAAC,EAAE;QAAE,GAAG,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,IAAI,CAAC;IAElE;;;;OAIG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC;;;;;;;OAOG;IACH,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAE5E;;;;;OAKG;IACH,cAAc,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpD;;;;OAIG;IACH,QAAQ,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAE7B;;;;OAIG;IACH,cAAc,IAAI,OAAO,CAAC,OAAO,CAAC,CAAC;IAEnC;;;;;;;OAOG;IACH,aAAa,CAAC,CAAC,SAAS,MAAM,qBAAqB,EACjD,IAAI,EAAE,CAAC,EACP,EAAE,EAAE,MAAM,GACT,qBAAqB,CAAC,CAAC,CAAC,CAAC;IAE5B;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,CAAC;IAE7B;;;;OAIG;IACH,kBAAkB,IAAI,MAAM,CAAC;CAC9B"}
@@ -40,7 +40,7 @@ import { IApiExportParams } from '../../common';
40
40
  */
41
41
  export interface IApiGridController<T extends IDEGrid = IDEGrid, S extends IApiGridState = IApiGridState> extends IApiMDControlController<T, S> {
42
42
  /**
43
- * @description 表格列数据
43
+ * @description 表格列数据,key为表格列代码名称,可通过ctrl.columns['表格列codeName'],codeName 与 IApiColumnState.key 相同
44
44
  * @type {{ [key: string]: IApiGridColumnController }}
45
45
  * @memberof IApiGridController
46
46
  */
@@ -55,8 +55,8 @@ export interface IApiGridController<T extends IDEGrid = IDEGrid, S extends IApiG
55
55
  */
56
56
  save(data: IApiData): Promise<void>;
57
57
  /**
58
- * @description 设置行属性的值
59
- * @param {IApiGridRowState} row 行状态控制器
58
+ * @description 设置行属性的值,其中ignore=是否忽略脏值检查(true=不提示用户数据变更,默认false)
59
+ * @param {IApiGridRowState} row 行状态对象
60
60
  * @param {string} name 要设置数据的列名称
61
61
  * @param {unknown} value 要设置的值
62
62
  * @param {boolean} ignore 忽略脏值检查
@@ -66,7 +66,7 @@ export interface IApiGridController<T extends IDEGrid = IDEGrid, S extends IApiG
66
66
  setRowValue(row: IApiGridRowState, name: string, value: unknown, ignore: boolean): Promise<void>;
67
67
  /**
68
68
  * @description 校验一行数据的所有编辑项
69
- * @param {IApiGridRowState} row 要校验的行数据控制器
69
+ * @param {IApiGridRowState} row 要校验的行数据
70
70
  * @returns {*} {Promise<boolean>}
71
71
  * @memberof IApiGridController
72
72
  */
@@ -89,7 +89,7 @@ export interface IApiGridController<T extends IDEGrid = IDEGrid, S extends IApiG
89
89
  */
90
90
  toggleRowEdit(): void;
91
91
  /**
92
- * @description 切换单行的编辑状态
92
+ * @description 切换单行编辑状态,editable表示行编辑目标状态,isSave=true表示关闭编辑时自动保存(默认true)
93
93
  * @param {IApiGridRowState} row 行数据控制器
94
94
  * @param {boolean} [editable] 目标编辑状态
95
95
  * @param {boolean} [isSave] 是否保存
@@ -123,7 +123,7 @@ export interface IApiGridController<T extends IDEGrid = IDEGrid, S extends IApiG
123
123
  */
124
124
  findRowState(data: IApiData): IApiGridRowState | undefined;
125
125
  /**
126
- * @description 切换折叠(分组表格使用),其中tag表示操作指定表格分组行标识,若不传则操作当前表格的所有分组展开状态,expand表示是否展开,若不传则以当前分组状态为基准切换
126
+ * @description 切换折叠(分组表格使用),tag=指定分组标识(不传则全部),expand=目标状态(不传则反转)
127
127
  * @param {{ tag: string; expand: boolean }} [params] 切换折叠参数
128
128
  * @memberof IApiGridController
129
129
  */
@@ -25,7 +25,7 @@ export interface IApiListController<T extends IDEList = IDEList, S extends IApiL
25
25
  */
26
26
  getAllData(): IApiData[];
27
27
  /**
28
- * @description 切换折叠,其中tag表示操作指定列表分组标识,若不传则操作当前列表的所有分组展开状态,expand表示是否展开,若不传则基于当前分组状态取反
28
+ * @description 切换折叠,tag=指定分组标识(不传则全部),expand=目标状态(不传则反转)
29
29
  * @param {{ tag: string; expand: boolean }} [params] 切换折叠参数
30
30
  * @memberof IApiListController
31
31
  */
@@ -37,7 +37,7 @@ export interface IApiMDCtrlLoadParams extends IApiDataAbilityParams {
37
37
  */
38
38
  export interface IApiMDCtrlRemoveParams extends IApiDataAbilityParams {
39
39
  /**
40
- * @description 是否不需要刷新(默认为否,如果不需要刷新传true)
40
+ * @description 是否不需要刷新(默认为false,如果需要刷新不传即可,效果为删除后补全这一页缺少的数据)
41
41
  * @type {boolean}
42
42
  * @memberof IApiMDCtrlRemoveParams
43
43
  */
@@ -38,7 +38,7 @@ export interface IApiTreeController<T extends IDETree = IDETree, S extends IApiT
38
38
  */
39
39
  expandNodeByKey(expandedKeys: string[]): Promise<void>;
40
40
  /**
41
- * @description 切换折叠,其中tag表示操作指定树节点标识,若不传则操作当前树的第一层节点展开状态,expand表示是否展开,若不传则基于节点展开状态取反
41
+ * @description 切换折叠,tag=指定分组标识(不传则全部),expand=目标状态(不传则反转)
42
42
  * @param {{ tag?: string; expand?: boolean }} [params] 切换折叠参数
43
43
  * @memberof IApiTreeController
44
44
  */
@@ -62,7 +62,7 @@ export interface IApiViewController<T extends IAppView = IAppView, S extends IAp
62
62
  */
63
63
  parentData?: IApiData[];
64
64
  /**
65
- * @description 关闭视图
65
+ * @description 关闭视图,modalData为返回至外层的数据
66
66
  * @param {IApiModalData} [modalData] 返回数据
67
67
  * @returns {*} {Promise<void>}
68
68
  * @memberof IApiViewController
@@ -9,73 +9,73 @@ import { IApiOpenViewUtil } from './util/i-api-open-view-util';
9
9
  */
10
10
  export interface IApiRuntimeIbizsys {
11
11
  /**
12
- * @description 应用中心服务
12
+ * @description 应用中心服务,用于应用级资源调度、服务注册与统一访问入口
13
13
  * @type {IApiAppHubService}
14
14
  * @memberof IApiRuntimeIbizsys
15
15
  */
16
16
  hub: IApiAppHubService;
17
17
  /**
18
- * @description 全局配置
18
+ * @description 全局配置对象,用于获取系统级配置、运行环境参数及全局变量
19
19
  * @type {IApiGlobalConfig}
20
20
  * @memberof IApiRuntimeIbizsys
21
21
  */
22
22
  config: IApiGlobalConfig;
23
23
  /**
24
- * @description 消息提示服务
24
+ * @description 模态框工具服务,用于弹出对话框(如信息提示、表单弹窗等)
25
25
  * @type {IApiModalUtil}
26
26
  * @memberof IApiRuntimeIbizsys
27
27
  */
28
28
  modal: IApiModalUtil;
29
29
  /**
30
- * @description 确认消息服务
30
+ * @description 确认框服务,用于触发用户确认操作(如删除确认、操作二次确认等)
31
31
  * @type {IApiConfirmUtil}
32
32
  * @memberof IApiRuntimeIbizsys
33
33
  */
34
34
  confirm: IApiConfirmUtil;
35
35
  /**
36
- * @description 顶部居中显示反馈提示服务
36
+ * @description 消息提示服务,用于在页面顶部居中展示轻量级反馈信息(如成功、警告、错误提示)
37
37
  * @type {IApiMessageUtil}
38
38
  * @memberof IApiRuntimeIbizsys
39
39
  */
40
40
  message: IApiMessageUtil;
41
41
  /**
42
- * @description 全局通知服务
42
+ * @description 全局通知服务,用于展示系统级通知(支持持久化或可关闭通知)
43
43
  * @type {IApiNotificationUtil}
44
44
  * @memberof IApiRuntimeIbizsys
45
45
  */
46
46
  notification: IApiNotificationUtil;
47
47
  /**
48
- * @description 打开视图服务
48
+ * @description 视图打开服务,用于打开或跳转至指定视图(支持路由、模态、抽屉等多种方式)
49
49
  * @type {IApiOpenViewUtil}
50
50
  * @memberof IApiRuntimeIbizsys
51
51
  */
52
52
  openView: IApiOpenViewUtil;
53
53
  /**
54
- * @description 全局工具服务
54
+ * @description 全局工具服务,提供通用方法(如自定义主题、文本格式化等)
55
55
  * @type {IApiGlobalUtil}
56
56
  * @memberof IApiRuntimeIbizsys
57
57
  */
58
58
  util: IApiGlobalUtil;
59
59
  /**
60
- * @description 全屏工具服务
60
+ * @description 全屏工具服务,用于控制页面或指定元素进入/退出全屏模式
61
61
  * @type {IApiFullscreenUtil}
62
62
  * @memberof IApiRuntimeIbizsys
63
63
  */
64
64
  fullscreenUtil: IApiFullscreenUtil;
65
65
  /**
66
- * @description 二维码工具服务
66
+ * @description 二维码工具服务,用于生成或解析二维码内容
67
67
  * @type {IApiQrcodeUtil}
68
68
  * @memberof IApiRuntimeIbizsys
69
69
  */
70
70
  qrcodeUtil: IApiQrcodeUtil;
71
71
  /**
72
- * @description 应用级功能服务
72
+ * @description 应用级工具服务,提供调整整个应用状态的功能(如登录、登出、切换主题等)
73
73
  * @type {IApiAppUtil}
74
74
  * @memberof IApiRuntimeIbizsys
75
75
  */
76
76
  appUtil: IApiAppUtil;
77
77
  /**
78
- * @description 打印预览服务
78
+ * @description 打印预览服务,用于生成并展示打印预览内容,支持导出或打印操作
79
79
  */
80
80
  printPreview: IApiPrintPreviewUtil;
81
81
  }
@@ -15,7 +15,7 @@ export interface IApiCodeListService {
15
15
  */
16
16
  getCodeList(tag: string): IAppCodeList | undefined;
17
17
  /**
18
- * @description 获取指定代码表所有代码表项
18
+ * @description 获取指定代码表所有代码表项,返回树形结构数据格式
19
19
  * @param {string} tag 代码表标识
20
20
  * @param {IApiContext} context 应用上下文
21
21
  * @param {IApiParams} [params] 视图参数
@@ -21,7 +21,7 @@ export interface IApiDEServiceUtil {
21
21
  */
22
22
  reset(context: IApiContext): void;
23
23
  /**
24
- * @description 执行服务方法
24
+ * @description 执行服务方法(无需提前 getService,直传appDataEntityId一步到位;如已有服务实例则用IApiAppDEService.exec),appDataEntityId 通常是应用标识.实体标识,如:checkinweb.shift,methodName 即当前实体的行为标识,如:'create' / 'update' / 'remove' / 'get' / 'fetchDefault'
25
25
  * @param {string} appDataEntityId 实体标识,通常是应用标识.实体标识,如:checkinweb.shift
26
26
  * @param {string} methodName 方法名
27
27
  * @param {IApiContext} context 应用上下文
@@ -6,19 +6,19 @@ import { IApiContext, IApiData } from '@ibiz-template/core';
6
6
  */
7
7
  export interface IApiButtonContainerState {
8
8
  /**
9
- * @description 是否显示
9
+ * @description 是否显示,直接修改值界面即可生效
10
10
  * @type {boolean}
11
11
  * @memberof IApiButtonContainerState
12
12
  */
13
13
  visible: boolean;
14
14
  /**
15
- * @description 是否禁用
15
+ * @description 是否禁用,直接修改值界面即可生效
16
16
  * @type {boolean}
17
17
  * @memberof IApiButtonContainerState
18
18
  */
19
19
  disabled: boolean;
20
20
  /**
21
- * @description 设置当前执行的按钮
21
+ * @description 设置当前执行的按钮,name为按钮标识
22
22
  * @param {string} name
23
23
  * @memberof IApiButtonContainerState
24
24
  */