ワークブック

Options は、スプレッドシートを読み書きするためのオプションを定義します。

type Options struct {
    MaxCalcIterations uint
    Password          string
    RawCellValue      bool
    UnzipSizeLimit    int64
    UnzipXMLSizeLimit int64
    ShortDatePattern  string
    LongDatePattern   string
    LongTimePattern   string
    CultureInfo       CultureName
}

MaxCalcIterations は反復計算の最大反復回数を指定します。デフォルト値は 0 です。

Password は、スプレッドシートのパスワードをプレーンテキストで指定します。

RawCellValue は、セル値に数値形式を適用するか、生の値を取得するかを指定します。

UnzipSizeLimit は、スプレッドシートを開いたときの解凍サイズの制限をバイト単位で指定します。この値は UnzipXMLSizeLimit 以上である必要があり、デフォルトのサイズ制限は 16GB です。

UnzipXMLSizeLimit は、ワークシートと共有文字列テーブルを解凍する際のメモリ制限をバイト単位で指定します。ファイルサイズがこの値を超えると、ワークシートXMLがシステム一時ディレクトリに抽出されます。この値はデフォルトの UnzipSizeLimit 以下である必要があります。値は 16MB です。

ShortDatePattern は、短い日付数値形式コードを指定します。スプレッドシート アプリケーションでは、日付形式により日付と時刻のシリアル番号が日付値として表示されます。アスタリスク (*) で始まる日付形式は、オペレーティング システムに指定されている地域の日付と時刻の設定の変更に対応します。アスタリスクのない形式は、オペレーティング システムの設定の影響を受けません。に使用される ShortDatePattern は、アスタリスクで始まる適用日付形式を指定します。

LongDatePattern は、長い日付数値形式コードを指定します。

LongTimePattern は、長い時間の数値形式コードを指定します。

CultureInfo は、システムのローカル言語設定によって影響を受ける組み込みの言語数値形式コードを適用するための国コードを指定します。

HeaderFooterImagePositionType は、ヘッダーとフッターの画像の位置のタイプです。

type HeaderFooterImagePositionType byte

このセクションでは、ワークシートのヘッダーとフッターの画像位置の種類の列挙を定義します。

const (
    HeaderFooterImagePositionLeft HeaderFooterImagePositionType = iota
    HeaderFooterImagePositionCenter
    HeaderFooterImagePositionRight
)

CalcPropsOptions は、計算の状態と詳細を記録するためにアプリケーションが使用するプロパティのコレクションを定義します。

type CalcPropsOptions struct {
    CalcID                *uint
    CalcMode              *string
    FullCalcOnLoad        *bool
    RefMode               *string
    Iterate               *bool
    IterateCount          *uint
    IterateDelta          *float64
    FullPrecision         *bool
    CalcCompleted         *bool
    CalcOnSave            *bool
    ConcurrentCalc        *bool
    ConcurrentManualCount *uint
    ForceFullCalc         *bool
}

Excel 文書を作成する

func NewFile(opts ...Options) *File

NewFile を使って新しい Excel ワークブックを作成します。新しく作成されたワークブックにはデフォルトで Sheet1 という名前のワークシートが含まれます。

開く

func OpenFile(filename string, opts ...Options) (*File, error)

既存の Excel 文書を OpenFile で開きます。たとえば、パスワード保護された開いているスプレッドシート:

f, err := excelize.OpenFile("Book1.xlsx", excelize.Options{Password: "password"})
if err != nil {
    return
}

スプレッドシートを開いた後、Close() でファイルを閉じます。

データストリームを開く

func OpenReader(r io.Reader, opts ...Options) (*File, error)

OpenReaderは io.Reader からデータストリームを読み取り、入力されたスプレッドシートファイルを返します。

たとえば、アップロードテンプレートを処理する HTTP サーバーを作成してから、新しいワークシートが追加された応答ダウンロードファイルを作成します:

package main

import (
    "fmt"
    "net/http"

    "github.com/xuri/excelize/v2"
)

