@ibiz-template/runtime 0.7.41-alpha.105 → 0.7.41-alpha.106

package/src/interface/api/controller/control/grid-column/i-api-grid-column.controller.ts

@@ -0,0 +1,89 @@
+import { IApiContext, IApiParams } from '@ibiz-template/core';
+import { IDEGridColumn, IDEGridDataItem } from '@ibiz/model-core';
+import { IApiGridRowState } from '../../../state';
+import { IApiGridController } from '../i-api-grid.controller';
+
+/**
+ * @description 表格列控制器
+ * @export
+ * @interface IApiGridColumnController
+ */
+export interface IApiGridColumnController {
+  /**
+   * @description 表格列模型
+   * @type {IDEGridColumn}
+   * @memberof IApiGridColumnController
+   */
+  readonly model: IDEGridColumn;
+
+  /**
+   * @description 所属表格控制器（反向引用）
+   * @type {IApiGridController}
+   * @memberof IApiGridColumnController
+   */
+  readonly grid: IApiGridController;
+
+  /**
+   * @description 是否是自适应列
+   * @type {boolean}
+   * @memberof IApiGridColumnController
+   */
+  isAdaptiveColumn: boolean;
+
+  /**
+   * @description 是否是脚本代码列
+   * @type {boolean}
+   * @memberof IApiGridColumnController
+   */
+  isCustomCode: boolean;
+
+  /**
+   * @description 上下文
+   * @type {IApiContext}
+   * @memberof IApiGridColumnController
+   */
+  readonly context: IApiContext;
+
+  /**
+   * @description 视图参数
+   * @type {IApiParams}
+   * @memberof IApiGridColumnController
+   */
+  readonly params: IApiParams;
+
+  /**
+   * @description 该列是否启用行编辑
+   * @type {boolean}
+   * @memberof IApiGridColumnController
+   */
+  readonly enableRowEdit: boolean;
+
+  /**
+   * @description 该列对应数据项
+   * @returns {*}  {(IDEGridDataItem | undefined)}
+   * @memberof IApiGridColumnController
+   */
+  readonly deGridDataItem: IDEGridDataItem | undefined;
+
+  /**
+   * @description 值格式化
+   * @type {(string | undefined)}
+   * @memberof IApiGridColumnController
+   */
+  readonly valueFormat: string | undefined;
+
+  /**
+   * @description 数据类型（数值）
+   * @type {(number | undefined)}
+   * @memberof IApiGridColumnController
+   */
+  readonly dataType: number | undefined;
+
+  /**
+   * @description 解析获取脚本代码html
+   * @param {IApiGridRowState} row 行数据状态
+   * @returns {*}  {(Promise<string | undefined>)}
+   * @memberof IApiGridColumnController
+   */
+  getCustomHtml(row: IApiGridRowState): Promise<string | undefined>;
+}

package/src/interface/api/controller/control/grid-column/i-api-grid-field-column.controller.ts

@@ -0,0 +1,79 @@
+import { IUIActionGroupDetail } from '@ibiz/model-core';
+import { IApiGridRowState } from '../../../state';
+import { IApiGridColumnController } from './i-api-grid-column.controller';
+/**
+ * @description 表格属性列控制器
+ * @export
+ * @interface IApiGridFieldColumnController
+ * @extends {IApiGridColumnController}
+ */
+export interface IApiGridFieldColumnController
+  extends IApiGridColumnController {
+  /**
+   * @description 是否是链接列
+   * @type {boolean}
+   * @memberof IApiGridFieldColumnController
+   */
+  readonly isLinkColumn: boolean;
+
+  /**
+   * @description 是否可触发界面行为
+   * @type {boolean}
+   * @memberof IApiGridFieldColumnController
+   */
+  readonly hasAction: boolean;
+
+  /**
+   * @description 属性列对应值在数据里的属性字段名称
+   * @type {string}
+   * @memberof IApiGridFieldColumnController
+   */
+  readonly fieldName: string;
+
+  /**
+   * @description 单位
+   * @type {(string | undefined)}
+   * @memberof IApiGridFieldColumnController
+   */
+  readonly unitName: string | undefined;
+
+  /**
+   * @description 格式化值
+   * @param {unknown} value 属性值
+   * @returns {*}  {string}
+   * @memberof IApiGridFieldColumnController
+   */
+  formatValue(value: unknown): string;
+
+  /**
+   * @description 打开链接视图
+   * @param {IApiGridRowState} row 行数据状态
+   * @param {MouseEvent} event 鼠标事件
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiGridFieldColumnController
+   */
+  openLinkView(row: IApiGridRowState, event: MouseEvent): Promise<void>;
+
+  /**
+   * @description 触发表格列附加界面行为
+   * @param {IApiGridRowState} row 行数据状态
+   * @param {MouseEvent} event 鼠标事件
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiGridFieldColumnController
+   */
+  triggerAction(row: IApiGridRowState, event: MouseEvent): Promise<void>;
+
+  /**
+   * @description 触发界面行为组点击事件
+   * @param {IUIActionGroupDetail} detail 界面行为组成员模型
+   * @param {IApiGridRowState} row 行数据状态
+   * @param {MouseEvent} event 鼠标事件
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiGridFieldColumnController
+   */
+  onActionClick(
+    detail: IUIActionGroupDetail,
+    row: IApiGridRowState,
+    event: MouseEvent,
+  ): Promise<void>;
+}

