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.
Christian Fiedler 3280e1b686 Allow access to more formula attributes in SetCellFormula (#484) 17 hours ago
.github/ISSUE_TEMPLATE Delete ISSUE_TEMPLATE.md 1 year ago
test Testing files updated 2 weeks ago
.gitignore refactor: handler error instead of panic, 6 months ago
.travis.yml Documentation updated, Go 1.10+ required 1 month ago
CODE_OF_CONDUCT.md Code of conduct and contributing updated. 2 years ago
CONTRIBUTING.md Resolve #318, add new functions and 8 months ago
LICENSE Resolve #329, add copyright agreement statement on README and LICENSE 8 months ago
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md 1 year ago
README.md Combine functions: 1 week ago
README_zh.md Combine functions: 1 week ago
adjust.go Documentation updated, Go 1.10+ required 1 month ago
adjust_test.go Optimize code, fix golint issues 3 months ago
calcchain.go Documentation updated, Go 1.10+ required 1 month ago
cell.go Allow access to more formula attributes in SetCellFormula (#484) 17 hours ago
cell_test.go Testing files updated 2 weeks ago
cellmerged.go Documentation updated, Go 1.10+ required 1 month ago
cellmerged_test.go Resolve #393, upgrade Go module to v2 4 months ago
chart.go Combine functions: 1 week ago
chart_test.go Support to create bubble and 3D bubble chart 3 months ago
codelingo.yaml CodeLingo setup 9 months ago
col.go Documentation updated, Go 1.10+ required 1 month ago
col_test.go Resolve #397, support set style by columns 4 months ago
comment.go Combine functions: 1 week ago
datavalidation.go Documentation updated, Go 1.10+ required 1 month ago
datavalidation_test.go Documentation updated, Go 1.10+ required 1 month ago
date.go Documentation updated, Go 1.10+ required 1 month ago
date_test.go add unit tests to functions 5 months ago
docProps.go Documentation updated, Go 1.10+ required 1 month ago
docProps_test.go Documentation updated, Go 1.10+ required 1 month ago
errors.go Documentation updated, Go 1.10+ required 1 month ago
errors_test.go Huge refactorig for consistent col/row numbering (#356) 6 months ago
excelize.go Combine functions: 1 week ago
excelize.svg Combine functions: 1 week ago
excelize_test.go Allow access to more formula attributes in SetCellFormula (#484) 17 hours ago
file.go Combine functions: 1 week ago
go.mod Fix dependency on github.com/360EntSecGroup-Skylar/excelize v1 1 week ago
go.sum Fix dependency on github.com/360EntSecGroup-Skylar/excelize v1 1 week ago
hsl.go Comments style changed. 1 year ago
lib.go Documentation updated, Go 1.10+ required 1 month ago
lib_test.go refactor: handler error instead of panic, 6 months ago
logo.png Typo fixed and godoc updated 6 months ago
picture.go Combine functions: 1 week ago
picture_test.go Add TIF, TIFF format images and more detailed error information when open the encrypted file 2 months ago
pivotTable.go Resolve #40, init pivot table support 3 days ago
pivotTable_test.go Resolve #40, init pivot table support 3 days ago
rows.go Documentation updated, Go 1.10+ required 1 month ago
rows_test.go Only parse xml once when reading 1 month ago
shape.go Combine functions: 1 week ago
sheet.go Combine functions: 1 week ago
sheet_test.go Fix dependency on github.com/360EntSecGroup-Skylar/excelize v1 1 week ago
sheetpr.go Documentation updated, Go 1.10+ required 1 month ago
sheetpr_test.go Fix dependency on github.com/360EntSecGroup-Skylar/excelize v1 1 week ago
sheetview.go Documentation updated, Go 1.10+ required 1 month ago
sheetview_test.go Fix dependency on github.com/360EntSecGroup-Skylar/excelize v1 1 week ago
sparkline.go Update the Godoc 1 month ago
sparkline_test.go New feature: sparkline supported 1 month ago
styles.go Fix #386 regression test added (#440) 3 weeks ago
styles_test.go Update the Godoc 1 month ago
table.go Combine functions: 1 week ago
templates.go Documentation updated, Go 1.10+ required 1 month ago
vmlDrawing.go Documentation updated, Go 1.10+ required 1 month ago
xmlApp.go Documentation updated, Go 1.10+ required 1 month ago
xmlCalcChain.go Documentation updated, Go 1.10+ required 1 month ago
xmlChart.go Documentation updated, Go 1.10+ required 1 month ago
xmlComments.go Documentation updated, Go 1.10+ required 1 month ago
xmlContentTypes.go Documentation updated, Go 1.10+ required 1 month ago
xmlCore.go Documentation updated, Go 1.10+ required 1 month ago
xmlDecodeDrawing.go Documentation updated, Go 1.10+ required 1 month ago
xmlDrawing.go Combine functions: 1 week ago
xmlPivotCache.go Resolve #40, init pivot table support 3 days ago
xmlPivotTable.go Resolve #40, init pivot table support 3 days ago
xmlSharedStrings.go Documentation updated, Go 1.10+ required 1 month ago
xmlStyles.go Documentation updated, Go 1.10+ required 1 month ago
xmlTable.go Documentation updated, Go 1.10+ required 1 month ago
xmlTheme.go Documentation updated, Go 1.10+ required 1 month ago
xmlWorkbook.go Combine functions: 1 week ago
xmlWorksheet.go Fix #483, adjust the order of fields in the structure 5 days ago

README.md

Excelize logo

Build Status Code Coverage Go Report Card GoDoc Licenses Donate

Excelize

Introduction

Excelize is a library written in pure Go providing a set of functions that allow you to write to and read from XLSX files. Supports reading and writing XLSX file generated by Microsoft Excel™ 2007 and later. Supports saving a file without losing original charts of XLSX. This library needs Go version 1.10 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() {
    f := excelize.NewFile()
    // Create a new sheet.
    index := f.NewSheet("Sheet2")
    // Set value of a cell.
    f.SetCellValue("Sheet2", "A2", "Hello world.")
    f.SetCellValue("Sheet1", "B2", 100)
    // Set active sheet of the workbook.
    f.SetActiveSheet(index)
    // Save xlsx file by the given path.
    err := f.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() {
    f, err := excelize.OpenFile("./Book1.xlsx")
    if err != nil {
        fmt.Println(err)
        return
    }
    // Get value from cell by given worksheet name and axis.
    cell, err := f.GetCellValue("Sheet1", "B2")
    if err != nil {
        fmt.Println(err)
        return
    }
    fmt.Println(cell)
    // Get all the rows in the Sheet1.
    rows, err := f.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}
    f := excelize.NewFile()
    for k, v := range categories {
        f.SetCellValue("Sheet1", k, v)
    }
    for k, v := range values {
        f.SetCellValue("Sheet1", k, v)
    }
    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"}}`)
    if err != nil {
        fmt.Println(err)
        return
    }
    // Save xlsx file by the given path.
    err = f.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() {
    f, err := excelize.OpenFile("./Book1.xlsx")
    if err != nil {
        fmt.Println(err)
        return
    }
    // Insert a picture.
    err = f.AddPicture("Sheet1", "A2", "./image1.png", "")
    if err != nil {
        fmt.Println(err)
    }
    // Insert a picture to worksheet with scaling.
    err = f.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 = f.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 = f.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.

Licenses

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

The Excel logo is a trademark of Microsoft Corporation. This artwork is an adaptation.

Some struct of XML originally by tealeg/xlsx. Licensed under the BSD 3-Clause License.

gopher.{ai,svg,png} was created by Takuya Ueda. Licensed under the Creative Commons 3.0 Attributions license.