Style

Alignment directly maps the alignment settings of the cells.

class Alignment:
    horizontal: str = ""
    indent: int = 0
    justify_last_line: bool = False
    reading_order: int = 0
    relative_indent: int = 0
    shrink_to_fit: bool = False
    text_rotation: int = 0
    vertical: str = ""
    wrap_text: bool = False

Border directly maps the border settings of the cells.

class Border:
    type: str = ""
    color: str = ""
    style: int = 0

Font directly maps the font settings of the fonts.

class Font:
    bold: bool = False
    italic: bool = False
    underline: str = ""
    family: str = ""
    size: float = 0
    strike: bool = False
    color: str = ""
    color_indexed: int = 0
    color_theme: Optional[int] = None
    color_tint: float = 0
    vert_align: str = ""
    charset: Optional[int] = None

Fill directly maps the fill settings of the cells.

class Fill:
    type: str = ""
    pattern: int = 0
    color: Optional[List[str]] = None
    shading: int = 0

Protection directly maps the protection settings of the cells.

class Protection:
    hidden: bool = False
    locked: bool = False

Style directly maps the style settings of the cells.

class Style:
    border: Optional[List[Border]] = None
    fill: Fill = Fill
    font: Optional[Font] = None
    alignment: Optional[Alignment] = None
    protection: Optional[Protection] = None
    num_fmt: int = 0
    decimal_places: Optional[int] = None
    custom_num_fmt: Optional[str] = None
    neg_red: bool = False

Create style

def new_style(style: Style) -> int

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

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

reading_order 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.num_fmt 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 get_cell_value) currently:

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

import excelize

try:
    f = excelize.new_file()
except (RuntimeError, TypeError) as err:
    print(err)
    exit()
try:
    f.set_cell_value("Sheet1", "A6", 42920.5)
    style = f.new_style(
        excelize.Style(
            custom_num_fmt='[$-380A]dddd\\,\\ dd" de "mmmm" de "yyyy;@',
        )
    )
    f.set_cell_style("Sheet1", "A6", "A6", style)
    f.save_as("Book1.xlsx")
except (RuntimeError, TypeError) as err:
    print(err)
finally:
    err = f.close()
    if err:
        print(err)

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

Get style

def get_style(style_id: int) -> Optional[Style]

Get style definition by given style ID.

Set column style

def set_col_style(sheet: str, columns: str, style_id: int) -> None

Set style of columns by given worksheet name, columns range and style ID. 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:

try:
    f.set_col_style("Sheet1", "H", style)
except (RuntimeError, TypeError) as err:
    print(err)

Set style of columns C:F on Sheet1:

try:
    f.set_col_style("Sheet1", "C:F", style)
except (RuntimeError, TypeError) as err:
    print(err)

Get column style

def get_col_style(sheet: str, col: str) -> int

Get column style ID by given worksheet name and column name.

Set row style

def set_row_style(sheet: str, start: int, end: int, style_id: int) -> None

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:

try:
    f.set_row_style("Sheet1", 1, 1, style_id)
except (RuntimeError, TypeError) as err:
    print(err)

Set style of rows 1 to 10 on Sheet1:

try:
    f.set_row_style("Sheet1", 1, 10, style_id)
except (RuntimeError, TypeError) as err:
    print(err)

Set default font

def set_default_font(font_name: str) -> None

SetDefaultFont changes the default font in the workbook. The spreadsheet generated by excelize default font is Calibri.

Get default font

def get_default_font() -> str

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