package/src/interface/api/controller/control/grid-column/i-api-grid-field-edit-column.controller.ts

@@ -0,0 +1,58 @@
+import { IDEGridEditItem } from '@ibiz/model-core';
+import { IApiData } from '@ibiz-template/core';
+import { IApiGridFieldColumnController } from './i-api-grid-field-column.controller';
+import { IApiGridRowState } from '../../../state';
+
+/**
+ * @description 表格编辑列控制器
+ * @export
+ * @interface IApiGridFieldEditColumnController
+ * @extends {IApiGridFieldColumnController}
+ */
+export interface IApiGridFieldEditColumnController
+  extends IApiGridFieldColumnController {
+  /**
+   * @description 表格编辑项模型
+   * @type {IDEGridEditItem}
+   * @memberof IApiGridFieldEditColumnController
+   */
+  editItem: IDEGridEditItem;
+
+  /**
+   * @description 值规则
+   * @type {IApiData[]}
+   * @memberof IApiGridFieldEditColumnController
+   */
+  rules: IApiData[];
+
+  /**
+   * @description 值项
+   * @type {(string | undefined)}
+   * @memberof IApiGridFieldEditColumnController
+   */
+  readonly valueItemName: string | undefined;
+
+  /**
+   * @description 设置行属性的值
+   * @param {IApiGridRowState} row 行数据状态
+   * @param {unknown} value 要设置的值
+   * @param {string} [name] 要设置的行数据的属性名称
+   * @param {boolean} [ignore] 忽略脏值检查，默认值为false
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiGridFieldEditColumnController
+   */
+  setRowValue(
+    row: IApiGridRowState,
+    value: unknown,
+    name?: string,
+    ignore?: boolean,
+  ): Promise<void>;
+
+  /**
+   * @description 表格编辑项值规则校验（如果表格编辑项不显示则不校验直接返回true）
+   * @param {IApiGridRowState} row 行数据状态
+   * @returns {*}  {Promise<boolean>}
+   * @memberof IApiGridFieldEditColumnController
+   */
+  validate(row: IApiGridRowState): Promise<boolean>;
+}

package/src/interface/api/controller/control/grid-column/i-api-grid-group-column.controller.ts

@@ -0,0 +1,10 @@
+import { IApiGridColumnController } from './i-api-grid-column.controller';
+
+/**
+ * @description 表格分组列控制器
+ * @export
+ * @interface IApiGridGroupColumnController
+ * @extends {IApiGridColumnController}
+ */
+export interface IApiGridGroupColumnController
+  extends IApiGridColumnController {}

package/src/interface/api/controller/control/grid-column/i-api-grid-ua-column.controller.ts

