工作表

設定欄可見性

func (f *File) SetColVisible(sheet, col string, visible bool) error

根據給定的工作表名稱和欄名稱設定欄可見性。此功能是併發安全的。例如隱藏名為 Sheet1 工作表上的 D 欄：

err := f.SetColVisible("Sheet1", "D", false)

隱藏名稱為 Sheet1 的工作表中的 D 至 F 欄：

err := f.SetColVisible("Sheet1", "D:F", false)

設定欄寬度

func (f *File) SetColWidth(sheet, startCol, endCol string, width float64) error

根據給定的工作表名稱、列範圍和寬度值設定單個或多個列的寬度。此功能是併發安全的。例如設定名為 Sheet1 工作表上 A 到 H 欄的寬度為 20：

f := excelize.NewFile()
err := f.SetColWidth("Sheet1", "A", "H", 20)

設定列高度

func (f *File) SetRowHeight(sheet string, row int, height float64) error

根據給定的工作表名稱、列號和高度值設定單行高度，如果將高度的值設定為 0 將隱藏指定的列，如果將高度的值設定為 -1 將清除自訂列高。例如將工作表 Sheet1 首列的高度設定為 50：

err := f.SetRowHeight("Sheet1", 1, 50)

設定列可見性

func (f *File) SetRowVisible(sheet string, row int, visible bool) error

根據給定的工作表名稱和列號設定列可見性。例如隱藏名為 Sheet1 工作表上第二列：

err := f.SetRowVisible("Sheet1", 2, false)

獲取工作表名

func (f *File) GetSheetName(index int) string

根據給定的工作表索引獲取工作表名稱，如果工作表不存在將傳回空字符。

獲取欄可見性

func (f *File) GetColVisible(sheet, column string) (bool, error)

根據給定的工作表名稱和列名獲取工作表中指定列的可見性，可見傳回值為 true，否則為 false。此功能是併發安全的。例如，獲取名為 Sheet1 的工作表上 D 欄的可見性：

visible, err := f.GetColVisible("Sheet1", "D")

獲取欄寬度

func (f *File) GetColWidth(sheet, col string) (float64, error)

根據給定的工作表和列名獲取工作表中指定列的寬度。此功能是併發安全的。

獲取列高度

func (f *File) GetRowHeight(sheet string, row int) (float64, error)

根據給定的工作表名稱和列號獲取工作表中指定列的高度。例如，獲取名為 Sheet1 的工作表首列的高度：

height, err := f.GetRowHeight("Sheet1", 1)

獲取列可見性

func (f *File) GetRowVisible(sheet string, row int) (bool, error)

根據給定的工作表名稱和列號獲取工作表中指定列的可見性。例如，獲取名為 Sheet1 的工作表第 2 列的可見性：

visible, err := f.GetRowVisible("Sheet1", 2)

獲取工作表索引

func (f *File) GetSheetIndex(sheet string) (int, error)

根據給定的工作表名稱獲取該工作表的索引，如果工作表不存在將傳回 -1。

獲取到的索引可以在設定活頁簿默認工作表時，作為調用 SetActiveSheet() 函式的參數使用。

獲取工作表映射表

func (f *File) GetSheetMap() map[int]string

獲取活頁簿中以 ID 和名稱構成的全部工作表、圖表工作表和對話工作表映射表。

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) GetSheetList() []string

獲取與活頁簿內順序相一致的，包含工作表、圖表工作表、對話工作表在內的工作表列表。

設定工作表名稱

func (f *File) SetSheetName(source, target string) error

根據給定的新舊工作表名稱重命名工作表。工作表名稱最多允許使用 31 個字符，此功能僅更改工作表的名稱，而不會更新與儲存格關聯的公式或引用中的工作表名稱。因此使用此功能重命名工作表後可能導致公式錯誤或參考引用問題。

插入欄

func (f *File) InsertCols(sheet, col string, n int) error

根據給定的工作表名稱、欄名稱和要插入的欄數，在指定列前插入空白欄。例如，在名為 Sheet1 的工作表的 C 欄前插入 2 欄空白欄：

err := f.InsertCols("Sheet1", "C", 2)

插入列

func (f *File) InsertRows(sheet string, row, n int) error

根據給定的工作表名稱、列號和要插入的列數，在指定列前插入空白列。例如，在名為 Sheet1 的工作表的第 3 列前插入 2 列空白列：

err := f.InsertRows("Sheet1", 3, 2)

追加複製列

func (f *File) DuplicateRow(sheet string, row int) error

根據給定的工作表名稱和列號，在該列後追加複製。例如，將名為 Sheet1 的工作表的第 2 列複製到第 3 列：

