Golang library for reading and writing Microsoft Excel™ (XLSX) files.
Switch branches/tags
Clone or download
Latest commit 507fc53 Nov 8, 2018
Permalink
Failed to load latest commit information.
.github/ISSUE_TEMPLATE Delete ISSUE_TEMPLATE.md Jul 30, 2018
test resolve #273 new feature: protect sheet support Nov 2, 2018
.travis.yml Complete unit testing case for data validation Sep 13, 2018
CODE_OF_CONDUCT.md Code of conduct and contributing updated. Jul 10, 2017
CONTRIBUTING.md - Performance optimization 20% faster, 14% memory savings on set cell… May 15, 2018
LICENSE Copyright updated. Jan 3, 2018
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md Jul 29, 2018
README.md GoDoc updated. Jul 13, 2018
README_zh.md GoDoc updated. Jul 13, 2018
cell.go fix issue #290 Nov 8, 2018
cell_test.go - gofmted with -s; Jan 31, 2018
chart.go resolve #276, add OfficeOpenXML-XMLSchema-Strict mode support Oct 16, 2018
chart_test.go Use format string for chart dimension. May 9, 2018
col.go Comments style changed. Sep 13, 2018
comment.go Fix the issue caused by missing tradition to strict conversion for `s… Oct 18, 2018
datavalidation.go Comments style changed. Sep 13, 2018
datavalidation_test.go Comments style changed. Sep 13, 2018
date.go Comments style changed. Sep 13, 2018
date_test.go New function `AddPictureFromBytes()` has been added, this resolve #259 Sep 13, 2018
excelize.go resolve #276, add OfficeOpenXML-XMLSchema-Strict mode support Oct 16, 2018
excelize.png - Initialize shared formula types support, relate issue #227; May 26, 2018
excelize_test.go New function `UnprotectSheet()` has been added Nov 4, 2018
file.go feat: add new function and refactor writeto action Oct 12, 2018
hsl.go Comments style changed. Sep 13, 2018
lib.go resolve #273 new feature: protect sheet support Nov 2, 2018
lib_test.go - gofmted with -s; Jan 31, 2018
logo.png - Fix `checkCellInArea()` index out of range when merged cell ref is … Apr 8, 2018
picture.go resolve #276, add OfficeOpenXML-XMLSchema-Strict mode support Oct 16, 2018
rows.go Fix the issue caused by missing tradition to strict conversion for `s… Oct 18, 2018
shape.go Comments style changed. Sep 13, 2018
sheet.go New function `UnprotectSheet()` has been added Nov 4, 2018
sheetpr.go Comments style changed. Sep 13, 2018
sheetpr_test.go GitHub repo URL changed. Dec 1, 2017
sheetview.go Comments style changed. Sep 13, 2018
sheetview_test.go Added ZoomScale SheetViewOption Apr 16, 2018
styles.go resolve #276, add OfficeOpenXML-XMLSchema-Strict mode support Oct 16, 2018
styles_test.go Use min/mid/max value for 2 and 3 color scale conditional formatting Jul 25, 2018
table.go Comments style changed. Sep 13, 2018
templates.go Comments style changed. Sep 13, 2018
vmlDrawing.go Comments style changed. Sep 13, 2018
xmlChart.go fix unknown option in JSON struct tag Oct 27, 2018
xmlComments.go Comments style changed. Sep 13, 2018
xmlContentTypes.go Comments style changed. Sep 13, 2018
xmlDecodeDrawing.go Comments style changed. Sep 13, 2018
xmlDrawing.go resolve #276, add OfficeOpenXML-XMLSchema-Strict mode support Oct 16, 2018
xmlSharedStrings.go Comments style changed. Sep 13, 2018
xmlStyles.go Comments style changed. Sep 13, 2018
xmlTable.go Comments style changed. Sep 13, 2018
xmlTheme.go Comments style changed. Sep 13, 2018
xmlWorkbook.go Comments style changed. Sep 13, 2018
xmlWorksheet.go resolve #273 new feature: protect sheet support Nov 2, 2018

README.md

Excelize

Excelize

Build Status Code Coverage Go Report Card GoDoc Licenses Donate