@@ -0,0 +1,24 @@
+import { IUIActionGroupDetail } from '@ibiz/model-core';
+import { IApiGridColumnController } from './i-api-grid-column.controller';
+import { IApiGridRowState } from '../../../state';
+/**
+ * @description 表格操作列控制器
+ * @export
+ * @interface IApiGridUAColumnController
+ * @extends {IApiGridColumnController}
+ */
+export interface IApiGridUAColumnController extends IApiGridColumnController {
+  /**
+   * @description 触发界面行为
+   * @param {IUIActionGroupDetail} detail 界面行为组成员模型
+   * @param {IApiGridRowState} row 行数据状态
+   * @param {MouseEvent} event 鼠标事件
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiGridUAColumnController
+   */
+  onActionClick(
+    detail: IUIActionGroupDetail,
+    row: IApiGridRowState,
+    event: MouseEvent,
+  ): Promise<void>;
+}

package/src/interface/api/controller/control/grid-column/index.ts

@@ -0,0 +1,5 @@
+export type { IApiGridColumnController } from './i-api-grid-column.controller';
+export type { IApiGridFieldColumnController } from './i-api-grid-field-column.controller';
+export type { IApiGridFieldEditColumnController } from './i-api-grid-field-edit-column.controller';
+export type { IApiGridGroupColumnController } from './i-api-grid-group-column.controller';
+export type { IApiGridUAColumnController } from './i-api-grid-ua-column.controller';

package/src/interface/api/controller/control/i-api-app-menu.controller.ts

@@ -0,0 +1,41 @@
+import { IAppMenu, IAppMenuItem } from '@ibiz/model-core';
+import { IApiControlController } from './i-api-control.controller';
+import { IApiAppMenuState } from '../../state';
+
+/**
+ * 应用菜单
+ * @description 菜单是网站导航的核心组件，用于组织并展示站点层级结构，提供快速访问路径。其中PC端菜单通常包含水平/垂直布局、多级下拉、高亮交互等功能，移动端菜单则是在页面底部进行平铺展示，支持高亮交互，折叠收缩多余菜单项等功能。
+ * @ctrlparams {"name":"columnnum","title":"移动端图标菜单显示列数","defaultvalue":"4","parameterType":"number","description":"控制移动端每行显示的菜单项个数，当前菜单为图标菜单时生效","effectPlatform":"mob"}
+ * @ctrlparams {"name":"customizedalign","title":"移动端定制按钮对齐位置","defaultvalue":"'RIGHTEND'","parameterType":"'LEFTSTART' | 'LEFT' | 'LEFTEND' | 'RIGHT' | 'RIGHTSTART' | 'RIGHTEND'","description":"该参数可将定制按钮固定在屏幕左侧或右侧的顶部、中部、底部位置，可选值包含左上（LEFTSTART）、左侧居中（LEFT）、左下（LEFTEND）、右上（RIGHTSTART）、右侧居中（RIGHT）、右下（RIGHTEND）。当前菜单为图标菜单、列表菜单时生效","effectPlatform":"mob"}
+ * @primary
+ * @export
+ * @interface IApiMenuController
+ * @extends {IApiControlController<T, S>}
+ * @template T
+ * @template S
+ */
+export interface IApiMenuController<
+  T extends IAppMenu = IAppMenu,
+  S extends IApiAppMenuState = IApiAppMenuState,
+> extends IApiControlController<T, S> {
+  /**
+   * @description 所有菜单项(平铺数据)
+   * @returns {*}  {IAppMenuItem[]}
+   * @memberof IApiMenuController
+   */
+  getAllItems(): IAppMenuItem[];
+
+  /**
+   * @description 获取默认打开菜单项
+   * @returns {*}  {(IAppMenuItem | undefined)}
+   * @memberof IApiMenuController
+   */
+  getDefaultOpenMenuItem(): IAppMenuItem | undefined;
+
+  /**
+   * @description 获取菜单默认打开视图标识
+   * @returns {*}  {(string | undefined)}
+   * @memberof IApiMenuController
+   */
+  getDefaultOpenView(): string | undefined;
+}

package/src/interface/api/controller/control/i-api-calendar-exp-bar.controller.ts

