Click here to Skip to main content
65,938 articles
CodeProject is changing. Read more.
Articles / productivity / Office / MS-Excel

How to Import and Export Excel XLSX in Go Language

0.00/5 (No votes)
30 Dec 2019BSD 17.2K  
This post shows you how to import and export Excel XLSX in Go language.
Excelize logo

Excelize is a library written in pure Go providing a set of functions that allow you to write to and read from XLSX files. It supports reading and writing XLSX file generated by Microsoft Excelâ„¢ 2007 and later. It 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.

GitHub: https://github.com/360EntSecGroup-Skylar/excelize
Document: https://xuri.me/excelize/

Installation

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

Create XLSX File

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

Java
package main

import "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.
    if err := f.SaveAs("Book1.xlsx"); err != nil {
        println(err.Error())
    }
}

Reading XLSX File

The following constitutes the bar to read an XLSX document.

Java
package main

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

func main() {
    f, err := excelize.OpenFile("Book1.xlsx")
    if err != nil {
        println(err.Error())
        return
    }
    // Get value from cell by given worksheet name and axis.
    cell, err := f.GetCellValue("Sheet1", "B2")
    if err != nil {
        println(err.Error())
        return
    }
    println(cell)
    // Get all the rows in the Sheet1.
    rows, err := f.GetRows("Sheet1")
    for _, row := range rows {
        for _, colCell := range row {
            print(colCell, "\t")
        }
        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.

Add chart to Excel document

Java
package main

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

Add picture to XLSX file:

Java
package main

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

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

func main() {
    f, err := excelize.OpenFile("Book1.xlsx")
    if err != nil {
        println(err.Error())
        return
    }
    // Insert a picture.
    if err := f.AddPicture("Sheet1", "A2", "image.png", ""); err != nil {
        println(err.Error())
    }
    // Insert a picture to worksheet with scaling.
    if err := f.AddPicture("Sheet1", "D2", "image.jpg", 
             `{"x_scale": 0.5, "y_scale": 0.5}`); err != nil {
        println(err.Error())
    }
    // Insert a picture offset in the cell with printing support.
    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())
    }
    // Save the xlsx file with the origin path.
    if err = f.Save(); err != nil {
        println(err.Error())
    }
}

History

  • 30th December, 2019: Initial version

License

This article, along with any associated source code and files, is licensed under The BSD License