err := f.DuplicateRow("Sheet1", 2)

請謹慎使用此方法，這將影響所有對該工作表中原有公式、圖表等資源引用的更改。如果該工作表包含任何引用值，在使用此方法後使用 Excel 應用程式開啓它時將可能導致檔案錯誤。excelize 目前僅支援對工作表上部分引用的更新。

複製列

func (f *File) DuplicateRowTo(sheet string, row, row2 int) error

根據給定的工作表名稱和列號，在指定列後複製該列。例如，將名為 Sheet1 的工作表的第 2 列後複製到第 7 列：

err := f.DuplicateRowTo("Sheet1", 2, 7)

創建列的分級顯示

func (f *File) SetRowOutlineLevel(sheet string, row int, level uint8) error

根據給定的工作表名稱、列號和分級參數創建組。例如，在名為 Sheet1 的工作表的第 2 列創建 1 級分組。

err := f.SetRowOutlineLevel("Sheet1", 2, 1)

創建欄的分級顯示

func (f *File) SetColOutlineLevel(sheet, col string, level uint8) error

根據給定的工作表名稱、列名稱和分級參數創建組。例如，在名為 Sheet1 的工作表的 D 欄創建 2 級分組。

err := f.SetColOutlineLevel("Sheet1", "D", 2)

獲取列的分級顯示

func (f *File) GetRowOutlineLevel(sheet string, row int) (uint8, error)

根據給定的工作表名稱和列號獲取分組級別。例如，獲取名為 Sheet1 的工作表第 2 列的分組級別。

err := f.GetRowOutlineLevel("Sheet1", 2)

獲取欄的分級顯示

func (f *File) GetColOutlineLevel(sheet, col string) (uint8, error)

根據給定的工作表名稱和列名稱獲取分組分級。例如，獲取名為 Sheet1 的工作表的 D 欄的分組級別。

level, err := f.GetColOutlineLevel("Sheet1", "D")

欄迭代器

func (f *File) Cols(sheet string) (*Cols, error)

根據給定的工作表名稱獲取該工作表的欄迭代器。此功能是併發安全的。使用欄迭代器進行流式讀取遍歷儲存格：

cols, err := f.Cols("Sheet1")
if err != nil {
    fmt.Println(err)
    return
}
for cols.Next() {
    col, err := cols.Rows()
    if err != nil {
        fmt.Println(err)
    }
    for _, rowCell := range col {
        fmt.Print(rowCell, "\t")
    }
    fmt.Println()
}

欄迭代器 - 單欄操作

func (cols *Cols) Rows(opts ...Options) ([]string, error)

返回當前欄所有列的值。

欄迭代器 - 遍歷操作

func (cols *Cols) Next() bool

如果下一欄有值存在將返回 true。

欄迭代器 - 錯誤處理

func (cols *Cols) Error() error

當查找下一欄出現錯誤時將返回 error。

列迭代器

func (f *File) Rows(sheet string) (*Rows, error)

根據給定的工作表名稱獲取該工作表的列迭代器。此功能是併發安全的。使用列迭代器進行流式讀取遍歷儲存格：

rows, err := f.Rows("Sheet1")
if err != nil {
    fmt.Println(err)
    return
}
for rows.Next() {
    row, err := rows.Columns()
    if err != nil {
        fmt.Println(err)
    }
    for _, colCell := range row {
        fmt.Print(colCell, "\t")
    }
    fmt.Println()
}
if err = rows.Close(); err != nil {
    fmt.Println(err)
}

列迭代器 - 單列操作

func (rows *Rows) Columns(opts ...Options) ([]string, error)

此函式流式逐列讀取工作表，傳回當前列中各欄存儲格的值，不會跳過工作表尾部的有效空白列。

列迭代器 - 遍歷操作

func (rows *Rows) Next() bool

如果下一列有值存在將傳回 true。

列迭代器 - 錯誤處理

func (rows *Rows) Error() error

當查找下一列出現錯誤時將傳回 error。

列迭代器 - 讀取列屬性

func (rows *Rows) GetRowOpts() RowOpts

返回當前列的列高、可見性和樣式 ID 屬性。

列迭代器 - 關閉數據流

func (rows *Rows) Close() error

關閉數據流並清理開啓工作表時可能產生的系統磁盤緩存。

在工作表中搜尋

func (f *File) SearchSheet(sheet, value string, reg ...bool) ([]string, error)