@@ -0,0 +1,20 @@
+import { ICalendarExpBar } from '@ibiz/model-core';
+import { IApiExpBarControlController } from './i-api-exp-bar-control.controller';
+import { IApiCalendarExpBarState } from '../../state';
+
+/**
+ * 日历导航栏
+ * @description 允许用户通过直观的日历控件选择日期或时间段，实现快速视图切换。其核心功能包括日程可视化展示、动态高亮标记、响应式点击事件及与数据层的联动，支持跨月/年浏览，并可通过自定义样式适配不同业务场景，提升用户的时间导航效率。
+ * @primary
+ * @export
+ * @interface IApiCalendarExpBarController
+ * @extends {IApiExpBarControlController<T, S>}
+ * @ctrlparams {"name":"expcache","title":"是否启用缓存","defaultvalue":"'DEFAULT'","parameterType":"'DEFAULT' | 'CACHE' | 'NO_CACHE'","description":"用于判断导航区占位中显示的导航视图是否缓存。有三种情况，'CACHE' 为缓存；'NO_CACHE' 为不缓存；'DEFAULT' 时匹配当前部件类型是否存在于全局配置参数`expCacheMode`中，存在则缓存，否则不缓存"}
+ * @ctrlparams {name:searchphseparator,title:快速搜索提示分隔符,parameterType:string,defaultvalue:'、',description:搜索栏输入框根据该值将所有输入项提示文本进行拼接展示}
+ * @template T
+ * @template S
+ */
+export interface IApiCalendarExpBarController<
+  T extends ICalendarExpBar = ICalendarExpBar,
+  S extends IApiCalendarExpBarState = IApiCalendarExpBarState,
+> extends IApiExpBarControlController<T, S> {}

package/src/interface/api/controller/control/i-api-calendar.controller.ts

@@ -0,0 +1,40 @@
+import { IDECalendar } from '@ibiz/model-core';
+import { IApiCalendarState } from '../../state';
+import { IApiMDControlController } from './i-api-md-control.controller';
+
+/**
+ * 日历
+ * @description 用于显示和选择日期。其主要功能包括：展示时间轴，月/周/日视图， 支持日程查看，高亮当前日期，标记特殊事件，是日程管理类应用的核心组件。
+ *  - 在配置日历部件样式为【时间轴】时，会按照时间的顺序依次展示事件数据；
+ *  - 在配置日历部件样式为【月】时，可一次性显示一个月的时间以及该时间段内的事件数据，同时该模式下部件参数`showmode`可额外配置值为'daterange'和'expand'（详情见控件动态参数）；
+ *  - 在配置日历部件样式为【周】时，可一次性显示一周的时间以及每天的事件数据；
+ *  - 在配置日历部件样式为【天】时，可一次性显示一天24小时的时间以及各时间段内的事件数据；
+ *  - 当在配置日历部件样式为【用户自定义1】时，该模式是以只读模式的周视图进行展示；
+ *  - 当在配置日历部件样式为【用户自定义2】时，该模式是以只读模式的平铺月视图进行展示；
+ * @primary
+ * @export
+ * @interface ICalendarController
+ * @ctrlparams {"name":"showmode","title":"显示模式","defaultvalue":"'DEFAULT'","parameterType":"'DEFAULT' | 'ONLYDATA' | 'MIXIN' | 'daterange' | 'expand'","description":"该值为 'DEFAULT' 时正常显示无数据提示图片，该值为 'ONLYDATA' 和 'MIXIN' 时，不显示无数据提示图片；当日历部件样式为`月`时，默认情况下，时间单元格内仅显示首个事件数据，剩余事件数据隐藏，点击 `更多` 按钮后，剩余事件数据会以气泡形式展示。当该值为 'daterange' 时，会依据事件数据中的时间范围，在对应时间单元格内以连续的色块覆盖形式展示日历项范围。当该值为 'expand' 时，时间单元格内的事件数据会从上至下平铺展示","effectPlatform":"web"}
+ * @ctrlparams {name:showdetail,title:显示详情,defaultvalue:false,parameterType:boolean,description:当日历部件样式为`周` 、`天`时生效，鼠标悬浮到显示日历事件项之上时是否弹出气泡框显示事件项详情,effectPlatform:web}
+ * @ctrlparams {name:defaultdatetime,title:默认时间,defaultvalue:'',parameterType:string,description:当日历部件样式为`周` 、`天`、`月`、`用户自定义`时生效，用于设置日历初始化的时间，值格式化为YYYY-MM-DD,effectPlatform:web}
+ * @ctrlparams {"name":"mdctrlrefreshmode","title":"刷新模式","defaultvalue":"'cache'","parameterType":"'nocache' | 'cache'","description":"多数据部件刷新模式，当值为 'cache'，部件刷新时保留选中数据；当值为 'nocache'，部件刷新时清空选中数据","effectPlatform":"web"}
+ * @ctrlparams {"name":"timelinecaptionformat","title":"时光轴标题格式","defaultvalue":"'YYYY-MM-DD'","parameterType":"string","description":"时光轴标题格式，默认为 'YYYY-MM-DD'"}
+ * @ctrlparams {"name":"grouptimefield","title":"分组时间属性","defaultvalue":"'beginTime'","parameterType":"'beginTime' | 'endTime'","description":"指定时间轴样式日历的分组字段，只能为开始时间或结束时间，并以该字段倒序查询数据，默认为 'beginTime'"}
+ * @ctrlparams {"name":"timerangemode","title":"时间范围模式","defaultvalue":"'year'","parameterType":"'custom' | 'quarter' | 'year' | 'halfYear'","description":"日历【用户自定义2】的平铺月视图的时间范围，分别表示：自定义，当前时间季度，当前时间年度，当前时间半年，当值为自定义时，必须配置begintime和endtime动态控件参数"}
+ * @ctrlparams {"name":"begintime","title":"起始时间","defaultvalue":"-","parameterType":"string","description":"日历【用户自定义2】为自定义模式时必须配置该参数，这个参数的值可以是动态值，使用%xxxx%的格式"}
+ * @ctrlparams {"name":"endtime","title":"结束时间","defaultvalue":"-","parameterType":"string","description":"日历【用户自定义2】为自定义模式时必须配置该参数，这个参数的值可以是动态值，使用%xxxx%的格式"}
+ * @extends {IApiMDControlController<T, S>}
+ * @template T
+ * @template S
+ */
+export interface IApiCalendarController<
+  T extends IDECalendar = IDECalendar,
+  S extends IApiCalendarState = IApiCalendarState,
+> extends IApiMDControlController<T, S> {
+  /**
+   * @description  设置选中日期
+   * @param {Date} date 日期
+   * @memberof IApiCalendarController
+   */
+  setSelectDate(date: Date): void;
+}