func process(w http.ResponseWriter, req *http.Request) {
    file, _, err := req.FormFile("file")
    if err != nil {
        fmt.Fprint(w, err.Error())
        return
    }
    defer file.Close()
    f, err := excelize.OpenReader(file)
    if err != nil {
        fmt.Fprint(w, err.Error())
        return
    }
    f.Path = "Book1.xlsx"
    f.NewSheet("NewSheet")
    w.Header().Set("Content-Disposition", fmt.Sprintf("attachment; filename=%s", f.Path))
    w.Header().Set("Content-Type", req.Header.Get("Content-Type"))
    if err := f.Write(w); err != nil {
        fmt.Fprint(w, err.Error())
    }
}

func main() {
    http.HandleFunc("/process", process)
    http.ListenAndServe(":8090", nil)
}

cURLを使用してテストします:

curl --location --request GET 'http://127.0.0.1:8090/process' \
--form 'file=@/tmp/template.xltx' -O -J

保存

func (f *File) Save(opts ...Options) error

Excel 文書に編集内容を保存するには Save を使います。

名前を付けて保存

func (f *File) SaveAs(name string, opts ...Options) error

指定したファイルとして Excel 文書を保存するには SaveAs を使います。

閉じるワークブック

func (f *File) Close() error

Close は、スプレッドシート用に開いている一時ファイルを閉じてクリーンアップします。

ワークシートを作成する

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

NewSheet は、ワークシート名を指定して新しいシートを作成する関数を提供し、ワークブック（スプレッドシート）に追加された後のシートのインデックスを返します。新しいスプレッドシートファイルを作成すると、Sheet1という名前のデフォルトのワークシートが作成されることに注意してください。

ワークシートを削除する

func (f *File) DeleteSheet(sheet string) error

DeleteSheet は、指定されたワークシート名でブック内のワークシートを削除する機能を提供します。この方法は注意して使用してください。数式やグラフなどの参照の変更に影響します。削除されたワークシートの参照値がある場合、それを開いたときにファイルエラーが発生します。ワークシートが1つしか残っていない場合、この関数は無効になります。

ワークシートを移動する

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

MoveSheet は、シートをワークブック内の指定された位置に移動します。この関数は、ソース シートをターゲット シートの前に移動します。移動後、他のシートは左または右にシフトされます。シートがすでにターゲット位置にある場合、この関数は何も実行しません。この関数は、移動後にすべてのシートのグループを解除するわけではありません。たとえば、Sheet2 を Sheet1 の前に移動します:

err := f.MoveSheet("Sheet2", "Sheet1")

ワークシートをコピーする

func (f *File) CopySheet(from, to int) error

与えられた複製ワークシートおよびターゲットワークシートインデックスコピーワークシートに従って、ターゲットワークシートインデックスはそれが既に存在するかどうかを確認するために開発者を必要とします。セル値と数式のみを含むワークシート間の複製は現在サポートされています。テーブル、イメージ、チャート、ピボットテーブルなどの要素を含むワークシート間の複製はサポートされていません。

// Sheet1 という名前のワークシートは既に存在します ...
index, err := f.NewSheet("Sheet2")
if err != nil {
    fmt.Println(err)
    return
}
err := f.CopySheet(1, index)

グループワークシート

func (f *File) GroupSheets(sheets []string) error

GroupSheets は、指定されたワークシート名でワークシートをグループ化する機能を提供します。 グループワークシートには、アクティブなワークシートが含まれている必要があります。

ワークシートのグループ化を解除する

func (f *File) UngroupSheets() error

UngroupSheets は、ワークシートのグループ化を解除する機能を提供します。

ワークシートの背景

func (f *File) SetSheetBackground(sheet, picture string) error

SetSheetBackground は、ワークシート名とファイル パスを指定して背景画像を設定する機能を提供します。サポートされている画像の種類: BPM、EMF、EMZ、GIF、JPEG、JPG、PNG、SVG、TIF、TIFF、WMF、および WMZ。

func (f *File) SetSheetBackgroundFromBytes(sheet, extension string, picture []byte) error

SetSheetBackgroundFromBytes は、ワークシート名、拡張子名、画像データを指定して背景画像を設定する機能を提供します。サポートされている画像の種類: BPM、EMF、EMZ、GIF、JPEG、JPG、PNG、SVG、TIF、TIFF、WMF、および WMZ。

デフォルトワークシートを設定する

func (f *File) SetActiveSheet(index int)

SetActiveSheet は、指定されたインデックスによってワークブックのデフォルトのアクティブシートを設定する関数を提供します。アクティブなインデックスは、GetSheetMap 関数によって返されるIDとは異なることに注意してください。0 以上で、ワークシートの総数よりも少ない必要があります。

