excelize/README_zh.md

165 lines
6.2 KiB
Markdown
Raw Normal View History

<p align="center"><img width="650" src="./excelize.svg" alt="Excelize logo"></p>
2018-12-05 00:27:19 +08:00
<p align="center">
<a href="https://travis-ci.org/360EntSecGroup-Skylar/excelize"><img src="https://travis-ci.org/360EntSecGroup-Skylar/excelize.svg?branch=master" alt="Build Status"></a>
<a href="https://codecov.io/gh/360EntSecGroup-Skylar/excelize"><img src="https://codecov.io/gh/360EntSecGroup-Skylar/excelize/branch/master/graph/badge.svg" alt="Code Coverage"></a>
<a href="https://goreportcard.com/report/github.com/360EntSecGroup-Skylar/excelize"><img src="https://goreportcard.com/badge/github.com/360EntSecGroup-Skylar/excelize" alt="Go Report Card"></a>
<a href="https://godoc.org/github.com/360EntSecGroup-Skylar/excelize"><img src="https://godoc.org/github.com/360EntSecGroup-Skylar/excelize?status.svg" alt="GoDoc"></a>
<a href="https://opensource.org/licenses/BSD-3-Clause"><img src="https://img.shields.io/badge/license-bsd-orange.svg" alt="Licenses"></a>
<a href="https://www.paypal.me/xuri"><img src="https://img.shields.io/badge/Donate-PayPal-green.svg" alt="Donate"></a>
</p>
2018-12-05 00:27:19 +08:00
# Excelize
## 简介
2019-08-21 23:03:34 +08:00
Excelize 是 Go 语言编写的用于操作 Office Excel 文档类库,基于 ECMA-376 Office OpenXML 标准。可以使用它来读取、写入由 Microsoft Excel&trade; 2007 及以上版本创建的 XLSX 文档。相比较其他的开源类库Excelize 支持写入原本带有图片(表)、透视表和切片器等复杂样式的文档,还支持向 Excel 文档中插入图片与图表,并且在保存后不会丢失文档原有样式,可以应用于各类报表系统中。使用本类库要求使用的 Go 语言为 1.10 或更高版本,完整的 API 使用文档请访问 [godoc.org](https://godoc.org/github.com/360EntSecGroup-Skylar/excelize) 或查看 [参考文档](https://xuri.me/excelize/)。
## 快速上手
### 安装
2019-03-20 15:13:41 +08:00
```bash
2019-09-02 21:52:55 +08:00
go get github.com/360EntSecGroup-Skylar/excelize
```
### 创建 Excel 文档
下面是一个创建 Excel 文档的简单例子:
```go
package main
2019-12-29 16:02:31 +08:00
import "github.com/360EntSecGroup-Skylar/excelize"
func main() {
2019-04-20 14:57:50 +08:00
f := excelize.NewFile()
// 创建一个工作表
2019-04-20 14:57:50 +08:00
index := f.NewSheet("Sheet2")
// 设置单元格的值
2019-04-20 14:57:50 +08:00
f.SetCellValue("Sheet2", "A2", "Hello world.")
f.SetCellValue("Sheet1", "B2", 100)
// 设置工作簿的默认工作表
2019-04-20 14:57:50 +08:00
f.SetActiveSheet(index)
// 根据指定路径保存文件
2019-12-29 16:02:31 +08:00
if err := f.SaveAs("Book1.xlsx"); err != nil {
println(err.Error())
}
}
```
### 读取 Excel 文档
下面是读取 Excel 文档的例子:
```go
package main
2019-12-29 16:02:31 +08:00
import "github.com/360EntSecGroup-Skylar/excelize"
func main() {
2019-12-29 16:02:31 +08:00
f, err := excelize.OpenFile("Book1.xlsx")
if err != nil {
2019-12-29 16:02:31 +08:00
println(err.Error())
return
}
// 获取工作表中指定单元格的值
2019-04-23 13:34:24 +08:00
cell, err := f.GetCellValue("Sheet1", "B2")
if err != nil {
2019-12-29 16:02:31 +08:00
println(err.Error())
2019-04-23 13:34:24 +08:00
return
}
2019-12-29 16:02:31 +08:00
println(cell)
// 获取 Sheet1 上所有单元格
2019-04-20 14:57:50 +08:00
rows, err := f.GetRows("Sheet1")
for _, row := range rows {
for _, colCell := range row {
2019-12-29 16:02:31 +08:00
print(colCell, "\t")
}
2019-12-29 16:02:31 +08:00
println()
}
}
```
### 在 Excel 文档中创建图表
使用 Excelize 生成图表十分简单,仅需几行代码。您可以根据工作表中的已有数据构建图表,或向工作表中添加数据并创建图表。
2018-12-05 00:27:19 +08:00
<p align="center"><img width="650" src="./test/images/chart.png" alt="Excelize"></p>
```go
package main
2019-12-29 16:02:31 +08:00
import "github.com/360EntSecGroup-Skylar/excelize"
func main() {
categories := map[string]string{"A2": "Small", "A3": "Normal", "A4": "Large", "B1": "Apple", "C1": "Orange", "D1": "Pear"}
values := map[string]int{"B2": 2, "C2": 3, "D2": 3, "B3": 5, "C3": 2, "D3": 4, "B4": 6, "C4": 7, "D4": 8}
2019-04-20 14:57:50 +08:00
f := excelize.NewFile()
for k, v := range categories {
2019-04-20 14:57:50 +08:00
f.SetCellValue("Sheet1", k, v)
}
for k, v := range values {
2019-04-20 14:57:50 +08:00
f.SetCellValue("Sheet1", k, v)
}
2019-12-29 16:02:31 +08:00
if err := f.AddChart("Sheet1", "E1", `{"type":"col3DClustered","series":[{"name":"Sheet1!$A$2","categories":"Sheet1!$B$1:$D$1","values":"Sheet1!$B$2:$D$2"},{"name":"Sheet1!$A$3","categories":"Sheet1!$B$1:$D$1","values":"Sheet1!$B$3:$D$3"},{"name":"Sheet1!$A$4","categories":"Sheet1!$B$1:$D$1","values":"Sheet1!$B$4:$D$4"}],"title":{"name":"Fruit 3D Clustered Column Chart"}}`); err != nil {
println(err.Error())
2019-04-20 14:57:50 +08:00
return
}
// 根据指定路径保存文件
2019-12-29 16:02:31 +08:00
if err := f.SaveAs("Book1.xlsx"); err != nil {
println(err.Error())
}
}
```
### 向 Excel 文档中插入图片
```go
package main
import (
_ "image/gif"
_ "image/jpeg"
_ "image/png"
2019-09-02 21:52:55 +08:00
"github.com/360EntSecGroup-Skylar/excelize"
)
func main() {
2019-12-29 16:02:31 +08:00
f, err := excelize.OpenFile("Book1.xlsx")
if err != nil {
2019-12-29 16:02:31 +08:00
println(err.Error())
return
}
// 插入图片
2019-12-29 16:02:31 +08:00
if err := f.AddPicture("Sheet1", "A2", "image.png", ""); err != nil {
println(err.Error())
}
// 在工作表中插入图片,并设置图片的缩放比例
2019-12-29 16:02:31 +08:00
if err := f.AddPicture("Sheet1", "D2", "image.jpg", `{"x_scale": 0.5, "y_scale": 0.5}`); err != nil {
println(err.Error())
}
// 在工作表中插入图片,并设置图片的打印属性
2019-12-29 16:02:31 +08:00
if err := f.AddPicture("Sheet1", "H2", "image.gif", `{"x_offset": 15, "y_offset": 10, "print_obj": true, "lock_aspect_ratio": false, "locked": false}`); err != nil {
println(err.Error())
}
// 保存文件
2019-12-29 16:02:31 +08:00
if err = f.Save(); err != nil {
println(err.Error())
}
}
```
## 社区合作
欢迎您为此项目贡献代码,提出建议或问题、修复 Bug 以及参与讨论对新功能的想法。 XML 符合标准: [part 1 of the 5th edition of the ECMA-376 Standard for Office Open XML](http://www.ecma-international.org/publications/standards/Ecma-376.htm)。
## 开源许可
本项目遵循 BSD 3-Clause 开源许可协议,访问 [https://opensource.org/licenses/BSD-3-Clause](https://opensource.org/licenses/BSD-3-Clause) 查看许可协议文件。
2019-01-01 13:20:14 +08:00
Excel 徽标是 [Microsoft Corporation](https://aka.ms/trademarks-usage) 的商标,项目的图片是一种改编。
gopher.{ai,svg,png} 由 [Takuya Ueda](https://twitter.com/tenntenn) 创作,遵循 [Creative Commons 3.0 Attributions license](http://creativecommons.org/licenses/by/3.0/) 创作共用授权条款。