Browse Source

docs(docs): doc

doc
master
liurunze 5 years ago
parent
commit
ebc7d7d516
  1. 102
      docs/guide/format.md
  2. 85
      docs/zh/guide/config.md
  3. 102
      docs/zh/guide/format.md
  4. 3205
      src/demoData/sheetCell.js
  5. 2
      src/index.html

102
docs/guide/format.md

@ -72,108 +72,6 @@
<td>Underline</td> <td>Underline</td>
<td>0 Regular, 1 Underline</td> <td>0 Regular, 1 Underline</td>
</tr> </tr>
<tr>
<td rowspan="14">bs</td>
<td rowspan="14">borderstyle</td>
<td rowspan="14">Border style</td>
<td>0 none</td>
<td rowspan="14">LineStyle</td>
</tr>
<tr>
<td>1 Thin</td>
</tr>
<tr>
<td>2 Hair</td>
</tr>
<tr>
<td>3 Dotted</td>
</tr>
<tr>
<td>4 Dashed</td>
</tr>
<tr>
<td>5 DashDot</td>
</tr>
<tr>
<td>6 DashDotDot</td>
</tr>
<tr>
<td>7 Double</td>
</tr>
<tr>
<td>8 Medium</td>
</tr>
<tr>
<td>9 MediumDashed</td>
</tr>
<tr>
<td>10 MediumDashDot</td>
</tr>
<tr>
<td>11 MediumDashDotDot</td>
</tr>
<tr>
<td>12 SlantedDashDot</td>
</tr>
<tr>
<td>13 Thick</td>
</tr>
<tr>
<td>bc</td>
<td>bordercolor</td>
<td>Border color</td>
<td>#fff000</td>
<td>setBorderColor</td>
</tr>
<tr>
<td>bs_t</td>
<td>borderstyleTop</td>
<td>Top border style</td>
<td rowspan="8">Same as above</td>
<td></td>
</tr>
<tr>
<td>bc_t</td>
<td>bordercolorTop</td>
<td>Top border color</td>
<td></td>
</tr>
<tr>
<td>bs_b</td>
<td>borderstyleBottom</td>
<td>Bottom border style</td>
<td></td>
</tr>
<tr>
<td>bc_b</td>
<td>bordercolorBottom</td>
<td>Bottom border color</td>
<td></td>
</tr>
<tr>
<td>bs_l</td>
<td>borderstyleLeft</td>
<td>Left border style</td>
<td></td>
</tr>
<tr>
<td>bc_l</td>
<td>bordercolorLeft</td>
<td>Left border color</td>
<td></td>
</tr>
<tr>
<td>bs_r</td>
<td>borderstyleRight</td>
<td>Right border style</td>
<td></td>
</tr>
<tr>
<td>bc_r</td>
<td>bordercolorRight</td>
<td>Right border color</td>
<td></td>
</tr>
<tr> <tr>
<td>vt</td> <td>vt</td>
<td>verticaltype</td> <td>verticaltype</td>

85
docs/zh/guide/config.md

@ -168,9 +168,90 @@
对象中的`key`为`r + '_' + c`的拼接值,`value`为左上角单元格信息: r:行数,c:列数,rs:合并的行数,cs:合并的列数 对象中的`key`为`r + '_' + c`的拼接值,`value`为左上角单元格信息: r:行数,c:列数,rs:合并的行数,cs:合并的列数
### config.rowlen ### config.rowlen
- 类型:Array - 类型: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 ## devicePixelRatio

102
docs/zh/guide/format.md

@ -72,108 +72,6 @@
<td>下划线</td> <td>下划线</td>
<td>0 常规 、 1 下划线</td> <td>0 常规 、 1 下划线</td>
</tr> </tr>
<tr>
<td rowspan="14">bs</td>
<td rowspan="14">borderstyle</td>
<td rowspan="14">边框样式</td>
<td>0 none</td>
<td rowspan="14">LineStyle</td>
</tr>
<tr>
<td>1 Thin</td>
</tr>
<tr>
<td>2 Hair</td>
</tr>
<tr>
<td>3 Dotted</td>
</tr>
<tr>
<td>4 Dashed</td>
</tr>
<tr>
<td>5 DashDot</td>
</tr>
<tr>
<td>6 DashDotDot</td>
</tr>
<tr>
<td>7 Double</td>
</tr>
<tr>
<td>8 Medium</td>
</tr>
<tr>
<td>9 MediumDashed</td>
</tr>
<tr>
<td>10 MediumDashDot</td>
</tr>
<tr>
<td>11 MediumDashDotDot</td>
</tr>
<tr>
<td>12 SlantedDashDot</td>
</tr>
<tr>
<td>13 Thick</td>
</tr>
<tr>
<td>bc</td>
<td>bordercolor</td>
<td>边框颜色</td>
<td>#fff000</td>
<td>setBorderColor</td>
</tr>
<tr>
<td>bs_t</td>
<td>borderstyleTop</td>
<td>上边框样式</td>
<td rowspan="8">同上</td>
<td></td>
</tr>
<tr>
<td>bc_t</td>
<td>bordercolorTop</td>
<td>上边框颜色</td>
<td></td>
</tr>
<tr>
<td>bs_b</td>
<td>borderstyleBottom</td>
<td>下边框样式</td>
<td></td>
</tr>
<tr>
<td>bc_b</td>
<td>bordercolorBottom</td>
<td>下边框颜色</td>
<td></td>
</tr>
<tr>
<td>bs_l</td>
<td>borderstyleLeft</td>
<td>左边框样式</td>
<td></td>
</tr>
<tr>
<td>bc_l</td>
<td>bordercolorLeft</td>
<td>左边框颜色</td>
<td></td>
</tr>
<tr>
<td>bs_r</td>
<td>borderstyleRight</td>
<td>右边框样式</td>
<td></td>
</tr>
<tr>
<td>bc_r</td>
<td>bordercolorRight</td>
<td>右边框颜色</td>
<td></td>
</tr>
<tr> <tr>
<td>vt</td> <td>vt</td>
<td>verticaltype</td> <td>verticaltype</td>

3205
src/demoData/sheetCell.js

File diff suppressed because it is too large

2
src/index.html

@ -32,7 +32,7 @@
luckysheet.create({ luckysheet.create({
container: 'luckysheet', container: 'luckysheet',
lang: 'en', lang: 'zh',
plugins: ['chart'], plugins: ['chart'],
data: [sheetCell,sheetFormula,sheetConditionFormat,sheetTable,sheetSparkline,sheetComment,sheetPivotTableData,sheetPivotTable] data: [sheetCell,sheetFormula,sheetConditionFormat,sheetTable,sheetSparkline,sheetComment,sheetPivotTableData,sheetPivotTable]
}) })

Loading…
Cancel
Save