アクティブシートインデックスを取得する

func (f *File) GetActiveSheetIndex() int

デフォルトのワークシートのインデックスを取得します。デフォルトのワークシートが見つからない場合は、0 を返します。

ワークシートの表示設定

func (f *File) SetSheetVisible(sheet string, visible bool, veryHidden ...bool) error

SetSheetVisible は、与えられたワークシート名でワークシートを見えるように設定する機能を提供します。ワークブックには少なくとも1つの表示可能なワークシートが含まれている必要があります。指定したワークシートがアクティブになっている場合、この設定は無効になります。3 番目のオプションの veryHidden パラメーターは、visible が false の場合にのみ機能します。

例えば Sheet1 を隠す:

err := f.SetSheetVisible("Sheet1", false)

ワークシートの表示設定を取得する

func (f *File) GetSheetVisible(sheet string) (bool, error)

GetSheetVisible は、与えられたワークシート名でワークシートを見えるようにする機能を提供します。たとえば、Sheet1 の可視状態を取得します。

visible, err := f.GetSheetVisible("Sheet1")

ワークシートのプロパティを設定する

func (f *File) SetSheetProps(sheet string, opts *SheetPropsOptions) error

SetSheetProps には、ワークシートのプロパティを設定する関数が用意されています。設定できるプロパティは次のとおりです:

たとえば、ワークシートの行をデフォルトで非表示にします。

f, enable := excelize.NewFile(), true
if err := f.SetSheetProps("Sheet1", &excelize.SheetPropsOptions{
    ZeroHeight: &enable,
}); err != nil {
    fmt.Println(err)
}
if err := f.SetRowVisible("Sheet1", 10, true); err != nil {
    fmt.Println(err)
}
f.SaveAs("Book1.xlsx")

ワークシートのプロパティを取得する

func (f *File) GetSheetProps(sheet string) (SheetPropsOptions, error)

GetSheetProps には、ワークシートのプロパティを取得する関数が用意されています。

ワークシートビューのプロパティを設定する

func (f *File) SetSheetView(sheet string, viewIndex int, opts *ViewOptions) error

SetSheetView は、シート ビューのプロパティを設定します。viewIndex は負の値になる可能性があり、負の場合は逆方向にカウントされます (-1 が最後のビューです)。設定できるプロパティは次のとおりです:

ワークシートビュープロパティを取得する

func (f *File) GetSheetView(sheet string, viewIndex int) (ViewOptions, error)

GetSheetView は、シート ビューのプロパティの値を取得します。viewIndex は負の値になる可能性があり、負の場合は逆方向にカウントされます (-1 が最後のビューです)。

ワークシートのページレイアウトを設定する

func (f *File) SetPageLayout(sheet string, opts *PageLayoutOptions) error

指定されたワークシート名とページレイアウトパラメータに基づいて、ワークシートのページレイアウトプロパティを設定します。現在設定でサポートされているページレイアウトプロパティ:

Size メソッドでページの用紙サイズを設定するデフォルトのページレイアウトサイズは「Letter 用紙 8.5 インチ × 11 インチ」です。次の表は Excelize のページレイアウトサイズとインデックスの Size パラメータの比較です。

Orientation はワークシートの向きを指定し、デフォルトの向きは portrait です。このフィールドに指定できる値は、portrait と landscape です。

FirstPageNumber は最初に印刷されたページ番号を指定しました。値を指定しない場合は、「自動」と見なされます。

AdjustTo は印刷の拡大 / 縮小を指定しました。この属性は、10 (10%) から 400 (400%) の範囲の値に制限されます。この設定は、FitToWidth や FitToHeight が使用されている場合に上書きされます。

FitToHeight は、収まる垂直方向のページ数を指定しました。

FitToWidth は、収まる水平方向のページ数を指定します。

BlackAndWhite は白黒印刷を指定しました。

PageOrder は複数のページの順序を指定します。受け入れられる値: overThenDown および downThenOver。

たとえば、Sheet1 という名前のシート ページ レイアウトをモノクロ印刷、開始ページ番号 2、横向き、A4 (小) 210 × 297 mm 用紙、縦に収まるように2ページ、収まるように横に2つのページ:

f := excelize.NewFile()
var (
    size                 = 10
    orientation          = "landscape"
    firstPageNumber uint = 2
    adjustTo        uint = 100
    fitToHeight          = 2
    fitToWidth           = 2
    blackAndWhite        = true
)
if err := f.SetPageLayout("Sheet1", &excelize.PageLayoutOptions{
    Size:            &size,
    Orientation:     &orientation,
    FirstPageNumber: &firstPageNumber,
    AdjustTo:        &adjustTo,
    FitToHeight:     &fitToHeight,
    FitToWidth:      &fitToWidth,
    BlackAndWhite:   &blackAndWhite,
}); err != nil {
    fmt.Println(err)
}

ワークシートのページレイアウトを取得する

func (f *File) GetPageLayout(sheet string) (PageLayoutOptions, error)

GetPageLayout には、ワークシートのページ レイアウトを取得する関数が用意されています。

ワークシートのページ余白を設定する

func (f *File) SetPageMargins(sheet string, opts *PageLayoutMarginsOptions) error

SetPageMargins は、ワークシートのページ余白を設定する機能を提供します。利用可能なオプション：

ワークシートのページ余白を取得する

func (f *File) GetPageMargins(sheet string) (PageLayoutMarginsOptions, error)

GetPageMargins は、ワークシートのページ余白を取得する関数を提供します。

ブックのプロパティを設定する

func (f *File) SetWorkbookProps(opts *WorkbookPropsOptions) error

SetWorkbookProps は、ブックのプロパティを設定する関数を提供します。利用可能なオプション:

ブックのプロパティを取得する

func (f *File) GetWorkbookProps() (WorkbookPropsOptions, error)

GetWorkbookProps は、ブックのプロパティを取得する関数を提供します。

ヘッダとフッタを設定する

func (f *File) SetHeaderFooter(sheet string, opts *HeaderFooterOptions) error

SetHeaderFooter は、与えられたワークシート名と制御文字によってヘッダーとフッターを設定する機能を提供します。

ヘッダーとフッターは、次の設定フィールドを使って指定します。

以下のフォーマットコードは、6 つの文字列型フィールドで使用できます。OddHeader, OddFooter, EvenHeader, EvenFooter, FirstFooter, FirstHeader