package/src/interface/api/controller/control/i-api-caption-bar.controller.ts

@@ -0,0 +1,24 @@
+import { ICaptionBar } from '@ibiz/model-core';
+import { IApiCaptionBarState } from '../../state';
+import { IApiControlController } from './i-api-control.controller';
+
+/**
+ * 标题栏
+ * @description 在 PC 端场景下，页面标题通常清晰显示于页面顶部的左侧区域；而在移动端场景下，页面标题则一般位于页面顶部的中间区域。
+ * @primary
+ * @export
+ * @interface IApiCaptionBarController
+ * @extends {IApiControlController<T, S>}
+ * @template T
+ * @template S
+ */
+export interface IApiCaptionBarController<
+  T extends ICaptionBar = ICaptionBar,
+  S extends IApiCaptionBarState = IApiCaptionBarState,
+> extends IApiControlController<T, S> {
+  /**
+   * @description 设置浏览器标签页标题
+   * @memberof IApiCaptionBarController
+   */
+  setBrowserTabTitle(): void;
+}

package/src/interface/api/controller/control/i-api-chart-exp-bar.controller.ts

@@ -0,0 +1,20 @@
+import { IChartExpBar } from '@ibiz/model-core';
+import { IApiChartExpBarState } from '../../state';
+import { IApiExpBarControlController } from './i-api-exp-bar-control.controller';
+
+/**
+ * 图表导航栏
+ * @description 通过点击图表内的数据节点，实现视图的快速切换，方便用户快速查看业务形态。
+ * @primary
+ * @export
+ * @interface IApiChartExpBarController
+ * @extends {IApiExpBarControlController<T, S>}
+ * @ctrlparams {"name":"expcache","title":"是否启用缓存","defaultvalue":"'DEFAULT'","parameterType":"'DEFAULT' | 'CACHE' | 'NO_CACHE'","description":"用于判断导航区占位中显示的导航视图是否缓存。有三种情况，'CACHE' 为缓存；'NO_CACHE' 为不缓存；'DEFAULT' 时匹配当前部件类型是否存在于全局配置参数`expCacheMode`中，存在则缓存，否则不缓存"}
+ * @ctrlparams {name:searchphseparator,title:快速搜索提示分隔符,parameterType:string,defaultvalue:'、',description:搜索栏输入框根据该值将所有输入项提示文本进行拼接展示}
+ * @template T
+ * @template S
+ */
+export interface IApiChartExpBarController<
+  T extends IChartExpBar = IChartExpBar,
+  S extends IApiChartExpBarState = IApiChartExpBarState,
+> extends IApiExpBarControlController<T, S> {}

