@dhccmobile/vue3-lo-form 2.0.0 → 2.0.2

package/types/core/FormApi.d.ts

@@ -1,376 +1,376 @@
-import { AbstractControl } from "@/domain/AbstractControl";
-import { Validate, ValidateReport } from "../domain/FormControl";
-import { CustomFormat, FieldChangeHistory } from "../domain";
-import { Rule } from "../services/validate-generator.service";
-import { MathJsStatic } from "mathjs";
-import { Vue } from "vue-property-decorator";
-export declare type FormatType = "default" | "ebtrust";
-export declare enum Attribute {
-    IsHideControl = "isHideControl",
-    IsRequiredValidate = "isRequiredValidate",
-    FormFieldDescribe = "formFieldDescribe",
-    FieldDefaultValue = "fieldDefaultValue",
-    TitleWidth = "titleWidth",
-    IsBoldTitle = "isBoldTitle",
-    IsHideTitle = "isHideTitle",
-    TitleColor = "titleColor",
-    Placeholder = "placeholder",
-    Tips = "tips",
-    IsNotEdit = "isNotEdit",
-    BindingPrefix = "bindingPrefix",
-    BindingSuffix = "bindingSuffix",
-    BuiltInFrontLabel = "builtInFrontLabel",
-    BuiltInPostLabel = "builtInPostLabel",
-    ControlWidth = "controlWidth",
-    IsPasswordBox = "isPasswordBox",
-    InitRowHeight = "initRowHeight",
-    IsFixedRowHeight = "isFixedRowHeight",
-    FormatType = "formatType",
-    MinValue = "minValue",
-    MaxValue = "maxValue",
-    Step = "step",
-    DecimalPlaces = "decimalPlaces",
-    ThousandthPercentileFormat = "thousandthPercentileFormat",
-    Unit = "unit",
-    ZoomType = "zoomType",
-    ZoomMultiple = "zoomMultiple",
-    IsShowCapitalization = "isShowCapitalization",
-    IsLineFeedDisplay = "isLineFeedDisplay",
-    IsOptionType = "isOptionType",
-    OptionConfig = "optionConfig",
-    DateFormat = "dateFormat",
-    TimeFormat = "timeFormat",
-    IsSupportMultiple = "isSupportMultiple",
-    MaxUploadNumber = "maxUploadNumber",
-    LimitSize = "limitSize",
-    SupportUploadType = "supportUploadType",
-    CustomUploadType = "customUploadType",
-    ExtendUploadType = "extendUploadType",
-    AttachmentExtendProperties = "attachmentExtendProperties",
-    IsMultipleChoice = "isMultipleChoice",
-    IsSearchable = "isSearchable",
-    CanAddEntry = "canAddEntry",
-    IsClearButton = "isClearButton",
-    OnOpeningValue = "onOpeningValue",
-    WhenClosedValue = "whenClosedValue",
-    OnOpeningText = "onOpeningText",
-    WhenClosedText = "whenClosedText",
-    CustomFieldName = "customFieldName",
-    TextFold = "textFold",
-    HiddenDropdown = "hiddenDropdown",
-    BusAttr = "busAttr",
-    EnableAutoComplete = "enableAutoComplete",
-    AutoCompleteOptions = "autoCompleteOptions",
-    IsTreeOpen = "isTreeOpen",
-    CheckboxStyle = "checkboxStyle",
-    ItemWidth = "itemWidth",
-    ChangeOnSelect = "changeOnSelect",
-    TextareaRows = "textareaRows",
-    IsShowHoliday = "isShowHoliday"
-}
-/**
- * @description: 表单基础类，聚合常用api
- * @author ChenRui
- * @date 2020/11/28 23:27
- */
-export declare class FormApi {
-    id?: any;
-    dvForm: Vue | any;
-    edit: boolean | undefined;
-    formatType: FormatType;
-    apiMetaRefresh: any;
-    [key: string]: any;
-    oldVal: any;
-    /**
-     * @description: 获取表单对象
-     * @author ChenRui
-     * @date 2020/11/28 23:29
-     */
-    constructor(options?: {
-        id?: any;
-        dvForm?: Vue;
-        edit?: boolean;
-        formatType?: FormatType;
-    });
-    get mathjs(): MathJsStatic;
-    /**
-     * @description: 获取表单值
-     * @author ChenRui
-     * @date 2021/2/4 10:36
-     */
-    get formData(): any;
-    /**
-     * @Description 获取表单全部值
-     * @Author JiangTao
-     * @Date 2023-12-22 下午 02:50
-     */
-    get formAllData(): any;
-    /**
-     * @description: 编码表单对象
-     * @author ChenRui
-     * @date 2021/4/25 16:41
-     */
-    get encodedFormData(): any;
-    /**
-     * @description: 设置表单值
-     * @author ChenRui
-     * @date 2021/2/4 10:37
-     */
-    setFormData(srcData: any, isDefault?: boolean, validate?: boolean, oldVal?: any): void;
-    /**
-     * @description: 获取控件对象
-     * @author ChenRui
-     * @date 2021/1/29 10:08
-     */
-    getControl(key: string, control?: AbstractControl, showError?: boolean): AbstractControl | any;
-    /**
-     * @description: 获取值
-     * @author ChenRui
-     * @date 2021/1/29 14:57
-     */
-    getValue(key: string): any;
-    /**
-     * @description: 设置值
-     * @author ChenRui
-     * @date 2021/1/29 16:23
-     */
-    setValue(key: string, val: any, isDefault?: boolean, validate?: boolean): void;
-    /**
-     * @description: 重置表单
-     * @author ChenRui
-     * @date 2021/2/22 17:40
-     */
-    resetValue(): void;
-    /**
-     * @description: 获取文本内容
-     * @author ChenRui
-     * @date 2021/1/29 15:03
-     */
-    getText(key: string): any;
-    /**
-     * @description: 获取可选项
-     * @author ChenRui
-     * @date 2021/1/29 16:11
-     */
-    getOptions(key: string): any[];
-    /**
-     * @description: 设置可选项
-     * @author ChenRui
-     * @date 2021/1/29 16:15
-     */
-    setOptions(key: string, data: any[], defaultVal?: any): void;
-    /**
-     * @description: 获取常规属性
-     * @author ChenRui
-     * @date 2021/1/29 17:21
-     */
-    getAttribute(key: string, attribute: Attribute): any;
-    /**
-     * @description: 设置常规属性
-     * @author ChenRui
-     * @date 2021/1/29 17:21
-     */
-    setAttribute(key: string, attribute: Attribute, data: any): void;
-    /**
-     * @description: 根据name获取校验
-     * @author ChenRui
-     * @date 2021/1/30 11:46
-     */
-    getValidate(key: string, name: string): any;
-    /**
-     * @description: 移除校验
-     * @author ChenRui
-     * @date 2021/4/1 21:30
-     */
-    removeValidate(key: string, validateName: string): void;
-    /**
-     * @description: 移除所有校验
-     * @author ChenRui
-     * @date 2021/4/1 21:48
-     */
-    removeAllValidates(key: string): void;
-    /**
-     * @description: 获取校验集合
-     * @author ChenRui
-     * @date 2021/1/30 11:40
-     */
-    getValidates(key: string): Validate[];
-    /**
-     * @Description: 设置必输校验
-     * @author GuoXuHui
-     * @date 2022-05-25
-     * @time 10:09
-     */
-    setRequiredValidate(key: string, data: boolean): void;
-    /**
-     * @description: 设置校验
-     * @author ChenRui
-     * @date 2021/1/30 11:54
-     */
-    setValidate(key: string, validate: Validate | Validate[] | Rule, isCover?: boolean): void;
-    /**
-     * @description: 校验提示
-     * @author ChenRui
-     * @date 2021/8/18 17:40
-     */
-    validateTips(scrollView?: any): boolean;
-    /**
-     * @description: 全局校验报告
-     * @author ChenRui
-     * @date 2021/2/5 11:48
-     */
-    validateReport(formGroup?: AbstractControl, validateReports?: ValidateReport[], refreshFeedback?: boolean): ValidateReport[];
-    /**
-     * @description: 表单全局校验
-     * @author ChenRui
-     * @date 2021/2/5 14:11
-     */
-    validate(refreshFeedback?: boolean): boolean;
-    /**
-     * @description: 刷新校验
-     * @author ChenRui
-     * @date 2021/6/4 19:32
-     */
-    refreshValidate(key: string): void;
-    /**
-     * @description: 重置表单校验
-     * @author ChenRui
-     * @date 2022/4/6 11:51
-     */
-    resetFormValidateState(): void;
-    /**
-     * @description: 设置格式化显示和输出函数
-     * @author ChenRui
-     * @date 2021/2/4 19:44
-     */
-    setFormatDisplayAndOutput(key: string, customFormat: CustomFormat): void;
-    /**
-     * @description: 刷新数据
-     * @author ChenRui
-     * @date 2021/2/4 20:22
-     */
-    refreshAndUpdateData(): void;
-    /**
-     * @description: 获取控件dom对象
-     * @author ChenRui
-     * @date 2021/2/26 17:12
-     */
-    getControlEl(key: string): any;
-    /**
-     * @description: 检查是否包含上传控件
-     * @author ChenRui
-     * @date 2021/4/23 11:30
-     */
-    checkHasUploadControl(abstractControl: AbstractControl): boolean;
-    /**
-     * @description: json格式转表单格式
-     * @author ChenRui
-     * @date 2020/8/28 15:20
-     */
-    jsonToFormData(params: any): FormData;
-    /**
-     * @description: 设置变更历史记录
-     * @author ChenRui
-     * @date 2021/4/25 15:55
-     */
-    setFieldChangeHistory(fieldChangeHistory: FieldChangeHistory): void;
-    /**
-     * @description: 隐藏布局
-     * @author ChenRui
-     * @date 2021/11/16 0:01
-     */
-    hideLayout(layoutName: string, mark?: boolean): void;
-    /**
-     * @description: 设置表单值
-     * @author ChenRui
-     * @date 2021/8/16 9:29
-     */
-    private setFormDataInner;
-    /**
-     * @description: 设置控件值
-     * @author ChenRui
-     * @date 2021/4/13 12:50
-     */
-    private setControlValue;
-    /**
-     * @description: 设置控件可选项
-     * @author ChenRui
-     * @date 2021/4/13 15:09
-     */
-    private setControlOptions;
-    /**
-     * @description: 设置控件常规属性
-     * @author ChenRui
-     * @date 2021/4/13 15:11
-     */
-    private setControlAttribute;
-    /**
-     * @description: 设置校验内部函数
-     * @author ChenRui
-     * @date 2021/7/19 17:51
-     */
-    private setValidateInner;
-    /**
-     * @description: 生成数据信息
-     * @author ChenRui
-     * @date 2021/1/29 10:06
-     */
-    private generateData;
-    /**
-     * @description: 数据解码输出
-     * @author ChenRui
-     * @date 2021/5/29 23:03
-     */
-    private decodeData;
-    /**
-     * @description: 获取当前日期字符串
-     * @author ChenRui
-     * @date 2021/2/4 11:43
-     */
-    private nowDateStr;
-    /**
-     * @description: uuid生成器
-     * @author ChenRui
-     * @date 2021/7/20 11:14
-     */
-    private getUuid;
-    /**
-     * @Description: 对比新旧表单值
-     * @author lzs
-     * @date 2022/9/3
-     * @time 21:49
-     */
-    private contrast;
-    /**
-     * @Description: 获取表单值更改信息
-     * @author lzs
-     * @date 2022/10/11
-     * @time 09:53
-     */
-    getChangedInfo(control: any, oldValue: any, newValue: any): boolean;
-    /**
-     * @Description: 翻译字典项
-     * @author lzs
-     * @date 2022/9/6
-     * @time 11:54
-     */
-    translateDictionaries(control: any, key: any, value: any): string;
-    /**
-     * @Description 根据报送类型返回需要隐藏的表单字段
-     * @Author JiangTao
-     * @Date 2024-01-30 上午 09:33
-     */
-    getFormSubmittedType(form: any, code: any): void;
-    /**
-     * @Description 筛选报送类型字段数据处理
-     * @Author JiangTao
-     * @Date 2024-01-30 下午 08:50
-     */
-    private handleSubmittedData;
-    /**
-     * @Description 获取报送类型枚举（数组）
-     * @Author JiangTao
-     * @Date 2024-01-30 下午 03:30
-     */
-    getSubmittedType(): any;
-}
+import { AbstractControl } from "@/domain/AbstractControl";
+import { Validate, ValidateReport } from "../domain/FormControl";
+import { CustomFormat, FieldChangeHistory } from "../domain";
+import { Rule } from "../services/validate-generator.service";
+import { MathJsStatic } from "mathjs";
+import { Vue } from "vue-property-decorator";
+export declare type FormatType = "default" | "ebtrust";
+export declare enum Attribute {
+    IsHideControl = "isHideControl",
+    IsRequiredValidate = "isRequiredValidate",
+    FormFieldDescribe = "formFieldDescribe",
+    FieldDefaultValue = "fieldDefaultValue",
+    TitleWidth = "titleWidth",
+    IsBoldTitle = "isBoldTitle",
+    IsHideTitle = "isHideTitle",
+    TitleColor = "titleColor",
+    Placeholder = "placeholder",
+    Tips = "tips",
+    IsNotEdit = "isNotEdit",
+    BindingPrefix = "bindingPrefix",
+    BindingSuffix = "bindingSuffix",
+    BuiltInFrontLabel = "builtInFrontLabel",
+    BuiltInPostLabel = "builtInPostLabel",
+    ControlWidth = "controlWidth",
+    IsPasswordBox = "isPasswordBox",
+    InitRowHeight = "initRowHeight",
+    IsFixedRowHeight = "isFixedRowHeight",
+    FormatType = "formatType",
+    MinValue = "minValue",
+    MaxValue = "maxValue",
+    Step = "step",
+    DecimalPlaces = "decimalPlaces",
+    ThousandthPercentileFormat = "thousandthPercentileFormat",
+    Unit = "unit",
+    ZoomType = "zoomType",
+    ZoomMultiple = "zoomMultiple",
+    IsShowCapitalization = "isShowCapitalization",
+    IsLineFeedDisplay = "isLineFeedDisplay",
+    IsOptionType = "isOptionType",
+    OptionConfig = "optionConfig",
+    DateFormat = "dateFormat",
+    TimeFormat = "timeFormat",
+    IsSupportMultiple = "isSupportMultiple",
+    MaxUploadNumber = "maxUploadNumber",
+    LimitSize = "limitSize",
+    SupportUploadType = "supportUploadType",
+    CustomUploadType = "customUploadType",
+    ExtendUploadType = "extendUploadType",
+    AttachmentExtendProperties = "attachmentExtendProperties",
+    IsMultipleChoice = "isMultipleChoice",
+    IsSearchable = "isSearchable",
+    CanAddEntry = "canAddEntry",
+    IsClearButton = "isClearButton",
+    OnOpeningValue = "onOpeningValue",
+    WhenClosedValue = "whenClosedValue",
+    OnOpeningText = "onOpeningText",
+    WhenClosedText = "whenClosedText",
+    CustomFieldName = "customFieldName",
+    TextFold = "textFold",
+    HiddenDropdown = "hiddenDropdown",
+    BusAttr = "busAttr",
+    EnableAutoComplete = "enableAutoComplete",
+    AutoCompleteOptions = "autoCompleteOptions",
+    IsTreeOpen = "isTreeOpen",
+    CheckboxStyle = "checkboxStyle",
+    ItemWidth = "itemWidth",
+    ChangeOnSelect = "changeOnSelect",
+    TextareaRows = "textareaRows",
+    IsShowHoliday = "isShowHoliday"
+}
+/**
+ * @description: 表单基础类，聚合常用api
+ * @author ChenRui
+ * @date 2020/11/28 23:27
+ */
+export declare class FormApi {
+    id?: any;
+    dvForm: Vue | any;
+    edit: boolean | undefined;
+    formatType: FormatType;
+    apiMetaRefresh: any;
+    [key: string]: any;
+    oldVal: any;
+    /**
+     * @description: 获取表单对象
+     * @author ChenRui
+     * @date 2020/11/28 23:29
+     */
+    constructor(options?: {
+        id?: any;
+        dvForm?: Vue;
+        edit?: boolean;
+        formatType?: FormatType;
+    });
+    get mathjs(): MathJsStatic;
+    /**
+     * @description: 获取表单值
+     * @author ChenRui
+     * @date 2021/2/4 10:36
+     */
+    get formData(): any;
+    /**
+     * @Description 获取表单全部值
+     * @Author JiangTao
+     * @Date 2023-12-22 下午 02:50
+     */
+    get formAllData(): any;
+    /**
+     * @description: 编码表单对象
+     * @author ChenRui
+     * @date 2021/4/25 16:41
+     */
+    get encodedFormData(): any;
+    /**
+     * @description: 设置表单值
+     * @author ChenRui
+     * @date 2021/2/4 10:37
+     */
+    setFormData(srcData: any, isDefault?: boolean, validate?: boolean, oldVal?: any): void;
+    /**
+     * @description: 获取控件对象
+     * @author ChenRui
+     * @date 2021/1/29 10:08
+     */
+    getControl(key: string, control?: AbstractControl, showError?: boolean): AbstractControl | any;
+    /**
+     * @description: 获取值
+     * @author ChenRui
+     * @date 2021/1/29 14:57
+     */
+    getValue(key: string): any;
+    /**
+     * @description: 设置值
+     * @author ChenRui
+     * @date 2021/1/29 16:23
+     */
+    setValue(key: string, val: any, isDefault?: boolean, validate?: boolean): void;
+    /**
+     * @description: 重置表单
+     * @author ChenRui
+     * @date 2021/2/22 17:40
+     */
+    resetValue(): void;
+    /**
+     * @description: 获取文本内容
+     * @author ChenRui
+     * @date 2021/1/29 15:03
+     */
+    getText(key: string): any;
+    /**
+     * @description: 获取可选项
+     * @author ChenRui
+     * @date 2021/1/29 16:11
+     */
+    getOptions(key: string): any[];
+    /**
+     * @description: 设置可选项
+     * @author ChenRui
+     * @date 2021/1/29 16:15
+     */
+    setOptions(key: string, data: any[], defaultVal?: any): void;
+    /**
+     * @description: 获取常规属性
+     * @author ChenRui
+     * @date 2021/1/29 17:21
+     */
+    getAttribute(key: string, attribute: Attribute): any;
+    /**
+     * @description: 设置常规属性
+     * @author ChenRui
+     * @date 2021/1/29 17:21
+     */
+    setAttribute(key: string, attribute: Attribute, data: any): void;
+    /**
+     * @description: 根据name获取校验
+     * @author ChenRui
+     * @date 2021/1/30 11:46
+     */
+    getValidate(key: string, name: string): any;
+    /**
+     * @description: 移除校验
+     * @author ChenRui
+     * @date 2021/4/1 21:30
+     */
+    removeValidate(key: string, validateName: string): void;
+    /**
+     * @description: 移除所有校验
+     * @author ChenRui
+     * @date 2021/4/1 21:48
+     */
+    removeAllValidates(key: string): void;
+    /**
+     * @description: 获取校验集合
+     * @author ChenRui
+     * @date 2021/1/30 11:40
+     */
+    getValidates(key: string): Validate[];
+    /**
+     * @Description: 设置必输校验
+     * @author GuoXuHui
+     * @date 2022-05-25
+     * @time 10:09
+     */
+    setRequiredValidate(key: string, data: boolean): void;
+    /**
+     * @description: 设置校验
+     * @author ChenRui
+     * @date 2021/1/30 11:54
+     */
+    setValidate(key: string, validate: Validate | Validate[] | Rule, isCover?: boolean): void;
+    /**
+     * @description: 校验提示
+     * @author ChenRui
+     * @date 2021/8/18 17:40
+     */
+    validateTips(scrollView?: any): boolean;
+    /**
+     * @description: 全局校验报告
+     * @author ChenRui
+     * @date 2021/2/5 11:48
+     */
+    validateReport(formGroup?: AbstractControl, validateReports?: ValidateReport[], refreshFeedback?: boolean): ValidateReport[];
+    /**
+     * @description: 表单全局校验
+     * @author ChenRui
+     * @date 2021/2/5 14:11
+     */
+    validate(refreshFeedback?: boolean): boolean;
+    /**
+     * @description: 刷新校验
+     * @author ChenRui
+     * @date 2021/6/4 19:32
+     */
+    refreshValidate(key: string): void;
+    /**
+     * @description: 重置表单校验
+     * @author ChenRui
+     * @date 2022/4/6 11:51
+     */
+    resetFormValidateState(): void;
+    /**
+     * @description: 设置格式化显示和输出函数
+     * @author ChenRui
+     * @date 2021/2/4 19:44
+     */
+    setFormatDisplayAndOutput(key: string, customFormat: CustomFormat): void;
+    /**
+     * @description: 刷新数据
+     * @author ChenRui
+     * @date 2021/2/4 20:22
+     */
+    refreshAndUpdateData(): void;
+    /**
+     * @description: 获取控件dom对象
+     * @author ChenRui
+     * @date 2021/2/26 17:12
+     */
+    getControlEl(key: string): any;
+    /**
+     * @description: 检查是否包含上传控件
+     * @author ChenRui
+     * @date 2021/4/23 11:30
+     */
+    checkHasUploadControl(abstractControl: AbstractControl): boolean;
+    /**
+     * @description: json格式转表单格式
+     * @author ChenRui
+     * @date 2020/8/28 15:20
+     */
+    jsonToFormData(params: any): FormData;
+    /**
+     * @description: 设置变更历史记录
+     * @author ChenRui
+     * @date 2021/4/25 15:55
+     */
+    setFieldChangeHistory(fieldChangeHistory: FieldChangeHistory): void;
+    /**
+     * @description: 隐藏布局
+     * @author ChenRui
+     * @date 2021/11/16 0:01
+     */
+    hideLayout(layoutName: string, mark?: boolean): void;
+    /**
+     * @description: 设置表单值
+     * @author ChenRui
+     * @date 2021/8/16 9:29
+     */
+    private setFormDataInner;
+    /**
+     * @description: 设置控件值
+     * @author ChenRui
+     * @date 2021/4/13 12:50
+     */
+    private setControlValue;
+    /**
+     * @description: 设置控件可选项
+     * @author ChenRui
+     * @date 2021/4/13 15:09
+     */
+    private setControlOptions;
+    /**
+     * @description: 设置控件常规属性
+     * @author ChenRui
+     * @date 2021/4/13 15:11
+     */
+    private setControlAttribute;
+    /**
+     * @description: 设置校验内部函数
+     * @author ChenRui
+     * @date 2021/7/19 17:51
+     */
+    private setValidateInner;
+    /**
+     * @description: 生成数据信息
+     * @author ChenRui
+     * @date 2021/1/29 10:06
+     */
+    private generateData;
+    /**
+     * @description: 数据解码输出
+     * @author ChenRui
+     * @date 2021/5/29 23:03
+     */
+    private decodeData;
+    /**
+     * @description: 获取当前日期字符串
+     * @author ChenRui
+     * @date 2021/2/4 11:43
+     */
+    private nowDateStr;
+    /**
+     * @description: uuid生成器
+     * @author ChenRui
+     * @date 2021/7/20 11:14
+     */
+    private getUuid;
+    /**
+     * @Description: 对比新旧表单值
+     * @author lzs
+     * @date 2022/9/3
+     * @time 21:49
+     */
+    private contrast;
+    /**
+     * @Description: 获取表单值更改信息
+     * @author lzs
+     * @date 2022/10/11
+     * @time 09:53
+     */
+    getChangedInfo(control: any, oldValue: any, newValue: any): boolean;
+    /**
+     * @Description: 翻译字典项
+     * @author lzs
+     * @date 2022/9/6
+     * @time 11:54
+     */
+    translateDictionaries(control: any, key: any, value: any): string;
+    /**
+     * @Description 根据报送类型返回需要隐藏的表单字段
+     * @Author JiangTao
+     * @Date 2024-01-30 上午 09:33
+     */
+    getFormSubmittedType(form: any, code: any): void;
+    /**
+     * @Description 筛选报送类型字段数据处理
+     * @Author JiangTao
+     * @Date 2024-01-30 下午 08:50
+     */
+    private handleSubmittedData;
+    /**
+     * @Description 获取报送类型枚举（数组）
+     * @Author JiangTao
+     * @Date 2024-01-30 下午 03:30
+     */
+    getSubmittedType(): any;
+}