# BsTable 文档

l

<template>
  <DocTable
    :table-data="tableData"
  />
</template>

<script>
  export default {
    data() {
      return {
        tableData: [
          {
            keyName: 'Props',
            desc: '参数',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'id',
                desc: '唯一标识(被某些特定的功能所依赖)',
                type: 'string',
                enum: '',
                defVal: 'TableGeneral',
                emc: ''
              },
              {
                keyName: 'loading',
                desc: '表格是否显示加载中',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'height',
                desc: '表格的高度;支持铺满父容器或者固定高度,如果设置 auto 为铺满父容器(如果设置为 auto,则必须确保存在父节点且不允许存在相邻元素)',
                type: 'number | string',
                enum: 'auto, %, px',
                defVal: 'auto',
                emc: ''
              },
              {
                keyName: 'showZero',
                desc: '当单元格内容为0时是否显示',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'defaultMoneyUnit',
                desc: '金额单位为元或万元',
                type: '',
                enum: '1, 10000',
                defVal: '1',
                emc: ''
              },
              {
                keyName: 'batchModifyFields',
                desc: '批量修改项字段',
                type: 'Array | boolean',
                enum: '',
                defVal: 'true',
                emc: ''
              },
              {
                keyName: 'highConfig',
                desc: '虚拟滚动配置',
                type: 'Object',
                enum: '',
                defVal: '',
                emc: '',
                children: [
                  {
                    keyName: 'scrollX',
                    desc: '横向虚拟滚动配置(不支持展开行)',
                    type: 'Object',
                    enum: '',
                    defVal: '继承 setup.table.scrollX',
                    emc: '',
                    children: [
                      {
                        keyName: 'enabled',
                        desc: '是否启用',
                        type: 'boolean',
                        enum: '',
                        defVal: 'true',
                        emc: ''
                      },
                      {
                        keyName: 'gt',
                        desc: '指定大于指定列时自动启动横向虚拟滚动,如果为 0 则总是启用;如果需要关闭,可以设置 enabled 为 false(注:启用横向虚拟滚动之后将不能支持分组表头)',
                        type: 'number',
                        enum: '',
                        defVal: '60',
                        emc: ''
                      },
                      {
                        keyName: 'oSize',
                        desc: '指定每次渲染的数据偏移量,偏移量越大渲染次数就越少,但每次渲染耗时就越久(对于低性能浏览器可以设置大一点,减低渲染次数)',
                        type: 'number',
                        enum: '',
                        defVal: '0',
                        emc: ''
                      }
                    ]
                  },
                  {
                    keyName: 'scroll-y',
                    desc: '纵向虚拟滚动配置(不支持展开行)',
                    type: 'Object',
                    enum: '',
                    defVal: '继承 setup.table.scrollY',
                    emc: '',
                    children: [
                      {
                        keyName: 'enabled',
                        desc: '是否启用',
                        type: 'boolean',
                        enum: '',
                        defVal: 'true',
                        emc: ''
                      },
                      {
                        keyName: 'mode',
                        desc: '滚动模式',
                        type: 'string',
                        enum: 'default,wheel',
                        defVal: 'default',
                        emc: ''
                      },
                      {
                        keyName: 'gt',
                        desc: '指定大于指定行时自动启动纵向虚拟滚动,如果为 0 则总是启用;如果需要关闭,可以设置 enabled 为 false(注:启用纵向虚拟滚动之后将不能支持动态行高)',
                        type: 'number',
                        enum: '',
                        defVal: '100',
                        emc: ''
                      },
                      {
                        keyName: 'oSize',
                        desc: '指定每次渲染的数据偏移量,偏移量越大渲染次数就越少,但每次渲染耗时就越久(对于低性能浏览器可以设置大一点,减低渲染次数)',
                        type: 'number',
                        enum: '',
                        defVal: '0',
                        emc: ''
                      }
                    ]
                  }
                ]
              },
              {
                keyName: 'keyboardConfig',
                desc: '按键配置项: 具体配置请移步vxe-grid查阅Props.keyboard-config',
                type: 'Object',
                enum: '',
                defVal: '{ isArrow: true, isDel: true, isEnter: true, isTab: true, isEdit: true }',
                emc: ''
              },
              {
                keyName: 'tableFormConfig',
                desc: '表单配置项: 具体配置请移步vxe-grid查阅Props.form-config',
                type: 'Object | boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'tableGlobalConfig',
                desc: 'BsTable表格全局配置项',
                type: 'Object',
                enum: '',
                defVal: '',
                emc: '',
                children: [
                  {
                    keyName: 'storage',
                    desc: '是否开启列设置缓存',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'stripe',
                    desc: '是否带有斑马纹(需要注意的是,在可编辑表格场景下,临时插入的数据不会有斑马纹样式)',
                    type: 'boolean',
                    enum: '',
                    defVal: '默认 false,继承 setup.table.stripe',
                    emc: ''
                  },
                  {
                    keyName: 'editable',
                    desc: '可编辑',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'resizable',
                    desc: '所有的列是否允许拖动列宽调整大小',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'align',
                    desc: '	所有的列对齐方式',
                    type: 'string',
                    enum: 'left | center | right',
                    defVal: 'center',
                    emc: ''
                  },
                  {
                    keyName: 'highlightCell',
                    desc: '只对 edit-config 配置时有效,是否在编辑时高亮单元格边框(只支持部分)',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'highlightCurrentRow',
                    desc: '是否要高亮当前行',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'showOverflow',
                    desc: '单行省略并显示提示文字',
                    type: 'String',
                    enum: '',
                    defVal: 'tooltip',
                    emc: ''
                  },
                  {
                    keyName: 'showHeaderOverflow',
                    desc: '头部单行省略并显示',
                    type: 'String',
                    enum: '',
                    defVal: 'tooltip',
                    emc: ''
                  },
                  {
                    keyName: 'showFooterOverflow',
                    desc: '尾部单行省略并显示',
                    type: 'String',
                    enum: '',
                    defVal: 'tooltip',
                    emc: ''
                  },
                  {
                    keyName: 'filterConfig',
                    desc: '表头过滤项配置: 具体配置请移步vxe-grid查阅Props.filter-config',
                    type: 'Object',
                    enum: '',
                    defVal: '{ showIcon: true }',
                    emc: ''
                  },
                  {
                    keyName: 'dragColumnsConfig',
                    desc: '列拖拽项配置',
                    type: 'Object',
                    enum: '',
                    defVal: '',
                    emc: '',
                    children: [
                      {
                        keyName: 'openDrag',
                        desc: '是否开启列拖拽',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      },
                      {
                        keyName: 'cacheStatus',
                        desc: '是否开启列拖拽后,对列顺序进行缓存',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      }
                    ]
                  },
                  {
                    keyName: 'exportConfig',
                    desc: '导出配置项: 具体配置请移步vxe-grid查阅Props.export-config',
                    type: 'Boolean, Object',
                    enum: '',
                    defVal: `{ filename: 'exportDowload', original: false, mode: 'current', type: 'xlsx', types: ['csv', 'xlsx'], columnFilterMethod(column, $columnIndex, ColumnConfigs) { // 导出过滤
                            let filterConlumsType = ['dragSort', 'seq', 'checkbox', 'radio', 'optionRow']
                            return filterConlumsType.indexOf(column.type) === -1
                          } }`,
                    emc: ''
                  },
                  {
                    keyName: 'tooltipConfig',
                    desc: 'tooltip 配置项: 具体配置请移步vxe-grid查阅Props.tooltip-config',
                    type: '',
                    enum: '',
                    defVal: '',
                    emc: ''
                  }
                ]
              },
              {
                keyName: 'tableConfig',
                desc: '表格渲染配置',
                type: 'Object',
                enum: '',
                defVal: '',
                emc: '',
                children: [
                  {
                    keyName: 'globalConfig',
                    desc: '全局默认渲染列配置',
                    type: 'Object',
                    enum: '',
                    defVal: '',
                    emc: '',
                    children: [
                      {
                        keyName: 'checkType',
                        desc: '是否显示checkbox列 | radio列',
                        type: 'string',
                        enum: 'checkbox | radio | false',
                        defVal: 'checkbox',
                        emc: ''
                      },
                      {
                        keyName: 'seq',
                        desc: '是否显示序号列',
                        type: 'boolean',
                        enum: '',
                        defVal: 'true',
                        emc: ''
                      },
                      {
                        keyName: 'rowDrop',
                        desc: '行拖动',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      },
                      {
                        keyName: 'cellClickCheck',
                        desc: '行点击选中【只对checkType=radio有效】',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      },
                      {
                        keyName: 'optionSort',
                        desc: '可对表格行上移下移置顶等',
                        type: 'boolean',
                        enum: '',
                        defVal: 'false',
                        emc: ''
                      }
                    ]
                  },
                  {
                    keyName: 'renderers',
                    desc: '自定义渲染器【不推荐使用,如果要用因为重名覆盖原因,切记全局渲染器名称要唯一,建议起名时  模块名+OperateBtns 比如:AccountOperateBtns】',
                    type: 'Object',
                    enum: '',
                    defVal: '{渲染器名: 渲染器内容}',
                    emc: ''
                  },
                  {
                    keyName: 'methods',
                    desc: '操作列按钮或工具栏按钮点击时的回掉事件',
                    type: 'Object',
                    enum: '',
                    defVal: `{ onOptionRowClick: function(obj, $event) { }, toolbarButtonClickEvent: function(obj, $event) { } }`,
                    emc: '',
                    children: [
                      {
                        keyName: 'onOptionRowClick',
                        desc: '操作列按钮点击时的回掉事件',
                        type: 'Function',
                        enum: '',
                        defVal: '',
                        emc: ''
                      },
                      {
                        keyName: 'toolbarButtonClickEvent',
                        desc: '工具栏按钮点击时的回掉事件',
                        type: 'Function',
                        enum: '',
                        defVal: '',
                        emc: ''
                      }
                    ]
                  }
                ]
              },
              {
                keyName: 'batchModifyFields',
                desc: '表格支持批量修改的列Field',
                type: 'Array | boolean',
                enum: '',
                defVal: 'true',
                emc: ''
              },
              {
                keyName: 'toolbarConfig',
                desc: '表格上方工具栏配置',
                type: 'Object | false',
                enum: '',
                defVal: '',
                emc: '',
                children: [
                  {
                    keyName: 'reverseCheck',
                    desc: '是否显示反选按钮操作',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'moneyInputSwich',
                    desc: '表格内金额是否随着金额单位切换而转换',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'batchModify',
                    desc: '是否显示批量修改',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'yearlist',
                    desc: '是否显示年份下拉选择按钮',
                    type: 'Array',
                    enum: '',
                    defVal: '[]',
                    emc: ''
                  },
                  {
                    keyName: 'disabledMoneyConversion',
                    desc: '在显示金额元和万元单位切换按钮时,是否禁用',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'moneyConversion',
                    desc: '是否显示金额元和万元单位切换按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'search',
                    desc: '是否显示search',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'calculator',
                    desc: '是否显示计算按钮【此功能还在开发中,建议置为false】',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'refresh',
                    desc: '是否显示刷新按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'import',
                    desc: '是否显示导入按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'export',
                    desc: '是否显示导出按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'print',
                    desc: '是否显示打印按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'zoom',
                    desc: '是否显示缩放按钮',
                    type: 'boolean',
                    enum: '',
                    defVal: 'true',
                    emc: ''
                  },
                  {
                    keyName: 'slots',
                    desc: '插槽',
                    type: 'Object',
                    enum: '',
                    defVal: "{ tools: 'toolbarTools' }",
                    emc: '',
                    children: [
                      {
                        keyName: 'buttons',
                        desc: '按钮列表',
                        type: 'string | ((params, h) => any[])',
                        enum: '',
                        defVal: '{}, h',
                        emc: ''
                      },
                      {
                        keyName: 'tools',
                        desc: '右侧工具列表',
                        type: 'string | ((params, h) => any[])',
                        enum: '',
                        defVal: '{}, h',
                        emc: ''
                      }
                    ]
                  }
                ]
              },
              {
                keyName: 'pagerConfig',
                desc: '分页配置项: 具体配置请移步vxe-grid查阅Props.pager-config',
                type: 'Object | false',
                enum: '',
                defVal: `{ total: 0, currentPage: 1, pageSize: 20, align: 'right' }`,
                emc: ''
              },
              {
                keyName: 'tableColumnsConfig',
                desc: '表头配置: 具体配置请查阅各个渲染器配置 并 结合vxe-grid查阅Props.columns',
                type: '[{}]',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'tableData',
                desc: '表格数据(与 loadData 行为一致,更新数据是不会重置状态)',
                type: 'Array',
                enum: '',
                defVal: '[]',
                emc: ''
              },
              {
                keyName: 'editConfig',
                desc: '编辑配置: 具体配置请移步vxe-grid查阅Props.edit-config',
                type: 'Object | false',
                enum: '',
                defVal: '默认支持表格可编辑,具体是否可编辑根据列配置 | 当 { editConfig: false } 或 {editConfig: { editable: false }} 时不可编辑',
                emc: ''
              },
              {
                keyName: 'editRules',
                desc: '校验规则配置项: 具体配置请移步vxe-grid查阅Props.edit-rules',
                type: '[{}]',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'expandConfig',
                desc: '展开行配置(不能用于虚拟滚动): 具体配置请移步vxe-grid查阅Props.expand-config',
                type: 'Object | false',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'footerConfig',
                desc: '表尾配置',
                type: 'Object',
                enum: '',
                defVal: '{ showFooter: false }',
                emc: '',
                children: [
                  {
                    keyName: 'showFooter',
                    desc: '是否显示表尾',
                    type: 'boolean',
                    enum: '',
                    defVal: 'false',
                    emc: ''
                  },
                  {
                    keyName: 'combinedType',
                    desc: '显示哪些合计行类型,注意顺序',
                    type: 'array',
                    enum: '',
                    defVal: `['subTotal', 'total', 'totalAll', 'switchTotal']`,
                    emc: ''
                  },
                  {
                    keyName: 'footerMethod',
                    desc: '表尾的数据获取方法,返回一个二维数组',
                    type: 'Function',
                    enum: '',
                    defVal: '',
                    emc: ''
                  },
                  {
                    keyName: 'footerSpanMethod',
                    desc: '表尾合并行或列,返回计算后的值 (不能用于虚拟滚动、展开行,不建议用于固定列、树形结构)',
                    type: 'Object',
                    enum: '',
                    defVal: '',
                    emc: ''
                  }
                ]
              },
              {
                keyName: 'treeConfig',
                desc: '树形结构配置项(不能用于虚拟滚动): 具体配置请移步vxe-grid查阅Props.tree-config',
                type: 'Object, false',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'loading',
                desc: '表格是否显示加载中',
                type: 'boolean',
                enum: '',
                defVal: 'false',
                emc: ''
              },
              {
                keyName: 'contextMenuConfig: 具体配置请移步vxe-grid查阅Props.context-menu',
                desc: 'Object | false',
                type: '',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'radioConfig',
                desc: '单选框配置项: 具体配置请移步vxe-grid查阅Props.radio-config',
                type: 'Object',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'checkboxConfig',
                desc: '复选框配置项: 具体配置请移步vxe-grid查阅Props.checkbox-config',
                type: 'Object',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'tableRowClass',
                desc: '给行附加 className',
                type: 'String, Function',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'cellClassName',
                desc: '给单元格附加 className',
                type: 'String, Function',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'rowStyle',
                desc: '给行附加样式,也可以是函数',
                type: 'String, Function',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'cellStyle',
                desc: '给单元格附加样式',
                type: 'String, Function',
                enum: '',
                defVal: '{}',
                emc: ''
              },
              {
                keyName: 'calculateConstraintConfig',
                desc: '计算和约束配置',
                type: 'Object',
                enum: '',
                defVal: '{}',
                emc: '',
                children: [
                  {
                    keyName: 'rowformulaConfig',
                    desc: '行公式配置',
                    type: 'Object',
                    enum: '',
                    defVal: '{}',
                    emc: ''
                  },
                  {
                    keyName: 'rowCodeFormulaConfig',
                    desc: '单元格交叉计算',
                    type: 'Object',
                    enum: '',
                    defVal: '{}',
                    emc: ''
                  },
                  {
                    keyName: 'colFormulaConfig',
                    desc: '列公式配置',
                    type: 'Object',
                    enum: '',
                    defVal: '{}',
                    emc: ''
                  },
                  {
                    keyName: 'constraintConfig',
                    desc: '表间约束配置',
                    type: 'Object',
                    enum: '',
                    defVal: '{}',
                    emc: ''
                  }
                ]
              },
              {
                keyName: 'scrollLoadConfig',
                desc: '滚动配置项',
                type: 'Object',
                enum: '',
                defVal: '{ tatal: 0, currentPage: 1, enabled: true, curGt: 100,  gt: 100, pageSize: 100, loadData: function(){} }',
                emc: ''
              }
            ]
          },
          {
            keyName: 'Slots',
            desc: '插槽',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'toolbarSlots',
                desc: `工具栏内容区域, 注意:如果要用这个插槽,需要在toolbarConfig里添加 slots: { buttons: 'toolbarSlots' }, 否则不显示`,
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'toolbarTools',
                desc: '工具栏内容区域',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              }
            ]
          },
          {
            keyName: 'Events',
            desc: '事件',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'columnDrag',
                desc: '当列被拖拽后触发的事件',
                type: '',
                enum: '',
                defVal: 'tableColumn',
                emc: ''
              },
              {
                keyName: 'checkboxChange',
                desc: '只对 type=checkbox 有效,当手动勾选并且值发生改变时触发的事件',
                type: '',
                enum: '',
                defVal: '{ records, reserves, indeterminates, checked, row, rowIndex, $rowIndex, column, columnIndex, $columnIndex, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'checkboxAll',
                desc: '只对 type=checkbox 有效,当手动勾选全选时触发的事件',
                type: '',
                enum: '',
                defVal: '{ records, reserves, indeterminates, checked, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'radioChange',
                desc: '只对 type=radio 有效,当手动勾选并且值发生改变时触发的事件',
                type: '',
                enum: '',
                defVal: '{ row, rowIndex, $rowIndex, column, columnIndex, $columnIndex, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'editClosed',
                desc: '只对 edit-config 配置时有效,单元格编辑状态下被关闭时会触发该事件',
                type: '',
                enum: '',
                defVal: '{ row, rowIndex, $rowIndex, column, columnIndex, $columnIndex }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'editActived',
                desc: '只对 edit-config 配置时有效,单元格被激活编辑时会触发该事件',
                type: '',
                enum: '',
                defVal: '{ row, rowIndex, $rowIndex, column, columnIndex, $columnIndex }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'keydown',
                desc: '当表格被激活且键盘被按下时会触发的事件',
                type: '',
                enum: '',
                defVal: 'obj, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'currentChange',
                desc: '	只对 highlightCurrentRow 有效,当手动选中行并且值发生改变时触发的事件',
                type: '',
                enum: '',
                defVal: '{ row, rowIndex, $rowIndex, column, columnIndex, $columnIndex, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'cellClick',
                desc: '单元格被点击时会触发该事件',
                type: '',
                enum: '',
                defVal: '{ row, rowIndex, $rowIndex, column, columnIndex, $columnIndex, triggerRadio, triggerCheckbox, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'cellDblclick',
                desc: '单元格被双击时会触发该事件',
                type: '',
                enum: '',
                defVal: '{ row, rowIndex, $rowIndex, column, columnIndex, $columnIndex, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'ajaxData',
                desc: '只对 pager-config 配置时有效,分页发生改变时会触发该事件',
                type: '',
                enum: '',
                defVal: '{ params, currentPage, pageSize }, $event',
                emc: ''
              },
              {
                keyName: 'onToolbarBtnClick',
                desc: '只对 toolbar.buttons 配置时有效,当工具栏的按钮被点击时会后触发该事件',
                type: '',
                enum: '',
                defVal: 'obj, $event',
                emc: ''
              },
              {
                keyName: 'scroll',
                desc: '表格滚动时会触发该事件',
                type: '',
                enum: '',
                defVal: '{ type, scrollTop, scrollLeft, isX, isY, $event }, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'onOptionRowClick',
                desc: '操作列点击事件',
                type: '',
                enum: '',
                defVal: 'obj, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'triggerReverseCheck',
                desc: '当点击反选时触发的事件',
                type: '',
                enum: '',
                defVal: '{ records }, $event',
                emc: ''
              },
              {
                keyName: 'importSuccessCallback',
                desc: '当点击导入,导入成功后出触发的事件',
                type: '',
                enum: '',
                defVal: 'obj',
                emc: ''
              },
              {
                keyName: 'cellOptionCallBack',
                desc: '渲染器回调事件',
                type: '',
                enum: '',
                defVal: 'params, obj, $event, gridContext',
                emc: ''
              },
              {
                keyName: 'onBatchModifyItemChange',
                desc: '当批量修改时触发的事件',
                type: '',
                enum: '',
                defVal: 'obj, modifyForm',
                emc: ''
              }
            ]
          },
          {
            keyName: 'Methods',
            desc: '方法',
            type: '',
            enum: '',
            defVal: '',
            emc: '',
            children: [
              {
                keyName: 'triggerReverseCheck',
                desc: '反选',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'tableOptionFn',
                desc: '返回xgrid实例',
                type: '',
                enum: '',
                defVal: 'gridContext',
                emc: ''
              },
              {
                keyName: 'updateFooter',
                desc: '更新表尾',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'updateData',
                desc: '刷新数据',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'exportData',
                desc: '导出数据',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'importDataEvent',
                desc: '导入数据',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'setAllCheckboxRow',
                desc: '设置所有选中',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'clearCheckboxRow',
                desc: '清除所有选中',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'removeCheckboxRow',
                desc: '删除选中行操作',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'revertEvent',
                desc: '撤销操作',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'deleteRowData',
                desc: '删除选中行操作',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'reLoadTable',
                desc: '重加载表格,包括表头和表体',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'reLoadTableData',
                desc: '重加载表格数据不包含表头',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'refreshTable',
                desc: '刷新表格',
                type: '',
                enum: '',
                defVal: `data | ''`,
                emc: ''
              },
              {
                keyName: 'reloadTableConlums',
                desc: '重加载表头',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'clearDataRenderField',
                desc: '删除viewSort字段',
                type: '',
                enum: '',
                defVal: 'data',
                emc: ''
              },
              {
                keyName: 'getTableData',
                desc: '获取表格数据',
                type: '',
                enum: '',
                defVal: '返回:{ combinedData, keepSource, tableSourceData, fullData, visibleData, tableData, footerData, tableColumnsConfig, selection, editRules, insertRecords, removeRecords, updateRecords }',
                emc: ''
              },
              {
                keyName: 'getPureTableData',
                desc: '获取表格纯净数据',
                type: '',
                enum: '',
                defVal: '返回:{combinedData, keepSource, tableSourceData, fullData, visibleData, tableData, footerData, tableColumnsConfig, selection, editRules, listData, insertRecords, updateRecords, removeRecords}',
                emc: ''
              },
              {
                keyName: 'getOptionData',
                desc: '获取表格数据集(获取插入、删除、更改的数据,对于增删改查表格非常方便)',
                type: '',
                enum: '',
                defVal: '{insertRecords, removeRecords, updateRecords}',
                emc: ''
              },
              {
                keyName: 'getInsertRowData',
                desc: '用于 edit-config,获取插入的临时数据',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'getSelectionData',
                desc: '用于 type=checkbox,获取当前已选中的行数据(当前列表,如果 isFull=true 则获取全表已选中的数据)',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'getData',
                desc: '	获取数据,和 data 的行为一致,也可以指定索引获取数据',
                type: 'Array',
                enum: '',
                defVal: 'rowIndex?: number',
                emc: ''
              },
              {
                keyName: 'validate',
                desc: '校验',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'copySelectionRowData',
                desc: '复制选中行数据',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'copyRowData',
                desc: '复制行',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'insertRowData',
                desc: '新增行',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'getbasicDataType',
                desc: '获取数据类型',
                type: 'obj',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'hyphenate',
                desc: '小驼峰转成连字符',
                type: 'string',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'smallHump',
                desc: '连字符转成小驼峰',
                type: 'string',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'deepCopy',
                desc: '深拷贝通用方法',
                type: 'object',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: 'accurateJiafa',
                desc: '精确加法',
                type: '',
                enum: '',
                defVal: 'num1, num2',
                emc: ''
              },
              {
                keyName: 'accurateJianfa',
                desc: '精确减法',
                type: '',
                enum: '',
                defVal: 'num1, num2',
                emc: ''
              },
              {
                keyName: 'accurateChuFa',
                desc: '精确除法',
                type: '',
                enum: '',
                defVal: 'num1, num2',
                emc: ''
              },
              {
                keyName: 'accurateChengFa',
                desc: '精确乘法',
                type: '',
                enum: '',
                defVal: 'num1, num2',
                emc: ''
              },
              {
                keyName: 'transToNumberLocalString',
                desc: '返回逗号隔开千分位的数字',
                type: '',
                enum: '',
                defVal: 'number, digits',
                emc: ''
              },
              {
                keyName: 'digitUppercase',
                desc: '输出的中文金额字符串',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              },
              {
                keyName: '...',
                desc: '其它方法: 参考vxe-grid的Methods, 可以通过tableOptionFn获取vxe-grid实例后,直接使用vxe-grid的Methods方法',
                type: '',
                enum: '',
                defVal: '',
                emc: ''
              }
            ]
          }
        ]
      }
    }
  }
</script>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
Expand Copy