Style

Alignment directly maps the alignment settings of the cells.

type Alignment struct {
    Horizontal      string
    Indent          int
    JustifyLastLine bool
    ReadingOrder    uint64
    RelativeIndent  int
    ShrinkToFit     bool
    TextRotation    int
    Vertical        string
    WrapText        bool
}

Border directly maps the border settings of the cells.

type Border struct {
    Type  string
    Color string
    Style int
}

Font directly maps the font settings of the fonts.

type Font struct {
    Bold         bool
    Italic       bool
    Underline    string
    Family       string
    Size         float64
    Strike       bool
    Color        string
    ColorIndexed int
    ColorTheme   *int
    ColorTint    float64
    VertAlign    string
}

Fill directly maps the fill settings of the cells.

type Fill struct {
    Type         string
    Pattern      int
    Color        []string
    Shading      int
    Transparency int
}

Protection directly maps the protection settings of the cells.

type Protection struct {
    Hidden bool
    Locked bool
}

Style directly maps the style settings of the cells.

type Style struct {
    Border        []Border
    Fill          Fill
    Font          *Font
    Alignment     *Alignment
    Protection    *Protection
    NumFmt        int
    DecimalPlaces int
    CustomNumFmt  *string
    NegRed        bool
}

Create style

func (f *File) NewStyle(style *Style) (int, error)

NewStyle provides a function to create the style for cells by a given style options, and returns style index. The same style index can not be used across different workbook. This function is concurrency safe. Note that the Font.Color field uses an RGB color represented in RRGGBB hexadecimal notation.

Border

The following table shows the border types used in Border.Type supported by excelize:

The following table shows the border styles used in Border.Style supported by excelize index number:

Index	Style	Line	Preview
0	None	0
1	Continuous	1
2	Continuous	2
3	Dash	1
4	Dot	1
5	Continuous	3
6	Double	3
7	Continuous	0
8	Dash	2
9	Dash Dot	1
10	Dash Dot	2
11	Dash Dot Dot	1
12	Dash Dot Dot	2
13	SlantDash Dot	2

The following table shows the border styles used in Border.Style in the order shown in the Excel dialog:

Index	Preview	Index	Preview
0		12
7		13
4		10
11		8
9		2
3		5
1		6

Color fill

The following table shows the shading styles used in Fill.Shading supported by excelize index number:

Pattern fill

The following table shows the pattern styles used in Fill.Pattern supported by excelize index number:

Index	Style	Index	Style
0	None	10
1		11
2		12
3		13
4		14
5		15
6		16
7		17
8		18
9

Transparency

The Fill.Transparency only use to set transparency for chart and shape, not used for cell. The value should be a number from 0 to 100, which represents 0% to 100%, The default value is 0, representing full opaque (not transparent).

Align

Indent

The Indent is an integer value, where an increment of 1 represents 3 spaces. Indicates the number of spaces (of the normal style font) of indentation for text in a cell. The number of spaces to indent is calculated as following:

Number of spaces to indent = indent value * 3

For example, an indent value of 1 means that the text begins 3 space widths (of the normal style font) from the edge of the cell. Note: The width of one space character is defined by the font. Only left, right, and distributed horizontal alignments are supported.

Horizontal alignment

The following table shows the type of cells' horizontal alignment used in Alignment.Horizontal:

Vertical alignment

The following table shows the type of cells' vertical alignment used in Alignment.Vertical:

Reading order

ReadingOrder is an uint64 value indicating whether the reading order of the cell is left-to-right, right-to-left, or context dependent. the valid value of this field was:

Relative indent

RelativeIndent is an integer value to indicate the additional number of spaces of indentation to adjust for text in a cell.

Font underline

The following table shows the type of font underline style used in Font.Underline:

Number format

Excel's built-in all languages formats (the Style.NumFmt field) are shown in the following table:

Traditional Chinese number format

Number format code in zh-tw language:

Simplified Chinese number format

Number format code in zh-cn language:

Japanese number format

Number format code in ja-jp language:

Korean number format

Number format code in ko-kr language:

Thai language number format

Number format code in th-th language:

Currency format

Excelize built-in currency formats are shown in the following table, only support these types in the following table (Index number is used only for markup and is not used inside an Excel file and you can't get formatted value by the function GetCellValue) currently:

Excelize support set custom number format for cell. For example, set number as date type in Uruguay (Spanish) format for Sheet1!A6:

f := excelize.NewFile()
defer func() {
    if err := f.Close(); err != nil {
        fmt.Println(err)
    }
}()
if err := f.SetCellValue("Sheet1", "A6", 42920.5); err != nil {
    fmt.Println(err)
    return
}
exp := "[$-380A]dddd\\,\\ dd\" de \"mmmm\" de \"yyyy;@"
style, err := f.NewStyle(&excelize.Style{CustomNumFmt: &exp})
if err != nil {
    fmt.Println(err)
    return
}
err = f.SetCellStyle("Sheet1", "A6", "A6", style)

Cell Sheet1!A6 in the Excel Application: martes, 04 de Julio de 2017

Get style

func (f *File) GetStyle(idx int) (*Style, error)

GetStyle provides a function to get style definition by given style index.

Set column style

func (f *File) SetColStyle(sheet, columns string, styleID int) error

SetColStyle provides a function to set style of columns by given worksheet name, columns range and style ID. This function is concurrency safe. Note that this will overwrite the existing styles for the columns, it won't append or merge style with existing styles.

For example set style of column H on Sheet1:

err = f.SetColStyle("Sheet1", "H", style)

Set style of columns C:F on Sheet1:

err = f.SetColStyle("Sheet1", "C:F", style)

Get column style

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

GetColStyle provides a function to get column style ID by given worksheet name and column name. This function is concurrency safe.

Set row style

func (f *File) SetRowStyle(sheet string, start, end, styleID int) error

SetRowStyle provides a function to set the style of rows by given worksheet name, row range, and style ID. Note that this will overwrite the existing styles for the rows, it won't append or merge style with existing styles.

For example set style of row 1 on Sheet1:

err := f.SetRowStyle("Sheet1", 1, 1, styleID)

Set style of rows 1 to 10 on Sheet1:

err := f.SetRowStyle("Sheet1", 1, 10, styleID)

Set default font

func (f *File) SetDefaultFont(fontName string)

SetDefaultFont changes the default font in the workbook.

Get default font

func (f *File) GetDefaultFont() string

GetDefaultFont provides the default font name currently set in the workbook. The spreadsheet generated by excelize default font is Calibri.