package/src/interface/api/controller/control/i-api-chart.controller.ts

@@ -0,0 +1,51 @@
+import { IDEChart } from '@ibiz/model-core';
+import { IApiData } from '@ibiz-template/core';
+import { IApiChartState } from '../../state';
+import { IApiMDControlController } from './i-api-md-control.controller';
+
+/**
+ * 图表
+ * @description 以数据可视化形式呈现网站页面数据的工具，通过图形（如折线图、柱状图、饼图等）直观展示业务关键指标。
+ * @primary
+ * @export
+ * @interface IApiChartController
+ * @extends {IApiMDControlController<T, S>}
+ * @ctrlparams {name:chartid,title:图表标识,parameterType:string,description:此部件参数仅应用于bi报表，用于指定图表标识,effectPlatform:web}
+ * @ctrlparams {name:enabledrilldetail,title:是否开启数据反查,defaultvalue:[],parameterType:IApiData[],description:此部件参数仅应用于bi报表。主要用于判断当前点击序列是否开启数据反查，如果当前序列有反查视图模型，则左键单击时弹出检查明细按钮,effectPlatform:web}
+ * @ctrlparams {"name":"mdctrlrefreshmode","title":"刷新模式","defaultvalue":"'cache'","parameterType":"'nocache' | 'cache'","description":"多数据部件刷新模式，当值为 'cache'，部件刷新时保留选中数据；当值为 'nocache'，部件刷新时清空选中数据","effectPlatform":"web"}
+ * @ctrlparams {"name":"mode","title":"柱状图图表绘制模式","defaultvalue":"'DEFAULT'","parameterType":"'DEFAULT' | 'ROW'","description":"控制柱状图绘制方向，默认垂直绘制，为ROW时水平绘制"}
+ * @ctrlparams {"name":"completiondate","title":"是否填充日期","parameterType":"boolean","description":"该参数为序列自定义参数，用于控制时间分组模式下是否补全时间数据（无横轴序列默认不补全（饼图，仪表盘，雷达图，漏斗图），有横轴序列默认补全）"}
+ * @template T
+ * @template S
+ */
+export interface IApiChartController<
+  T extends IDEChart = IDEChart,
+  S extends IApiChartState = IApiChartState,
+> extends IApiMDControlController<T, S> {
+  /**
+   * @description echarts 实例，使用前需判断是否存在（图表未初始化时为 undefined）
+   * @type {IApiData | undefined}
+   * @memberof IApiChartController
+   */
+  chart: IApiData | undefined;
+
+  /**
+   * @description 图表配置对象，使用前需判断是否存在
+   * @type {IApiData | undefined}
+   * @memberof IApiChartController
+   */
+  options: IApiData | undefined;
+
+  /**
+   * @description 重新计算图表尺寸（容器大小变化后调用，如：面板展开/收起后）
+   * @memberof IApiChartController
+   */
+  resizeChart(): void;
+
+  /**
+   * @description 修改 tooltip 显示状态，true=显示（默认），false=隐藏
+   * @param {boolean} state 显示状态
+   * @memberof IApiChartController
+   */
+  changeTooltipState(state?: boolean): void;
+}

package/src/interface/api/controller/control/i-api-context-menu.controller.ts

