1.0.1 • Published 3 years ago

spread-js-table v1.0.1

Weekly downloads
1
License
MIT
Repository
-
Last release
3 years ago

SpreadJsTable

一个基于葡萄城SpreadJS的表格组件

SpreadJsTable依赖使用的SpreadJS版本是13.0.0

对于非SpreadJS 13.0.0的版本,目前没有做兼容。

!!!完整版文档传送门!!!

安装

npm 安装

npm install spread-js-table -S

script 引入

<script src="http://sunxuedong.gitee.io/spread-js-table/dist/spread-js-table.js"></script>

SpreadJsTable 表格

基础表格

基础的表格展示用法。

基础表格

带斑马纹表格

使用带斑马纹的表格,可以更容易区分出不同行的数据。

带斑马纹表格

带状态表格

可将表格内容 highlight 显示,方便区分「成功、信息、警告、危险」等内容。

带状态表格

固定列

横向内容过多时,可选择固定列,frozenColumnNum决定固定的列数,frozenTrailingColumnNum决定固定尾列的列数。

固定列

多级表头

数据结构比较复杂的时候,可使用多级表头来展现数据的层次关系。

多级表头

单选

选择单行数据时使用 Checkbox。

单选

全选

选择多行数据时使用 Checkbox。

全选

排序 & 筛选(spreadJS 本身具有的功能)

表尾合计行

若表格展示的是各类数字,可以在表尾显示各列的合计,可以通过isNeedGather的bool值来决定是否汇总。

表尾合计行

SpreadJsTable Attributes

参数说明类型可选值默认值
data显示的数据array
columns列头array
isShowFilteredNumber是否显示使用spreadJS过滤后,过滤的数量array
oddRowBackColor奇数行的背景色string#dcdcdc
evenRowBackColor偶数行的背景色string#ffffff
frozenColumnNum固定表格列的数量,从左边开始number0
frozenTrailingColumnNum固定表格列的数量,从左边开始number0

SpreadJsTable Events

事件名说明参数
selection-change当选择项发生变化时会触发该事件selection
cell-mouse-enter当单元格 hover 进入时会触发该事件arrayrow, column, hitinfo
cell-mouse-leave当单元格 hover 退出时会触发该事件row, column, hitinfo
header-cell-mouse-center当列头单元格 hover 进入时会触发该事件column, hitinfo
header-cell-mouse-leave列头当列头单元格 hover 退出时会触发该事件column, hitinfo
cell-db-click当某一单元格被双击时会触发该事件row, column
row-db-click当某一行被双击时会触发该事件row, column
button-click当点击单元格button时会触发该事件{row, column, text}
render-row当处理表格的每行数据时会触发该事件(可以通过对style对象的属性赋值,达到更改行样式的目的){rowIdx, rowData, style}
render-cell当渲染单元格时会触发该事件(可以通过对style对象的属性赋值,达到更改单元格样式的目的){rowIdx, colIdx, column, style}
render-header当渲染列头时会触发该事件(可以通过对style对象的属性赋值,达到更改列头单元格样式的目的){style, column, colIdx, rowIdx}

SpreadJsTable Methods

方法名说明参数
refresh刷新sheet
clearTableCheckStatus清空表格的选中状态
exporting导出{name:'', data: []} // name:导出文件的名称 data: 导出的数据,默认当前页数据

SpreadTable-column Attributes

参数说明类型可选值默认值
type对应列的类型stringradio/checkbox
namecolumn 的 keystring
displayName显示的标题string
cellType单元格的类型object
isProtect该列是否开启表单保护booleantrue
isFilterable该列是否有过滤功能booleantrue
isNeedGather该列是否有汇总功能booleanfalse
isVisible该列是否可见booleantrue
children多表头的keyboolean
wordWrap是否允许换行,值为true时,可通过‘\r\n’给文字换行booleanfalse