# vue-bigdata-table

**Repository Path**: ikanbest/vue-bigdata-table

## Basic Information

- **Project Name**: vue-bigdata-table
- **Description**: vue bigdata
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 2
- **Created**: 2024-01-17
- **Last Updated**: 2024-01-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# vue-bigdata-table

> Powerful, table components optimized for large amounts of data, based on Vue2.0

## Build Setup

``` bash
# install dependencies
npm install

# serve with hot reload at localhost:8080
npm run dev

# build for production with minification
npm run dist
```
## Feature

采用虚拟渲染方案，解决大数据量DOM渲染性能瓶颈，原理请看文章[实战Vue百万条数据渲染表格组件开发](https://juejin.im/post/5ad876a36fb9a045df1720b9?utm_source=gold_browser_extension)

#### 作者系列视频课程：

[Vue技术栈开发实战(26课时)](https://segmentfault.com/ls/1650000016221751?utm_source=recommend_web-live-new)

[TypeScript完全解读(26课时)](https://segmentfault.com/ls/1650000018455856?utm_source=recommend_web-live-new)

#### 进群和4000+前后端开发者交流学习

![image](https://github.com/lison16/v-org-tree/blob/master/group.png)

## API

### props:

属性  |  说明  |  类型  |  默认值
:-------: | -------  |  :-------:  |  :-------:
showIndex  |  是否显示序列号列  |  Boolean  |  false
value  |  表格数据，可以使用v-model双向绑定  |  Array  |  -
rowHeight  |  表格行高  |  Number  |  48
fixed  |  固定表头，设为true后表头不随表格滚动  |  Boolean  |  false
fixedWrapperWidth  | 设为true后表格列宽总是平分容器宽度减去indexWidth后的宽度 |  Boolean  |  false
disabledHover  |  是否取消鼠标悬浮高亮效果  |  Boolean  |  true
columns  |  表头数组，元素为单个表头的对象，{title: 'xxx', width: 该列宽度(number), render: (h) => {}, cellRender: (h, params) => {}},默认只需要title属性，render是表头渲染函数，cellRender是列单元格渲染函数  |  Array  |  -
colWidth  |  列宽，如果单独列中指定了宽度则按单独列，如果所有宽度加起来比容器宽度小，则平分宽度，否则用colWidth  |  Number  |  100
headerHeight  |  表头高度  |  Number  |  52
highlightRow  |  点击一行是否高亮  |  Boolean  |  false
headerTrStyle  |  表头tr样式  |  Object  |  {}
indexWidth  |  序列号列宽，如果没有设置，则会根据数据行数自动计算合适的宽度  |  Number  |  -
indexRender  |  序列号渲染render  |  Function  |  (h, index) => {return h('span', index + 1);}
indexRenderParams  |  indexRender的第三个参数  |  Object  |  default: () => ({})
stripe  |  是否显示斑马线  |  Boolean  |  false
atLeftCellPosi  |  指定当前鼠标在表头单元格左侧atLeftCellPosi像素处  |  Number  |  80
atRightCellPosi  |  指定当前鼠标在表头单元格右侧atRightCellPosi像素处  |  Number  |  80
fixedCol  |  固定的列的范围，[0, fixedCol]，设为2即固定0，1，2列，这三列横向不滚动，固定后列横向不随表格滚动  |  Number  |  -1
appendNum  |  根据表格容器高度计算内置单个表格（1/3）渲染的行数基础上额外渲染的行数，行数越多表格接替渲染效果越好，但越耗性能  |  Number  |  15
canEdit  |  是否可编辑  |  Boolean  |  false
startEditType  |  触发编辑单元格的方式，目前只支持dblclick一种，即鼠标双击单元格  |  String  |  'dblclick'
editCellRender  |  自定义编辑单元格的render函数，如果不指定则使用默认内置的editRender，可参考components/input-render.js  |  Funciton  |  editRender
beforeSave  |  保存修改的单元格内容之前的钩子，如果该函数返回false，则阻止保存  |  Function  |  ({ row, col, value, initRowIndex }) => {return true}
selectable  |  是否可选择单元格，开启后效果就像excel点击一个单元格然后拖动选择  |  Boolean  |  false
 paste |  是否可粘贴，设为true后可划选要粘贴的位置，然后ctrl+v粘贴从其他地方复制的表格数据，设为true则selectable将开启  |  Boolean  |  false
sortable  |  是否可排序  |  Boolean  |  false
sortIndex  |  开启排序的列序号数组或序号  |  Array, Number  |  -
defaultSort  |  数据默认排序方式，是一个包含一对键值对的对象，键是要按其排序的序号，值是'up'（升序）或'down'（降序）（为方便记忆，并没有使用'asc'和'desc'）  |  Object  |  -

### Event:

事件名  |  说明  |  返回值
:-------: | -------  |  :-------:
on-success-save  |  编辑保存成功时触发  |  row(当前行号，指当前在表格中的行号), col(列号，序列号列列号为0), value(该单元格修改后的值), initRowIndex(初始行号，即改行数据原本在数据二维数组中的索引，不受排序等影响)
on-fail-save  |  编辑保存失败时触发  |  同on-success-save
on-click-tr  |  点击行时触发  |  index（当前行号）
on-click-td  |  点击单元格时触发  |  {row, col}，是个对象
on-moving-on-header  |  鼠标在表头移动时触发  |  鼠标事件对象，其中还添加了一些属性：colIndex(当前所在的列的索引号), atRightGivenArea(是否在当前单元格右侧atRightCellPosi指定的距离内), atLeftGivenArea(是否在当前单元格左侧atLeftCellPosi指定的距离内)
on-click-tr  |  点击行时触发  |  index（当前行号）

### Methods:

方法  |  说明  |  参数
:-------: | -------  |  :-------:
resize  |  涉及到表格容器尺寸变化或数据变化的情况需要调用此方法，如果设changeInitIndex为false，则不会重新为数据设置原始行号  |  changeInitIndex
getScrollLeft  |  用于获取当前横向滚动的距离  |  -
scrollToRow  |  跳转到指定行号的一行，这里的行号是从0开始的  |  index
editCell  |  canEdit为true时调用此方法使第row+1行第col+1列变为编辑状态，这里的行列指的是表格显示的行和除序列号列的列  |  row, col
selectCell  |  canEdit为true时调用此方法使指定单元格被选中  |  row, col
setHighlightRow  |  手动设置高亮行  |  row
filter  |  按照某一列的指定关键词进行筛选  |  col: 要按哪一列筛选的列号, queryArr: 筛选关键字数组
cancelFilter  |  取消筛选  |  -
clearCurrentRow  |  清除高亮项目  |  -
getInitRowIndexByIndex  |  获取指定行的初始行号  |  row
getIndexByInitRowIndex  |  获取指定初始行号的当前行号  |  initRow