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.
Rafael Barros dea7ba0ec4 Fixes #195: Make GetRows return value avoid empty cell 11 months ago
.github/ISSUE_TEMPLATE Delete ISSUE_TEMPLATE.md 1 year ago
test Fixes #195: Make GetRows return value avoid empty cell 11 months ago
.gitignore Tests refactoring 11 months ago
.travis.yml Complete unit testing case for data validation 1 year ago
CODE_OF_CONDUCT.md Code of conduct and contributing updated. 2 years ago
CONTRIBUTING.md CodeLingo setup 11 months ago
CONTRIBUTING_TEMPLATE.md CodeLingo setup 11 months ago
LICENSE README updated 11 months ago
PULL_REQUEST_TEMPLATE.md Create PULL_REQUEST_TEMPLATE.md 1 year ago
README.md README updated 11 months ago
README_zh.md README updated 11 months ago
cell.go README updated 11 months ago
cell_test.go Tests refactoring 11 months ago
chart.go README updated 11 months ago
chart_test.go Tests refactoring 11 months ago
codelingo.yaml CodeLingo setup 11 months ago
col.go README updated 11 months ago
comment.go README updated 11 months ago
datavalidation.go README updated 11 months ago
datavalidation_test.go README updated 11 months ago
date.go README updated 11 months ago
date_test.go Tests refactoring 11 months ago
excelize.go README updated 11 months ago
excelize.png Add new logo for excelize 1 year ago
excelize_test.go README updated 11 months ago
file.go README updated 11 months ago
go.mod Tests refactoring 11 months ago
go.sum Tests refactoring 11 months ago
hsl.go Comments style changed. 1 year ago
lib.go README updated 11 months ago
lib_test.go Tests refactoring 11 months ago
logo.png Fixes #308, refactor `NewSheet()`, `DeleteSheet()`, `SetActiveSheet()` and `GetActiveSheetIndex()` 1 year ago
picture.go README updated 11 months ago
rows.go Fixes #195: Make GetRows return value avoid empty cell 11 months ago
shape.go README updated 11 months ago
sheet.go README updated 11 months ago
sheetpr.go README updated 11 months ago
sheetpr_test.go Tests refactoring 11 months ago
sheetview.go README updated 11 months ago
sheetview_test.go Tests refactoring 11 months ago
styles.go README updated 11 months ago
styles_test.go Use min/mid/max value for 2 and 3 color scale conditional formatting 1 year ago
table.go README updated 11 months ago
templates.go README updated 11 months ago
vmlDrawing.go README updated 11 months ago
xmlChart.go README updated 11 months ago
xmlComments.go README updated 11 months ago
xmlContentTypes.go README updated 11 months ago
xmlDecodeDrawing.go README updated 11 months ago
xmlDrawing.go README updated 11 months ago
xmlSharedStrings.go README updated 11 months ago
xmlStyles.go README updated 11 months ago
xmlTable.go README updated 11 months ago
xmlTheme.go README updated 11 months ago
xmlWorkbook.go README updated 11 months ago
xmlWorksheet.go README updated 11 months 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 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.

FOSSA Status