README
¶
xlsxPlus : A go extension library that can handle both xls and xlsx
Documentation
See the 中文文档 for document in Chinese.
Project Introduction
At work, I often encounter some businesses that need to process Excel files, such as common data import and export. Although the common Excel files are basically in xlsx format, but because of some historical issues or the office/wps used by the docking client Because of the version, I occasionally encounter situations that require handling xls. But at present, there does not seem to be a go library that can process files in both formats at the same time.
When I encountered this situation in the previous development process, I often needed to write two sets of business logic at the same time to call different Excel processing libraries to adapt to different file formats, which naturally introduced excessively high maintenance for the project later. The complexity, so I thought if I could try to be compatible with the old and new formats under some simple logic based on the achievements of my predecessors, so I tried this project.
The project starts at
- tealeg/xlsx v3.2.0
- extrame/xls 6fdb969 8fb5669
Version maintenance history
Function points
- Complete the file content reading in both formats
- Complete file content modification in both formats
Note
This project does not guarantee the stability of the production environment. It is just an attempt. My ability is limited. Please pass by cautiously.
Documentation
¶
Overview ¶
xls package use to parse the 97 -2004 microsoft xls file(".xls" suffix, NOT ".xlsx" suffix )
there are some example in godoc, please follow them.
Index ¶
- Constants
- Variables
- func CompareXlsXlsx(xlsfilepathname string, xlsxfilepathname string) string
- type BlankCol
- type CellRange
- type Col
- type Coler
- type Font
- type FontInfo
- type Format
- type FormulaCol
- type FormulaStringCol
- type HyperLink
- type LabelsstCol
- type MulBlankCol
- type MulrkCol
- type NumberCol
- type RK
- type Ranger
- type RkCol
- type Row
- type SstInfo
- type TWorkSheetVisibility
- type WorkBook
- func Open(file string, charset string) (*WorkBook, error)
- func OpenReader(reader io.ReadSeeker, charset string) (wb *WorkBook, err error)
- func OpenWithCloser(file string, charset string) (*WorkBook, io.Closer, error)
- func Openx(file string, charset string) (*WorkBook, error)
- func OpenxReader(reader io.ReadSeeker, charset string) (wb *WorkBook, err error)
- func OpenxWithCloser(file string, charset string) (*WorkBook, io.Closer, error)
- type WorkSheet
- type Xf5
- type Xf8
- type XfRk
Examples ¶
Constants ¶
const MJD_0 float64 = 2400000.5
const MJD_JD2000 float64 = 51544.5
Variables ¶
var ErrIsInt = fmt.Errorf("is int")
Functions ¶
func CompareXlsXlsx ¶
Compares xls and xlsx files
Types ¶
type FormulaCol ¶
type FormulaCol struct {
Header struct {
Col
IndexXf uint16
Result [8]byte
Flags uint16
// contains filtered or unexported fields
}
Bts []byte
}
func (*FormulaCol) String ¶
func (c *FormulaCol) String(wb *WorkBook) []string
type FormulaStringCol ¶
func (*FormulaStringCol) String ¶
func (c *FormulaStringCol) String(wb *WorkBook) []string
type HyperLink ¶
type HyperLink struct {
CellRange
Description string
TextMark string
TargetFrame string
Url string
ShortedFilePath string
ExtendedFilePath string
IsUrl bool
}
hyperlink type's content
type LabelsstCol ¶
func (*LabelsstCol) String ¶
func (c *LabelsstCol) String(wb *WorkBook) []string
type MulBlankCol ¶
func (*MulBlankCol) LastCol ¶
func (c *MulBlankCol) LastCol() uint16
func (*MulBlankCol) String ¶
func (c *MulBlankCol) String(wb *WorkBook) []string
type Row ¶
type Row struct {
// contains filtered or unexported fields
}
Row the data of one row
func (*Row) Col ¶
Col Get the Nth Col from the Row, if has not, return nil. Suggest use Has function to test it.
func (*Row) ColExact ¶
ColExact Get the Nth Col from the Row, if has not, return nil. For merged cells value is returned for first cell only
type TWorkSheetVisibility ¶
type TWorkSheetVisibility byte
const ( WorkSheetVisible TWorkSheetVisibility = 0 WorkSheetHidden TWorkSheetVisibility = 1 WorkSheetVeryHidden TWorkSheetVisibility = 2 )
type WorkBook ¶
type WorkBook struct {
Is5ver bool
Type uint16
Codepage uint16
Xfs []st_xf_data
Fonts []Font
Formats map[uint16]*Format
Author string
// contains filtered or unexported fields
}
xls workbook type
func Open ¶
Open one xls file
Example ¶
if xlFile, err := Open("Table.xls", "utf-8"); err == nil {
fmt.Println(xlFile.Author)
}
Output:
func OpenReader ¶
func OpenReader(reader io.ReadSeeker, charset string) (wb *WorkBook, err error)
Open xls file from reader
func OpenWithCloser ¶
Open one xls file and return the closer
func OpenxReader ¶
func OpenxReader(reader io.ReadSeeker, charset string) (wb *WorkBook, err error)
Open xlsx file from reader
func OpenxWithCloser ¶
Open one xlsx file and return the closer
func (*WorkBook) GetSheet ¶
Get one sheet by its number
Example ¶
Output: read the content of first two cols in each row
if xlFile, err := Open("Table.xls", "utf-8"); err == nil {
if sheet1 := xlFile.GetSheet(0); sheet1 != nil {
fmt.Print("Total Lines ", sheet1.MaxRow, sheet1.Name)
col1 := sheet1.Row(0).Col(0)
col2 := sheet1.Row(0).Col(0)
for i := 0; i <= (int(sheet1.MaxRow)); i++ {
row1 := sheet1.Row(i)
col1 = row1.Col(0)
col2 = row1.Col(1)
fmt.Print("\n", col1, ",", col2)
}
}
}
Output:
func (*WorkBook) Parse ¶
func (w *WorkBook) Parse(buf io.ReadSeeker)
func (*WorkBook) ReadAllCells ¶
helper function to read all cells from file Notice: the max value is the limit of the max capacity of lines. Warning: the helper function will need big memeory if file is large.
type WorkSheet ¶
type WorkSheet struct {
Name string
Selected bool
Visibility TWorkSheetVisibility
//NOTICE: this is the max row number of the sheet, so it should be count -1
MaxRow uint16
// contains filtered or unexported fields
}
WorkSheet in one WorkBook
Source Files