@opentiny/vue-docs 1.0.0

package/resources/pc/api/zh-CN/grid-table.json

@@ -0,0 +1,1368 @@
+{
+  "attrs": [
+    {
+      "name": "pager",
+      "sample": "grid-pager#pager-inner-pager",
+      "type": "Object",
+      "desc": "设置分页配置项。通过 pager 的属性 {component: Pager} 注入分页组件，{attrs：{currentPage: 1,pageSize: 5,pageSizes: [5, 10], total: 0,layout: 'total, prev, pager, next, jumper, sizes'}}配置分页",
+      "defaultValue": ""
+    },
+    {
+      "name": "fetch-data",
+      "sample": "grid-data-source#tiny-first-menu-request-service",
+      "type": "Object",
+      "desc": "服务端数据查询方法",
+      "defaultValue": ""
+    },
+    {
+      "name": "save-data",
+      "sample": "grid-toolbar#tiny-first-menu-save-data",
+      "type": "Object",
+      "desc": "服务端数据保存方法",
+      "defaultValue": ""
+    },
+    {
+      "name": "delete-data",
+      "sample": "",
+      "type": "Object",
+      "desc": "服务端数据删除方法",
+      "defaultValue": ""
+    },
+    {
+      "name": "row-group",
+      "sample": "grid-row-grouping#row-grouping",
+      "type": "Object",
+      "desc": "设置行分组",
+      "defaultValue": ""
+    },
+    {
+      "name": "toolbar",
+      "sample": "",
+      "type": "Object",
+      "desc": "工具栏配置",
+      "defaultValue": ""
+    },
+    {
+      "name": "align",
+      "sample": "grid-align#align-grid-align-left-grid-align",
+      "type": "String",
+      "desc": "所有的列对其方式;该属性的可选值为 left（左对其）, center（居中对其）, right（右对齐）",
+      "defaultValue": "该属性的默认值为 left"
+    },
+    {
+      "name": "auto-resize",
+      "sample": "grid-width-height#tiny-first-menu-adaptive-grid-width-height",
+      "type": "Boolean",
+      "desc": "父元素响应式监听（对于父元素可能存在动态变化的场景可能会用到）",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "border",
+      "sample": "grid-grid-border#tiny-first-menu-grid-border",
+      "type": "Boolean",
+      "desc": "是否带有纵向边框",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "cell-class-name",
+      "sample": "grid-custom-style#custom-style-cell-style",
+      "type": "String, Function",
+      "desc": "给单元格附加 className，也可以是函数 Function({seq, row, rowIndex, $rowIndex, column, columnIndex, $columnIndex})",
+      "defaultValue": ""
+    },
+    {
+      "name": "column-key",
+      "sample": "grid-operation-column#tiny-first-menu-column-key",
+      "type": "Boolean",
+      "desc": "是否需要为每一列的 VNode 设置 key 属性（非特殊情况下不需要使用）",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "column-min-width",
+      "sample": "grid-width-height#tiny-first-menu-column-min-width",
+      "type": "Number , String",
+      "desc": "设置可以调整到的最小宽度，不设置时默认为列头 span 的宽度 + 36（头部固定宽度）。 ;所有最小列宽度；会自动将剩余空间按比例分配;该属性的可选值为 整数, px，%",
+      "defaultValue": ""
+    },
+    {
+      "name": "column-width",
+      "sample": "grid-width-height#tiny-first-menu-column-width",
+      "type": "Number, String",
+      "desc": "所有列宽度;该属性的可选值为 整数, px，%",
+      "defaultValue": "该属性的默认值为 默认均匀分配"
+    },
+    {
+      "name": "context-menu",
+      "sample": "grid-context-menu#grid_Example-shortcutMenu-footer-menu",
+      "type": "Object",
+      "desc": "快捷菜单配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "edit-rules",
+      "sample": "grid-validation#grid_Example-gridValid-editing-validation",
+      "type": "Object",
+      "desc": "校验规则配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "expand-config",
+      "sample": "grid-tree-grid#tree-table-tree-grid-expand-config",
+      "type": "Object",
+      "desc": "展开行配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "fit",
+      "sample": "grid-width-height#tiny-first-menu-adaptive-column-width",
+      "type": "Boolean",
+      "desc": "所有列的宽度是否自撑开",
+      "defaultValue": "该属性的默认值为 true"
+    },
+    {
+      "name": "footer-align",
+      "sample": "grid-align#align-footer-align-left-footer-align",
+      "type": "String",
+      "desc": "所有的表尾列的对齐方式;该属性的可选值为 left（左对其）, center（居中对其）, right（右对齐）",
+      "defaultValue": "该属性的默认值为 继承 align"
+    },
+    {
+      "name": "optimization",
+      "sample": "grid-grid-optimization#tiny-first-menu-grid-optimization",
+      "type": "Object",
+      "desc": "优化配置项",
+      "defaultValue": "该属性的默认值为 { animat: true, delayHover: 250, scrollX: { gt: 100 }, scrollY: { gt: 500 }"
+    },
+    {
+      "name": "params",
+      "sample": "",
+      "type": "Object",
+      "desc": "额外的参数",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-cell-class-name",
+      "sample": "grid-custom-style#custom-style-footer-style-footer-cell-style",
+      "type": "String, Function",
+      "desc": "给表尾的单元格附加 className，也可以是函数 Function({$rowIndex, column, columnIndex, $columnIndex})",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-method",
+      "sample": "grid-summary#summary-custom-summary",
+      "type": "Function",
+      "desc": "表尾合计的计算方法 Function({columns, data})",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-row-class-name",
+      "sample": "grid-custom-style#custom-style-footer-style-footer-cell-style",
+      "type": "String, Function",
+      "desc": "给表尾的行附加 className，也可以是函数 Function({$rowIndex})",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-span-method",
+      "sample": "grid-footer#footer-footer-row-or-column-span",
+      "type": "Object",
+      "desc": "表尾合并行或列，该函数 Function({$rowIndex, column, columnIndex, $columnIndex, data}) 返回计算后的值",
+      "defaultValue": "该属性的默认值为 { rowspan: 1, colspan: 1}"
+    },
+    {
+      "name": "header-align",
+      "sample": "grid-align#align-header-align-left-header-align",
+      "type": "String",
+      "desc": "所有的表头列的对齐方式;该属性的可选值为 left（左对其）, center（居中对其）, right（右对齐）",
+      "defaultValue": "该属性的默认值为 继承 align"
+    },
+    {
+      "name": "header-cell-class-name",
+      "sample": "grid-custom-style#custom-style-header-style-header-cell-style",
+      "type": "String, Function",
+      "desc": "给表头的单元格附加 className，也可以是函数 Function({$rowIndex, column, columnIndex, $columnIndex})",
+      "defaultValue": ""
+    },
+    {
+      "name": "header-row-class-name",
+      "sample": "grid-custom-style#custom-style-header-style-header-cell-style",
+      "type": "String, Function",
+      "desc": "给表头的行附加 className，也可以是函数 Function({$rowIndex})",
+      "defaultValue": ""
+    },
+    {
+      "name": "height",
+      "sample": "grid-width-height#tiny-first-menu-fixed-grid-height",
+      "type": "Number , String",
+      "desc": "设置表格内容区域（不含表格头部，底部）的高度。 不设置时，表格内容区域的高度度自适应。 ;表格的高度；支持铺满父容器或者固定宽高;该属性的可选值为 整数, px，%",
+      "defaultValue": ""
+    },
+    {
+      "name": "highlight-cell",
+      "sample": "grid-highlight#highlight-highlight-cell",
+      "type": "Boolean",
+      "desc": "只对 editConfig 配置时有效，是否在编辑时高亮单元格边框",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "highlight-current-column",
+      "sample": "grid-highlight#highlight-highlight-current-column",
+      "type": "Boolean",
+      "desc": "是否要高亮当前列",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "highlight-current-row",
+      "sample": "grid-highlight#highlight-highlight-current-row",
+      "type": "Boolean",
+      "desc": "是否要高亮当前行",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "highlight-hover-column",
+      "sample": "grid-highlight#highlight-highlight-hover-column",
+      "type": "Boolean",
+      "desc": "鼠标移到列是否要高亮显示",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "highlight-hover-row",
+      "sample": "grid-highlight#highlight-highlight-hover-row",
+      "type": "Boolean",
+      "desc": "鼠标移到行是否要高亮显示",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "keyboard-config",
+      "sample": "grid-tree-grid#tree-table-tree-grid-keyboard-operation",
+      "type": "Object",
+      "desc": "按键配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "loading",
+      "sample": "grid-grid-loading-tip#tiny-first-menu-grid-loading-off-tip",
+      "type": "Boolean",
+      "desc": "表格是否显示加载中",
+      "defaultValue": "该属性的默认值为 true"
+    },
+    {
+      "name": "max-height",
+      "sample": "grid-width-height#tiny-first-menu-min-grid-height",
+      "type": "Number , String",
+      "desc": "设置表格内容区域（不含表格头部，底部）的最大高度。;该属性的可选值为 整数, px，%",
+      "defaultValue": ""
+    },
+    {
+      "name": "mouse-config",
+      "sample": "grid-keyboard#mouse-config",
+      "type": "Object",
+      "desc": "鼠标配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "radio-config",
+      "sample": "grid-operation-column#tiny-first-menu-default-serial-column",
+      "type": "Object",
+      "desc": "单选框配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "remote-filter",
+      "sample": "grid-filter#filter-server-filter",
+      "type": "Boolean",
+      "desc": "所有列是否使用服务端筛选，如果设置为 true 则不会对数据进行处理",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "remote-sort",
+      "sample": "grid-filter#filter-server-filter",
+      "type": "Boolean",
+      "desc": "是否将服务端的全部数据进行排序。默认为 false 不进行服务端排序。",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "resizable",
+      "sample": "grid-width-height#tiny-first-menu-resize-column-width",
+      "type": "Boolean",
+      "desc": "设置是否允许调整列宽",
+      "defaultValue": "该属性的默认值为 true"
+    },
+    {
+      "name": "row-class-name",
+      "sample": "grid-custom-style#custom-style-row-style",
+      "type": "String, Function",
+      "desc": "给行附加 className，也可以是函数 Function({seq, row, rowIndex, $rowIndex})",
+      "defaultValue": ""
+    },
+    {
+      "name": "row-id",
+      "sample": "",
+      "type": "String",
+      "desc": "自定义行数据唯一主键的字段名（行数据必须要有唯一主键，默认自动生成）",
+      "defaultValue": "该属性的默认值为 _XID"
+    },
+    {
+      "name": "row-key",
+      "sample": "",
+      "type": "Boolean",
+      "desc": "是否需要为每一行的 VNode 设置 key 属性（非特殊情况下没必要设置）",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "select-config",
+      "sample": "grid-tree-grid#tree-table-tree-grid-operation-column",
+      "type": "Object",
+      "desc": "复选框配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "show-footer",
+      "sample": "grid-summary#summary-custom-summary",
+      "type": "Boolean",
+      "desc": "是否显示表尾合计",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "show-header",
+      "sample": "grid-header#header-hide-grid-header",
+      "type": "Boolean",
+      "desc": "是否显示表头",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "show-header-overflow",
+      "sample": "grid-tip#tip-column-header-tip",
+      "type": "Boolean, String",
+      "desc": "设置表头所有内容过长时显示为省略号;该属性的可选值为 ellipsis（只显示省略号）,title（并且显示为原生 title）,tooltip（并且显示为 tooltip 提示）",
+      "defaultValue": ""
+    },
+    {
+      "name": "show-overflow",
+      "sample": "grid-tip#tip-cell-tip",
+      "type": "Boolean, String",
+      "desc": "设置所有内容过长时显示为省略号（如果是固定列建议设置该值，提升渲染速度）;该属性的可选值为 ellipsis（只显示省略号）,title（并且显示为原生 title）,tooltip（并且显示为 tooltip 提示）",
+      "defaultValue": ""
+    },
+    {
+      "name": "size",
+      "sample": "grid-grid-size#tiny-first-menu-grid-size",
+      "type": "String",
+      "desc": "表格的尺寸;该属性的可选值为 medium, small, mini",
+      "defaultValue": ""
+    },
+    {
+      "name": "sort-config",
+      "sample": "grid-sort#sort-default-sort",
+      "type": "Object",
+      "desc": "排序配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "sort-method",
+      "sample": "grid-sort#sort-custom-sort",
+      "type": "Function",
+      "desc": "自定义所有列的排序方法，当触发排序时会调用该函数 Function({ data, column, property, order  }) 返回排序后的结果",
+      "defaultValue": ""
+    },
+    {
+      "name": "span-method",
+      "sample": "grid-span#span-column-span",
+      "type": "Object",
+      "desc": "合并行或列，该函数 Function({seq, row, rowIndex, $rowIndex, column, columnIndex, $columnIndex, data}) 返回计算后的值",
+      "defaultValue": "该属性的默认值为 { rowspan: 1, colspan: 1}"
+    },
+    {
+      "name": "start-index",
+      "sample": "grid-serial-column#tiny-first-menu-custom-serial-column",
+      "type": "Number",
+      "desc": "只对 type=index 的列有效，动态索引的起始值",
+      "defaultValue": "该属性的默认值为 0"
+    },
+    {
+      "name": "stripe",
+      "sample": "grid-grid-stripe#stripe-stripe",
+      "type": "Boolean",
+      "desc": "是否带有斑马纹",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "sync-resize",
+      "sample": "grid-width-height#tiny-first-menu-adaptive-grid-width-height",
+      "type": "Boolean",
+      "desc": "响应式跟随某个属性（对于通过某个属性来控制显示/隐藏切换的场景可能会用到）",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "tree-config",
+      "sample": "grid-tree-grid#tree-table-tree-grid-base",
+      "type": "Object",
+      "desc": "树形结构配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "valid-config",
+      "sample": "grid-validation#grid_Example-gridValid-editing-validation",
+      "type": "Object",
+      "desc": "校验配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "summary-config",
+      "sample": "grid-summary#summary-configuration-summary",
+      "type": "Object",
+      "desc": "表格统计功能的配置信息",
+      "defaultValue": ""
+    },
+    {
+      "name": "sortable",
+      "sample": "grid-customized#custom-column-sort",
+      "type": "Boolean",
+      "desc": "设置是否允许列数据排序。默认为 true 可排序",
+      "defaultValue": "该属性的默认值为 true"
+    },
+    {
+      "name": "auto-load",
+      "sample": "grid-data-source#tiny-first-menu-auto-load",
+      "type": "Boolean",
+      "desc": "",
+      "defaultValue": "是否开启自动请求服务，配置 fetch-data 时有效，该属性的默认值为 true"
+    },
+    {
+      "name": "is-async-column",
+      "sample": "grid-data-source#tiny-first-menu-column-asyn-rendering",
+      "type": "Boolean",
+      "desc": "设置表格的列是否延迟加载;是否开启异步列功能，配合 scrollLoad 一起使用",
+      "defaultValue": ""
+    },
+    {
+      "name": "columns",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "Array",
+      "desc": "表格列的配置信息，具体参考列配置项",
+      "defaultValue": ""
+    },
+    {
+      "name": "scroll-load",
+      "sample": "grid-large-data#tiny-first-menu-scroll-paging",
+      "type": "Object",
+      "desc": "滚动加载配置;设置是否滚动加载分页，当 showPager 为 true 时有效。",
+      "defaultValue": ""
+    },
+    {
+      "name": "row-span",
+      "sample": "grid-span#span-row-span-row-span-easy",
+      "type": "Array",
+      "desc": "设置行合并",
+      "defaultValue": ""
+    },
+    {
+      "name": "render-empty",
+      "sample": "",
+      "type": "Function",
+      "desc": "空数据渲染",
+      "defaultValue": ""
+    },
+    {
+      "name": "events",
+      "sample": "grid-event#event-grid-events",
+      "type": "Object",
+      "desc": "事件对象",
+      "defaultValue": ""
+    },
+    {
+      "name": "data",
+      "sample": "grid-data-source#tiny-first-menu-static-data",
+      "type": "Array",
+      "desc": "设置表格的数据;",
+      "defaultValue": ""
+    },
+    {
+      "name": "expand-last-column",
+      "sample": "",
+      "type": "Boolean",
+      "desc": "横向滚动时，最后一列是否会填充整个表格，默认为 false 最后一列不填充整个表格。",
+      "defaultValue": "该属性的默认值为 false"
+    },
+    {
+      "name": "head-custom",
+      "sample": "",
+      "type": "String",
+      "desc": "设置自定义表头的容器选择器。;通过 columns 内部层级或者 <grid-column> 嵌套实现自定义表头",
+      "defaultValue": ""
+    },
+    {
+      "name": "summary-config",
+      "sample": "grid-summary#summary-configuration-summary",
+      "type": "Object",
+      "desc": "设置表格统计功能。",
+      "defaultValue": ""
+    },
+    {
+      "name": "context-menu",
+      "sample": "grid-context-menu#grid_Example-shortcutMenu-header-menu",
+      "type": "Object",
+      "desc": "菜单的配置信息。",
+      "defaultValue": ""
+    },
+    {
+      "name": "min-height",
+      "sample": "grid-width-height#tiny-first-menu-min-grid-height",
+      "type": "Number , String",
+      "desc": "设置表格内容区域（不含表格头部，底部）的最小高度。",
+      "defaultValue": ""
+    },
+    {
+      "name": "operation",
+      "sample": "",
+      "type": "Object",
+      "desc": "表格操作列配置信息;通过设置 columns 的 renderer 来实现自定义列内容或者使用 <grid-column> 内嵌组件实现",
+      "defaultValue": ""
+    },
+    {
+      "name": "render-util",
+      "sample": "",
+      "type": "Object",
+      "desc": "grid渲染是传入的模板工具方法对象, renderer和content渲染器中都可以使用。;使用列配置的 renderer 配置自定义内容显示",
+      "defaultValue": ""
+    },
+    {
+      "name": "drop-config",
+      "sample": "grid-drag#drag-row-drag",
+      "type": "Object",
+      "desc": "表格行上下拖拽配置信息。",
+      "defaultValue": ""
+    },
+    {
+      "name": "edit-config",
+      "sample": "grid-editor#grid_Example-gridEdit-inner-editor",
+      "type": "Object",
+      "desc": "设置是否启用行编辑，即每个单元格都显示编辑状态。当 editMode 为 true 时有效。;设置 mode = row 启用行编辑",
+      "defaultValue": ""
+    },
+    {
+      "name": "seq-serial",
+      "sample": "grid-pager#pager-inner-pager",
+      "type": "Boolean",
+      "desc": "设置行序号是否连续，seqSerial 当 showSeq 为 true 时有效。",
+      "defaultValue": "设置行序号是否连续，开启分页时有效，该属性的默认值为 false"
+    },
+    {
+      "name": "tooltip-config",
+      "sample": "",
+      "type": "Object",
+      "desc": "组件的配置信息，具体参考 Hae.Widget.Tip.op。;Grid 内置 Tip 配置信息",
+      "defaultValue": ""
+    }
+  ],
+  "slots": [
+    {
+      "name": "default",
+      "sample": "",
+      "type": "",
+      "desc": "默认插槽（表格列 <grid-column> ）",
+      "defaultValue": ""
+    },
+    {
+      "name": "toolbar",
+      "sample": "",
+      "type": "",
+      "desc": "工具栏，（包含：缩放、个性化、刷新表格、自定义按钮）<grid-toolbar>",
+      "defaultValue": ""
+    },
+    {
+      "name": "pager",
+      "sample": "grid-pager#pager-inner-pager",
+      "type": "",
+      "desc": "分页插件，<pager>",
+      "defaultValue": ""
+    },
+    {
+      "name": "empty",
+      "sample": "grid-empty-data-tip#tiny-first-menu-empty-data-tip",
+      "type": "",
+      "desc": "空数据时显示的文本内容",
+      "defaultValue": ""
+    }
+  ],
+  "methods": [
+    {
+      "name": "clearActived()",
+      "sample": "grid-edit#tiny-first-menu-trigger-mode-for-editing",
+      "type": "",
+      "desc": "手动清除单元格激活状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearAll()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "手动清除表格所有条件，还原到初始状态（对于增删改查的场景中可能会用到，比如在数据保存之后清除表格缓存）",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearCurrentColumn()",
+      "sample": "grid-highlight#highlight-highlight-current-column",
+      "type": "",
+      "desc": "用于当前列，手动清空当前高亮的状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearCurrentRow()",
+      "sample": "grid-highlight#highlight-highlight-current-row",
+      "type": "",
+      "desc": "用于当前行，手动清空当前高亮的状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearData(rows, field)",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "手动清空单元格内容，如果不传参数，则清空整个表格内容，如果传了行则清空指定行内容，如果传了指定字段，则清空该字段内容",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearFilter(field)",
+      "sample": "grid-filter#filter-default-filter",
+      "type": "",
+      "desc": "手动清空筛选条件（如果不传 field 则清空所有筛选条件），数据会恢复成未筛选的状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearRadioRow()",
+      "sample": "grid-operation-column#tiny-first-menu-default-serial-column",
+      "type": "",
+      "desc": "用于单选行，手动清空用户的选择",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearRowExpand()",
+      "sample": "grid-nested-grid#grid_Example-nestedGrid",
+      "type": "",
+      "desc": "手动清空展开行状态，数据会恢复成未展开的状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearScroll()",
+      "sample": "grid-width-height#tiny-first-menu-min-grid-height",
+      "type": "",
+      "desc": "手动清除滚动相关信息，还原到初始状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearSelected()",
+      "sample": "grid-highlight#highlight-highlight-cell",
+      "type": "",
+      "desc": "手动清除单元格选中状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearSelection()",
+      "sample": "grid-operation-column#tiny-first-menu-custom-serial-column",
+      "type": "",
+      "desc": "用于多选行，手动清空用户的选择",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearSort()",
+      "sample": "grid-sort#sort-default-sort",
+      "type": "",
+      "desc": "手动清空排序条件，数据会恢复成未排序的状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "clearTreeExpand()",
+      "sample": "grid-tree-grid#tree-table-tree-grid-insert-delete-update",
+      "type": "",
+      "desc": "手动清空树形节点的展开状态，数据会恢复成未展开的状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "closeFilter()",
+      "sample": "grid-filter#filter-default-filter",
+      "type": "",
+      "desc": "手动关闭筛选面板（某些特殊场景可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "closeMenu()",
+      "sample": "grid-context-menu#grid_Example-shortcutMenu-header-menu",
+      "type": "",
+      "desc": "手动关闭快捷菜单（某些特殊场景可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "createData(records)",
+      "sample": "grid-data-source#tiny-first-menu-static-data",
+      "type": "",
+      "desc": "创建 data 对象（对于某些特殊场景可能会用到，会自动对数据的字段名进行检测，如果不存在就自动定义）",
+      "defaultValue": ""
+    },
+    {
+      "name": "createRow(records)",
+      "sample": "grid-data-source#tiny-first-menu-static-data",
+      "type": "",
+      "desc": "创建 Row|Rows 对象（对于某些特殊场景需要对数据进行手动插入时可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "exportCsv(options)",
+      "sample": "grid-import-export#tiny-first-menu-export-excel",
+      "type": "",
+      "desc": "将表格数据导出为 .csv 文件（支持所有主流的浏览器，不支持合并行或列）",
+      "defaultValue": ""
+    },
+    {
+      "name": "fullValidate(rows, callback)",
+      "sample": "grid-validation#grid_Example-gridValid-before-submit-validation",
+      "type": "",
+      "desc": "表格完整校验函数，和 validate 的区别就是会对全量数据的所有规则进行完整校验",
+      "defaultValue": ""
+    },
+    {
+      "name": "getActiveRow()",
+      "sample": "grid-edit#tiny-first-menu-trigger-mode-for-editing",
+      "type": "",
+      "desc": "获取已激活的行数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getColumnByField(field)",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "",
+      "desc": "根据列的字段名获取列",
+      "defaultValue": ""
+    },
+    {
+      "name": "getColumnById(colid)",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "",
+      "desc": "根据列的唯一主键获取列",
+      "defaultValue": ""
+    },
+    {
+      "name": "getColumnIndex(column)",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "",
+      "desc": "根据 column 获取相对于 columns 中的索引",
+      "defaultValue": ""
+    },
+    {
+      "name": "getColumnNode(cell)",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "",
+      "desc": "根据 th/td 元素获取对应的 column 信息",
+      "defaultValue": ""
+    },
+    {
+      "name": "getColumns(columnIndex)",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "",
+      "desc": "获取表格的可视列，也可以指定索引获取列",
+      "defaultValue": ""
+    },
+    {
+      "name": "getCurrentRow()",
+      "sample": "",
+      "type": "",
+      "desc": "用于当前行，获取当前行的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getData(rowIndex)",
+      "sample": "grid-data-source#tiny-first-menu-columns",
+      "type": "",
+      "desc": "获取数据，和 data 的行为一致，也可以指定索引获取数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getInsertRecords()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "获取新增的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getRadioRow()",
+      "sample": "",
+      "type": "",
+      "desc": "用于单选行，获取当已选中的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getRecordset()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "获取表格数据集（获取新增、删除、更改的数据，对于增删改查表格非常方便）",
+      "defaultValue": ""
+    },
+    {
+      "name": "getRemoveRecords()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "获取已删除的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getRowById(rowid)",
+      "sample": "",
+      "type": "",
+      "desc": "根据行的唯一主键获取行",
+      "defaultValue": ""
+    },
+    {
+      "name": "getRowIndex(row:Object)",
+      "sample": "",
+      "type": "",
+      "desc": "根据 row 获取相对于 data 中的索引",
+      "defaultValue": ""
+    },
+    {
+      "name": "getRowNode(tr)",
+      "sample": "",
+      "type": "",
+      "desc": "根据 tr 元素获取对应的 row 信息",
+      "defaultValue": ""
+    },
+    {
+      "name": "getSelectRecords()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "用于多选行，获取已选中的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "getTableColumn()",
+      "sample": "grid-data-source#tiny-first-menu-static-data",
+      "type": "",
+      "desc": "获取当前表格的列（完整的全量表头列、处理条件之后的全量表头列、当前渲染中的表头列）",
+      "defaultValue": ""
+    },
+    {
+      "name": "getTableData()",
+      "sample": "grid-data-source#tiny-first-menu-static-data",
+      "type": "",
+      "desc": "获取当前表格的数据（完整的全量表体数据、处理条件之后的全量表体数据、当前渲染中的表体数据、当前渲染中的表尾数据）",
+      "defaultValue": ""
+    },
+    {
+      "name": "getUpdateRecords()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "获取已修改的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "hasActiveRow(row)",
+      "sample": "grid-edit#tiny-first-menu-trigger-mode-for-editing",
+      "type": "",
+      "desc": "检查行是否已激活为编辑状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "hasRowChange(row, field)",
+      "sample": "grid-edit#tiny-first-menu-row-editing",
+      "type": "",
+      "desc": "检查行或列数据是否发生改变",
+      "defaultValue": ""
+    },
+    {
+      "name": "hasRowExpand(row)",
+      "sample": "grid-nested-grid#grid_Example-nestedGrid",
+      "type": "",
+      "desc": "检查行是否已展开",
+      "defaultValue": ""
+    },
+    {
+      "name": "hasTreeExpand(row)",
+      "sample": "grid-tree-grid#tree-table-tree-grid-expand",
+      "type": "",
+      "desc": "检查树节点是否已展开",
+      "defaultValue": ""
+    },
+    {
+      "name": "hideColumn(column)",
+      "sample": "grid-customized#custom-column-visible-hidden",
+      "type": "",
+      "desc": "隐藏指定列",
+      "defaultValue": ""
+    },
+    {
+      "name": "insert(records)",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "在表格中新增数据。 ;往表格插入数据，从第一行新增一行或多行新数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "insertAt(records, row)",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "往表格插入数据，从指定位置插入一行或多行；第二个参数：row 指定位置（不支持树表格）、null从第一行插入、-1 从最后插入",
+      "defaultValue": ""
+    },
+    {
+      "name": "loadColumn(columns)",
+      "sample": "grid-large-data#large-data-load-column",
+      "type": "",
+      "desc": "加载列配置（对于表格列需要重载、局部递增场景下可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "loadData(data)",
+      "sample": "grid-large-data#tiny-first-menu-full-data-loading",
+      "type": "",
+      "desc": "加载数据（对于表格数据需要重载、局部递增场景下可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "recalculate()",
+      "sample": "grid-width-height#recalculate",
+      "type": "",
+      "desc": "重新计算表格（对于某些特殊场景可能会用到，比如隐藏的表格、更新列宽...等）",
+      "defaultValue": ""
+    },
+    {
+      "name": "refreshColumn()",
+      "sample": "grid-customized#custom-column-visible-hidden",
+      "type": "",
+      "desc": "刷新列配置（对于显示/隐藏列场景下可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "refreshData()",
+      "sample": "grid-tree-grid#tree-table-tree-grid-insert-delete-update",
+      "type": "",
+      "desc": "同步刷新 data 数据；如果用了该方法，那么组件将不再记录增删改的状态，只能自行实现对应逻辑（对于某些特殊的场景，比如深层树节点元素发生变动时可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "reloadCustoms(customs)",
+      "sample": "grid-customized#custom-server-storage",
+      "type": "",
+      "desc": "初始化加载显示/隐藏列（对于异步更新的场景下可能会用到）",
+      "defaultValue": ""
+    },
+    {
+      "name": "remove(rows)",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "删除指定行数据，指定 row 或 [row, ...] 删除多条数据，如果为空则删除所有数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "removeSelecteds()",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "删除已选中的所有行数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "resetAll()",
+      "sample": "grid-customized#custom-column-width",
+      "type": "",
+      "desc": "手动重置列的所有操作，还原到初始状态（如果已关联工具栏，则会同步更新）",
+      "defaultValue": ""
+    },
+    {
+      "name": "resetCustoms()",
+      "sample": "grid-customized#custom-column-width",
+      "type": "",
+      "desc": "手动重置列的显示/隐藏操作，还原到初始状态（如果已关联工具栏，则会同步更新）",
+      "defaultValue": ""
+    },
+    {
+      "name": "resetResizable()",
+      "sample": "grid-customized#custom-column-width",
+      "type": "",
+      "desc": "手动重置列宽拖动的操作，还原到初始状态（如果已关联工具栏，则会同步更新）",
+      "defaultValue": ""
+    },
+    {
+      "name": "revertData(rows, field)",
+      "sample": "grid-edit#tiny-first-menu-row-editing",
+      "type": "",
+      "desc": "还原更改，还原指定行 row 或者整个表格的数据",
+      "defaultValue": ""
+    },
+    {
+      "name": "scrollTo(scrollLeft, scrollTop)",
+      "sample": "grid-large-data#large-data-scroll-to",
+      "type": "",
+      "desc": "如果有滚动条，则滚动到对应的位置",
+      "defaultValue": ""
+    },
+    {
+      "name": "scrollToColumn(column)",
+      "sample": "grid-large-data#large-data-scroll-to",
+      "type": "",
+      "desc": "如果有滚动条，则滚动到对应的列",
+      "defaultValue": ""
+    },
+    {
+      "name": "scrollToRow(row)",
+      "sample": "grid-large-data#large-data-scroll-to",
+      "type": "",
+      "desc": "如果有滚动条，则滚动到对应的行",
+      "defaultValue": ""
+    },
+    {
+      "name": "setActiveCell(row, field)",
+      "sample": "grid-edit#tiny-first-menu-cell-editing",
+      "type": "",
+      "desc": "激活单元格编辑",
+      "defaultValue": ""
+    },
+    {
+      "name": "setActiveRow(row)",
+      "sample": "grid-edit#tiny-first-menu-cell-editing",
+      "type": "",
+      "desc": "激活行编辑，如果是 mode=cell 则默认激活第一个单元格",
+      "defaultValue": ""
+    },
+    {
+      "name": "setAllRowExpansion(checked)",
+      "sample": "grid-nested-grid#grid_Example-nestedGrid",
+      "type": "",
+      "desc": "设置所有行的展开与否",
+      "defaultValue": ""
+    },
+    {
+      "name": "setAllSelection(checked)",
+      "sample": "grid-operation-column#tiny-first-menu-custom-serial-column",
+      "type": "",
+      "desc": "用于多选行，设置所有行的选中状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "setAllTreeExpansion(checked)",
+      "sample": "grid-tree-grid#tree-table-tree-grid-operation-column",
+      "type": "",
+      "desc": "设置所有树节点的展开与否",
+      "defaultValue": ""
+    },
+    {
+      "name": "setCurrentRow(row)",
+      "sample": "grid-highlight#highlight-highlight-hover-row",
+      "type": "",
+      "desc": "用于当前行，设置某一行为高亮状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "setRadioRow(row)",
+      "sample": "grid-operation-column#tiny-first-menu-default-serial-column",
+      "type": "",
+      "desc": "用于单选行，设置某一行为选中状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "setRowExpansion(rows, checked)",
+      "sample": "grid-nested-grid#grid_Example-nestedGrid",
+      "type": "",
+      "desc": "设置展开行，二个参数设置这一行展开与否",
+      "defaultValue": ""
+    },
+    {
+      "name": "setSelection(rows, checked)",
+      "sample": "grid-operation-column#tiny-first-menu-custom-serial-column",
+      "type": "",
+      "desc": "用于多选行，设置行为选中状态，第二个参数为选中与否",
+      "defaultValue": ""
+    },
+    {
+      "name": "setTreeExpansion(rows, checked)",
+      "sample": "grid-tree-grid#tree-table-tree-grid-operation-column",
+      "type": "",
+      "desc": "设置展开树形节点，二个参数设置这一行展开与否",
+      "defaultValue": ""
+    },
+    {
+      "name": "showColumn(column)",
+      "sample": "grid-customized#custom-column-visible-hidden",
+      "type": "",
+      "desc": "显示指定列",
+      "defaultValue": ""
+    },
+    {
+      "name": "sort(field, order)",
+      "sample": "grid-sort#sort-custom-sort",
+      "type": "",
+      "desc": "手动对表格进行排序（如果 order 为空则自动切换排序）",
+      "defaultValue": ""
+    },
+    {
+      "name": "toggleAllSelection()",
+      "sample": "grid-operation-column#tiny-first-menu-custom-serial-column",
+      "type": "",
+      "desc": "用于多选行，切换所有行的选中状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "toggleRowExpansion(row)",
+      "sample": "grid-nested-grid#grid_Example-nestedGrid",
+      "type": "",
+      "desc": "用于可展开表格，切换展开行",
+      "defaultValue": ""
+    },
+    {
+      "name": "toggleRowSelection(row)",
+      "sample": "grid-operation-column#tiny-first-menu-custom-serial-column",
+      "type": "",
+      "desc": "用于多选行，切换某一行的选中状态",
+      "defaultValue": ""
+    },
+    {
+      "name": "toggleTreeExpansion(row)",
+      "sample": "grid-tree-grid#tree-table-tree-grid-operation-column",
+      "type": "",
+      "desc": "用于可树形表格，切换展开树形节点",
+      "defaultValue": ""
+    },
+    {
+      "name": "validate(rows, callback)",
+      "sample": "grid-validation#grid_Example-gridValid-before-submit-validation",
+      "type": "",
+      "desc": "表格校验函数，如果指定 row 或 rows 则校验指定一行或多行，否则校验整个表格。该回调函数会在校验结束后被调用，并传入两个参数：（是否校验成功，最近一列未通过校验的字段）。若不传入回调函数，则会返回一个 promise",
+      "defaultValue": ""
+    },
+    {
+      "name": "getSelectRecords",
+      "sample": "",
+      "type": "",
+      "desc": "获取选中标识的数据。",
+      "defaultValue": ""
+    },
+    {
+      "name": "getUpdateRecords",
+      "sample": "",
+      "type": "",
+      "desc": "获取更新标识的数据（不包括删除与新增标识的数据）",
+      "defaultValue": ""
+    },
+    {
+      "name": "renderSort",
+      "sample": "",
+      "type": "",
+      "desc": "分组/合并渲染排序。 前置条件：已进行分组/合并数据处理。",
+      "defaultValue": ""
+    }
+  ],
+  "events": [
+    {
+      "name": "current-page-change",
+      "sample": "",
+      "type": "",
+      "desc": "只对 pager-config 配置时有效，当前页发生改变时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "page-change",
+      "sample": "",
+      "type": "",
+      "desc": "只对 pager-config 配置时有效，分页发生改变时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "toolbar-button-click",
+      "sample": "grid-toolbar#tiny-first-menu-insert-delete-update",
+      "type": "",
+      "desc": "只对 toolbar.buttons 配置时有效，当工具栏的按钮被点击时会后触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "cell-click",
+      "sample": "grid-event#event-cell-click-event",
+      "type": "",
+      "desc": "单元格被点击时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "cell-context-menu",
+      "sample": "grid-context-menu#grid_Example-shortcutMenu-menu-permissions",
+      "type": "",
+      "desc": "单元格被鼠标右键点击时触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "cell-dblclick",
+      "sample": "grid-event#event-cell-dblclick-event",
+      "type": "",
+      "desc": "单元格被双击时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "cell-mouseenter",
+      "sample": "grid-event#event-cell-mouseenter-event",
+      "type": "",
+      "desc": "当单元格 hover 进入时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "cell-mouseleave",
+      "sample": "grid-event#event-cell-mouseleave-event",
+      "type": "",
+      "desc": "当单元格 hover 退出时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "context-menu-click",
+      "sample": "grid-context-menu#grid_Example-shortcutMenu-header-menu",
+      "type": "",
+      "desc": "只对 context-menu 配置时有效，当点击快捷菜单时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "current-change",
+      "sample": "",
+      "type": "",
+      "desc": "只对 highlightCurrentRow 有效，当手动选中行并且值发生改变时触发的事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "edit-actived",
+      "sample": "grid-event#event-edit-actived-event",
+      "type": "",
+      "desc": "单元格被激活编辑时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "edit-closed",
+      "sample": "grid-event#event-edit-closed-event",
+      "type": "",
+      "desc": "单元格编辑状态下被关闭时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "edit-disabled",
+      "sample": "grid-event#event-edit-disabled-event",
+      "type": "",
+      "desc": "当单元格激活时如果是禁用状态时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "filter-change",
+      "sample": "grid-filter#filter-server-filter",
+      "type": "",
+      "desc": "当筛选条件发生变化时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-cell-click",
+      "sample": "",
+      "type": "",
+      "desc": "表尾单元格被点击时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-cell-context-menu",
+      "sample": "grid-context-menu#grid_Example-shortcutMenu-cell-menu",
+      "type": "",
+      "desc": "表尾单元格被鼠标右键点击时触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "footer-cell-dblclick",
+      "sample": "",
+      "type": "",
+      "desc": "表尾单元格被双击时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "header-cell-click",
+      "sample": "grid-event#event-header-click-event",
+      "type": "",
+      "desc": "表头单元格被点击时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "header-cell-context-menu",
+      "sample": "",
+      "type": "",
+      "desc": "表头单元格被鼠标右键点击时触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "header-cell-dblclick",
+      "sample": "grid-event#event-header-dblclick-event",
+      "type": "",
+      "desc": "表头单元格被双击时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "radio-change",
+      "sample": "",
+      "type": "",
+      "desc": "只对 type=radio 有效，当手动勾选并且值发生改变时触发的事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "resizable-change",
+      "sample": "",
+      "type": "",
+      "desc": "当列宽拖动发生变化时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "scroll",
+      "sample": "grid-event#event-grid-scroll-event",
+      "type": "",
+      "desc": "表格滚动时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "select-all",
+      "sample": "",
+      "type": "",
+      "desc": "只对 type=selection 有效，当手动勾选全选时触发的事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "select-change",
+      "sample": "",
+      "type": "",
+      "desc": "只对 type=selection 有效，当手动勾选并且值发生改变时触发的事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "toggle-expand-change",
+      "sample": "",
+      "type": "",
+      "desc": "当行展开或收起时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "toggle-tree-change",
+      "sample": "",
+      "type": "",
+      "desc": "当树节点展开或收起时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "valid-error",
+      "sample": "",
+      "type": "",
+      "desc": "当数据校验不通过时会触发该事件",
+      "defaultValue": ""
+    },
+    {
+      "name": "BeforeEdit",
+      "sample": "",
+      "type": "",
+      "desc": "点击单元格，显示编辑组件前触发的事件。;点击单元格，显示编辑组件前触发的事件 —— edit-config 中的 activeMethod 方法",
+      "defaultValue": ""
+    },
+    {
+      "name": "CellClick",
+      "sample": "",
+      "type": "",
+      "desc": "点击单元格触发的事件。",
+      "defaultValue": ""
+    },
+    {
+      "name": "sort-change",
+      "sample": "grid-sort#sort-server-sort",
+      "type": "",
+      "desc": "点击列头，执行数据排序前触发的事件。;当排序条件发生变化时会触发该事件",
+      "defaultValue": ""
+    }
+  ]
+}