luckysheet/docs/zh/guide/config.md

# 基本配置

## container
- 类型：String
- 默认值："luckysheet"
- 作用：容器的ID
  
------------
## title
- 类型：String
- 默认值："Luckysheet Demo"
- 作用：表格的名称

------------
## column
- 类型：Number
- 默认值：60
- 作用：空表格默认的列数量

------------
## row
- 类型：Number
- 默认值：84
- 作用：空表格默认的行数据量

------------
## 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  }]
- 作用：客户端sheet数据`[shee1, sheet2, sheet3]`

------------

## fullscreenmode
- 类型：Boolean
- 默认值：true
- 作用：是否全屏模式。非全屏模式下，标记框不会强制选中

------------
## 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
- 作用：允许增加列

------------
## pointEdit
- 类型：Boolean
- 默认值：false
- 作用：是否是编辑器插入表格模式

------------
## pointEditUpdate
- 类型：Function
- 默认值：null
- 作用：编辑器表格更新函数

------------
## pointEditZoom
- 类型：Number
- 默认值：1
- 作用：编辑器表格编辑时缩放比例

------------
## 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"
- 作用：左上角<返回按钮的链接

------------
## config
- 类型：Object
- 默认值：{}
- 作用：表格行高、列宽、合并单元格、公式等设置

### config.merge
- 类型：Object
- 默认值：{}
- 作用：合并单元格设置,示例：
  ```js
  {
        "13_5": {
            "r": 13,
            "c": 5,
            "rs": 3,
            "cs": 1
        },
        "13_7": {
            "r": 13,
            "c": 7,
            "rs": 3,
            "cs": 2
        },
        "14_2": {
            "r": 14,
            "c": 2,
            "rs": 1,
            "cs": 2
        }
    }
  ```
  对象中的`key`为`r + '_' + c`的拼接值，`value`为左上角单元格信息: r:行数，c:列数，rs：合并的行数，cs:合并的列数

### config.rowlen
- 类型：Object
- 默认值：{}
- 作用：每个单元格的行高,示例：
  ```js
  "rowlen": {
			"0": 20,
			"1": 20,
			"2": 20
		}
  ```

### config.columlen
- 类型：Object
- 默认值：{}
- 作用：每个单元格的列宽,示例：
  ```js
  "columlen": {
			"0": 97,
			"1": 115,
			"2": 128
		}
  ```

### config.borderInfo
- 类型：Object
- 默认值：{}
- 作用：单元格的边框信息,示例：
  ```js
  "borderInfo": [{
                    "rangeType": "cell",
                    "value": {
                        "row_index": 3,
                        "col_index": 3,
                        "l": {
                            "style": 10,
                            "color": "rgb(255, 0, 0)"
                        },
                        "r": {
                            "style": 10,
                            "color": "rgb(255, 0, 0)"
                        },
                        "t": {
                            "style": 10,
                            "color": "rgb(255, 0, 0)"
                        },
                        "b": {
                            "style": 10,
                            "color": "rgb(255, 0, 0)"
                        }
                    }
                },
                {
                    "rangeType": "range",
                    "borderType": "border-all",
                    "style": "3",
                    "color": "#0000ff",
                    "range": [{
                        "row": [7, 8],
                        "column": [2, 3]
                    }]
                }, {
                    "rangeType": "range",
                    "borderType": "border-inside",
                    "style": "3",
                    "color": "#0000ff",
                    "range": [{
                        "row": [7, 8],
                        "column": [8, 9]
                    }]
                }]
  ```
  范围类型分单个单元格和选区两种情况
1. 选区 `rangeType: "range"`

    - 边框类型 `borderType："border-left" | "border-right" | "border-top" | "border-bottom" | "border-all" | "border-outside" | "border-inside" | "border-horizontal" | "border-vertical" | "border-none"`，
    - 边框粗细 `style:  1 Thin | 2 Hair | 3 Dotted | 4 Dashed | 5 DashDot | 6 DashDotDot | 7 Double | 8 Medium | 9 MediumDashed | 10 MediumDashDot | 11 MediumDashDotDot | 12 SlantedDashDot | 13 Thick`
    - 边框颜色 `color: 16进制颜色值`
    - 选区范围 `range: 行列信息数组`
  
2. 单个单元格 `rangeType："cell"` 
   - 行数和列数 `value.row_index: 数字，value.col_index: 数字`
   - 四个边框对象 `value.l:左边框，value.r:右边框，value.t:上边框，value.b:下边框`
   - 边框粗细 `value.l.style: 1 Thin | 2 Hair | 3 Dotted | 4 Dashed | 5 DashDot | 6 DashDotDot | 7 Double | 8 Medium | 9 MediumDashed | 10 MediumDashDot | 11 MediumDashDotDot | 12 SlantedDashDot | 13 Thick`
   - 边框颜色 `value.l.color: 16进制颜色值`

------------
## devicePixelRatio
- 类型：Number
- 默认值：window.devicePixelRatio
- 作用：设备比例，比例越大表格分辨率越高

------------
## gridKey
- 类型：String
- 默认值：""
- 作用：表格唯一标识符

------------
## loadUrl
- 类型：String
- 默认值：""
- 作用：配置`loadUrl`的地址，Luckysheet会通过ajax请求表格数据，默认载入status为1的sheet数据中的所有`data`，其余的sheet载入除`data`字段外的所有字段

------------
## loadSheetUrl
- 类型：String
- 默认值：""
- 作用：配置`loadSheetUrl`的地址，参数为`gridKey`（表格主键） 和 `index`（sheet主键合集，格式为`[1,2,3]`），返回的数据为sheet的`data`字段数据集合

------------
## updateUrl
- 类型：String
- 默认值：""
- 作用：表格数据的更新地址

------------
## updateImageUrl
- 类型：String
- 默认值：""
- 作用：缩略图的更新地址

------------
## allowUpdate
- 类型：Boolean
- 默认值：false
- 作用：是否允许编辑后的后台更新

------------
## 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
- 作用：允许加载下一页

------------
## chartConfigChange
- 类型：Function
- 默认值：null
- 作用：图表插件中图表更新触发的自定义方法

------------
## beforeCreateDom
- 类型：Function
- 默认值：null
- 作用：表格创建之前自定义方法

------------
## fireMousedown
- 类型：Function
- 默认值：null
- 作用：单元格数据下钻自定义方法

------------