@byteluck-fe/model-driven-controls 7.0.0-beta.5 → 7.0.0-beta.8

package/dist/types/baseControls/Link/property.d.ts

@@ -42,11 +42,41 @@ interface LinkPropertyInterface extends PropertyInterface {
     icon: string;
 }
 declare class LinkProperty extends Property implements LinkPropertyInterface {
+    /**
+     * 内容
+     * @defaultValue '我是一个链接'
+     * @public
+     */
     content: string;
+    /**
+     * 链接地址
+     * @defaultValue ''
+     * @public
+     */
     url: string;
+    /**
+     * 位置；取值：left：左侧；center：居中；right：右侧；
+     * @defaultValue 'left'
+     * @public
+     */
     position: 'left' | 'center' | 'right';
+    /**
+     * 颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'primary'
+     * @public
+     */
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
+    /**
+     * 打开方式；取值：new：新页面；current：当前；
+     * @defaultValue 'new'
+     * @public
+     */
     openMode: 'new' | 'current';
+    /**
+     * 图标
+     * @defaultValue ''
+     * @public
+     */
     icon: string;
     constructor(props?: Partial<LinkProperty>);
 }

package/dist/types/baseControls/ListSelectButton/property.d.ts

@@ -61,12 +61,47 @@ interface ListSelectButtonPropertyInterface extends ButtonPropertyInterface {
  */
 declare class ListSelectButtonProperty extends ButtonProperty implements ListSelectButtonPropertyInterface {
     static readonly Rules: typeof ListSelectButtonPropertyRules;
+    /**
+     * 数据过滤
+     * @defaultValue new FillPayloadBind()
+     * @public
+     */
     fillPayload: FillPayloadBind;
+    /**
+     * 绑定列表页
+     * @defaultValue new ListBind()
+     * @public
+     */
     listPageBind: ListBind;
+    /**
+     * 禁用填充
+     * @defaultValue true
+     * @public
+     */
     disableFilling: boolean;
+    /**
+     * 回填配置
+     * @defaultValue new FillBackBind()
+     * @public
+     */
     fillBack: FillBackBind;
+    /**
+     * 展示已选明细
+     * @defaultValue false
+     * @public
+     */
     showSelectedDetail: boolean;
+    /**
+     * 是否使用选中行填充
+     * @defaultValue false
+     * @public
+     */
     isSelectedRowFill: boolean;
+    /**
+     * 展示已选内容配置字段
+     * @defaultValue new SelectedContentConfig()
+     * @public
+     */
     selectedContentConfig: SelectedContentConfig;
     constructor(props?: Partial<ListSelectButtonProperty>);
 }

package/dist/types/baseControls/ListViewSelect/property.d.ts

@@ -25,7 +25,17 @@ interface ListViewSelectPropertyInterface extends PropertyInterface {
 }
 declare class ListViewSelectProperty extends Property implements ListViewSelectPropertyInterface {
     static readonly Rules: typeof ListViewSelectPropertyRules;
+    /**
+     * 展示类型；取值：select：下拉选择；tabs：页签切换；
+     * @defaultValue 'select'
+     * @public
+     */
     showType: 'select' | 'tabs';
+    /**
+     * 查看操作列表
+     * @defaultValue []
+     * @public
+     */
     viewList: ViewOperationItem[];
     constructor(props?: Partial<ListViewSelectProperty>);
 }

package/dist/types/baseControls/OperationButton/property.d.ts

@@ -100,19 +100,89 @@ interface OperationButtonPropertyInterface extends PropertyInterface {
 }
 declare class OperationButtonProperty extends Property implements OperationButtonPropertyInterface {
     static readonly Rules: typeof OperationButtonPropertyRules;
+    /**
+     * 按钮内容
+     * @defaultValue '按钮'
+     * @public
+     */
     content: string;
+    /**
+     * 按钮代码
+     * @defaultValue undefined
+     * @public
+     */
     code?: string;
+    /**
+     * 操作类型；取值：edit：编辑；view：查看；delete：删除；custom：自定义；
+     * @defaultValue 'custom'
+     * @public
+     */
     command: 'edit' | 'view' | 'delete' | 'custom';
+    /**
+     * 按钮颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'primary'
+     * @public
+     */
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
+    /**
+     * 按钮图标
+     * @defaultValue undefined
+     * @public
+     */
     icon?: string;
+    /**
+     * 绑定表单
+     * @defaultValue undefined
+     * @public
+     */
     formKey?: string;
+    /**
+     * 打开方式；取值：modal：弹窗；window：新窗口；dialog：对话框；tab：页签；
+     * @defaultValue undefined
+     * @public
+     */
     openType?: 'modal' | 'window' | 'dialog' | 'tab';
+    /**
+     * 是否需要确认
+     * @defaultValue undefined
+     * @public
+     */
     needConfirm?: boolean;
+    /**
+     * 确认消息
+     * @defaultValue undefined
+     * @public
+     */
     confirmMessage?: string;
+    /**
+     * 自定义参数
+     * @defaultValue undefined
+     * @public
+     */
     options?: object;
+    /**
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
+     * @public
+     */
     defaultState: 'default' | 'readonly';
+    /**
+     * 优先访问流程列表
+     * @defaultValue undefined
+     * @public
+     */
     priorityProcess?: boolean;
+    /**
+     * 是否加载中
+     * @defaultValue false
+     * @public
+     */
     isLoading: boolean;
+    /**
+     * 是否同步删除流程数据
+     * @defaultValue false
+     * @public
+     */
     isSyncDelete: boolean;
     constructor(props?: Partial<OperationButtonProperty>);
 }

package/dist/types/baseControls/PieChart/property.d.ts

@@ -127,24 +127,119 @@ interface PieChartPropertyInterface extends PropertyInterface {
 }
 declare class PieChartProperty extends Property implements PieChartPropertyInterface {
     static readonly Rules: typeof PieChartPropertyRules;
+    /**
+     * 标题
+     * @defaultValue '饼图'
+     * @public
+     */
     caption: string;
+    /**
+     * 是否隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
+    /**
+     * 是否显示气泡提示
+     * @defaultValue false
+     * @public
+     */
     isShowCaptionTip: boolean;
+    /**
+     * 标题布局；取值：top：上方；left：左侧；
+     * @defaultValue 'top'
+     * @public
+     */
     labelPosition: 'top' | 'left';
+    /**
+     * 气泡提示语
+     * @defaultValue ''
+     * @public
+     */
     captionTip: string;
+    /**
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
     captionSize: string;
+    /**
+     * 标题颜色
+     * @defaultValue ''
+     * @public
+     */
     captionColor: string;
+    /**
+     * 标题斜体
+     * @defaultValue false
+     * @public
+     */
     isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
     captionFontWeight: FONT_WEIGHT;
+    /**
+     * 是否隐藏组件
+     * @defaultValue false
+     * @public
+     */
     isHide: boolean;
+    /**
+     * 图表模板
+     * @defaultValue 'pie-rounded-ring'
+     * @public
+     */
     template: string;
+    /**
+     * 图表 option JSON
+     * @defaultValue '{}'
+     * @public
+     */
     optionJson: string;
+    /**
+     * 选项配置方式；取值：datasource：数据源；
+     * @defaultValue 'datasource'
+     * @public
+     */
     optionConfig: 'datasource';
+    /**
+     * 数据源绑定
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 筛选项数据源绑定
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     filterItemDatasourceBind: DataSourceBind;
+    /**
+     * 多级填充
+     * @defaultValue []
+     * @public
+     */
     multistageFilling: MultistageFillingItem[];
+    /**
+     * 默认值
+     * @defaultValue []
+     * @public
+     */
     defaultValue: string[];
+    /**
+     * 是否开启填充
+     * @defaultValue false
+     * @public
+     */
     openMultistageFilling: boolean;
+    /**
+     * 饼图系列数据映射
+     * @defaultValue []
+     * @public
+     */
     seriesConfig: PieSeriesDataConfig[];
     constructor(props?: Partial<PieChartProperty>);
 }

package/dist/types/baseControls/ReferenceList/property.d.ts

@@ -47,10 +47,35 @@ interface ReferenceListPropertyInterface extends PropertyInterface {
  */
 declare class ReferenceListProperty extends Property implements ReferenceListPropertyInterface {
     static readonly Rules: typeof ReferenceListPropertyRules;
+    /**
+     * 是否显示查询栏
+     * @defaultValue true
+     * @public
+     */
     isShowSimpleSearch: boolean;
+    /**
+     * 是否显示工具栏
+     * @defaultValue true
+     * @public
+     */
     isShowToolbar: boolean;
+    /**
+     * 动作设置
+     * @defaultValue new ActionSetting()
+     * @public
+     */
     actionSetting: ActionSetting;
+    /**
+     * 列表高度配置
+     * @defaultValue new ListHeightSetting()
+     * @public
+     */
     listHeightSetting: ListHeightSetting;
+    /**
+     * 列表高度配置
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
     constructor(props?: Partial<ReferenceListProperty>);
 }

package/dist/types/baseControls/Text/property.d.ts

@@ -85,17 +85,77 @@ interface TextPropertyInterface extends PropertyInterface {
     background: BackgroundProperty;
 }
 declare class TextProperty extends Property implements TextPropertyInterface {
+    /**
+     * 内容
+     * @defaultValue '说明文字'
+     * @public
+     */
     content: string;
+    /**
+     * 图标
+     * @defaultValue 'page-hint'
+     * @public
+     */
     icon: string;
+    /**
+     * 位置对齐
+     * @defaultValue ''
+     * @public
+     */
     align: string;
+    /**
+     * 显示状态；取值：text：纯文本；imageText：图文；image：纯图片；
+     * @defaultValue 'text'
+     * @public
+     */
     showState: 'text' | 'imageText' | 'image';
+    /**
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
     captionSize: string;
+    /**
+     * 标题颜色
+     * @defaultValue ''
+     * @public
+     */
     captionColor: string;
+    /**
+     * 标题斜体
+     * @defaultValue false
+     * @public
+     */
     isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
     captionFontWeight: FONT_WEIGHT;
+    /**
+     * 是否开启 AI 内容搜索
+     * @defaultValue false
+     * @public
+     */
     aiContentSearch: boolean;
+    /**
+     * 是否作为标签展示
+     * @defaultValue false
+     * @public
+     */
     isLabel: boolean;
+    /**
+     * 关闭配置
+     * @defaultValue { show: false, text: '关闭' }
+     * @public
+     */
     close: closeProperty;
+    /**
+     * 背景
+     * @defaultValue { type: 'backgroundColor', backgroundColor: '', backgroundImage: '', ... }
+     * @public
+     */
     background: BackgroundProperty;
     constructor(props?: Partial<TextProperty>);
 }

package/dist/types/baseControls/TextOcrButton/property.d.ts

@@ -60,12 +60,47 @@ interface TextOcrButtonPropertyInterface extends ButtonPropertyInterface {
 }
 declare class TextOcrButtonProperty extends ButtonProperty implements TextOcrButtonPropertyInterface {
     static readonly Rules: typeof TextOcrButtonPropertyRules;
+    /**
+     * 标题
+     * @defaultValue 控件名称
+     * @public
+     */
     caption: string;
+    /**
+     * 隐藏标题
+     * @defaultValue false
+     * @public
+     */
     isHideCaption: boolean;
+    /**
+     * 是否开启气泡提示
+     * @defaultValue false
+     * @public
+     */
     isShowCaptionTip: boolean;
+    /**
+     * 气泡提示语
+     * @defaultValue ''
+     * @public
+     */
     captionTip: string;
+    /**
+     * 标题布局；取值：top：上方；left：左侧；
+     * @defaultValue 'top'
+     * @public
+     */
     labelPosition: 'top' | 'left';
+    /**
+     * 识别类型
+     * @defaultValue ''
+     * @public
+     */
     ocrType: string;
+    /**
+     * 填充配置
+     * @defaultValue []
+     * @public
+     */
     fillList: MultistageFillingItem[];
     constructor(props?: Partial<TextOcrButtonProperty>);
 }

package/dist/types/baseControls/Title/property.d.ts

@@ -39,9 +39,29 @@ interface TitlePropertyInterface extends PropertyInterface {
 }
 declare class TitleProperty extends Property implements TitlePropertyInterface {
     static readonly Rules: typeof TitleControlPropertyRules;
+    /**
+     * 数据绑定项
+     * @defaultValue new DataBind()
+     * @public
+     */
     dataBind: DataBind;
+    /**
+     * 标题
+     * @defaultValue ''
+     * @public
+     */
     caption: string;
+    /**
+     * 标题配置项；取值：is_show_biz_key：显示业务标题；is_show_submit_user：显示提交人；is_show_submit_time：显示提交时间；is_show_submit_dept：显示提交部门；is_show_current_approvar：显示当前审批人；is_show_title：显示标题；
+     * @defaultValue ['is_show_submit_user', ...]
+     * @public
+     */
     config: TitleConfigEnum[];
+    /**
+     * 位置
+     * @defaultValue 'top'
+     * @public
+     */
     position: string;
     constructor(props?: Partial<TitleProperty>);
 }

package/dist/types/columnControls/ApprovalStatusColumn/property.d.ts

@@ -24,8 +24,23 @@ interface ApprovalStatusColumnPropertyInterface extends ColumnControlPropertyInt
     linkOperationOption: LinkOperationOption;
 }
 declare class ApprovalStatusColumnControlProperty extends ColumnControlProperty implements ApprovalStatusColumnPropertyInterface {
+    /**
+     * 行数设置
+     * @defaultValue 1
+     * @public
+     */
     lineEllipsis: number;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
     constructor(props?: Partial<ApprovalStatusColumnControlProperty>);
 }

package/dist/types/columnControls/ArrayColumn/property.d.ts

@@ -48,10 +48,35 @@ interface ArrayColumnPropertyInterface extends ColumnControlPropertyInterface {
 }
 declare class ArrayColumnControlProperty extends ColumnControlProperty implements ArrayColumnPropertyInterface {
     static readonly Rules: typeof ArrayColumnControlPropertyRules;
+    /**
+     * 选项配置；取值：none：无；custom：自定义；datasource：数据源；
+     * @defaultValue 'none'
+     * @public
+     */
     optionConfig: 'none' | 'custom' | 'datasource';
+    /**
+     * 关联数据源
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
+    /**
+     * 自定义选项
+     * @defaultValue [{}]
+     * @public
+     */
     options: OptionSetting[];
     constructor(props?: Partial<ArrayColumnControlProperty>);
 }

package/dist/types/columnControls/AutoNumberColumn/property.d.ts

@@ -26,7 +26,17 @@ interface AutoNumberColumnPropertyInterface extends ColumnControlPropertyInterfa
  */
 declare class AutoNumberColumnControlProperty extends ColumnControlProperty implements AutoNumberColumnPropertyInterface {
     static readonly Rules: typeof AutoNumberColumnControlPropertyRules;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
     constructor(props?: Partial<AutoNumberColumnControlProperty>);
 }

package/dist/types/columnControls/CustomColumn/property.d.ts

@@ -28,7 +28,17 @@ interface CustomColumnPropertyInterface extends ColumnControlPropertyInterface {
 }
 declare class CustomColumnControlProperty extends ColumnControlProperty implements CustomColumnPropertyInterface {
     static readonly Rules: typeof CustomColumnControlPropertyRules;
+    /**
+     * 字段编码列表
+     * @defaultValue []
+     * @public
+     */
     fieldCodeList: string[];
+    /**
+     * 排序字段编码
+     * @defaultValue ''
+     * @public
+     */
     sortFieldCode: string;
     constructor(props?: Partial<CustomColumnControlProperty>);
 }

package/dist/types/columnControls/DecimalColumn/property.d.ts

@@ -62,13 +62,53 @@ interface DecimalColumnPropertyInterface extends ColumnControlPropertyInterface
 }
 declare class DecimalColumnControlProperty extends ColumnControlProperty implements DecimalColumnPropertyInterface {
     static readonly Rules: typeof DecimalColumnControlPropertyRules;
+    /**
+     * 选项配置；取值：none：无；custom：自定义；datasource：数据源；
+     * @defaultValue 'none'
+     * @public
+     */
     optionConfig: 'none' | 'custom' | 'datasource';
+    /**
+     * 关联数据源
+     * @defaultValue new DataSourceBind()
+     * @public
+     */
     datasourceBind: DataSourceBind;
+    /**
+     * 是否显示链接操作
+     * @defaultValue false
+     * @public
+     */
     showLinkOperation: boolean;
+    /**
+     * 链接操作配置
+     * @defaultValue new LinkOperationOption()
+     * @public
+     */
     linkOperationOption: LinkOperationOption;
+    /**
+     * 自定义选项
+     * @defaultValue [{}]
+     * @public
+     */
     options: OptionSetting[];
+    /**
+     * 保留几位小数
+     * @defaultValue 0
+     * @public
+     */
     precision: number | '';
+    /**
+     * 千分位展示
+     * @defaultValue false
+     * @public
+     */
     micrometer: false;
+    /**
+     * 百分比格式化
+     * @defaultValue false
+     * @public
+     */
     percentageFormat: boolean;
     constructor(props?: Partial<DecimalColumnControlProperty>);
 }

package/dist/types/columnControls/DepartmentColumn/property.d.ts

@@ -12,6 +12,11 @@ interface DepartmentColumnPropertyInterface extends ColumnControlPropertyInterfa
     displayLevel: number;
 }
 declare class DepartmentColumnControlProperty extends ColumnControlProperty implements DepartmentColumnPropertyInterface {
+    /**
+     * 部门显示层级
+     * @defaultValue 1
+     * @public
+     */
     displayLevel: number;
     constructor(props?: Partial<DepartmentColumnControlProperty>);
 }

package/dist/types/columnControls/EmployeeColumn/property.d.ts

@@ -12,6 +12,11 @@ interface EmployeeColumnPropertyInterface extends ColumnControlPropertyInterface
     datasourceBind: SuperDataSourceBind;
 }
 declare class EmployeeColumnControlProperty extends ColumnControlProperty implements EmployeeColumnPropertyInterface {
+    /**
+     * 关联数据源
+     * @defaultValue new SuperDataSourceBind({ attributes: EmployeeColumnControl.controlCustomAttributes })
+     * @public
+     */
     datasourceBind: SuperDataSourceBind;
     constructor(props?: Partial<EmployeeColumnControlProperty>);
 }