例えば：

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`,
})

この例は次のことを示しています:

• 最初のページには独自のヘッダーとフッターがあります
• 奇数ページと偶数ページでヘッダーとフッターが異なる
• 奇数ページヘッダの右側のセクションにある現在のページ番号
• 奇数ページのフッターの中央部分にある現在のワークブックのファイル名
• 偶数ページヘッダの左側のセクションにある現在のページ番号
• 偶数ページのフッターの左側のセクションに現在の日付と右側のセクションに現在の時刻
• 最初のページの中央セクションの1行目のテキスト "Center Bold Header"、および同じページの中央セクションの2行目の日付
• 最初のページにフッターなし

ヘッダーとフッターの画像を追加する

func (f *File) AddHeaderFooterImage(sheet string, opts *HeaderFooterImageOptions) error

AddHeaderFooterImage は、&G を介してヘッダーとフッターの定義で参照できるグラフィックを設定するメカニズムを提供します。サポートされている画像タイプは、EMF、EMZ、GIF、JPEG、JPG、PNG、SVG、TIF、TIFF、WMF、WMZ です。

名前を設定する

func (f *File) SetDefinedName(definedName *DefinedName) error

与えられた名前とスコープに基づいて名前を設定しますデフォルトのスコープはワークブックです。例えば、

err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "Amount",
    RefersTo: "Sheet1!$A$2:$D$5",
    Comment:  "defined name comment",
    Scope:    "Sheet2",
})

ワークシートの印刷領域と印刷タイトルの設定:

if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Area",
    RefersTo: "Sheet1!$A$1:$Z$100",
    Scope:    "Sheet1",
}); err != nil {
    fmt.Println(err)
}
if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Titles",
    RefersTo: "Sheet1!$A:$A,Sheet1!$1:$1",
    Scope:    "Sheet1",
}); err != nil {
    fmt.Println(err)
}

RefersTo プロパティにカンマなしで 1 つの列範囲のみを入力すると、「左側で繰り返す列」としてのみ機能します。例:

if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Titles",
    RefersTo: "Sheet1!$A:$A",
    Scope:    "Sheet1",
}); err != nil {
    fmt.Println(err)
}

RefersTo プロパティにコンマなしで 1 つの行範囲のみを入力すると、「上部で繰り返す行」としてのみ機能します。例:

if err := f.SetDefinedName(&excelize.DefinedName{
    Name:     "_xlnm.Print_Titles",
    RefersTo: "Sheet1!$1:$1",
    Scope:    "Sheet1",
}); err != nil {
    fmt.Println(err)
}

名前を取得する

func (f *File) GetDefinedName() []DefinedName

範囲内のワークブックとワークシートの名前のリストを取得します。

定義された名前を削除

func (f *File) DeleteDefinedName(definedName *DefinedName) error

DeleteDefinedName は、ワークブックまたはワークシートの定義名を削除する機能を提供します。スコープが指定されていない場合、デフォルトのスコープはワークブックです。例えば：

err := f.DeleteDefinedName(&excelize.DefinedName{
    Name:     "Amount",
    Scope:    "Sheet2",
})

アプリケーションのプロパティを設定する

func (f *File) SetAppProps(appProperties *AppProperties) error

SetAppProps は、ドキュメントアプリケーションのプロパティを設定する機能を提供します。設定できるプロパティは次のとおりです。

例えば：

err := f.SetAppProps(&excelize.AppProperties{
    Application:       "Microsoft Excel",
    ScaleCrop:         true,
    DocSecurity:       3,
    Company:           "Company Name",
    LinksUpToDate:     true,
    HyperlinksChanged: true,
    AppVersion:        "16.0000",
})

アプリケーションのプロパティを取得する

func (f *File) GetAppProps() (*AppProperties, error)

GetAppProps は、ドキュメントアプリケーションのプロパティを取得する関数を提供します。

ドキュメントのプロパティを設定する

func (f *File) SetDocProps(docProperties *DocProperties) error

ワークブックのコアプロパティを設定します。設定できるプロパティは次のとおりです:

例えば：

err := f.SetDocProps(&excelize.DocProperties{
    Category:       "category",
    ContentStatus:  "Draft",
    Created:        "2019-06-04T22:00:10Z",
    Creator:        "Go Excelize",
    Description:    "This file created by Go Excelize",
    Identifier:     "xlsx",
    Keywords:       "Spreadsheet",
    LastModifiedBy: "Go Author",
    Modified:       "2019-06-04T22:00:10Z",
    Revision:       "0",
    Subject:        "Test Subject",
    Title:          "Test Title",
    Language:       "en-US",
    Version:        "1.0.0",
})

ドキュメントのプロパティを取得する

func (f *File) GetDocProps() (*DocProperties, error)

ワークブックのコアとなるプロパティを取得してください。

計算プロパティを設定する

func (f *File) SetCalcProps(opts *CalcPropsOptions) error

SetCalcProps は、計算プロパティを設定する関数を提供します。

CalcMode プロパティのオプションの値は、manual、auto、または autoNoTable です。

RefMode プロパティのオプションの値は、A1 または R1C1 です。

計算プロパティを取得する

func (f *File) GetCalcProps() (CalcPropsOptions, error)

GetCalcProps は計算プロパティを取得する関数を提供します。

ブックを保護する

func (f *File) ProtectWorkbook(opts *WorkbookProtectionOptions) error

ProtectWorkbook は、他のユーザーが誤ってまたは故意にブック内のデータを変更、移動、または削除するのを防ぐ機能を提供します。 オプション フィールド AlgorithmName は、ハッシュ アルゴリズムを指定し、XOR、MD4、MD5、SHA-1、SHA2-56、SHA-384、および SHA-512 をサポートします。現在、ハッシュ アルゴリズムが指定されていない場合、デフォルトとして XOR アルゴリズムが使用されます。 たとえば、保護設定でワークブックを保護します:

err := f.ProtectWorkbook(&excelize.WorkbookProtectionOptions{
    Password:      "password",
    LockStructure: true,
})

WorkbookProtectionOptions は、ブックの保護の設定を直接マップします。

type WorkbookProtectionOptions struct {
    AlgorithmName string
    Password      string
    LockStructure bool
    LockWindows   bool
}

ブックの保護を解除する

func (f *File) UnprotectWorkbook(password ...string) error

UnprotectWorkbook は、ワークブックの保護を解除する機能を提供します。オプションのパスワード パラメーターを指定して、パスワードの検証でワークブックの保護を解除します。