根據給定的工作表名稱，儲存格值或正則表達式來獲取坐標。此函式僅支援字符串和數字的完全匹配，不支援公式計算後的結果、格式化數字和條件搜尋。如果搜尋結果是合併的儲存格，將傳回合併區域左上角的坐標。

例如，在名為 Sheet1 的工作表中搜尋值 100 的坐標:

result, err := f.SearchSheet("Sheet1", "100")

例如，在名為 Sheet1 的工作表中搜尋 0-9 範圍內數值的坐標:

result, err := f.SearchSheet("Sheet1", "[0-9]", true)

保護工作表

func (f *File) ProtectSheet(sheet string, opts *SheetProtectionOptions) error

防止其他用戶意外或有意更改、移動或刪除工作表中的資料。可選字段 AlgorithmName 支援指定哈希算法 XOR、MD4、MD5、SHA-1、SHA-256、SHA-384 或 SHA-512，如果未指定哈希算法，默認使用 XOR 算法。例如，為名為 Sheet1 的工作表設定密碼保護，但是允許選擇鎖定的儲存格、選擇未鎖定的儲存格、編輯方案：

err := f.ProtectSheet("Sheet1", &excelize.SheetProtectionOptions{
    AlgorithmName:       "SHA-512",
    Password:            "password",
    SelectLockedCells:   true,
    SelectUnlockedCells: true,
    EditScenarios:       true,
})

SheetProtectionOptions 定義了保護工作表的設定選項。

type SheetProtectionOptions struct {
    AlgorithmName       string
    AutoFilter          bool
    DeleteColumns       bool
    DeleteRows          bool
    EditObjects         bool
    EditScenarios       bool
    FormatCells         bool
    FormatColumns       bool
    FormatRows          bool
    InsertColumns       bool
    InsertHyperlinks    bool
    InsertRows          bool
    Password            string
    PivotTables         bool
    SelectLockedCells   bool
    SelectUnlockedCells bool
    Sort                bool
}

取消保護工作表

func (f *File) UnprotectSheet(sheet string, password ...string) error

根據給定的工作表名稱取消保護該工作表，指定第二個可選密碼參數以透過密碼驗證來取消工作表保護。

刪除欄

func (f *File) RemoveCol(sheet, col string) error

根據給定的工作表名稱和欄名稱刪除指定欄。例如，刪除名為 Sheet1 的 C 欄：

err := f.RemoveCol("Sheet1", "C")

刪除列

func (f *File) RemoveRow(sheet string, row int) error

根據給定的工作表名稱和列號刪除指定列。例如，刪除名為 Sheet1 的第 3 列：

err := f.RemoveRow("Sheet1", 3)

請謹慎使用此方法，這將影響所有對該工作表中原有公式、圖表等資源引用的更改。如果該工作表包含任何引用值，在使用此方法後使用 Excel 應用程式開啓它時將可能導致檔案錯誤。Excelize 目前僅支援對工作表上部分引用的更新。

按欄賦值

func (f *File) SetSheetCol(sheet, cell string, slice interface{}) error

根據給定的工作表名稱、起始坐標和 slice 類型引用按欄賦值。例如，在名為 Sheet1 的工作表 B 欄上，以 B6 存儲格作為起始坐標按欄賦值：

err := f.SetSheetCol("Sheet1", "B6", &[]interface{}{"1", nil, 2})

按列賦值

func (f *File) SetSheetRow(sheet, cell string, slice interface{}) error

根據給定的工作表名稱、起始坐標和 slice 類型引用按列賦值。此功能是併發安全的。例如，在名為 Sheet1 的工作表第 6 列上，以 B6 存儲格作為起始坐標按列賦值：

err := f.SetSheetRow("Sheet1", "B6", &[]interface{}{"1", nil, 2})

插入分頁符

func (f *File) InsertPageBreak(sheet, cell string) error

根據給定的工作表名稱和儲存格坐標插入分頁符。分頁符是將工作表分成單獨的頁面以便列印的分隔線。

刪除分頁符

func (f *File) RemovePageBreak(sheet, cell string) error

根據給定的工作表名稱和儲存格坐標刪除分頁符。

設定工作表已用區域

func (f *File) SetSheetDimension(sheet string, rangeRef string) error

根據給定的工作表名稱和存儲格坐標或存儲格坐標區域設定或移除工作表的已用區域。使用的存儲格包括具有公式、文本內容和存儲格格式的存儲格。例如 A1:D5。當給定的存儲格坐標區域為空字符時，將移除工作表的已用區域。

獲取工作表已用區域

func (f *File) GetSheetDimension(sheet string) (string, error)

根據給定的工作表名稱獲取指定工作表的已用區域。

工作表