// Copyright 2016 - 2024 The excelize Authors. All rights reserved. Use of // this source code is governed by a BSD-style license that can be found in // the LICENSE file. // // Package excelize providing a set of functions that allow you to write to and // read from XLAM / XLSM / XLSX / XLTM / XLTX files. Supports reading and // writing spreadsheet documents generated by Microsoft Excelâ„¢ 2007 and later. // Supports complex components by high compatibility, and provided streaming // API for generating or reading data from a worksheet with huge amounts of // data. This library needs Go version 1.18 or later. package excelize import ( "bytes" "encoding/xml" "fmt" "io" "os" "path" "path/filepath" "reflect" "regexp" "sort" "strconv" "strings" "unicode/utf16" "unicode/utf8" "github.com/mohae/deepcopy" ) // NewSheet provides the function to create a new sheet by given a worksheet // name and returns the index of the sheets in the workbook after it appended. // Note that when creating a new workbook, the default worksheet named // `Sheet1` will be created. func (f *File) NewSheet(sheet string) (int, error) { var err error if err = checkSheetName(sheet); err != nil { return -1, err } // Check if the worksheet already exists index, err := f.GetSheetIndex(sheet) if index != -1 { return index, err } _ = f.DeleteSheet(sheet) f.SheetCount++ wb, _ := f.workbookReader() sheetID := 0 for _, v := range wb.Sheets.Sheet { if v.SheetID > sheetID { sheetID = v.SheetID } } sheetID++ // Update [Content_Types].xml _ = f.setContentTypes("/xl/worksheets/sheet"+strconv.Itoa(sheetID)+".xml", ContentTypeSpreadSheetMLWorksheet) // Create new sheet /xl/worksheets/sheet%d.xml f.setSheet(sheetID, sheet) // Update workbook.xml.rels rID := f.addRels(f.getWorkbookRelsPath(), SourceRelationshipWorkSheet, fmt.Sprintf("/xl/worksheets/sheet%d.xml", sheetID), "") // Update workbook.xml f.setWorkbook(sheet, sheetID, rID) return f.GetSheetIndex(sheet) } // contentTypesReader provides a function to get the pointer to the // [Content_Types].xml structure after deserialization. func (f *File) contentTypesReader() (*xlsxTypes, error) { if f.ContentTypes == nil { f.ContentTypes = new(xlsxTypes) f.ContentTypes.mu.Lock() defer f.ContentTypes.mu.Unlock() if err := f.xmlNewDecoder(bytes.NewReader(namespaceStrictToTransitional(f.readXML(defaultXMLPathContentTypes)))). Decode(f.ContentTypes); err != nil && err != io.EOF { return f.ContentTypes, err } } return f.ContentTypes, nil } // contentTypesWriter provides a function to save [Content_Types].xml after // serialize structure. func (f *File) contentTypesWriter() { if f.ContentTypes != nil { output, _ := xml.Marshal(f.ContentTypes) f.saveFileList(defaultXMLPathContentTypes, output) } } // getWorksheetPath construct a target XML as xl/worksheets/sheet%d by split // path, compatible with different types of relative paths in // workbook.xml.rels, for example: worksheets/sheet%d.xml // and /xl/worksheets/sheet%d.xml func (f *File) getWorksheetPath(relTarget string) (path string) { path = filepath.ToSlash(strings.TrimPrefix( strings.ReplaceAll(filepath.Clean(fmt.Sprintf("%s/%s", filepath.Dir(f.getWorkbookPath()), relTarget)), "\\", "/"), "/")) if strings.HasPrefix(relTarget, "/") { path = filepath.ToSlash(strings.TrimPrefix(strings.ReplaceAll(filepath.Clean(relTarget), "\\", "/"), "/")) } return path } // mergeExpandedCols merge expanded columns. func (f *File) mergeExpandedCols(ws *xlsxWorksheet) { sort.Slice(ws.Cols.Col, func(i, j int) bool { return ws.Cols.Col[i].Min < ws.Cols.Col[j].Min }) var columns []xlsxCol for i, n := 0, len(ws.Cols.Col); i < n; { left := i for i++; i < n && reflect.DeepEqual( xlsxCol{ BestFit: ws.Cols.Col[i-1].BestFit, Collapsed: ws.Cols.Col[i-1].Collapsed, CustomWidth: ws.Cols.Col[i-1].CustomWidth, Hidden: ws.Cols.Col[i-1].Hidden, Max: ws.Cols.Col[i-1].Max + 1, Min: ws.Cols.Col[i-1].Min + 1, OutlineLevel: ws.Cols.Col[i-1].OutlineLevel, Phonetic: ws.Cols.Col[i-1].Phonetic, Style: ws.Cols.Col[i-1].Style, Width: ws.Cols.Col[i-1].Width, }, ws.Cols.Col[i]); i++ { } column := deepcopy.Copy(ws.Cols.Col[left]).(xlsxCol) if left < i-1 { column.Max = ws.Cols.Col[i-1].Min } columns = append(columns, column) } ws.Cols.Col = columns } // workSheetWriter provides a function to save xl/worksheets/sheet%d.xml after // serialize structure. func (f *File) workSheetWriter() { var ( arr []byte buffer = bytes.NewBuffer(arr) encoder = xml.NewEncoder(buffer) ) f.Sheet.Range(func(p, ws interface{}) bool { if ws != nil { sheet := ws.(*xlsxWorksheet) if sheet.MergeCells != nil && len(sheet.MergeCells.Cells) > 0 { _ = f.mergeOverlapCells(sheet) } if sheet.Cols != nil && len(sheet.Cols.Col) > 0 { f.mergeExpandedCols(sheet) } sheet.SheetData.Row = trimRow(&sheet.SheetData) if sheet.SheetPr != nil || sheet.Drawing != nil || sheet.Hyperlinks != nil || sheet.Picture != nil || sheet.TableParts != nil { f.addNameSpaces(p.(string), SourceRelationship) } if sheet.DecodeAlternateContent != nil { sheet.AlternateContent = &xlsxAlternateContent{ Content: sheet.DecodeAlternateContent.Content, XMLNSMC: SourceRelationshipCompatibility.Value, } } sheet.DecodeAlternateContent = nil // reusing buffer _ = encoder.Encode(sheet) f.saveFileList(p.(string), replaceRelationshipsBytes(f.replaceNameSpaceBytes(p.(string), buffer.Bytes()))) _, ok := f.checked.Load(p.(string)) if ok { f.Sheet.Delete(p.(string)) f.checked.Delete(p.(string)) } buffer.Reset() } return true }) } // trimRow provides a function to trim empty rows. func trimRow(sheetData *xlsxSheetData) []xlsxRow { var ( row xlsxRow i int ) for k := range sheetData.Row { row = sheetData.Row[k] if row = trimCell(row); len(row.C) != 0 || row.hasAttr() { sheetData.Row[i] = row } i++ } return sheetData.Row[:i] } // trimCell provides a function to trim blank cells which created by fillColumns. func trimCell(row xlsxRow) xlsxRow { column := row.C rowFull := true for i := range column { rowFull = column[i].hasValue() && rowFull } if rowFull { return row } i := 0 for _, c := range column { if c.hasValue() { row.C[i] = c i++ } } row.C = row.C[:i] return row } // setContentTypes provides a function to read and update property of contents // type of the spreadsheet. func (f *File) setContentTypes(partName, contentType string) error { content, err := f.contentTypesReader() if err != nil { return err } content.mu.Lock() defer content.mu.Unlock() content.Overrides = append(content.Overrides, xlsxOverride{ PartName: partName, ContentType: contentType, }) return err } // setSheet provides a function to update sheet property by given index. func (f *File) setSheet(index int, name string) { ws := xlsxWorksheet{ Dimension: &xlsxDimension{Ref: "A1"}, SheetViews: &xlsxSheetViews{ SheetView: []xlsxSheetView{{WorkbookViewID: 0}}, }, } sheetXMLPath := "xl/worksheets/sheet" + strconv.Itoa(index) + ".xml" f.sheetMap[name] = sheetXMLPath f.Sheet.Store(sheetXMLPath, &ws) f.xmlAttr.Store(sheetXMLPath, []xml.Attr{NameSpaceSpreadSheet}) } // relsWriter provides a function to save relationships after // serialize structure. func (f *File) relsWriter() { f.Relationships.Range(func(path, rel interface{}) bool { if rel != nil { output, _ := xml.Marshal(rel.(*xlsxRelationships)) if strings.HasPrefix(path.(string), "xl/worksheets/sheet/rels/sheet") { output = f.replaceNameSpaceBytes(path.(string), output) } f.saveFileList(path.(string), replaceRelationshipsBytes(output)) } return true }) } // replaceRelationshipsBytes; Some tools that read spreadsheet files have very // strict requirements about the structure of the input XML. This function is // a horrible hack to fix that after the XML marshalling is completed. func replaceRelationshipsBytes(content []byte) []byte { sourceXmlns := []byte(`xmlns:relationships="http://schemas.openxmlformats.org/officeDocument/2006/relationships" relationships`) targetXmlns := []byte("r") return bytesReplace(content, sourceXmlns, targetXmlns, -1) } // SetActiveSheet provides a function to set the default active sheet of the // workbook by a given index. Note that the active index is different from the // ID returned by function GetSheetMap(). It should be greater than or equal to 0 // and less than the total worksheet numbers. func (f *File) SetActiveSheet(index int) { if index < 0 { index = 0 } wb, _ := f.workbookReader() for activeTab := range wb.Sheets.Sheet { if activeTab == index { if wb.BookViews == nil { wb.BookViews = &xlsxBookViews{} } if len(wb.BookViews.WorkBookView) > 0 { wb.BookViews.WorkBookView[0].ActiveTab = activeTab } else { wb.BookViews.WorkBookView = append(wb.BookViews.WorkBookView, xlsxWorkBookView{ ActiveTab: activeTab, }) } } } for idx, name := range f.GetSheetList() { ws, err := f.workSheetReader(name) if err != nil { // Chartsheet, macrosheet or dialogsheet return } if ws.SheetViews == nil { ws.SheetViews = &xlsxSheetViews{ SheetView: []xlsxSheetView{{WorkbookViewID: 0}}, } } if len(ws.SheetViews.SheetView) > 0 { ws.SheetViews.SheetView[0].TabSelected = false } if index == idx { if len(ws.SheetViews.SheetView) > 0 { ws.SheetViews.SheetView[0].TabSelected = true } else { ws.SheetViews.SheetView = append(ws.SheetViews.SheetView, xlsxSheetView{ TabSelected: true, }) } } } } // GetActiveSheetIndex provides a function to get active sheet index of the // spreadsheet. If not found the active sheet will be return integer 0. func (f *File) GetActiveSheetIndex() (index int) { sheetID := f.getActiveSheetID() wb, _ := f.workbookReader() if wb != nil { for idx, sheet := range wb.Sheets.Sheet { if sheet.SheetID == sheetID { index = idx return } } } return } // getActiveSheetID provides a function to get active sheet ID of the // spreadsheet. If not found the active sheet will be return integer 0. func (f *File) getActiveSheetID() int { wb, _ := f.workbookReader() if wb != nil { if wb.BookViews != nil && len(wb.BookViews.WorkBookView) > 0 { activeTab := wb.BookViews.WorkBookView[0].ActiveTab if len(wb.Sheets.Sheet) > activeTab && wb.Sheets.Sheet[activeTab].SheetID != 0 { return wb.Sheets.Sheet[activeTab].SheetID } } if len(wb.Sheets.Sheet) >= 1 { return wb.Sheets.Sheet[0].SheetID } } return 0 } // SetSheetName provides a function to set the worksheet name by given source and // target worksheet names. Maximum 31 characters are allowed in sheet title and // this function only changes the name of the sheet and will not update the // sheet name in the formula or reference associated with the cell. So there // may be problem formula error or reference missing. func (f *File) SetSheetName(source, target string) error { var err error if err = checkSheetName(source); err != nil { return err } if err = checkSheetName(target); err != nil { return err } if target == source { return err } wb, _ := f.workbookReader() for k, v := range wb.Sheets.Sheet { if v.Name == source { wb.Sheets.Sheet[k].Name = target f.sheetMap[target] = f.sheetMap[source] delete(f.sheetMap, source) } } if wb.DefinedNames == nil { return err } for i, dn := range wb.DefinedNames.DefinedName { wb.DefinedNames.DefinedName[i].Data = adjustRangeSheetName(dn.Data, source, target) } return err } // GetSheetName provides a function to get the sheet name of the workbook by // the given sheet index. If the given sheet index is invalid, it will return // an empty string. func (f *File) GetSheetName(index int) (name string) { for idx, sheet := range f.GetSheetList() { if idx == index { name = sheet return } } return } // getSheetID provides a function to get worksheet ID of the spreadsheet by // given sheet name. If given worksheet name is invalid, will return an // integer type value -1. func (f *File) getSheetID(sheet string) int { for sheetID, name := range f.GetSheetMap() { if strings.EqualFold(name, sheet) { return sheetID } } return -1 } // GetSheetIndex provides a function to get a sheet index of the workbook by // the given sheet name. If the given sheet name is invalid or sheet doesn't // exist, it will return an integer type value -1. func (f *File) GetSheetIndex(sheet string) (int, error) { if err := checkSheetName(sheet); err != nil { return -1, err } for index, name := range f.GetSheetList() { if strings.EqualFold(name, sheet) { return index, nil } } return -1, nil } // GetSheetMap provides a function to get worksheets, chart sheets, dialog // sheets ID and name map of the workbook. For example: // // f, err := excelize.OpenFile("Book1.xlsx") // if err != nil { // return // } // defer func() { // if err := f.Close(); err != nil { // fmt.Println(err) // } // }() // for index, name := range f.GetSheetMap() { // fmt.Println(index, name) // } func (f *File) GetSheetMap() map[int]string { wb, _ := f.workbookReader() sheetMap := map[int]string{} if wb != nil { for _, sheet := range wb.Sheets.Sheet { sheetMap[sheet.SheetID] = sheet.Name } } return sheetMap } // GetSheetList provides a function to get worksheets, chart sheets, and // dialog sheets name list of the workbook. func (f *File) GetSheetList() (list []string) { wb, _ := f.workbookReader() if wb != nil { for _, sheet := range wb.Sheets.Sheet { list = append(list, sheet.Name) } } return } // getSheetMap provides a function to get worksheet name and XML file path map // of the spreadsheet. func (f *File) getSheetMap() (map[string]string, error) { maps := map[string]string{} wb, err := f.workbookReader() if err != nil { return nil, err } rels, err := f.relsReader(f.getWorkbookRelsPath()) if err != nil { return nil, err } if rels == nil { return maps, nil } for _, v := range wb.Sheets.Sheet { for _, rel := range rels.Relationships { if rel.ID == v.ID { sheetXMLPath := f.getWorksheetPath(rel.Target) if _, ok := f.Pkg.Load(sheetXMLPath); ok { maps[v.Name] = sheetXMLPath } if _, ok := f.tempFiles.Load(sheetXMLPath); ok { maps[v.Name] = sheetXMLPath } } } } return maps, nil } // getSheetXMLPath provides a function to get XML file path by given sheet // name. func (f *File) getSheetXMLPath(sheet string) (string, bool) { var ( name string ok bool ) for sheetName, filePath := range f.sheetMap { if strings.EqualFold(sheetName, sheet) { name, ok = filePath, true break } } return name, ok } // SetSheetBackground provides a function to set background picture by given // worksheet name and file path. Supported image types: BMP, EMF, EMZ, GIF, // JPEG, JPG, PNG, SVG, TIF, TIFF, WMF, and WMZ. func (f *File) SetSheetBackground(sheet, picture string) error { var err error // Check picture exists first. if _, err = os.Stat(picture); os.IsNotExist(err) { return err } file, _ := os.ReadFile(filepath.Clean(picture)) return f.setSheetBackground(sheet, path.Ext(picture), file) } // SetSheetBackgroundFromBytes provides a function to set background picture by // given worksheet name, extension name and image data. Supported image types: // BMP, EMF, EMZ, GIF, JPEG, JPG, PNG, SVG, TIF, TIFF, WMF, and WMZ. func (f *File) SetSheetBackgroundFromBytes(sheet, extension string, picture []byte) error { if len(picture) == 0 { return ErrParameterInvalid } return f.setSheetBackground(sheet, extension, picture) } // setSheetBackground provides a function to set background picture by given // worksheet name, file name extension and image data. func (f *File) setSheetBackground(sheet, extension string, file []byte) error { imageType, ok := supportedImageTypes[strings.ToLower(extension)] if !ok { return ErrImgExt } name := f.addMedia(file, imageType) sheetXMLPath, _ := f.getSheetXMLPath(sheet) sheetRels := "xl/worksheets/_rels/" + strings.TrimPrefix(sheetXMLPath, "xl/worksheets/") + ".rels" rID := f.addRels(sheetRels, SourceRelationshipImage, strings.Replace(name, "xl", "..", 1), "") if err := f.addSheetPicture(sheet, rID); err != nil { return err } f.addSheetNameSpace(sheet, SourceRelationship) return f.setContentTypePartImageExtensions() } // DeleteSheet provides a function to delete worksheet in a workbook by given // worksheet name. Use this method with caution, which will affect changes in // references such as formulas, charts, and so on. If there is any referenced // value of the deleted worksheet, it will cause a file error when you open // it. This function will be invalid when only one worksheet is left. func (f *File) DeleteSheet(sheet string) error { if err := checkSheetName(sheet); err != nil { return err } if idx, _ := f.GetSheetIndex(sheet); f.SheetCount == 1 || idx == -1 { return nil } wb, _ := f.workbookReader() wbRels, _ := f.relsReader(f.getWorkbookRelsPath()) activeSheetName := f.GetSheetName(f.GetActiveSheetIndex()) deleteLocalSheetID, _ := f.GetSheetIndex(sheet) deleteAndAdjustDefinedNames(wb, deleteLocalSheetID) for idx, v := range wb.Sheets.Sheet { if !strings.EqualFold(v.Name, sheet) { continue } wb.Sheets.Sheet = append(wb.Sheets.Sheet[:idx], wb.Sheets.Sheet[idx+1:]...) var sheetXML, rels string if wbRels != nil { for _, rel := range wbRels.Relationships { if rel.ID == v.ID { sheetXML = f.getWorksheetPath(rel.Target) sheetXMLPath, _ := f.getSheetXMLPath(sheet) rels = "xl/worksheets/_rels/" + strings.TrimPrefix(sheetXMLPath, "xl/worksheets/") + ".rels" } } } target := f.deleteSheetFromWorkbookRels(v.ID) _ = f.removeContentTypesPart(ContentTypeSpreadSheetMLWorksheet, target) _ = f.deleteCalcChain(f.getSheetID(sheet), "") delete(f.sheetMap, v.Name) f.Pkg.Delete(sheetXML) f.Pkg.Delete(rels) f.Relationships.Delete(rels) f.Sheet.Delete(sheetXML) f.xmlAttr.Delete(sheetXML) f.SheetCount-- } index, err := f.GetSheetIndex(activeSheetName) f.SetActiveSheet(index) return err } // MoveSheet moves a sheet to a specified position in the workbook. The function // moves the source sheet before the target sheet. After moving, other sheets // will be shifted to the left or right. If the sheet is already at the target // position, the function will not perform any action. Not that this function // will be ungroup all sheets after moving. For example, move Sheet2 before // Sheet1: // // err := f.MoveSheet("Sheet2", "Sheet1") func (f *File) MoveSheet(source, target string) error { if strings.EqualFold(source, target) { return nil } wb, err := f.workbookReader() if err != nil { return err } sourceIdx, err := f.GetSheetIndex(source) if err != nil { return err } targetIdx, err := f.GetSheetIndex(target) if err != nil { return err } if sourceIdx < 0 { return ErrSheetNotExist{source} } if targetIdx < 0 { return ErrSheetNotExist{target} } _ = f.UngroupSheets() activeSheetName := f.GetSheetName(f.GetActiveSheetIndex()) sourceSheet := wb.Sheets.Sheet[sourceIdx] wb.Sheets.Sheet = append(wb.Sheets.Sheet[:sourceIdx], wb.Sheets.Sheet[sourceIdx+1:]...) if targetIdx > sourceIdx { targetIdx-- } wb.Sheets.Sheet = append(wb.Sheets.Sheet[:targetIdx], append([]xlsxSheet{sourceSheet}, wb.Sheets.Sheet[targetIdx:]...)...) activeSheetIdx, _ := f.GetSheetIndex(activeSheetName) f.SetActiveSheet(activeSheetIdx) return err } // deleteAndAdjustDefinedNames delete and adjust defined name in the workbook // by given worksheet ID. func deleteAndAdjustDefinedNames(wb *xlsxWorkbook, deleteLocalSheetID int) { if wb == nil || wb.DefinedNames == nil { return } for idx := 0; idx < len(wb.DefinedNames.DefinedName); idx++ { dn := wb.DefinedNames.DefinedName[idx] if dn.LocalSheetID != nil { localSheetID := *dn.LocalSheetID if localSheetID == deleteLocalSheetID { wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName[:idx], wb.DefinedNames.DefinedName[idx+1:]...) idx-- } else if localSheetID > deleteLocalSheetID { wb.DefinedNames.DefinedName[idx].LocalSheetID = intPtr(*dn.LocalSheetID - 1) } } } } // deleteSheetFromWorkbookRels provides a function to remove worksheet // relationships by given relationships ID in the file workbook.xml.rels. func (f *File) deleteSheetFromWorkbookRels(rID string) string { rels, _ := f.relsReader(f.getWorkbookRelsPath()) rels.mu.Lock() defer rels.mu.Unlock() for k, v := range rels.Relationships { if v.ID == rID { rels.Relationships = append(rels.Relationships[:k], rels.Relationships[k+1:]...) return v.Target } } return "" } // deleteSheetRelationships provides a function to delete relationships in // xl/worksheets/_rels/sheet%d.xml.rels by given worksheet name and // relationship index. func (f *File) deleteSheetRelationships(sheet, rID string) { name, ok := f.getSheetXMLPath(sheet) if !ok { name = strings.ToLower(sheet) + ".xml" } rels := "xl/worksheets/_rels/" + strings.TrimPrefix(name, "xl/worksheets/") + ".rels" sheetRels, _ := f.relsReader(rels) if sheetRels == nil { sheetRels = &xlsxRelationships{} } sheetRels.mu.Lock() defer sheetRels.mu.Unlock() for k, v := range sheetRels.Relationships { if v.ID == rID { sheetRels.Relationships = append(sheetRels.Relationships[:k], sheetRels.Relationships[k+1:]...) } } f.Relationships.Store(rels, sheetRels) } // getSheetRelationshipsTargetByID provides a function to get Target attribute // value in xl/worksheets/_rels/sheet%d.xml.rels by given worksheet name and // relationship index. func (f *File) getSheetRelationshipsTargetByID(sheet, rID string) string { name, ok := f.getSheetXMLPath(sheet) if !ok { name = strings.ToLower(sheet) + ".xml" } rels := "xl/worksheets/_rels/" + strings.TrimPrefix(name, "xl/worksheets/") + ".rels" sheetRels, _ := f.relsReader(rels) if sheetRels == nil { sheetRels = &xlsxRelationships{} } sheetRels.mu.Lock() defer sheetRels.mu.Unlock() for _, v := range sheetRels.Relationships { if v.ID == rID { return v.Target } } return "" } // CopySheet provides a function to duplicate a worksheet by gave source and // target worksheet index. Note that currently doesn't support duplicate // workbooks that contain tables, charts or pictures. For Example: // // // Sheet1 already exists... // index, err := f.NewSheet("Sheet2") // if err != nil { // fmt.Println(err) // return // } // err := f.CopySheet(1, index) func (f *File) CopySheet(from, to int) error { if from < 0 || to < 0 || from == to || f.GetSheetName(from) == "" || f.GetSheetName(to) == "" { return ErrSheetIdx } return f.copySheet(from, to) } // copySheet provides a function to duplicate a worksheet by gave source and // target worksheet name. func (f *File) copySheet(from, to int) error { fromSheet := f.GetSheetName(from) sheet, err := f.workSheetReader(fromSheet) if err != nil { return err } worksheet := deepcopy.Copy(sheet).(*xlsxWorksheet) toSheetID := strconv.Itoa(f.getSheetID(f.GetSheetName(to))) sheetXMLPath := "xl/worksheets/sheet" + toSheetID + ".xml" if len(worksheet.SheetViews.SheetView) > 0 { worksheet.SheetViews.SheetView[0].TabSelected = false } worksheet.Drawing = nil worksheet.TableParts = nil worksheet.PageSetUp = nil f.Sheet.Store(sheetXMLPath, worksheet) toRels := "xl/worksheets/_rels/sheet" + toSheetID + ".xml.rels" fromRels := "xl/worksheets/_rels/sheet" + strconv.Itoa(f.getSheetID(fromSheet)) + ".xml.rels" if rels, ok := f.Pkg.Load(fromRels); ok && rels != nil { f.Pkg.Store(toRels, rels.([]byte)) } fromSheetXMLPath, _ := f.getSheetXMLPath(fromSheet) fromSheetAttr, _ := f.xmlAttr.Load(fromSheetXMLPath) f.xmlAttr.Store(sheetXMLPath, fromSheetAttr) return err } // getSheetState returns sheet visible enumeration by given hidden status. func getSheetState(visible bool, veryHidden []bool) string { state := "hidden" if !visible && len(veryHidden) > 0 && veryHidden[0] { state = "veryHidden" } return state } // SetSheetVisible provides a function to set worksheet visible by given // worksheet name. A workbook must contain at least one visible worksheet. If // the given worksheet has been activated, this setting will be invalidated. // The third optional veryHidden parameter only works when visible was false. // // For example, hide Sheet1: // // err := f.SetSheetVisible("Sheet1", false) func (f *File) SetSheetVisible(sheet string, visible bool, veryHidden ...bool) error { if err := checkSheetName(sheet); err != nil { return err } wb, err := f.workbookReader() if err != nil { return err } if visible { for k, v := range wb.Sheets.Sheet { if strings.EqualFold(v.Name, sheet) { wb.Sheets.Sheet[k].State = "" } } return err } count, state := 0, getSheetState(visible, veryHidden) for _, v := range wb.Sheets.Sheet { if v.State != state { count++ } } for k, v := range wb.Sheets.Sheet { ws, err := f.workSheetReader(v.Name) if err != nil { return err } tabSelected := false if ws.SheetViews == nil { ws.SheetViews = &xlsxSheetViews{ SheetView: []xlsxSheetView{{WorkbookViewID: 0}}, } } if len(ws.SheetViews.SheetView) > 0 { tabSelected = ws.SheetViews.SheetView[0].TabSelected } if strings.EqualFold(v.Name, sheet) && count > 1 && !tabSelected { wb.Sheets.Sheet[k].State = state } } return err } // setPanes set create freeze panes and split panes by given options. func (ws *xlsxWorksheet) setPanes(panes *Panes) error { if panes == nil { return ErrParameterInvalid } p := &xlsxPane{ ActivePane: panes.ActivePane, TopLeftCell: panes.TopLeftCell, XSplit: float64(panes.XSplit), YSplit: float64(panes.YSplit), } if panes.Freeze { p.State = "frozen" } if ws.SheetViews == nil { ws.SheetViews = &xlsxSheetViews{SheetView: []xlsxSheetView{{}}} } ws.SheetViews.SheetView[len(ws.SheetViews.SheetView)-1].Pane = p if !(panes.Freeze) && !(panes.Split) { if len(ws.SheetViews.SheetView) > 0 { ws.SheetViews.SheetView[len(ws.SheetViews.SheetView)-1].Pane = nil } } var s []*xlsxSelection for _, p := range panes.Selection { s = append(s, &xlsxSelection{ ActiveCell: p.ActiveCell, Pane: p.Pane, SQRef: p.SQRef, }) } ws.SheetViews.SheetView[len(ws.SheetViews.SheetView)-1].Selection = s return nil } // SetPanes provides a function to create and remove freeze panes and split panes // by given worksheet name and panes options. // // ActivePane defines the pane that is active. The possible values for this // attribute are defined in the following table: // // Enumeration Value | Description // ---------------------------------+------------------------------------------------------------- // bottomLeft (Bottom Left Pane) | Bottom left pane, when both vertical and horizontal // | splits are applied. // | // | This value is also used when only a horizontal split has // | been applied, dividing the pane into upper and lower // | regions. In that case, this value specifies the bottom // | pane. // | // bottomRight (Bottom Right Pane) | Bottom right pane, when both vertical and horizontal // | splits are applied. // | // topLeft (Top Left Pane) | Top left pane, when both vertical and horizontal splits // | are applied. // | // | This value is also used when only a horizontal split has // | been applied, dividing the pane into upper and lower // | regions. In that case, this value specifies the top pane. // | // | This value is also used when only a vertical split has // | been applied, dividing the pane into right and left // | regions. In that case, this value specifies the left pane // | // topRight (Top Right Pane) | Top right pane, when both vertical and horizontal // | splits are applied. // | // | This value is also used when only a vertical split has // | been applied, dividing the pane into right and left // | regions. In that case, this value specifies the right // | pane. // // Pane state type is restricted to the values supported currently listed in the following table: // // Enumeration Value | Description // ---------------------------------+------------------------------------------------------------- // frozen (Frozen) | Panes are frozen, but were not split being frozen. In // | this state, when the panes are unfrozen again, a single // | pane results, with no split. // | // | In this state, the split bars are not adjustable. // | // split (Split) | Panes are split, but not frozen. In this state, the split // | bars are adjustable by the user. // // XSplit (Horizontal Split Position): Horizontal position of the split, in // 1/20th of a point; 0 (zero) if none. If the pane is frozen, this value // indicates the number of columns visible in the top pane. // // YSplit (Vertical Split Position): Vertical position of the split, in 1/20th // of a point; 0 (zero) if none. If the pane is frozen, this value indicates the // number of rows visible in the left pane. The possible values for this // attribute are defined by the W3C XML Schema double datatype. // // TopLeftCell: Location of the top left visible cell in the bottom right pane // (when in Left-To-Right mode). // // SQRef (Sequence of References): Range of the selection. Can be non-contiguous // set of ranges. // // An example of how to freeze column A in the Sheet1 and set the active cell on // Sheet1!K16: // // err := f.SetPanes("Sheet1", &excelize.Panes{ // Freeze: true, // Split: false, // XSplit: 1, // YSplit: 0, // TopLeftCell: "B1", // ActivePane: "topRight", // Selection: []excelize.Selection{ // {SQRef: "K16", ActiveCell: "K16", Pane: "topRight"}, // }, // }) // // An example of how to freeze rows 1 to 9 in the Sheet1 and set the active cell // ranges on Sheet1!A11:XFD11: // // err := f.SetPanes("Sheet1", &excelize.Panes{ // Freeze: true, // Split: false, // XSplit: 0, // YSplit: 9, // TopLeftCell: "A34", // ActivePane: "bottomLeft", // Selection: []excelize.Selection{ // {SQRef: "A11:XFD11", ActiveCell: "A11", Pane: "bottomLeft"}, // }, // }) // // An example of how to create split panes in the Sheet1 and set the active cell // on Sheet1!J60: // // err := f.SetPanes("Sheet1", &excelize.Panes{ // Freeze: false, // Split: true, // XSplit: 3270, // YSplit: 1800, // TopLeftCell: "N57", // ActivePane: "bottomLeft", // Selection: []excelize.Selection{ // {SQRef: "I36", ActiveCell: "I36"}, // {SQRef: "G33", ActiveCell: "G33", Pane: "topRight"}, // {SQRef: "J60", ActiveCell: "J60", Pane: "bottomLeft"}, // {SQRef: "O60", ActiveCell: "O60", Pane: "bottomRight"}, // }, // }) // // An example of how to unfreeze and remove all panes on Sheet1: // // err := f.SetPanes("Sheet1", &excelize.Panes{Freeze: false, Split: false}) func (f *File) SetPanes(sheet string, panes *Panes) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } return ws.setPanes(panes) } // getPanes returns freeze panes, split panes, and views of the worksheet. func (ws *xlsxWorksheet) getPanes() Panes { var ( panes Panes section []Selection ) if ws.SheetViews == nil || len(ws.SheetViews.SheetView) < 1 { return panes } sw := ws.SheetViews.SheetView[len(ws.SheetViews.SheetView)-1] for _, s := range sw.Selection { if s != nil { section = append(section, Selection{ SQRef: s.SQRef, ActiveCell: s.ActiveCell, Pane: s.Pane, }) } } panes.Selection = section if sw.Pane == nil { return panes } panes.ActivePane = sw.Pane.ActivePane if sw.Pane.State == "frozen" { panes.Freeze = true } panes.TopLeftCell = sw.Pane.TopLeftCell panes.XSplit = int(sw.Pane.XSplit) panes.YSplit = int(sw.Pane.YSplit) return panes } // GetPanes provides a function to get freeze panes, split panes, and worksheet // views by given worksheet name. func (f *File) GetPanes(sheet string) (Panes, error) { var panes Panes ws, err := f.workSheetReader(sheet) if err != nil { return panes, err } return ws.getPanes(), err } // GetSheetVisible provides a function to get worksheet visible by given worksheet // name. For example, get visible state of Sheet1: // // visible, err := f.GetSheetVisible("Sheet1") func (f *File) GetSheetVisible(sheet string) (bool, error) { var visible bool if err := checkSheetName(sheet); err != nil { return visible, err } wb, _ := f.workbookReader() for k, v := range wb.Sheets.Sheet { if strings.EqualFold(v.Name, sheet) { if wb.Sheets.Sheet[k].State == "" || wb.Sheets.Sheet[k].State == "visible" { visible = true } } } return visible, nil } // SearchSheet provides a function to get cell reference by given worksheet name, // cell value, and regular expression. The function doesn't support searching // on the calculated result, formatted numbers and conditional lookup // currently. If it is a merged cell, it will return the cell reference of the // upper left cell of the merged range reference. // // An example of search the cell reference of the value of "100" on Sheet1: // // result, err := f.SearchSheet("Sheet1", "100") // // An example of search the cell reference where the numerical value in the range // of "0-9" of Sheet1 is described: // // result, err := f.SearchSheet("Sheet1", "[0-9]", true) func (f *File) SearchSheet(sheet, value string, reg ...bool) ([]string, error) { var ( regSearch bool result []string ) if err := checkSheetName(sheet); err != nil { return result, err } for _, r := range reg { regSearch = r } name, ok := f.getSheetXMLPath(sheet) if !ok { return result, ErrSheetNotExist{sheet} } if ws, ok := f.Sheet.Load(name); ok && ws != nil { // Flush data output, _ := xml.Marshal(ws.(*xlsxWorksheet)) f.saveFileList(name, f.replaceNameSpaceBytes(name, output)) } return f.searchSheet(name, value, regSearch) } // searchSheet provides a function to get cell reference by given worksheet // name, cell value, and regular expression. func (f *File) searchSheet(name, value string, regSearch bool) (result []string, err error) { var ( cellName, inElement string cellCol, row int sst *xlsxSST ) if sst, err = f.sharedStringsReader(); err != nil { return } regex := regexp.MustCompile(value) decoder := f.xmlNewDecoder(bytes.NewReader(f.readBytes(name))) for { var token xml.Token token, err = decoder.Token() if err != nil || token == nil { if err == io.EOF { err = nil } break } switch xmlElement := token.(type) { case xml.StartElement: inElement = xmlElement.Name.Local if inElement == "row" { row, err = attrValToInt("r", xmlElement.Attr) if err != nil { return } } if inElement == "c" { colCell := xlsxC{} _ = decoder.DecodeElement(&colCell, &xmlElement) val, _ := colCell.getValueFrom(f, sst, false) if regSearch { if !regex.MatchString(val) { continue } } else { if val != value { continue } } cellCol, _, err = CellNameToCoordinates(colCell.R) if err != nil { return result, err } cellName, err = CoordinatesToCellName(cellCol, row) if err != nil { return result, err } result = append(result, cellName) } default: } } return } // attrValToInt provides a function to convert the local names to an integer // by given XML attributes and specified names. func attrValToInt(name string, attrs []xml.Attr) (val int, err error) { for _, attr := range attrs { if attr.Name.Local == name { val, err = strconv.Atoi(attr.Value) if err != nil { return } } } return } // attrValToFloat provides a function to convert the local names to a float64 // by given XML attributes and specified names. func attrValToFloat(name string, attrs []xml.Attr) (val float64, err error) { for _, attr := range attrs { if attr.Name.Local == name { val, err = strconv.ParseFloat(attr.Value, 64) if err != nil { return } } } return } // attrValToBool provides a function to convert the local names to a boolean // by given XML attributes and specified names. func attrValToBool(name string, attrs []xml.Attr) (val bool, err error) { for _, attr := range attrs { if attr.Name.Local == name { val, err = strconv.ParseBool(attr.Value) if err != nil { return } } } return } // SetHeaderFooter provides a function to set headers and footers by given // worksheet name and the control characters. // // Headers and footers are specified using the following settings fields: // // Fields | Description // ------------------+----------------------------------------------------------- // AlignWithMargins | Align header footer margins with page margins // DifferentFirst | Different first-page header and footer indicator // DifferentOddEven | Different odd and even page headers and footers indicator // ScaleWithDoc | Scale header and footer with document scaling // OddFooter | Odd Page Footer, or primary Page Footer if 'DifferentOddEven' is 'false' // OddHeader | Odd Header, or primary Page Header if 'DifferentOddEven' is 'false' // EvenFooter | Even Page Footer // EvenHeader | Even Page Header // FirstFooter | First Page Footer // FirstHeader | First Page Header // // The following formatting codes can be used in 6 string type fields: // OddHeader, OddFooter, EvenHeader, EvenFooter, FirstFooter, FirstHeader // // Formatting Code | Description // ------------------------+------------------------------------------------------------------------- // && | The character "&" // | // &font-size | Size of the text font, where font-size is a decimal font size in points // | // &"font name,font type" | A text font-name string, font name, and a text font-type string, // | font type // | // &"-,Regular" | Regular text format. Toggles bold and italic modes to off // | // &A | Current worksheet's tab name // | // &B or &"-,Bold" | Bold text format, from off to on, or vice versa. The default mode is off // | // &D | Current date // | // &C | Center section // | // &E | Double-underline text format // | // &F | Current workbook's file name // | // &G | Drawing object as background (Use AddHeaderFooterImage) // | // &H | Shadow text format // | // &I or &"-,Italic" | Italic text format // | // &K | Text font color // | // | An RGB Color is specified as RRGGBB // | // | A Theme Color is specified as TTSNNN where TT is the theme color Id, // | S is either "+" or "-" of the tint/shade value, and NNN is the // | tint/shade value // | // &L | Left section // | // &N | Total number of pages // | // &O | Outline text format // | // &P[[+|-]n] | Without the optional suffix, the current page number in decimal // | // &R | Right section // | // &S | Strike through text format // | // &T | Current time // | // &U | Single-underline text format. If double-underline mode is on, the next // | occurrence in a section specifier toggles double-underline mode to off; // | otherwise, it toggles single-underline mode, from off to on, or vice // | versa. The default mode is off // | // &X | Superscript text format // | // &Y | Subscript text format // | // &Z | Current workbook's file path // // For example: // // err := f.SetHeaderFooter("Sheet1", &excelize.HeaderFooterOptions{ // DifferentFirst: true, // DifferentOddEven: true, // OddHeader: "&R&P", // OddFooter: "&C&F", // EvenHeader: "&L&P", // EvenFooter: "&L&D&R&T", // FirstHeader: `&CCenter &"-,Bold"Bold&"-,Regular"HeaderU+000A&D`, // }) // // This example shows: // // - The first page has its own header and footer // // - Odd and even-numbered pages have different headers and footers // // - Current page number in the right section of odd-page headers // // - Current workbook's file name in the center section of odd-page footers // // - Current page number in the left section of even-page headers // // - Current date in the left section and the current time in the right section // of even-page footers // // - The text "Center Bold Header" on the first line of the center section of // the first page, and the date on the second line of the center section of // that same page // // - No footer on the first page func (f *File) SetHeaderFooter(sheet string, opts *HeaderFooterOptions) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } if opts == nil { ws.HeaderFooter = nil return err } v := reflect.ValueOf(*opts) // Check 6 string type fields: OddHeader, OddFooter, EvenHeader, EvenFooter, // FirstFooter, FirstHeader for i := 4; i < v.NumField()-1; i++ { if len(utf16.Encode([]rune(v.Field(i).String()))) > MaxFieldLength { return newFieldLengthError(v.Type().Field(i).Name) } } ws.HeaderFooter = &xlsxHeaderFooter{ AlignWithMargins: opts.AlignWithMargins, DifferentFirst: opts.DifferentFirst, DifferentOddEven: opts.DifferentOddEven, ScaleWithDoc: opts.ScaleWithDoc, OddHeader: opts.OddHeader, OddFooter: opts.OddFooter, EvenHeader: opts.EvenHeader, EvenFooter: opts.EvenFooter, FirstFooter: opts.FirstFooter, FirstHeader: opts.FirstHeader, } return err } // GetHeaderFooter provides a function to get worksheet header and footer by // given worksheet name. func (f *File) GetHeaderFooter(sheet string) (*HeaderFooterOptions, error) { var opts *HeaderFooterOptions ws, err := f.workSheetReader(sheet) if err != nil { return opts, err } if ws.HeaderFooter == nil { return opts, err } opts = &HeaderFooterOptions{ AlignWithMargins: ws.HeaderFooter.AlignWithMargins, DifferentFirst: ws.HeaderFooter.DifferentFirst, DifferentOddEven: ws.HeaderFooter.DifferentOddEven, ScaleWithDoc: ws.HeaderFooter.ScaleWithDoc, OddHeader: ws.HeaderFooter.OddHeader, OddFooter: ws.HeaderFooter.OddFooter, EvenHeader: ws.HeaderFooter.EvenHeader, EvenFooter: ws.HeaderFooter.EvenFooter, FirstHeader: ws.HeaderFooter.FirstHeader, FirstFooter: ws.HeaderFooter.FirstFooter, } return opts, err } // ProtectSheet provides a function to prevent other users from accidentally or // deliberately changing, moving, or deleting data in a worksheet. The // optional field AlgorithmName specified hash algorithm, support XOR, MD4, // MD5, SHA-1, SHA2-56, SHA-384, and SHA-512 currently, if no hash algorithm // specified, will be using the XOR algorithm as default. For example, protect // Sheet1 with protection settings: // // err := f.ProtectSheet("Sheet1", &excelize.SheetProtectionOptions{ // AlgorithmName: "SHA-512", // Password: "password", // SelectLockedCells: true, // SelectUnlockedCells: true, // EditScenarios: true, // }) func (f *File) ProtectSheet(sheet string, opts *SheetProtectionOptions) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } if opts == nil { return ErrParameterInvalid } ws.SheetProtection = &xlsxSheetProtection{ AutoFilter: !opts.AutoFilter, DeleteColumns: !opts.DeleteColumns, DeleteRows: !opts.DeleteRows, FormatCells: !opts.FormatCells, FormatColumns: !opts.FormatColumns, FormatRows: !opts.FormatRows, InsertColumns: !opts.InsertColumns, InsertHyperlinks: !opts.InsertHyperlinks, InsertRows: !opts.InsertRows, Objects: !opts.EditObjects, PivotTables: !opts.PivotTables, Scenarios: !opts.EditScenarios, SelectLockedCells: !opts.SelectLockedCells, SelectUnlockedCells: !opts.SelectUnlockedCells, Sheet: true, Sort: !opts.Sort, } if opts.Password != "" { if opts.AlgorithmName == "" { ws.SheetProtection.Password = genSheetPasswd(opts.Password) return err } hashValue, saltValue, err := genISOPasswdHash(opts.Password, opts.AlgorithmName, "", int(sheetProtectionSpinCount)) if err != nil { return err } ws.SheetProtection.Password = "" ws.SheetProtection.AlgorithmName = opts.AlgorithmName ws.SheetProtection.SaltValue = saltValue ws.SheetProtection.HashValue = hashValue ws.SheetProtection.SpinCount = int(sheetProtectionSpinCount) } return err } // UnprotectSheet provides a function to remove protection for a sheet, // specified the second optional password parameter to remove sheet // protection with password verification. func (f *File) UnprotectSheet(sheet string, password ...string) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } // password verification if len(password) > 0 { if ws.SheetProtection == nil { return ErrUnprotectSheet } if ws.SheetProtection.AlgorithmName == "" && ws.SheetProtection.Password != genSheetPasswd(password[0]) { return ErrUnprotectSheetPassword } if ws.SheetProtection.AlgorithmName != "" { // check with given salt value hashValue, _, err := genISOPasswdHash(password[0], ws.SheetProtection.AlgorithmName, ws.SheetProtection.SaltValue, ws.SheetProtection.SpinCount) if err != nil { return err } if ws.SheetProtection.HashValue != hashValue { return ErrUnprotectSheetPassword } } } ws.SheetProtection = nil return err } // checkSheetName check whether there are illegal characters in the sheet name. // 1. Confirm that the sheet name is not empty // 2. Make sure to enter a name with no more than 31 characters // 3. Make sure the first or last character of the name cannot be a single quote // 4. Verify that the following characters are not included in the name :\/?*[] func checkSheetName(name string) error { if name == "" { return ErrSheetNameBlank } if utf8.RuneCountInString(name) > MaxSheetNameLength { return ErrSheetNameLength } if strings.HasPrefix(name, "'") || strings.HasSuffix(name, "'") { return ErrSheetNameSingleQuote } if strings.ContainsAny(name, ":\\/?*[]") { return ErrSheetNameInvalid } return nil } // SetPageLayout provides a function to sets worksheet page layout. // // The following shows the paper size sorted by excelize index number: // // Index | Paper Size // -------+----------------------------------------------- // 1 | Letter paper (8.5 in. by 11 in.) // 2 | Letter small paper (8.5 in. by 11 in.) // 3 | Tabloid paper (11 in. by 17 in.) // 4 | Ledger paper (17 in. by 11 in.) // 5 | Legal paper (8.5 in. by 14 in.) // 6 | Statement paper (5.5 in. by 8.5 in.) // 7 | Executive paper (7.25 in. by 10.5 in.) // 8 | A3 paper (297 mm by 420 mm) // 9 | A4 paper (210 mm by 297 mm) // 10 | A4 small paper (210 mm by 297 mm) // 11 | A5 paper (148 mm by 210 mm) // 12 | B4 paper (250 mm by 353 mm) // 13 | B5 paper (176 mm by 250 mm) // 14 | Folio paper (8.5 in. by 13 in.) // 15 | Quarto paper (215 mm by 275 mm) // 16 | Standard paper (10 in. by 14 in.) // 17 | Standard paper (11 in. by 17 in.) // 18 | Note paper (8.5 in. by 11 in.) // 19 | #9 envelope (3.875 in. by 8.875 in.) // 20 | #10 envelope (4.125 in. by 9.5 in.) // 21 | #11 envelope (4.5 in. by 10.375 in.) // 22 | #12 envelope (4.75 in. by 11 in.) // 23 | #14 envelope (5 in. by 11.5 in.) // 24 | C paper (17 in. by 22 in.) // 25 | D paper (22 in. by 34 in.) // 26 | E paper (34 in. by 44 in.) // 27 | DL envelope (110 mm by 220 mm) // 28 | C5 envelope (162 mm by 229 mm) // 29 | C3 envelope (324 mm by 458 mm) // 30 | C4 envelope (229 mm by 324 mm) // 31 | C6 envelope (114 mm by 162 mm) // 32 | C65 envelope (114 mm by 229 mm) // 33 | B4 envelope (250 mm by 353 mm) // 34 | B5 envelope (176 mm by 250 mm) // 35 | B6 envelope (176 mm by 125 mm) // 36 | Italy envelope (110 mm by 230 mm) // 37 | Monarch envelope (3.875 in. by 7.5 in.). // 38 | 6 3/4 envelope (3.625 in. by 6.5 in.) // 39 | US standard fanfold (14.875 in. by 11 in.) // 40 | German standard fanfold (8.5 in. by 12 in.) // 41 | German legal fanfold (8.5 in. by 13 in.) // 42 | ISO B4 (250 mm by 353 mm) // 43 | Japanese postcard (100 mm by 148 mm) // 44 | Standard paper (9 in. by 11 in.) // 45 | Standard paper (10 in. by 11 in.) // 46 | Standard paper (15 in. by 11 in.) // 47 | Invite envelope (220 mm by 220 mm) // 50 | Letter extra paper (9.275 in. by 12 in.) // 51 | Legal extra paper (9.275 in. by 15 in.) // 52 | Tabloid extra paper (11.69 in. by 18 in.) // 53 | A4 extra paper (236 mm by 322 mm) // 54 | Letter transverse paper (8.275 in. by 11 in.) // 55 | A4 transverse paper (210 mm by 297 mm) // 56 | Letter extra transverse paper (9.275 in. by 12 in.) // 57 | SuperA/SuperA/A4 paper (227 mm by 356 mm) // 58 | SuperB/SuperB/A3 paper (305 mm by 487 mm) // 59 | Letter plus paper (8.5 in. by 12.69 in.) // 60 | A4 plus paper (210 mm by 330 mm) // 61 | A5 transverse paper (148 mm by 210 mm) // 62 | JIS B5 transverse paper (182 mm by 257 mm) // 63 | A3 extra paper (322 mm by 445 mm) // 64 | A5 extra paper (174 mm by 235 mm) // 65 | ISO B5 extra paper (201 mm by 276 mm) // 66 | A2 paper (420 mm by 594 mm) // 67 | A3 transverse paper (297 mm by 420 mm) // 68 | A3 extra transverse paper (322 mm by 445 mm) // 69 | Japanese Double Postcard (200 mm x 148 mm) // 70 | A6 (105 mm x 148 mm) // 71 | Japanese Envelope Kaku #2 // 72 | Japanese Envelope Kaku #3 // 73 | Japanese Envelope Chou #3 // 74 | Japanese Envelope Chou #4 // 75 | Letter Rotated (11in x 8 1/2 11 in) // 76 | A3 Rotated (420 mm x 297 mm) // 77 | A4 Rotated (297 mm x 210 mm) // 78 | A5 Rotated (210 mm x 148 mm) // 79 | B4 (JIS) Rotated (364 mm x 257 mm) // 80 | B5 (JIS) Rotated (257 mm x 182 mm) // 81 | Japanese Postcard Rotated (148 mm x 100 mm) // 82 | Double Japanese Postcard Rotated (148 mm x 200 mm) // 83 | A6 Rotated (148 mm x 105 mm) // 84 | Japanese Envelope Kaku #2 Rotated // 85 | Japanese Envelope Kaku #3 Rotated // 86 | Japanese Envelope Chou #3 Rotated // 87 | Japanese Envelope Chou #4 Rotated // 88 | B6 (JIS) (128 mm x 182 mm) // 89 | B6 (JIS) Rotated (182 mm x 128 mm) // 90 | (12 in x 11 in) // 91 | Japanese Envelope You #4 // 92 | Japanese Envelope You #4 Rotated // 93 | PRC 16K (146 mm x 215 mm) // 94 | PRC 32K (97 mm x 151 mm) // 95 | PRC 32K(Big) (97 mm x 151 mm) // 96 | PRC Envelope #1 (102 mm x 165 mm) // 97 | PRC Envelope #2 (102 mm x 176 mm) // 98 | PRC Envelope #3 (125 mm x 176 mm) // 99 | PRC Envelope #4 (110 mm x 208 mm) // 100 | PRC Envelope #5 (110 mm x 220 mm) // 101 | PRC Envelope #6 (120 mm x 230 mm) // 102 | PRC Envelope #7 (160 mm x 230 mm) // 103 | PRC Envelope #8 (120 mm x 309 mm) // 104 | PRC Envelope #9 (229 mm x 324 mm) // 105 | PRC Envelope #10 (324 mm x 458 mm) // 106 | PRC 16K Rotated // 107 | PRC 32K Rotated // 108 | PRC 32K(Big) Rotated // 109 | PRC Envelope #1 Rotated (165 mm x 102 mm) // 110 | PRC Envelope #2 Rotated (176 mm x 102 mm) // 111 | PRC Envelope #3 Rotated (176 mm x 125 mm) // 112 | PRC Envelope #4 Rotated (208 mm x 110 mm) // 113 | PRC Envelope #5 Rotated (220 mm x 110 mm) // 114 | PRC Envelope #6 Rotated (230 mm x 120 mm) // 115 | PRC Envelope #7 Rotated (230 mm x 160 mm) // 116 | PRC Envelope #8 Rotated (309 mm x 120 mm) // 117 | PRC Envelope #9 Rotated (324 mm x 229 mm) // 118 | PRC Envelope #10 Rotated (458 mm x 324 mm) func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } if opts == nil { return err } return ws.setPageSetUp(opts) } // newPageSetUp initialize page setup settings for the worksheet if which not // exist. func (ws *xlsxWorksheet) newPageSetUp() { if ws.PageSetUp == nil { ws.PageSetUp = new(xlsxPageSetUp) } } // setPageSetUp set page setup settings for the worksheet by given options. func (ws *xlsxWorksheet) setPageSetUp(opts *PageLayoutOptions) error { if opts.Size != nil { ws.newPageSetUp() ws.PageSetUp.PaperSize = opts.Size } if opts.Orientation != nil { if inStrSlice(supportedPageOrientation, *opts.Orientation, true) == -1 { return newInvalidPageLayoutValueError("Orientation", *opts.Orientation, strings.Join(supportedPageOrientation, ", ")) } ws.newPageSetUp() ws.PageSetUp.Orientation = *opts.Orientation } if opts.FirstPageNumber != nil && *opts.FirstPageNumber > 0 { ws.newPageSetUp() ws.PageSetUp.FirstPageNumber = strconv.Itoa(int(*opts.FirstPageNumber)) ws.PageSetUp.UseFirstPageNumber = true } if opts.AdjustTo != nil { if *opts.AdjustTo < 10 || 400 < *opts.AdjustTo { return ErrPageSetupAdjustTo } ws.newPageSetUp() ws.PageSetUp.Scale = int(*opts.AdjustTo) } if opts.FitToHeight != nil { ws.newPageSetUp() ws.PageSetUp.FitToHeight = opts.FitToHeight } if opts.FitToWidth != nil { ws.newPageSetUp() ws.PageSetUp.FitToWidth = opts.FitToWidth } if opts.BlackAndWhite != nil { ws.newPageSetUp() ws.PageSetUp.BlackAndWhite = *opts.BlackAndWhite } if opts.PageOrder != nil { if inStrSlice(supportedPageOrder, *opts.PageOrder, true) == -1 { return newInvalidPageLayoutValueError("PageOrder", *opts.PageOrder, strings.Join(supportedPageOrder, ", ")) } ws.newPageSetUp() ws.PageSetUp.PageOrder = *opts.PageOrder } return nil } // GetPageLayout provides a function to gets worksheet page layout. func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error) { opts := PageLayoutOptions{ Size: intPtr(0), Orientation: stringPtr(supportedPageOrientation[0]), FirstPageNumber: uintPtr(1), AdjustTo: uintPtr(100), } ws, err := f.workSheetReader(sheet) if err != nil { return opts, err } if ws.PageSetUp != nil { if ws.PageSetUp.PaperSize != nil { opts.Size = ws.PageSetUp.PaperSize } if ws.PageSetUp.Orientation != "" { opts.Orientation = stringPtr(ws.PageSetUp.Orientation) } if num, _ := strconv.Atoi(ws.PageSetUp.FirstPageNumber); num != 0 { opts.FirstPageNumber = uintPtr(uint(num)) } if ws.PageSetUp.Scale >= 10 && ws.PageSetUp.Scale <= 400 { opts.AdjustTo = uintPtr(uint(ws.PageSetUp.Scale)) } if ws.PageSetUp.FitToHeight != nil { opts.FitToHeight = ws.PageSetUp.FitToHeight } if ws.PageSetUp.FitToWidth != nil { opts.FitToWidth = ws.PageSetUp.FitToWidth } opts.BlackAndWhite = boolPtr(ws.PageSetUp.BlackAndWhite) if ws.PageSetUp.PageOrder != "" { opts.PageOrder = stringPtr(ws.PageSetUp.PageOrder) } } return opts, err } // SetDefinedName provides a function to set the defined names of the workbook // or worksheet. If not specified scope, the default scope is workbook. // For example: // // err := f.SetDefinedName(&excelize.DefinedName{ // Name: "Amount", // RefersTo: "Sheet1!$A$2:$D$5", // Comment: "defined name comment", // Scope: "Sheet2", // }) // // If you fill the RefersTo property with only one columns range without a // comma, it will work as "Columns to repeat at left" only. For example: // // err := f.SetDefinedName(&excelize.DefinedName{ // Name: "_xlnm.Print_Titles", // RefersTo: "Sheet1!$A:$A", // Scope: "Sheet1", // }) // // If you fill the RefersTo property with only one rows range without a comma, // it will work as "Rows to repeat at top" only. For example: // // err := f.SetDefinedName(&excelize.DefinedName{ // Name: "_xlnm.Print_Titles", // RefersTo: "Sheet1!$1:$1", // Scope: "Sheet1", // }) func (f *File) SetDefinedName(definedName *DefinedName) error { if definedName.Name == "" || definedName.RefersTo == "" { return ErrParameterInvalid } if err := checkDefinedName(definedName.Name); err != nil && inStrSlice(builtInDefinedNames[:2], definedName.Name, false) == -1 { return err } wb, err := f.workbookReader() if err != nil { return err } d := xlsxDefinedName{ Name: definedName.Name, Comment: definedName.Comment, Data: definedName.RefersTo, } if definedName.Scope != "" { if sheetIndex, _ := f.GetSheetIndex(definedName.Scope); sheetIndex >= 0 { d.LocalSheetID = &sheetIndex } } if wb.DefinedNames != nil { for _, dn := range wb.DefinedNames.DefinedName { var scope string if dn.LocalSheetID != nil { scope = f.GetSheetName(*dn.LocalSheetID) } if scope == definedName.Scope && dn.Name == definedName.Name { return ErrDefinedNameDuplicate } } wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName, d) return nil } wb.DefinedNames = &xlsxDefinedNames{ DefinedName: []xlsxDefinedName{d}, } return nil } // DeleteDefinedName provides a function to delete the defined names of the // workbook or worksheet. If not specified scope, the default scope is // workbook. For example: // // err := f.DeleteDefinedName(&excelize.DefinedName{ // Name: "Amount", // Scope: "Sheet2", // }) func (f *File) DeleteDefinedName(definedName *DefinedName) error { wb, err := f.workbookReader() if err != nil { return err } if wb.DefinedNames != nil { for idx, dn := range wb.DefinedNames.DefinedName { scope := "Workbook" deleteScope := definedName.Scope if deleteScope == "" { deleteScope = "Workbook" } if dn.LocalSheetID != nil { scope = f.GetSheetName(*dn.LocalSheetID) } if scope == deleteScope && dn.Name == definedName.Name { wb.DefinedNames.DefinedName = append(wb.DefinedNames.DefinedName[:idx], wb.DefinedNames.DefinedName[idx+1:]...) return err } } } return ErrDefinedNameScope } // GetDefinedName provides a function to get the defined names of the workbook // or worksheet. func (f *File) GetDefinedName() []DefinedName { var definedNames []DefinedName wb, _ := f.workbookReader() if wb.DefinedNames != nil { for _, dn := range wb.DefinedNames.DefinedName { definedName := DefinedName{ Name: dn.Name, Comment: dn.Comment, RefersTo: dn.Data, Scope: "Workbook", } if dn.LocalSheetID != nil && *dn.LocalSheetID >= 0 { definedName.Scope = f.GetSheetName(*dn.LocalSheetID) } definedNames = append(definedNames, definedName) } } return definedNames } // GroupSheets provides a function to group worksheets by given worksheets // name. Group worksheets must contain an active worksheet. func (f *File) GroupSheets(sheets []string) error { // Check an active worksheet in group worksheets var inActiveSheet bool activeSheet := f.GetActiveSheetIndex() sheetMap := f.GetSheetList() for idx, sheetName := range sheetMap { for _, s := range sheets { if strings.EqualFold(s, sheetName) && idx == activeSheet { inActiveSheet = true } } } if !inActiveSheet { return ErrGroupSheets } // check worksheet exists var wss []*xlsxWorksheet for _, sheet := range sheets { worksheet, err := f.workSheetReader(sheet) if err != nil { return err } wss = append(wss, worksheet) } for _, ws := range wss { sheetViews := ws.SheetViews.SheetView for idx := range sheetViews { ws.SheetViews.SheetView[idx].TabSelected = true } } return nil } // UngroupSheets provides a function to ungroup worksheets. func (f *File) UngroupSheets() error { activeSheet := f.GetActiveSheetIndex() for index, sheet := range f.GetSheetList() { if activeSheet == index { continue } ws, _ := f.workSheetReader(sheet) sheetViews := ws.SheetViews.SheetView for idx := range sheetViews { ws.SheetViews.SheetView[idx].TabSelected = false } } return nil } // InsertPageBreak create a page break to determine where the printed page // ends and where begins the next one by given worksheet name and cell // reference, so the content before the page break will be printed on one page // and after the page break on another. func (f *File) InsertPageBreak(sheet, cell string) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } return ws.insertPageBreak(cell) } // insertPageBreak create a page break in the worksheet by specific cell // reference. func (ws *xlsxWorksheet) insertPageBreak(cell string) error { var ( row, col int err error rowBrk, colBrk = -1, -1 ) if col, row, err = CellNameToCoordinates(cell); err != nil { return err } col-- row-- if col == row && col == 0 { return err } if ws.RowBreaks == nil { ws.RowBreaks = &xlsxRowBreaks{} } if ws.ColBreaks == nil { ws.ColBreaks = &xlsxColBreaks{} } for idx, brk := range ws.RowBreaks.Brk { if brk.ID == row { rowBrk = idx } } for idx, brk := range ws.ColBreaks.Brk { if brk.ID == col { colBrk = idx } } if row != 0 && rowBrk == -1 { ws.RowBreaks.Brk = append(ws.RowBreaks.Brk, &xlsxBrk{ ID: row, Max: MaxColumns - 1, Man: true, }) ws.RowBreaks.ManualBreakCount++ } if col != 0 && colBrk == -1 { ws.ColBreaks.Brk = append(ws.ColBreaks.Brk, &xlsxBrk{ ID: col, Max: TotalRows - 1, Man: true, }) ws.ColBreaks.ManualBreakCount++ } ws.RowBreaks.Count = len(ws.RowBreaks.Brk) ws.ColBreaks.Count = len(ws.ColBreaks.Brk) return err } // RemovePageBreak remove a page break by given worksheet name and cell // reference. func (f *File) RemovePageBreak(sheet, cell string) error { var ( ws *xlsxWorksheet row, col int err error ) if ws, err = f.workSheetReader(sheet); err != nil { return err } if col, row, err = CellNameToCoordinates(cell); err != nil { return err } col-- row-- if col == row && col == 0 { return err } removeBrk := func(ID int, brks []*xlsxBrk) []*xlsxBrk { for i, brk := range brks { if brk.ID == ID { brks = append(brks[:i], brks[i+1:]...) } } return brks } if ws.RowBreaks == nil || ws.ColBreaks == nil { return err } rowBrks := len(ws.RowBreaks.Brk) colBrks := len(ws.ColBreaks.Brk) if rowBrks > 0 && rowBrks == colBrks { ws.RowBreaks.Brk = removeBrk(row, ws.RowBreaks.Brk) ws.ColBreaks.Brk = removeBrk(col, ws.ColBreaks.Brk) ws.RowBreaks.Count = len(ws.RowBreaks.Brk) ws.ColBreaks.Count = len(ws.ColBreaks.Brk) ws.RowBreaks.ManualBreakCount-- ws.ColBreaks.ManualBreakCount-- return err } if rowBrks > 0 && rowBrks > colBrks { ws.RowBreaks.Brk = removeBrk(row, ws.RowBreaks.Brk) ws.RowBreaks.Count = len(ws.RowBreaks.Brk) ws.RowBreaks.ManualBreakCount-- return err } if colBrks > 0 && colBrks > rowBrks { ws.ColBreaks.Brk = removeBrk(col, ws.ColBreaks.Brk) ws.ColBreaks.Count = len(ws.ColBreaks.Brk) ws.ColBreaks.ManualBreakCount-- } return err } // relsReader provides a function to get the pointer to the structure // after deserialization of relationships parts. func (f *File) relsReader(path string) (*xlsxRelationships, error) { rels, _ := f.Relationships.Load(path) if rels == nil { if _, ok := f.Pkg.Load(path); ok { c := xlsxRelationships{} if err := f.xmlNewDecoder(bytes.NewReader(namespaceStrictToTransitional(f.readXML(path)))). Decode(&c); err != nil && err != io.EOF { return nil, err } f.Relationships.Store(path, &c) } } if rels, _ = f.Relationships.Load(path); rels != nil { return rels.(*xlsxRelationships), nil } return nil, nil } // fillSheetData ensures there are enough rows, and columns in the chosen // row to accept data. Missing rows are backfilled and given their row number // Uses the last populated row as a hint for the size of the next row to add func (ws *xlsxWorksheet) prepareSheetXML(col int, row int) { rowCount := len(ws.SheetData.Row) sizeHint := 0 var ht *float64 var customHeight bool if ws.SheetFormatPr != nil && ws.SheetFormatPr.CustomHeight { ht = float64Ptr(ws.SheetFormatPr.DefaultRowHeight) customHeight = true } if rowCount > 0 { sizeHint = len(ws.SheetData.Row[rowCount-1].C) } if rowCount < row { // append missing rows for rowIdx := rowCount; rowIdx < row; rowIdx++ { ws.SheetData.Row = append(ws.SheetData.Row, xlsxRow{R: rowIdx + 1, CustomHeight: customHeight, Ht: ht, C: make([]xlsxC, 0, sizeHint)}) } } rowData := &ws.SheetData.Row[row-1] fillColumns(rowData, col, row) } // fillColumns fill cells in the column of the row as contiguous. func fillColumns(rowData *xlsxRow, col, row int) { cellCount := len(rowData.C) if cellCount < col { for colIdx := cellCount; colIdx < col; colIdx++ { cellName, _ := CoordinatesToCellName(colIdx+1, row) rowData.C = append(rowData.C, xlsxC{R: cellName}) } } } // makeContiguousColumns make columns in specific rows as contiguous. func (ws *xlsxWorksheet) makeContiguousColumns(fromRow, toRow, colCount int) { for ; fromRow < toRow; fromRow++ { rowData := &ws.SheetData.Row[fromRow-1] fillColumns(rowData, colCount, fromRow) } } // SetSheetDimension provides the method to set or remove the used range of the // worksheet by a given range reference. It specifies the row and column bounds // of used cells in the worksheet. The range reference is set using the A1 // reference style(e.g., "A1:D5"). Passing an empty range reference will remove // the used range of the worksheet. func (f *File) SetSheetDimension(sheet string, rangeRef string) error { ws, err := f.workSheetReader(sheet) if err != nil { return err } // Remove the dimension element if an empty string is provided if rangeRef == "" { ws.Dimension = nil return nil } parts := len(strings.Split(rangeRef, ":")) if parts == 1 { _, _, err = CellNameToCoordinates(rangeRef) if err == nil { ws.Dimension = &xlsxDimension{Ref: strings.ToUpper(rangeRef)} } return err } if parts != 2 { return ErrParameterInvalid } coordinates, err := rangeRefToCoordinates(rangeRef) if err != nil { return err } _ = sortCoordinates(coordinates) ref, err := coordinatesToRangeRef(coordinates) ws.Dimension = &xlsxDimension{Ref: ref} return err } // GetSheetDimension provides the method to get the used range of the worksheet. func (f *File) GetSheetDimension(sheet string) (string, error) { var ref string ws, err := f.workSheetReader(sheet) if err != nil { return ref, err } if ws.Dimension != nil { ref = ws.Dimension.Ref } return ref, err }