write_sheet_arrow

Write one sheet from Arrow data to a file

jet.write_sheet_arrow(arrow_data, filename, **options) -> None

The primary function. Every other Arrow function accepts the same options.

Positional

arrow_data · Any · required

A PyArrow Table or RecordBatch, or anything exposing Arrow data, such as df.to_arrow() from Polars or Pandas. A bare Polars DataFrame also works.

filename · str · required

Output path. Jetxl overwrites the file if it exists.

Layout

sheet_name · str | None · default: "None"

Tab label. Defaults to Sheet1.

auto_filter · bool · default: "False"

Filter dropdowns on the header row.

freeze_rows · int · default: "0"

Rows frozen at the top.

freeze_cols · int · default: "0"

Columns frozen at the left.

auto_width · bool · default: "False"

Size columns to contents. Costs time on large frames.

styled_headers · bool · default: "False"

Bold the header row. Applies bold only, with no fill.

write_header_row · bool · default: "True"

Write column names at all.

column_widths · dict[str, float | str] | None

By column name. A number, "150px", or "auto".

row_heights · dict[int, float] | None

Points, keyed by 1-based row.

default_row_height · float | None

Applies to all rows. Excel’s default is 15.

data_start_row · int · default: "0"

Row where the data begins. Also excluded from auto_width measurement.

header_content · list[tuple[int, int, str]] | None

(row, col, text) written above the data. Rows 1-based, columns 0-based.

Content

column_formats · dict[str, str] | None

Number format per column. See Number formats.

merge_cells · list[tuple[int, int, int, int]] | None

(start_row, start_col, end_row, end_col).

hyperlinks · list[tuple[int, int, str, str | None]] | None

(row, col, url, display).

formulas · list[tuple[int, int, str, str | None]] | None

(row, col, formula, cached_value).

Styling

cell_styles · list[dict] | None

Per-cell font, fill, border, alignment and number format. See Cell styles.

conditional_formats · list[dict] | None

Value-driven rules. See Conditional formatting.

data_validations · list[dict] | None

Input constraints. See Data validation.

Objects

tables · list[dict] | None

Native Excel tables. See Excel tables.

charts · list[dict] | None

Charts. See Charts.

images · list[dict] | None

Embedded images. See Images.

Appearance

gridlines_visible · bool · default: "True"

Show worksheet gridlines.

zoom_scale · int | None

Opening zoom, 10 to 400.

tab_color · str | None

Sheet tab color, hex.

hidden_columns · list[int] | None

0-based column indices to hide.

hidden_rows · list[int] | None

Row indices to hide.

right_to_left · bool · default: "False"

Right-to-left sheet layout.

Returns

None. Jetxl writes the file as a side effect.

Errors

Raises OSError for an invalid number format code, an unsupported column type, or a frame exceeding Excel’s grid limits. Several other mistakes are dropped silently instead. See Conventions.

Indexing isn’t uniform across options. cell_styles and header_content use 1-based rows with 0-based columns, while image positions are 0-based on both axes. See Conventions for the full table.