summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRi Xu <xuri.me@gmail.com>2017-01-22 19:20:33 +0800
committerRi Xu <xuri.me@gmail.com>2017-01-22 19:20:33 +0800
commit81146218c72c02af181e053187ac2b8561f61e02 (patch)
tree9c06d4d1ea918f0e1c3a2d1e41c6bfb3eb70ef38 /README.md
parent03234d6a254ea9fca674bf11564e88a5bd4d054f (diff)
Update README, godoc and fix typo.
Diffstat (limited to 'README.md')
-rw-r--r--README.md64
1 files changed, 25 insertions, 39 deletions
diff --git a/README.md b/README.md
index 0346fe8..fc6df01 100644
--- a/README.md
+++ b/README.md
@@ -21,7 +21,7 @@ Excelize is a library written in pure Golang and providing a set of functions th
go get github.com/Luxurioust/excelize
```
-### Create XLSX files
+### Create XLSX file
Here is a minimal example usage that will create XLSX file.
@@ -37,10 +37,14 @@ import (
func main() {
xlsx := excelize.CreateFile()
+ // Create a new sheet.
xlsx.NewSheet(2, "Sheet2")
- xlsx.NewSheet(3, "Sheet3")
- xlsx.SetCellInt("Sheet2", "A23", 10)
- xlsx.SetCellStr("Sheet3", "B20", "Hello")
+ // Set int or string type value of a cell.
+ xlsx.SetCellValue("Sheet2", "A2", "Hello world.")
+ xlsx.SetCellValue("Sheet1", "B2", 100)
+ // Set active sheet of workbook.
+ xlsx.SetActiveSheet(2)
+ // Save xlsx file by the given path.
err := xlsx.WriteTo("/tmp/Workbook.xlsx")
if err != nil {
fmt.Println(err)
@@ -49,9 +53,9 @@ func main() {
}
```
-### Writing XLSX files
+### Reading XLSX file
-The following constitutes the bare minimum required to write an XLSX document.
+The following constitutes the bare to read a XLSX document.
```go
package main
@@ -69,44 +73,26 @@ func main() {
fmt.Println(err)
os.Exit(1)
}
- xlsx.SetCellValue("Sheet2", "B2", 100)
- xlsx.SetCellValue("Sheet2", "C7", "Hello")
- xlsx.NewSheet(4, "TestSheet")
- xlsx.SetCellInt("Sheet4", "A3", 10)
- xlsx.SetCellStr("Sheet4", "b6", "World")
- xlsx.SetActiveSheet(2)
- err = xlsx.Save()
- if err != nil {
- fmt.Println(err)
- os.Exit(1)
+ // Get value from cell by given sheet index and axis.
+ cell := xlsx.GetCellValue("Sheet1", "B2")
+ fmt.Println(cell)
+ // Get all the rows in a sheet.
+ rows := xlsx.GetRows("Sheet2")
+ for _, row := range rows {
+ for _, colCell := range row {
+ fmt.Print(colCell, "\t")
+ }
}
-}
-```
-
-### Reading XLSX files
-
-```go
-package main
-
-import (
- "fmt"
- "os"
-
- "github.com/Luxurioust/excelize"
-)
-
-func main() {
- xlsx, err := excelize.OpenFile("/tmp/Workbook.xlsx")
+ // Save the xlsx file with origin path.
+ err = xlsx.Save()
if err != nil {
fmt.Println(err)
os.Exit(1)
}
- cell := xlsx.GetCellValue("Sheet2", "C7")
- fmt.Println(cell)
}
```
-### Add picture to XLSX files
+### Add picture to XLSX file
```go
package main
@@ -124,11 +110,11 @@ import (
func main() {
xlsx := excelize.CreateFile()
// Insert a picture.
- err := xlsx.AddPicture("Sheet1", "A2", "/tmp/image1.jpg", 0, 0, 1, 1)
+ err := xlsx.AddPicture("Sheet1", "A2", "/tmp/image1.gif", 0, 0, 1, 1)
// Insert a picture to sheet with scaling.
- err = xlsx.AddPicture("Sheet1", "D2", "/tmp/image1.png", 0, 0, 0.5, 0.5)
+ err = xlsx.AddPicture("Sheet1", "D2", "/tmp/image2.jpg", 0, 0, 0.5, 0.5)
// Insert a picture offset in the cell.
- err = xlsx.AddPicture("Sheet1", "H2", "/tmp/image3.gif", 15, 10, 1, 1)
+ err = xlsx.AddPicture("Sheet1", "H2", "/tmp/image3.png", 15, 10, 1, 1)
if err != nil {
fmt.Println(err)
os.Exit(1)