Type reference

Every structure accepted by the formatting options

The shapes below are the TypedDict definitions from jetxl.pyi. Your editor completes them if you type-annotate.

Colors

Give six or eight hex digits, with or without a leading #. Jetxl adds an opaque FF alpha to six-digit values. Chart text colors accept the same forms, but Jetxl drops the alpha from eight-digit values. Unusable values are omitted rather than raising an error. See Conventions.

Indexing

Structure	Rows	Columns
CellStyleMap	1-based	0-based
header_content	1-based	0-based
ExcelTable range	1-based	0-based
ExcelChart data range	1-based	0-based
ExcelChart position	0-based	0-based
ExcelImage position	0-based	0-based

Styling

FontStyle

bold · bool

italic · bool

underline · bool

size · float

Points.

color · str

Hex color.

name · str

Typeface.

FillStyle

pattern · "solid" | "gray125" | "none"

fg_color · str

Hex color.

bg_color · str

Hex color.

BorderSide

style · "thin" | "medium" | "thick" | "double" | "dotted" | "dashed"

color · str

Hex color.

BorderStyle

left · BorderSide

right · BorderSide

top · BorderSide

bottom · BorderSide

AlignmentStyle

horizontal · "left" | "center" | "right" | "justify"

vertical · "top" | "center" | "bottom"

wrap_text · bool

text_rotation · int

0 to 180 degrees, or 255 for vertical.

CellStyle

font · FontStyle

fill · FillStyle

border · BorderStyle

alignment · AlignmentStyle

number_format · NumberFormat

CellStyleMap

CellStyle plus a position. This is what cell_styles takes.

row · int

1-based.

col · int

0-based.

The stub annotates cell_styles as List[CellStyleMap] on write_sheet_arrow but as List[CellStyleDict] on write_sheet_arrow_to_bytes, and CellStyleDict has no definition in the file. The runtime behavior is the same; only the annotation differs.

Validation

All three share start_row, start_col, end_row, end_col, show_dropdown, error_title and error_message.

DataValidationList · TypedDict

Show fields

type · "list"

items · list[str]

DataValidationNumber · TypedDict

Show fields

type · "whole_number" | "decimal"

min · float

max · float

DataValidationTextLength · TypedDict

Show fields

type · "text_length"

min · int

max · int

Conditional formatting

All four share the four range keys, plus an optional priority (default 1) and an optional style. Omitting style gives bold red text. Color scales and data bars ignore style.

An unrecognized rule_type causes the rule to be dropped silently rather than raising.

ConditionalFormatCellValue · TypedDict

Show fields

rule_type · "cell_value"

operator · str

greater_than, less_than, equal, not_equal, greater_than_or_equal, less_than_or_equal, between. An unrecognized value silently becomes greater_than.

value · str

Threshold. Comma-separated pair for between.

ConditionalFormatColorScale · TypedDict

Show fields

rule_type · "color_scale"

min_color · str

max_color · str

mid_color · str

Optional third stop.

ConditionalFormatDataBar · TypedDict

Show fields

rule_type · "data_bar"

color · str

show_value · bool

Default True.

ConditionalFormatTop10 · TypedDict

Show fields

rule_type · "top10"

rank · int

bottom · bool

Default False. True selects the bottom N.

ExcelTable

name · str · required

start_row · int · required

1-based.

start_col · int · required

0-based.

end_row · int

Optional. Omit it or pass 0 to size from the data.

end_col · int

Optional. Omit it or pass 0 to size from the data.

display_name · str

style · str

show_first_column · bool

show_last_column · bool

show_row_stripes · bool

Default True.

show_column_stripes · bool

show_header_row · bool

Default True.

show_totals_row · bool

Default False.

column_names · list[str]

ExcelChart

chart_type · "column" | "bar" | "line" | "pie" | "scatter" | "area" · required

data_range · tuple[int, int, int, int]

Alternative to the four range keys.

start_row / start_col / end_row / end_col · int

Data range.

from_col / from_row / to_col / to_row · int

Chart position.

title · str

category_col · int

0-based x-axis column.

series_names · list[str]

show_legend · bool

legend_position · "right" | "left" | "top" | "bottom" | "none"

x_axis_title · str

y_axis_title · str

stacked · bool

percent_stacked · bool

Values run 0.0 to 1.0.

show_data_labels · bool

chart_style · int

1 to 48 legacy, 101 to 148 modern with a value - 100 fallback.

axis_min · float

axis_max · float

title_bold / axis_title_bold / legend_bold · bool

title_font_size / axis_title_font_size / legend_font_size · int

Hundredths of a point.

title_color / axis_title_color · str

Hex color. Eight-digit values have the alpha dropped.

ExcelImage

Either shape is accepted.

ExcelImageFromPath · TypedDict

Show fields

path · str · required

from_col / from_row / to_col / to_row · int · required

0-based.

ExcelImageFromBytes · TypedDict

Show fields

data · bytes · required

extension · str · required

"png", "jpg", and so on.

from_col / from_row / to_col / to_row · int · required

0-based.

NumberFormat

Sixteen built-in names, or any Excel format code as a string. See Number formats.