Introduction

Excelize is a library written in pure Go and providing a set of functions that allow you to write to and read from XLSX files. Support reads and writes XLSX file generated by Microsoft Excel™ 2007 and later. Support save file without losing original charts of XLSX. This library needs Go version 1.8 or later. The full API docs can be seen using go's built-in documentation tool, or online at godoc.org and docs reference.

Basic Usage

Installation

go get github.com/360EntSecGroup-Skylar/excelize

Create XLSX file

Here is a minimal example usage that will create XLSX file.

package main

import (
    "fmt"

    "github.com/360EntSecGroup-Skylar/excelize"
)

func main() {
    xlsx := excelize.NewFile()
    // Create a new sheet.
    index := xlsx.NewSheet("Sheet2")
    // Set value of a cell.
    xlsx.SetCellValue("Sheet2", "A2", "Hello world.")
    xlsx.SetCellValue("Sheet1", "B2", 100)
    // Set active sheet of the workbook.
    xlsx.SetActiveSheet(index)
    // Save xlsx file by the given path.
    err := xlsx.SaveAs("./Book1.xlsx")
    if err != nil {
        fmt.Println(err)
    }
}

Reading XLSX file

The following constitutes the bare to read a XLSX document.

package main

import (
    "fmt"

    "github.com/360EntSecGroup-Skylar/excelize"
)

func main() {
    xlsx, err := excelize.OpenFile("./Book1.xlsx")
    if err != nil {
        fmt.Println(err)
        return
    }
    // Get value from cell by given worksheet name and axis.
    cell := xlsx.GetCellValue("Sheet1", "B2")
    fmt.Println(cell)
    // Get all the rows in the Sheet1.
    rows := xlsx.GetRows("Sheet1")
    for _, row := range rows {
        for _, colCell := range row {
            fmt.Print(colCell, "\t")
        }
        fmt.Println()
    }
}

Add chart to XLSX file

With Excelize chart generation and management is as easy as a few lines of code. You can build charts based off data in your worksheet or generate charts without any data in your worksheet at all.

Excelize

package main

import (
    "fmt"

    "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}
    xlsx := excelize.NewFile()
    for k, v := range categories {
        xlsx.SetCellValue("Sheet1", k, v)
    }
    for k, v := range values {
        xlsx.SetCellValue("Sheet1", k, v)
    }
    xlsx.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"}}`)
    // Save xlsx file by the given path.
    err := xlsx.SaveAs("./Book1.xlsx")
    if err != nil {
        fmt.Println(err)
    }
}

Add picture to XLSX file

package main

import (
    "fmt"
    _ "image/gif"
    _ "image/jpeg"
    _ "image/png"

    "github.com/360EntSecGroup-Skylar/excelize"
)

func main() {
    xlsx, err := excelize.OpenFile("./Book1.xlsx")
    if err != nil {
        fmt.Println(err)
        return
    }
    // Insert a picture.
    err = xlsx.AddPicture("Sheet1", "A2", "./image1.png", "")
    if err != nil {
        fmt.Println(err)
    }
    // Insert a picture to worksheet with scaling.
    err = xlsx.AddPicture("Sheet1", "D2", "./image2.jpg", `{"x_scale": 0.5, "y_scale": 0.5}`)
    if err != nil {
        fmt.Println(err)
    }
    // Insert a picture offset in the cell with printing support.
    err = xlsx.AddPicture("Sheet1", "H2", "./image3.gif", `{"x_offset": 15, "y_offset": 10, "print_obj": true, "lock_aspect_ratio": false, "locked": false}`)
    if err != nil {
        fmt.Println(err)
    }
    // Save the xlsx file with the origin path.
    err = xlsx.Save()
    if err != nil {
        fmt.Println(err)
    }
}

Contributing

Contributions are welcome! Open a pull request to fix a bug, or open an issue to discuss a new feature or change. XML is compliant with part 1 of the 5th edition of the ECMA-376 Standard for Office Open XML.

Credits

Some struct of XML originally by tealeg/xlsx.

Licenses

This program is under the terms of the BSD 3-Clause License. See https://opensource.org/licenses/BSD-3-Clause.