@geelato/gl-ui-web-arco 0.0.1

package/dist/types/components/gl-entity-table-plus/constants.d.ts

@@ -0,0 +1,292 @@
+import { RenderFunction } from '../../../vue/dist/vue.esm-bundler.js';
+import { TableColumnData } from '@arco-design/web-vue';
+import { ComponentInstance } from '@geelato/gl-ui-schema';
+import { EntityReader, EntityReaderOrder, EntityReaderParam, PageProvideProxy } from '@geelato/gl-runtime-core';
+import { QueryItemKv } from '../gl-query/query';
+import { default as Toolbar } from '../gl-toolbar/toolbar';
+export declare const SlotNameSeq: string;
+export declare const SlotNameRecordStatus: string;
+export type Column = GlTableColumn & {
+    checked?: true;
+};
+export type DeleteActionMode = 'deleteFrontAndServer' | 'deleteFrontOnly';
+export interface TableMeta {
+    columns: GlTableColumn[];
+    columnResizable?: boolean;
+    entityReaderInfo: EntityReader;
+    enableI18n?: boolean;
+    rowSelection?: object;
+    size?: SizeProps;
+}
+export declare class BaseInfo {
+    /** 表格Id */
+    id?: string;
+    /** 显示名称，如用户列表 */
+    label?: string;
+    /** 对应的实体名 */
+    entityName?: string;
+    /** 外键字段加载配置 */
+    foreignKeys?: Array<{
+        field: string;
+        referenceEntity: string;
+        referenceField: string;
+        alias: string;
+    }>;
+    /** 控制权限，比如是否可以选择，如checkbox,radio,false */
+    checkType?: 'checkbox' | 'radio' | undefined;
+    /** 表格是否可拖动排序 */
+    tableDraggable?: boolean;
+    /** 拖拽后是否自动重置序号 */
+    autoResetSeqNoAfterDrag?: boolean;
+    /** 页面初始化时，是否自动加载第一页数据 */
+    triggerByInit?: boolean;
+    /** 查询条件组件中，值改变时，是否自动触发查询 */
+    triggerByValueChange?: boolean;
+    /** 是否显示序号列 */
+    showSeqNo?: boolean;
+    /** 是否显示复制行按钮 */
+    showActionCopy?: boolean;
+    /** 是否显示删除行按钮 */
+    showActionDelete?: boolean;
+    /** 删除行的操作模式 */
+    deleteActionMode?: 'deleteFrontAndServer' | 'deleteFrontOnly';
+    /** 是否显示解除关联关系的按钮 */
+    showActionRelease?: boolean;
+    /** 是否显示操作列，操作列一般包含添加复制编辑按钮 */
+    showOptColumn?: boolean;
+    /** 是否显示分页器，默认为是 */
+    showPagination?: boolean;
+    /** 点击行时，是否check该行 */
+    clickAsCheck?: boolean;
+    /** 双击单元格时，是否复制单元格内容到剪贴板 */
+    dblclickCopyCellText?: boolean;
+    /** 是否以逻辑删除的方式操作，如果是，则给该记录增加delFlag字段且值为1（表示删除），否则调用delete接口，直接删除该条记录。默认值为否 */
+    isLogicDeleteMode?: boolean;
+    /** 行只读表达式，js脚本，如 return row.status === 'paid' ，该行将不能再被编辑 */
+    isRowReadonlyExpression?: string;
+    /** 禁止保存表达式，js脚本，如 return row.status === 'paid' ，该行将不能再被保存 */
+    interdictExpression?: string;
+    /** 是否启用编辑模式，默认为否，不管页面是否处于只读状态，该表格都是不可以编辑 */
+    enableEdit?: boolean;
+    /** 是否为表单的子表，默认为否；如果是，当删除行时，只解除与父表单的关联关系，不删除记录 */
+    isFormSubTable?: boolean;
+    /** 作为子表，对应主表单ID的字段名，如orderId、pId等 */
+    subTablePidName?: string;
+    /** 是否显示工具栏，默认为是 */
+    showToolbar?: boolean;
+    /** 是否显示默认的导出按钮，默认为是 */
+    showDefaultExport?: boolean;
+    /** 是否显示查询区域，默认为是 */
+    showQuery?: boolean;
+    /** 是否显示重置查询条件按钮，默认为是 */
+    hideReset?: boolean;
+    /** 表格是否启用浏览器缓存记住用户设置的信息，默认为是 */
+    rememberInBrowser?: boolean;
+    /** 是否显示添加行按钮，默认为是 */
+    showAddRowBtn?: boolean;
+    /** 是否隐藏该表的标题名，默认为否 */
+    hideLabel?: boolean;
+    /** 表格元素外层的边距，默认为undefined，保持arco的默认padding */
+    tablePadding?: string;
+    /** 是否显示边框，默认为是 */
+    bordered?: boolean;
+    /** 是否显示hover效果，默认为否 */
+    hoverable?: boolean;
+    /** 是否显示过滤器，默认为否 */
+    showFilter?: boolean;
+    /** 是否自动计算表格高度 */
+    autoHeight?: boolean;
+    /** 自动高度调整值 */
+    autoHeightAdjust?: number;
+    /** 虚拟列表高度，大于0启用虚拟列表，值为高度(px)；≤0不启用 */
+    virtualListHeight?: number;
+    /** 是否受页面的readonly状态控制，如表单上的查看按钮点击后，页面会变为只读状态，此时需要约束按钮不可用 */
+    controlByPageStatus?: boolean;
+    /** 过滤器显示模式：'toolbar' | 'dropdown' | 'tabs' */
+    filterDisplayMode?: 'toolbar' | 'dropdown' | 'tabs';
+    /** 操作列最多展示的操作项，超出折叠到更多菜单 */
+    optColumnMaxInlineActions?: number;
+    /** 是否启用前端本地过滤功能（仅在编辑模式下有效），默认为false
+     * 启用后，工具栏会显示搜索框，可以对当前已加载的数据进行前端过滤
+     * 过滤基于单元格的展示文本（如字典显示名），而不是原始值
+     */
+    enableLocalFilter?: boolean;
+}
+export interface KeyboardProps {
+    enabled?: boolean;
+    enterToNextCell?: boolean;
+    tabToNextCell?: boolean;
+    shiftTabToPrevCell?: boolean;
+    enterToPrevCell?: boolean;
+    downToNextRowCell?: boolean;
+    upToPrevRowCell?: boolean;
+    downAtLastRowAddRow?: boolean;
+}
+export declare class TableExport {
+    btnText?: string;
+    fileName?: string;
+    scope?: 'CURRENT_PAGE' | 'ALL_PAGE' | 'SELECTED';
+    max?: number;
+    ignoreColumns?: string[];
+    readonly?: boolean;
+    hasSeqNo?: boolean;
+}
+export interface TableToolbar extends Toolbar {
+    export?: TableExport;
+}
+/**
+ *  定义导出表格的列
+ */
+export interface ExcelColumnMeta {
+    dataIndex?: string;
+    title?: string | RenderFunction;
+    width?: number;
+    align?: 'left' | 'center' | 'right';
+    description?: string;
+    children?: ExcelColumnMeta[];
+}
+/**
+ *  定义导出的excel值单元格的格式
+ */
+export declare enum ExcelCellValueType {
+    STRING = "STRING",
+    NUMBER = "NUMBER",
+    DATE = "DATE",
+    DATETIME = "DATETIME"
+}
+/**
+ *  定义导出的excel值的取值方式
+ */
+export declare enum ExcelCellValueComputeMode {
+    VAR = "VAR",
+    CONST = "CONST",
+    EXPRESSION = "EXPRESSION"
+}
+export declare const ExcelCellValueTypeOptions: {
+    label: string;
+    value: string;
+}[];
+export declare const ExcelCellValueComputeModeOptions: {
+    label: string;
+    value: string;
+}[];
+/**
+ *  定义导出Excel的元数据
+ */
+export declare class ExcelCellMeta {
+    placeholder: string;
+    valueType: ExcelCellValueType;
+    valueComputeMode: ExcelCellValueComputeMode;
+    var?: string;
+    listVar?: string;
+    constValue?: any;
+    expression?: string;
+    isImage?: boolean;
+    imageWidth?: number;
+    imageHeight?: number;
+    isList?: boolean;
+    isMerge?: boolean;
+    isUnique?: boolean;
+    description?: string;
+}
+/**
+ *  定义GlTable的列
+ */
+export interface GlTableColumn extends TableColumnData {
+    dataIndex?: string;
+    title?: string;
+    slotName?: string;
+    width?: number;
+    _show?: boolean;
+    _icon?: string;
+    _renderScript: string;
+    _component?: ComponentInstance;
+    _noCustomRender?: boolean;
+    _required?: boolean;
+    _checked?: boolean;
+    _renderFnBody: string;
+    _bgColor?: string;
+    _propsExpressions?: object;
+    _stat?: boolean;
+    _statGroupBy?: string;
+    _statDecimal?: number;
+    _description?: string;
+    /********* 以下为导出到Excel中用到的属性  ***********/
+    _cellMeta?: ExcelCellMeta;
+}
+export interface GlTableRow {
+    rowClassExpression?: string;
+}
+export type SizeProps = 'mini' | 'small' | 'medium' | 'large';
+export type GenShowColumnOptions = {
+    isShowByComponent: boolean;
+    showOptColumn?: boolean;
+    showSeqNoColumn?: boolean;
+    showRecordStatus?: boolean;
+    pageProxy: PageProvideProxy;
+    columnActions?: Array<ComponentInstance>;
+    optColumnMaxInlineActions?: number;
+};
+/**
+ *  在查询列表中，用于用户操作的查询信息，如查询条件、选择的页码信息
+ */
+export type EntityFetchDataInfo = {
+    pageSize?: number;
+    pageNo?: number;
+    order?: Array<EntityReaderOrder>;
+    params?: Array<EntityReaderParam>;
+    pushedRecordKeys?: string[];
+    unPushedRecordKeys?: string[];
+};
+/**
+ * 构建fetchData的初始化props
+ */
+export type EntityFetchDataProps = {
+    entityName: string;
+    isSubForm: boolean;
+    subFormPidName: string;
+    foreignKeys?: Array<{
+        field: string;
+        referenceEntity: string;
+        referenceField: string;
+        alias: string;
+    }>;
+};
+export interface FilterType {
+    id: string;
+    name: string;
+    showOnToolbar: boolean;
+    displayMode?: 'toolbar' | 'dropdown' | 'tabs';
+    queryItemKvs: Array<QueryItemKv>;
+}
+/**
+ *  个性化配置
+ */
+export type MyEntityTableConfig = {
+    filters: FilterType[];
+    columnsConfig?: {
+        visibleColumns?: string[];
+        columnWidths?: Record<string, number>;
+        columnOrder?: string[];
+    };
+    layoutConfig?: {
+        layoutMode?: 'vertical' | 'horizontal';
+        queryCollapsed?: boolean;
+        size?: SizeProps;
+        splitSize?: string | number;
+    };
+    pivotConfig?: {
+        rows?: any[];
+        cols?: any[];
+        values?: any[];
+        chartType?: string;
+        version?: string;
+        configs?: Record<string, any>;
+        [key: string]: any;
+    };
+    statConfig?: {
+        groupFields?: string[];
+        version?: string;
+        [key: string]: any;
+    };
+};