@alifd/next/lib/table/api-schema.json

A configurable component library for web built on React.

{
  "name": "Table",
  "props": {
    "prefix": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "样式类名的品牌前缀",
      "defaultValue": {
        "value": "'next-'",
        "computed": false
      },
      "docblock": "样式类名的品牌前缀"
    },
    "tableLayout": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'fixed'",
            "computed": false
          },
          {
            "value": "'auto'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "表格元素的 table-layout 属性，设为 fixed 表示内容不会影响列的布局",
      "docblock": "表格元素的 table-layout 属性，设为 fixed 表示内容不会影响列的布局"
    },
    "tableWidth": {
      "type": {
        "name": "number"
      },
      "required": false,
      "description": "表格的总长度，可以这么用：设置表格总长度 、设置部分列的宽度，这样表格会按照剩余空间大小，自动其他列分配宽度",
      "docblock": "表格的总长度，可以这么用：设置表格总长度 、设置部分列的宽度，这样表格会按照剩余空间大小，自动其他列分配宽度"
    },
    "className": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "自定义类名",
      "docblock": "自定义类名"
    },
    "style": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义内联样式",
      "docblock": "自定义内联样式",
      "properties": []
    },
    "size": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'small'",
            "computed": false
          },
          {
            "value": "'medium'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "尺寸 small为紧凑模式",
      "defaultValue": {
        "value": "'medium'",
        "computed": false
      },
      "docblock": "尺寸 small为紧凑模式"
    },
    "dataSource": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "表格展示的数据源",
      "defaultValue": {
        "value": "[]",
        "computed": false
      },
      "docblock": "表格展示的数据源"
    },
    "onRowClick": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "点击表格每一行触发的事件",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "点击表格每一行触发的事件\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@param {Event} e DOM事件对象",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        },
        {
          "name": "e",
          "description": "DOM事件对象",
          "type": {
            "name": "Event"
          }
        }
      ],
      "returns": null
    },
    "onRowMouseEnter": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "悬浮在表格每一行的时候触发的事件",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "悬浮在表格每一行的时候触发的事件\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@param {Event} e DOM事件对象",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        },
        {
          "name": "e",
          "description": "DOM事件对象",
          "type": {
            "name": "Event"
          }
        }
      ],
      "returns": null
    },
    "onRowMouseLeave": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "离开表格每一行的时候触发的事件",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "离开表格每一行的时候触发的事件\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@param {Event} e DOM事件对象",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        },
        {
          "name": "e",
          "description": "DOM事件对象",
          "type": {
            "name": "Event"
          }
        }
      ],
      "returns": null
    },
    "onSort": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "点击列排序触发的事件",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "点击列排序触发的事件\n@param {String} dataIndex 指定的排序的字段\n@param {String} order 排序对应的顺序, 有`desc`和`asc`两种",
      "params": [
        {
          "name": "dataIndex",
          "description": "指定的排序的字段",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "order",
          "description": "排序对应的顺序, 有`desc`和`asc`两种",
          "type": {
            "name": "String"
          }
        }
      ],
      "returns": null
    },
    "onFilter": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "点击过滤确认按钮触发的事件",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "点击过滤确认按钮触发的事件\n@param {Object} filterParams 过滤的字段信息",
      "params": [
        {
          "name": "filterParams",
          "description": "过滤的字段信息",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "onResizeChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "重设列尺寸的时候触发的事件",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "重设列尺寸的时候触发的事件\n@param {String} dataIndex 指定重设的字段\n@param {Number} value 列宽变动的数值",
      "params": [
        {
          "name": "dataIndex",
          "description": "指定重设的字段",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "value",
          "description": "列宽变动的数值",
          "type": {
            "name": "Number"
          }
        }
      ],
      "returns": null
    },
    "rowProps": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "设置每一行的属性，如果返回值和其他针对行操作的属性冲突则无效。",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "设置每一行的属性，如果返回值和其他针对行操作的属性冲突则无效。\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@returns {Object} 需要设置的行属性",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        }
      ],
      "returns": {
        "description": "需要设置的行属性",
        "type": {
          "name": "Object"
        }
      }
    },
    "cellProps": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "设置单元格的属性，通过该属性可以进行合并单元格",
      "defaultValue": {
        "value": "() => {}",
        "computed": false
      },
      "docblock": "设置单元格的属性，通过该属性可以进行合并单元格\n@param {Number} rowIndex 该行所对应的序列\n@param {Number} colIndex 该列所对应的序列\n@param {String} dataIndex 该列所对应的字段名称\n@param {Object} record 该行对应的记录\n@returns {Object} 返回td元素的所支持的属性对象",
      "params": [
        {
          "name": "rowIndex",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        },
        {
          "name": "colIndex",
          "description": "该列所对应的序列",
          "type": {
            "name": "Number"
          }
        },
        {
          "name": "dataIndex",
          "description": "该列所对应的字段名称",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "record",
          "description": "该行对应的记录",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": {
        "description": "返回td元素的所支持的属性对象",
        "type": {
          "name": "Object"
        }
      }
    },
    "hasBorder": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表格是否具有边框",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "表格是否具有边框"
    },
    "hasHeader": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表格是否具有头部",
      "defaultValue": {
        "value": "true",
        "computed": false
      },
      "docblock": "表格是否具有头部"
    },
    "isZebra": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表格是否是斑马线",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "表格是否是斑马线"
    },
    "loading": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表格是否在加载中",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "表格是否在加载中"
    },
    "loadingComponent": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "自定义 Loading 组件\n请务必传递 props, 使用方式： loadingComponent={props => <Loading {...props}/>}",
      "docblock": "自定义 Loading 组件\n请务必传递 props, 使用方式： loadingComponent={props => <Loading {...props}/>}\n@param {LoadingProps} props 需要透传给组件的参数\n@return {React.ReactNode} 展示的组件",
      "params": [
        {
          "name": "props",
          "description": "需要透传给组件的参数",
          "type": {
            "name": "LoadingProps"
          }
        }
      ],
      "returns": {
        "description": "展示的组件",
        "type": {
          "name": "React.ReactNode"
        }
      }
    },
    "filterParams": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "当前过滤的的keys,使用此属性可以控制表格的头部的过滤选项中哪个菜单被选中,格式为 {dataIndex: {selectedKeys:[]}}\n示例:\n假设要控制dataIndex为id的列的过滤菜单中key为one的菜单项选中\n`<Table filterParams={{id: {selectedKeys: ['one']}}}/>`",
      "docblock": "当前过滤的的keys,使用此属性可以控制表格的头部的过滤选项中哪个菜单被选中,格式为 {dataIndex: {selectedKeys:[]}}\n示例:\n假设要控制dataIndex为id的列的过滤菜单中key为one的菜单项选中\n`<Table filterParams={{id: {selectedKeys: ['one']}}}/>`",
      "properties": []
    },
    "sort": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "当前排序的字段,使用此属性可以控制表格的字段的排序,格式为{[dataIndex]: 'asc' | 'desc' } , 例如  {id: 'desc'}",
      "docblock": "当前排序的字段,使用此属性可以控制表格的字段的排序,格式为{[dataIndex]: 'asc' | 'desc' } , 例如  {id: 'desc'}",
      "properties": []
    },
    "sortIcons": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义排序按钮，例如上下排布的: `{desc: <Icon style={{top: '6px', left: '4px'}} type={'arrow-down'} size=\"small\" />, asc: <Icon style={{top: '-6px', left: '4px'}} type={'arrow-up'} size=\"small\" />}`",
      "docblock": "自定义排序按钮，例如上下排布的: `{desc: <Icon style={{top: '6px', left: '4px'}} type={'arrow-down'} size=\"small\" />, asc: <Icon style={{top: '-6px', left: '4px'}} type={'arrow-up'} size=\"small\" />}`",
      "properties": []
    },
    "locale": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义国际化文案对象",
      "defaultValue": {
        "value": "zhCN.Table",
        "computed": true
      },
      "docblock": "自定义国际化文案对象\n@property {String} ok 过滤器中确认按钮文案\n@property {String} reset 过滤器中重置按钮文案\n@property {String} empty 没有数据情况下 table内的文案\n@property {String} asc 排序升序状态下的文案\n@property {String} desc 排序将序状态下的文案\n@property {String} expanded 可折叠行，展开状态下的文案\n@property {String} folded 可折叠行，折叠状态下的文案\n@property {String} filter 过滤器文案\n@property {String} selectAll header里全选的按钮文案",
      "properties": [
        {
          "name": "ok",
          "description": "过滤器中确认按钮文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "reset",
          "description": "过滤器中重置按钮文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "empty",
          "description": "没有数据情况下 table内的文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "asc",
          "description": "排序升序状态下的文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "desc",
          "description": "排序将序状态下的文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "expanded",
          "description": "可折叠行，展开状态下的文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "folded",
          "description": "可折叠行，折叠状态下的文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "filter",
          "description": "过滤器文案",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "selectAll",
          "description": "header里全选的按钮文案",
          "type": {
            "name": "String"
          }
        }
      ]
    },
    "columns": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "等同于写子组件 Table.Column ，子组件优先级更高",
      "docblock": "等同于写子组件 Table.Column ，子组件优先级更高"
    },
    "emptyContent": {
      "type": {
        "name": "node"
      },
      "required": false,
      "description": "设置数据为空的时候的表格内容展现",
      "docblock": "设置数据为空的时候的表格内容展现"
    },
    "primaryKey": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "symbol"
          },
          {
            "name": "string"
          }
        ]
      },
      "required": false,
      "description": "dataSource当中数据的主键，如果给定的数据源中的属性不包含该主键，会造成选择状态全部选中",
      "defaultValue": {
        "value": "'id'",
        "computed": false
      },
      "docblock": "dataSource当中数据的主键，如果给定的数据源中的属性不包含该主键，会造成选择状态全部选中"
    },
    "expandedRowRender": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "额外渲染行的渲染函数",
      "docblock": "额外渲染行的渲染函数\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@returns {Element} 渲染内容",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        }
      ],
      "returns": {
        "description": "渲染内容",
        "type": {
          "name": "Element"
        }
      }
    },
    "rowExpandable": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "设置行是否可展开，设置 false 为不可展开",
      "docblock": "设置行是否可展开，设置 false 为不可展开\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@returns {Boolean} 是否可展开",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        }
      ],
      "returns": {
        "description": "是否可展开",
        "type": {
          "name": "Boolean"
        }
      }
    },
    "expandedRowIndent": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "额外渲染行的缩进",
      "docblock": "额外渲染行的缩进"
    },
    "hasExpandedRowCtrl": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否显示点击展开额外渲染行的+号按钮",
      "docblock": "是否显示点击展开额外渲染行的+号按钮"
    },
    "getExpandedColProps": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "设置额外渲染行的属性",
      "docblock": "设置额外渲染行的属性\n@param {Object} record 该行所对应的数据\n@param {Number} index 该行所对应的序列\n@returns {Object} 额外渲染行的属性",
      "params": [
        {
          "name": "record",
          "description": "该行所对应的数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "index",
          "description": "该行所对应的序列",
          "type": {
            "name": "Number"
          }
        }
      ],
      "returns": {
        "description": "额外渲染行的属性",
        "type": {
          "name": "Object"
        }
      }
    },
    "openRowKeys": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "当前展开的 Expand行 或者 Tree行 , 传入此属性为受控状态，一般配合 onRowOpen 使用",
      "docblock": "当前展开的 Expand行 或者 Tree行 , 传入此属性为受控状态，一般配合 onRowOpen 使用"
    },
    "defaultOpenRowKeys": {
      "type": {
        "name": "array"
      },
      "required": false,
      "description": "默认情况下展开的 Expand行 或者 Tree行，非受控模式",
      "docblock": "默认情况下展开的 Expand行 或者 Tree行，非受控模式\n@version 1.23.22",
      "version": {
        "value": "1.23.22",
        "computed": false
      }
    },
    "onRowOpen": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "在 Expand行 或者 Tree行 展开或者收起的时候触发的事件",
      "docblock": "在 Expand行 或者 Tree行 展开或者收起的时候触发的事件\n@param {Array} openRowKeys 展开的渲染行的key\n@param {String} currentRowKey 当前点击的渲染行的key\n@param {Boolean} expanded 当前点击是展开还是收起\n@param {Object} currentRecord 当前点击额外渲染行的记录",
      "params": [
        {
          "name": "openRowKeys",
          "description": "展开的渲染行的key",
          "type": {
            "name": "Array"
          }
        },
        {
          "name": "currentRowKey",
          "description": "当前点击的渲染行的key",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "expanded",
          "description": "当前点击是展开还是收起",
          "type": {
            "name": "Boolean"
          }
        },
        {
          "name": "currentRecord",
          "description": "当前点击额外渲染行的记录",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "fixedHeader": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表头是否固定，该属性配合maxBodyHeight使用，当内容区域的高度超过maxBodyHeight的时候，在内容区域会出现滚动条",
      "docblock": "表头是否固定，该属性配合maxBodyHeight使用，当内容区域的高度超过maxBodyHeight的时候，在内容区域会出现滚动条"
    },
    "maxBodyHeight": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "number"
          },
          {
            "name": "string"
          }
        ]
      },
      "required": false,
      "description": "最大内容区域的高度,在`fixedHeader`为`true`的时候,超过这个高度会出现滚动条",
      "docblock": "最大内容区域的高度,在`fixedHeader`为`true`的时候,超过这个高度会出现滚动条"
    },
    "rowSelection": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "是否启用选择模式",
      "docblock": "是否启用选择模式\n@property {Function} getProps `Function(record, index)=>Object` 获取selection的默认属性\n@property {Function} onChange `Function(selectedRowKeys:Array, records:Array)` 选择改变的时候触发的事件，**注意:** 其中records只会包含当前dataSource的数据，很可能会小于selectedRowKeys的长度。\n@property {Function} onSelect `Function(selected:Boolean, record:Object, records:Array)` 用户手动选择/取消选择某行的回调\n@property {Function} onSelectAll `Function(selected:Boolean, records:Array)` 用户手动选择/取消选择所有行的回调\n@property {Array} selectedRowKeys 设置了此属性,将rowSelection变为受控状态,接收值为该行数据的primaryKey的值\n@property {String} mode 选择selection的模式, 可选值为`single`, `multiple`，默认为`multiple`\n@property {Function} columnProps `Function()=>Object` 选择列 的props，例如锁列、对齐等，可使用`Table.Column` 的所有参数\n@property {Function} titleProps `Function()=>Object` 选择列 表头的props，仅在 `multiple` 模式下生效\n@property {Function} titleAddons `Function()=>Node` 选择列 表头添加的元素，在`single` `multiple` 下都生效",
      "properties": [
        {
          "name": "getProps",
          "description": "`Function(record, index)=>Object` 获取selection的默认属性",
          "type": {
            "name": "Function"
          }
        },
        {
          "name": "onChange",
          "description": "`Function(selectedRowKeys:Array, records:Array)` 选择改变的时候触发的事件，**注意:** 其中records只会包含当前dataSource的数据，很可能会小于selectedRowKeys的长度。",
          "type": {
            "name": "Function"
          }
        },
        {
          "name": "onSelect",
          "description": "`Function(selected:Boolean, record:Object, records:Array)` 用户手动选择/取消选择某行的回调",
          "type": {
            "name": "Function"
          }
        },
        {
          "name": "onSelectAll",
          "description": "`Function(selected:Boolean, records:Array)` 用户手动选择/取消选择所有行的回调",
          "type": {
            "name": "Function"
          }
        },
        {
          "name": "selectedRowKeys",
          "description": "设置了此属性,将rowSelection变为受控状态,接收值为该行数据的primaryKey的值",
          "type": {
            "name": "Array"
          }
        },
        {
          "name": "mode",
          "description": "选择selection的模式, 可选值为`single`, `multiple`，默认为`multiple`",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "columnProps",
          "description": "`Function()=>Object` 选择列 的props，例如锁列、对齐等，可使用`Table.Column` 的所有参数",
          "type": {
            "name": "Function"
          }
        },
        {
          "name": "titleProps",
          "description": "`Function()=>Object` 选择列 表头的props，仅在 `multiple` 模式下生效",
          "type": {
            "name": "Function"
          }
        },
        {
          "name": "titleAddons",
          "description": "`Function()=>Node` 选择列 表头添加的元素，在`single` `multiple` 下都生效",
          "type": {
            "name": "Function"
          }
        }
      ]
    },
    "stickyHeader": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表头是否是sticky",
      "docblock": "表头是否是sticky"
    },
    "offsetTop": {
      "type": {
        "name": "number"
      },
      "required": false,
      "description": "距离窗口顶部达到指定偏移量后触发",
      "docblock": "距离窗口顶部达到指定偏移量后触发"
    },
    "affixProps": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "affix组件的的属性",
      "docblock": "affix组件的的属性",
      "properties": []
    },
    "indent": {
      "type": {
        "name": "number"
      },
      "required": false,
      "description": "在tree模式下的缩进尺寸， 仅在isTree为true时候有效",
      "docblock": "在tree模式下的缩进尺寸， 仅在isTree为true时候有效"
    },
    "isTree": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "开启Table的tree模式, 接收的数据格式中包含children则渲染成tree table",
      "docblock": "开启Table的tree模式, 接收的数据格式中包含children则渲染成tree table"
    },
    "useVirtual": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否开启虚拟滚动",
      "docblock": "是否开启虚拟滚动"
    },
    "scrollToRow": {
      "type": {
        "name": "number"
      },
      "required": false,
      "description": "滚动到第几行，需要保证行高相同。1.22.15 版本之前仅在虚拟滚动场景下生效，之后在所有情况下生效",
      "docblock": "滚动到第几行，需要保证行高相同。1.22.15 版本之前仅在虚拟滚动场景下生效，之后在所有情况下生效\n@version 1.22.15",
      "version": {
        "value": "1.22.15",
        "computed": false
      }
    },
    "onBodyScroll": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "在内容区域滚动的时候触发的函数",
      "docblock": "在内容区域滚动的时候触发的函数",
      "params": [],
      "returns": null
    },
    "expandedIndexSimulate": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "开启时，getExpandedColProps() / rowProps() / expandedRowRender() 的第二个参数 index (该行所对应的序列) 将按照01,2,3,4...的顺序返回，否则返回真实index(0,2,4,6... / 1,3,5,7...)",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "开启时，getExpandedColProps() / rowProps() / expandedRowRender() 的第二个参数 index (该行所对应的序列) 将按照01,2,3,4...的顺序返回，否则返回真实index(0,2,4,6... / 1,3,5,7...)"
    },
    "crossline": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "在 hover 时出现十字参考轴，适用于表头比较复杂，需要做表头分类的场景。",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "在 hover 时出现十字参考轴，适用于表头比较复杂，需要做表头分类的场景。"
    }
  },
  "methods": [],
  "subComponents": [
    {
      "name": "Column",
      "props": {
        "dataIndex": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "指定列对应的字段，支持`a.b`形式的快速取值",
          "docblock": "指定列对应的字段，支持`a.b`形式的快速取值"
        },
        "cell": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "element"
              },
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "行渲染的逻辑\nvalue, rowIndex, record, context四个属性只可读不可被更改\nFunction(value, index, record) => Element",
          "defaultValue": {
            "value": "value => value",
            "computed": false
          },
          "docblock": "行渲染的逻辑\nvalue, rowIndex, record, context四个属性只可读不可被更改\nFunction(value, index, record) => Element"
        },
        "title": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "element"
              },
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "表头显示的内容",
          "docblock": "表头显示的内容"
        },
        "htmlTitle": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "写到 header 单元格上的title属性",
          "docblock": "写到 header 单元格上的title属性"
        },
        "sortable": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否支持排序",
          "docblock": "是否支持排序"
        },
        "sortDirections": {
          "type": {
            "name": "arrayOf",
            "value": {
              "name": "enum",
              "value": [
                {
                  "value": "'desc'",
                  "computed": false
                },
                {
                  "value": "'asc'",
                  "computed": false
                },
                {
                  "value": "'default'",
                  "computed": false
                }
              ]
            }
          },
          "required": false,
          "description": "排序的方向。\n设置 ['desc', 'asc']，表示降序、升序\n设置 ['desc', 'asc', 'default']，表示表示降序、升序、不排序",
          "docblock": "排序的方向。\n设置 ['desc', 'asc']，表示降序、升序\n设置 ['desc', 'asc', 'default']，表示表示降序、升序、不排序\n@version 1.23",
          "version": {
            "value": "1.23",
            "computed": false
          }
        },
        "width": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "number"
              },
              {
                "name": "string"
              }
            ]
          },
          "required": false,
          "description": "列宽，注意在锁列的情况下一定需要配置宽度",
          "docblock": "列宽，注意在锁列的情况下一定需要配置宽度"
        },
        "align": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'left'",
                "computed": false
              },
              {
                "value": "'center'",
                "computed": false
              },
              {
                "value": "'right'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "单元格的对齐方式",
          "docblock": "单元格的对齐方式"
        },
        "alignHeader": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'left'",
                "computed": false
              },
              {
                "value": "'center'",
                "computed": false
              },
              {
                "value": "'right'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "单元格标题的对齐方式, 不配置默认读取align值",
          "docblock": "单元格标题的对齐方式, 不配置默认读取align值"
        },
        "filters": {
          "type": {
            "name": "arrayOf",
            "value": {
              "name": "shape",
              "value": {
                "label": {
                  "name": "string",
                  "required": false
                },
                "value": {
                  "name": "union",
                  "value": [
                    {
                      "name": "node"
                    },
                    {
                      "name": "string"
                    }
                  ],
                  "required": false
                }
              }
            }
          },
          "required": false,
          "description": "生成标题过滤的菜单, 格式为`[{label:'xxx', value:'xxx'}]`",
          "docblock": "生成标题过滤的菜单, 格式为`[{label:'xxx', value:'xxx'}]`"
        },
        "filterMode": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'single'",
                "computed": false
              },
              {
                "value": "'multiple'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "过滤的模式是单选还是多选",
          "defaultValue": {
            "value": "'multiple'",
            "computed": false
          },
          "docblock": "过滤的模式是单选还是多选"
        },
        "filterMenuProps": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "filter 模式下传递给 Menu 菜单的属性， 默认继承 `Menu` 组件的API",
          "defaultValue": {
            "value": "{\n    subMenuSelectable: false,\n}",
            "computed": false
          },
          "docblock": "filter 模式下传递给 Menu 菜单的属性， 默认继承 `Menu` 组件的API\n@property {Boolean} subMenuSelectable 默认为`false` subMenu是否可选择\n@property {Boolean} isSelectIconRight 默认为`false` 是否将选中图标居右。注意：SubMenu 上的选中图标一直居左，不受此API控制",
          "properties": [
            {
              "name": "subMenuSelectable",
              "description": "默认为`false` subMenu是否可选择",
              "type": {
                "name": "Boolean"
              }
            },
            {
              "name": "isSelectIconRight",
              "description": "默认为`false` 是否将选中图标居右。注意：SubMenu 上的选中图标一直居左，不受此API控制",
              "type": {
                "name": "Boolean"
              }
            }
          ]
        },
        "lock": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "bool"
              },
              {
                "name": "string"
              }
            ]
          },
          "required": false,
          "description": "是否支持锁列,可选值为`left`,`right`, `true`",
          "docblock": "是否支持锁列,可选值为`left`,`right`, `true`"
        },
        "resizable": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否支持列宽调整, 当该值设为true，table的布局方式会修改为fixed.",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否支持列宽调整, 当该值设为true，table的布局方式会修改为fixed."
        },
        "asyncResizable": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "（推荐使用）是否支持异步列宽调整, 当该值设为true，table的布局方式会修改为fixed.",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "（推荐使用）是否支持异步列宽调整, 当该值设为true，table的布局方式会修改为fixed.\n@version 1.24",
          "version": {
            "value": "1.24",
            "computed": false
          }
        },
        "colSpan": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "header cell 横跨的格数，设置为0表示不出现此 th",
          "docblock": "header cell 横跨的格数，设置为0表示不出现此 th"
        },
        "wordBreak": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'all'",
                "computed": false,
                "description": "all"
              },
              {
                "value": "'word'",
                "computed": false,
                "description": "word"
              }
            ]
          },
          "required": false,
          "description": "设置该列单元格的word-break样式，对于id类、中文类适合用all，对于英文句子适合用word",
          "docblock": "设置该列单元格的word-break样式，对于id类、中文类适合用all，对于英文句子适合用word\n@enumdesc all, word\n@default all\n@version 1.23",
          "value": [
            {
              "value": "'all'",
              "computed": false,
              "description": "all"
            },
            {
              "value": "'word'",
              "computed": false,
              "description": "word"
            }
          ],
          "defaultValue": {
            "value": "all",
            "computed": false
          },
          "version": {
            "value": "1.23",
            "computed": false
          }
        }
      },
      "methods": [],
      "order": 0
    },
    {
      "name": "ColumnGroup",
      "props": {
        "title": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "element"
              },
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "表头显示的内容",
          "defaultValue": {
            "value": "'column-group'",
            "computed": false
          },
          "docblock": "表头显示的内容"
        }
      },
      "methods": [],
      "order": 1
    },
    {
      "name": "GroupHeader",
      "props": {
        "cell": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "element"
              },
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "行渲染的逻辑",
          "defaultValue": {
            "value": "() => ''",
            "computed": false
          },
          "docblock": "行渲染的逻辑"
        },
        "hasChildrenSelection": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否在Children上面渲染selection",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否在Children上面渲染selection"
        },
        "hasSelection": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否在GroupHeader上面渲染selection",
          "defaultValue": {
            "value": "true",
            "computed": false
          },
          "docblock": "是否在GroupHeader上面渲染selection"
        },
        "useFirstLevelDataWhenNoChildren": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "当 dataSouce 里没有 children 时，是否使用内容作为数据",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "当 dataSouce 里没有 children 时，是否使用内容作为数据"
        }
      },
      "methods": [],
      "order": 2
    },
    {
      "name": "GroupFooter",
      "props": {
        "cell": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "element"
              },
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "行渲染的逻辑",
          "defaultValue": {
            "value": "() => ''",
            "computed": false
          },
          "docblock": "行渲染的逻辑"
        }
      },
      "methods": [],
      "order": 3
    }
  ]
}