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

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

@@ -147,26 +147,131 @@ interface BarChartPropertyInterface extends PropertyInterface {
 }
 declare class BarChartProperty extends Property implements BarChartPropertyInterface {
     static readonly Rules: typeof BarChartPropertyRules;
+    /**
+     * 标题
+     * @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 'bar-basic'
+     * @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;
+    /**
+     * X 轴字段
+     * @defaultValue ''
+     * @public
+     */
     xField: string;
+    /**
+     * Y 轴字段（单值映射场景）
+     * @defaultValue ''
+     * @public
+     */
     yField: string;
+    /**
+     * 统一 series 配置；可同时覆盖宽表/长表/堆叠场景
+     * @defaultValue []
+     * @public
+     */
     seriesConfig: BarChartSeriesConfigItem[];
     constructor(props?: Partial<BarChartProperty>);
 }

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

@@ -54,13 +54,53 @@ interface BatchDeleteButtonPropertyInterface extends PropertyInterface {
     isLoading: boolean;
 }
 declare class BatchDeleteButtonProperty extends Property implements BatchDeleteButtonPropertyInterface {
+    /**
+     * 内容
+     * @defaultValue 控件名称
+     * @public
+     */
     content: string;
+    /**
+     * 按钮类型；取值：primary：主按钮；secondary：次按钮；text：文本；
+     * @defaultValue 'primary'
+     * @public
+     */
     buttonType: 'primary' | 'secondary' | 'text';
+    /**
+     * 展示类型；取值：text：文本；icon：图标；iconText：图标文字；
+     * @defaultValue 'iconText'
+     * @public
+     */
     showType: 'text' | 'icon' | 'iconText';
+    /**
+     * 颜色；取值：primary：主按钮；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue 'danger'
+     * @public
+     */
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
+    /**
+     * 图标
+     * @defaultValue 控件默认图标
+     * @public
+     */
     icon: string;
+    /**
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
+     * @public
+     */
     defaultState: 'default' | 'readonly';
+    /**
+     * 执行命令；取值：create：新建；edit：编辑；view：查看；delete：删除；custom：自定义；
+     * @defaultValue 'custom'
+     * @public
+     */
     command: string;
+    /**
+     * 加载中
+     * @defaultValue false
+     * @public
+     */
     isLoading: boolean;
     constructor(props?: Partial<BatchDeleteButtonProperty>);
 }

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

@@ -25,7 +25,17 @@ interface BatchPrintListButtonPropertyInterface extends ButtonPropertyInterface
 }
 declare class BatchPrintListButtonProperty extends ButtonProperty implements BatchPrintListButtonPropertyInterface {
     static readonly Rules: typeof BatchPrintListButtonRules;
+    /**
+     * 打印模板列表
+     * @defaultValue []
+     * @public
+     */
     printTemplates: PrintTemplate[];
+    /**
+     * 是否自动选择模板
+     * @defaultValue false
+     * @public
+     */
     autoSelectTemplate: boolean;
     constructor(props?: Partial<BatchPrintListButtonProperty>);
 }

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

@@ -37,9 +37,29 @@ interface BatchSubmissionListButtonPropertyInterface extends ButtonPropertyInter
 }
 declare class BatchSubmissionListButtonProperty extends ButtonProperty implements BatchSubmissionListButtonPropertyInterface {
     static readonly Rules: typeof BatchSubmissionListButtonPropertyRules;
+    /**
+     * 绑定的流程key
+     * @defaultValue ''
+     * @public
+     */
     processKey: string;
+    /**
+     * 发起人模式；取值：currentInitiator：当前发起人；assigned：指定操作人；
+     * @defaultValue 'currentInitiator'
+     * @public
+     */
     initiatorMode: 'currentInitiator' | 'assigned';
+    /**
+     * TODO 不知道干嘛的属性
+     * @defaultValue ''
+     * @public
+     */
     fieldCode: string;
+    /**
+     * 指定人员的id
+     * @defaultValue ''
+     * @public
+     */
     employeeId: string;
     constructor(props?: Partial<BatchSubmissionListButtonProperty>);
 }

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

@@ -73,6 +73,11 @@ declare class ButtonProperty extends Property implements ButtonPropertyInterface
     showType: 'text' | 'icon' | 'iconText';
     color: 'primary' | 'danger' | 'warning' | 'success' | 'info' | 'blue';
     icon: string;