@@ -0,0 +1,18 @@
+import { IDEContextMenu } from '@ibiz/model-core';
+import { IApiToolbarController } from './i-api-toolbar.controller';
+import { IApiContextMenuState } from '../../state';
+
+/**
+ * 上下文菜单
+ * @description 用于提供与当前操作场景相关的快捷命令集合，常用于树节点操作。
+ * @primary
+ * @export
+ * @interface IContextMenuController
+ * @extends {IApiToolbarController<T, S>}
+ * @template T
+ * @template S
+ */
+export interface IApiContextMenuController<
+  T extends IDEContextMenu = IDEContextMenu,
+  S extends IApiContextMenuState = IApiContextMenuState,
+> extends IApiToolbarController<T, S> {}

package/src/interface/api/controller/control/i-api-control.controller.ts

@@ -0,0 +1,106 @@
+import { IControl } from '@ibiz/model-core';
+import { IApiData, IApiParams } from '@ibiz-template/core';
+import { IApiControlState } from '../../state';
+import { IApiViewController } from '../view';
+import { IApiViewLayoutPanelController } from './i-api-view-layout-panel.controller';
+import { IApiController } from '../common/i-api.controller';
+import { IApiMaskOption } from '../common';
+
+/**
+ * @primary
+ * @description 部件控制器基类
+ * @export
+ * @interface IApiControlController
+ * @extends {IApiController<T, S>}
+ * @ctrlparams {"name":"ignoremcmsg","title":"是否忽略通知消息","parameterType":"boolean","defaultvalue":"undefined","description":"设置为true时，当前部件接受到数据变更通知消息时则不做处理，如：表单数据变更保存后，表格不会刷新当前数据"}
+ * @template T
+ * @template S
+ */
+export interface IApiControlController<
+  T extends IControl = IControl,
+  S extends IApiControlState = IApiControlState,
+> extends IApiController<T, S> {
+  /**
+   * @description 当前视图控制器
+   * @type {(IApiViewController & IApiData)}
+   * @memberof IApiControlController
+   */
+  view: IApiViewController & IApiData;
+
+  /**
+   * @description 部件标识
+   * @type {string}
+   * @memberof IApiControlController
+   */
+  ctrlId: string;
+
+  /**
+   * @description 部件参数
+   * @type {IApiParams}
+   * @memberof IApiControlController
+   */
+  controlParams: IApiParams;
+
+  /**
+   * @description 部件布局面板控制器
+   * @type {(IApiViewLayoutPanelController & IApiData)}
+   * @memberof IApiControlController
+   */
+  layoutPanel?: IApiViewLayoutPanelController & IApiData;
+
+  /**
+   * @description 运行模式（DESIGN：设计模式，RUNTIME：运行时）
+   * @type {('DESIGN' | 'RUNTIME')}
+   * @memberof IApiControlController
+   */
+  runMode: 'DESIGN' | 'RUNTIME';
+
+  /**
+   * @description 开始加载（不传时默认不显示加载文字）
+   * @param {string | undefined} loadingText 加载提示文本
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiControlController
+   */
+  startLoading(loadingText?: string): Promise<void>;
+
+  /**
+   * @description 加载完毕
+   * @returns {*}  {Promise<void>}
+   * @memberof IApiControlController
+   */
+  endLoading(): Promise<void>;
+
+  /**
+   * @description 获取部件类型
+   * @returns {*}  {string}
+   * @memberof IApiControlController
+   */
+  getControlType(): string;
+
+  /**
+   * @description 取消部件禁用
+   * @memberof IApiControlController
+   */
+  enable(): void;
+
+  /**
+   * @description 设置部件禁用
+   * @param {IApiMaskOption} [options] 部件禁用参数，主要包含遮罩层相关参数
+   * @memberof IApiControlController
+   */
+  disabled(options?: IApiMaskOption): void;
+
+  /**
+   * @description 禁用部件计数器
+   * @memberof IApiControlController
+   */
+  disableCounter(): void;
+
+  /**
+   * @description 触发实体数据变更的通知
+   * @param {('create' | 'update' | 'remove')} type 数据变更类型
+   * @param {IApiData} data 变更数据
+   * @memberof IApiControlController
+   */
+  emitDEDataChange(type: 'create' | 'update' | 'remove', data: IApiData): void;
+}