You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7.8 KiB
7.8 KiB
整体配置
基础结构
初始化表格时，可以设置一个对象配置串options来自定义配置Luckysheet表格。
如下是一个简洁的配置案例：
// 配置项
const options = {
container: 'luckysheet', // 设定DOM容器的id
title: 'Luckysheet Demo', // 设定表格名称
lang: 'zh' // 设定表格语言
// 更多其他设置...
}
// 初始化表格
luckysheet.create(options)
这里的options配置项会作用于整个表格，特别的，单个sheet的配置则需要在options.data数组中，分别设置对应更详细的参数，参考工作表配置
配置项
以下为所有支持的设置参数
- container
- title
- lang
- gridKey
- loadUrl
- loadSheetUrl
- allowUpdate
- updateUrl
- updateImageUrl
- data
- plugins
- column
- row
- autoFormatw
- accuracy
- allowCopy
- showtoolbar
- showinfobar
- showsheetbar
- showstatisticBar
- allowEdit
- enableAddRow
- enableAddCol
- userInfo
- userMenuItem
- myFolderUrl
- devicePixelRatio
- functionButton
- showConfigWindowResize
- enablePage
- fullscreenmode
- beforeCreateDom
- fireMousedown
- forceCalculation
container
- 类型：String
- 默认值："luckysheet"
- 作用：容器的ID
title
- 类型：String
- 默认值："Luckysheet Demo"
- 作用：表格的名称
lang
- 类型：String
- 默认值："en"
- 作用：国际化设置，允许设置表格的语言，支持中文("zh")和英文("en")
gridKey
- 类型：String
- 默认值：""
- 作用：表格唯一标识符
loadUrl
- 类型：String
- 默认值：""
- 作用：配置
loadUrl的地址，Luckysheet会通过ajax请求整个表格数据，默认载入status为1的sheet数据中的所有celldata，其余的sheet载入除celldata字段外的所有字段。但是考虑到一些公式、图表及数据透视表会引用其他sheet的数据，所以前台会加一个判断，如果该当前sheet引用了其他sheet的数据则把引用到的sheet的数据一并补全。
loadSheetUrl
- 类型：String
- 默认值：""
- 作用：配置
loadSheetUrl的地址，参数为gridKey（表格主键） 和index（sheet主键合集，格式为[1,2,3]），返回的数据为sheet的celldata字段数据集合
allowUpdate
- 类型：Boolean
- 默认值：false
- 作用：是否允许操作表格后的后台更新，与
updateUrl配合使用
updateUrl
- 类型：String
- 默认值：""
- 作用：操作表格后的后台更新地址，在
allowUpdate为true时才会有效
updateImageUrl
- 类型：String
- 默认值：""
- 作用：缩略图的更新地址
data
- 类型：Array
- 默认值：[{ "name": "Sheet1", color: "", "status": "1", "order": "0", "data": [], "config": {}, "index":0 }, { "name": "Sheet2", color: "", "status": "0", "order": "1", "data": [], "config": {}, "index":1 }, { "name": "Sheet3", color: "", "status": "0", "order": "2", "data": [], "config": {}, "index":2 }]
- 作用：当未配置
loadUrl和loadSheetUrl的时候，需要手动配置传入整个客户端所有sheet数据[shee1, sheet2, sheet3]，详细参数设置参见工作表配置
plugins
- 类型：Array
- 默认值：[]
- 作用：配置插件，支持图表："chart"
column
- 类型：Number
- 默认值：60
- 作用：空表格默认的列数量
row
- 类型：Number
- 默认值：84
- 作用：空表格默认的行数据量
autoFormatw
- 类型：Boolean
- 默认值：false
- 作用：自动格式化超过4位数的数字为‘亿万格式’，例：true or "true" or "TRUE"
accuracy
- 类型：Number
- 默认值：undefined
- 作用：设置精度，小数点后的位数。传参数为数字或数字字符串，例： "0" 或 0
allowCopy
- 类型：Boolean
- 默认值：true
- 作用：是否允许拷贝
showtoolbar
- 类型：Boolean
- 默认值：true
- 作用：是否第二列显示工具栏
showinfobar
- 类型：Boolean
- 默认值：true
- 作用：是否显示顶部名称栏
showsheetbar
- 类型：Boolean
- 默认值：true
- 作用：是否显示底部表格名称区域
showstatisticBar
- 类型：Boolean
- 默认值：true
- 作用：是否显示底部计数栏
allowEdit
- 类型：Boolean
- 默认值：true
- 作用：是否允许前台编辑
enableAddRow
- 类型：Boolean
- 默认值：true
- 作用：允许增加行
enableAddCol
- 类型：Boolean
- 默认值：true
- 作用：允许增加列
userInfo
- 类型：String
- 默认值：
'<i style="font-size:16px;color:#ff6a00;" class="fa fa-taxi" aria-hidden="true"></i> rabbit' - 作用：右上角的用户信息展示样式
userMenuItem
- 类型：Array
- 默认值：
[{url:"www.baidu.com", "icon":'<i class="fa fa-folder" aria-hidden="true"></i>', "name":"我的表格"}, {url:"www.baidu.com", "icon":'<i class="fa fa-sign-out" aria-hidden="true"></i>', "name":"退出登陆"}] - 作用：点击右上角的用户信息弹出的菜单
myFolderUrl
- 类型：String
- 默认值："www.baidu.com"
- 作用：左上角<返回按钮的链接
devicePixelRatio
- 类型：Number
- 默认值：window.devicePixelRatio
- 作用：设备比例，比例越大表格分辨率越高
functionButton
- 类型：String
- 默认值：""
- 作用：右上角功能按钮，例如
'<button id="" class="btn btn-primary" style="padding:3px 6px;font-size: 12px;margin-right: 10px;">下载</button> <button id="" class="btn btn-primary btn-danger" style=" padding:3px 6px; font-size: 12px; margin-right: 10px;">分享</button> <button id="luckysheet-share-btn-title" class="btn btn-primary btn-danger" style=" padding:3px 6px; font-size: 12px; margin-right: 10px;">秀数据</button>'
showConfigWindowResize
- 类型：Boolean
- 默认值：true
- 作用：图表或数据透视表的配置会在右侧弹出，设置弹出后表格是否会自动缩进
enablePage
- 类型：Boolean
- 默认值：false
- 作用：允许加载下一页
fullscreenmode
- 类型：Boolean
- 默认值：true
- 作用：是否全屏模式。非全屏模式下，标记框不会强制选中
beforeCreateDom
- 类型：Function
- 默认值：null
- 作用：表格创建之前自定义方法
fireMousedown
- 类型：Function
- 默认值：null
- 作用：单元格数据下钻自定义方法
forceCalculation
-
类型：Boolean
-
默认值：false
-
作用：强制刷新公式。
默认情况下，为提高加载性能，表格初始化的时候，含有公式的单元格会默认直接取得
v和m作为数据结果，而不做实时计算。如果公式关联到的单元格数据已经变化，或者公式所在的单元格数据结果改变了，则会导致关联单元格应该计算得出的结果和实际显示结果不一致，这是就需要开启公式刷新，保证数据实时计算的准确性。
⚠️提醒，公式较多时会有性能问题，慎用！