+    /**
+     * 默认状态；取值：default：默认；readonly：只读；
+     * @defaultValue 'default'
+     * @public
+     */
     defaultState: 'default' | 'readonly';
     command: string;
     isLoading: boolean;

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

@@ -26,7 +26,17 @@ interface CommentPropertyInterface extends PropertyInterface {
     commentOptions?: Array<CommentOption>;
 }
 declare class CommentProperty extends Property implements CommentPropertyInterface {
+    /**
+     * 内容
+     * @defaultValue ''
+     * @public
+     */
     content: string;
+    /**
+     * 评论选项
+     * @defaultValue []
+     * @public
+     */
     commentOptions?: Array<CommentOption>;
     constructor(props?: Partial<CommentProperty>);
 }

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

@@ -25,7 +25,17 @@ interface CreateFormListButtonPropertyInterface extends ButtonPropertyInterface
 }
 declare class CreateFormListButtonProperty extends ButtonProperty implements CreateFormListButtonPropertyInterface {
     static readonly Rules: typeof CreateFormListButtonPropertyRules;
+    /**
+     * 绑定表单
+     * @defaultValue ''
+     * @public
+     */
     formKey: string;
+    /**
+     * 打开方式；取值：modal：弹窗；window：新窗口；dialog：对话框；tab：页签；
+     * @defaultValue 'modal'
+     * @public
+     */
     openType: 'modal' | 'window' | 'dialog' | 'tab';
     constructor(props?: Partial<CreateFormListButtonProperty>);
 }

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

@@ -62,13 +62,53 @@ interface DashboardPropertyInterface extends PropertyInterface {
 }
 declare class DashboardProperty extends Property implements DashboardPropertyInterface {
     static readonly Rules: typeof DashboardPropertyRules;
+    /**
+     * 仪表盘标识
+     * @defaultValue ''
+     * @public
+     */
     dashboardKey: string;
+    /**
+     * 标题
+     * @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 false
+     * @public
+     */
     isShowReportParams: boolean;
+    /**
+     * 报表参数
+     * @defaultValue []
+     * @public
+     */
     reportParams: Array<FieldFilterCondition | FieldFilterConditions>[];
     constructor(props?: Partial<DashboardProperty>);
 }

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

@@ -61,14 +61,59 @@ interface DividerPropertyInterface extends PropertyInterface {
     verticalPosition: 'top' | 'middle' | 'bottom';
 }
 declare class DividerProperty extends Property implements DividerPropertyInterface {
+    /**
+     * 颜色；取值：primary：主色；danger：危险；warning：警告；success：成功；info：信息；blue：蓝色；
+     * @defaultValue '#000'
+     * @public
+     */
     color: string;
+    /**
+     * 线条样式；取值：solid-line：实线；dashed-line：虚线；bold-solid-line：粗实线；bold-dashed-line：粗虚线；double-solid-line：双实线；double-dashed-line：双虚线；
+     * @defaultValue 'solid-line'
+     * @public
+     */
     lineStyle: LINE_STYLE;
+    /**
+     * 内容
+     * @defaultValue ''
+     * @public
+     */
     content: string;
+    /**
+     * 位置；取值：left：左侧；center：居中；right：右侧；
+     * @defaultValue 'left'
+     * @public
+     */
     position: 'left' | 'center' | 'right';
+    /**
+     * 标题大小
+     * @defaultValue ''
+     * @public
+     */
     captionSize: string;
+    /**
+     * 标题颜色
+     * @defaultValue ''
+     * @public
+     */
     captionColor: string;
+    /**
+     * 标题斜体
+     * @defaultValue false
+     * @public
+     */
     isCaptionItalic: boolean;
+    /**
+     * 标题字重；取值：normal：常规；bold：粗体；lighter：更细；
+     * @defaultValue 'normal'
+     * @public
+     */
     captionFontWeight: FONT_WEIGHT;
+    /**
+     * 标题斜体；取值：top：上方；middle：中间；bottom：下方；
+     * @defaultValue 'middle'
+     * @public
+     */
     verticalPosition: 'top' | 'middle' | 'bottom';
     constructor(props?: Partial<DividerProperty>);
 }

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

@@ -19,7 +19,17 @@ interface ExportListButtonPropertyInterface extends ButtonPropertyInterface {
     templateType: 'system' | 'external';
 }
 declare class ExportListButtonProperty extends ButtonProperty implements ExportListButtonPropertyInterface {
+    /**
+     * 模板列表
+     * @defaultValue [new ExportTemplate({ id: 'default', name: '默认模版', appId: 'default', ... })]
+     * @public
+     */
     templateList: ExportTemplate[];
+    /**
+     * 模板类型；取值：system：系统；external：外部；
+     * @defaultValue 'system'
+     * @public
+     */
     templateType: 'system' | 'external';
     constructor(props?: Partial<ExportListButtonProperty>);
 }

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

@@ -39,9 +39,29 @@ interface FormSelectButtonPropertyInterface extends ButtonPropertyInterface {
 }
 declare class FormSelectButtonProperty extends ButtonProperty implements FormSelectButtonPropertyInterface {
     static readonly Rules: typeof FormSelectButtonPropertyRules;
+    /**
+     * 数据过滤
+     * @defaultValue new FillPayloadBind()
+     * @public
+     */
     fillPayload: FillPayloadBind;
+    /**
+     * 选择表单
+     * @defaultValue new FormSelectBind()
+     * @public
+     */
     formBind: FormSelectBind;
+    /**
+     * 回填配置
+     * @defaultValue new FillBackBind()
+     * @public
+     */
     fillBack: FillBackBind;
+    /**
+     * 按钮命令；取值：create：新建；edit：编辑；view：查看；
+     * @defaultValue 'create'
+     * @public
+     */
     command: 'create' | 'edit' | 'view';
     constructor(props?: Partial<FormSelectButtonProperty>);
 }

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

@@ -31,8 +31,23 @@ interface IframePropertyInterface extends PropertyInterface {
 }
 declare class IframeProperty extends Property implements IframePropertyInterface {
     static readonly Rules: typeof IframePropertyRules;
+    /**
+     * URL
+     * @defaultValue ''
+     * @public
+     */
     content: string;
+    /**
+     * 宽
+     * @defaultValue 600
+     * @public
+     */
     width: number;
+    /**
+     * 高
+     * @defaultValue 400
+     * @public
+     */
     height: number;
     constructor(props?: Partial<IframeProperty>);
 }

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

@@ -4,6 +4,10 @@
  */
 import { ButtonProperty, ButtonPropertyInterface } from '../Button';
 declare class ImportListBind {
+    /**
+     * 可导入数据编码
+     * @public
+     */
     dataCode: string;
     constructor(props: ImportListBind);
 }
@@ -22,7 +26,17 @@ interface ImportRecordListButtonPropertyInterface extends ButtonPropertyInterfac
     templateType: 'system' | 'external';
 }
 declare class ImportRecordListButtonProperty extends ButtonProperty implements ImportRecordListButtonPropertyInterface {
+    /**
+     * 可以导入的数据
+     * @defaultValue []
+     * @public
+     */
     canImportList: Array<ImportListBind>;
+    /**
+     * 模板类型；取值：system：系统；external：外部；
+     * @defaultValue 'system'
+     * @public
+     */
     templateType: 'system' | 'external';
     constructor(props?: Partial<ImportRecordListButtonProperty>);
 }

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

@@ -56,12 +56,47 @@ interface InvoiceCheckButtonPropertyInterface extends ButtonPropertyInterface {
 }
 declare class InvoiceCheckButtonProperty extends ButtonProperty implements InvoiceCheckButtonPropertyInterface {
     static readonly Rules: typeof InvoiceCheckButtonPropertyRules;
+    /**
+     * 标题
+     * @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 true
+     * @public
+     */
     invoiceCheck: boolean;
+    /**
+     * 填充配置
+     * @defaultValue []
+     * @public
+     */
     fillList: MultistageFillingItem[];
     constructor(props?: Partial<InvoiceCheckButtonProperty>);
 }

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

@@ -150,26 +150,131 @@ interface LineChartPropertyInterface extends PropertyInterface {
 }
 declare class LineChartProperty extends Property implements LineChartPropertyInterface {
     static readonly Rules: typeof LineChartPropertyRules;
+    /**
+     * 标题
+     * @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 'line-basic'
+     * @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;
+    /**
+     * X 轴字段
+     * @defaultValue ''
+     * @public
+     */
     xField: string;
+    /**
+     * Y 轴字段（单值映射场景）
+     * @defaultValue ''
+     * @public
+     */
     yField: string;
+    /**
+     * 统一 series 配置；可同时覆盖宽表/长表/堆叠场景
+     * @defaultValue []
+     * @public
+     */
     seriesConfig: LineChartSeriesConfigItem[];
     constructor(props?: Partial<LineChartProperty>);
 }