Table Style

isTableStyleElementType

_function

function isTableStyleElementType(value: string): value is TableStyleElementType;

---

STRIPE_ELEMENT_TYPES

_const

The four element types banded across several rows or columns: the only ones TableStyleElement.size means anything on.

const STRIPE_ELEMENT_TYPES: ReadonlySet<"blankRow" | "firstColumn" | "firstColumnStripe" | "firstColumnSubheading" | "firstHeaderCell" | "firstRowStripe" | "firstRowSubheading" | "firstSubtotalColumn" | "firstSubtotalRow" | "firstTotalCell" | "headerRow" | "lastColumn" | "lastHeaderCell" | "lastTotalCell" | "pageFieldLabels" | "pageFieldValues" | "secondColumnStripe" | "secondColumnSubheading" | "secondRowStripe" | "secondRowSubheading" | "secondSubtotalColumn" | "secondSubtotalRow" | "thirdColumnSubheading" | "thirdRowSubheading" | "thirdSubtotalColumn" | "thirdSubtotalRow" | "totalRow" | "wholeTable">

---

TABLE_STYLE_ELEMENT_TYPES

_const

The regions a table style can format (ST_TableStyleType).

The first thirteen apply to a table; the rest style a pivot table, which has regions a table does not have (subtotal rows, page-field labels, subheadings). Both live in the same enumeration and the same <tableStyle> element. What decides which regions a consumer honours is the style's own table/pivot flags, not the element names, so the type carries all of them rather than splitting into two enumerations that a caller would have to choose between up front.

const TABLE_STYLE_ELEMENT_TYPES: readonly ["wholeTable", "headerRow", "totalRow", "firstColumn", "lastColumn", "firstRowStripe", "secondRowStripe", "firstColumnStripe", "secondColumnStripe", "firstHeaderCell", "lastHeaderCell", "firstTotalCell", "lastTotalCell", "firstSubtotalColumn", "secondSubtotalColumn", "thirdSubtotalColumn", "firstSubtotalRow", "secondSubtotalRow", "thirdSubtotalRow", "blankRow", "firstColumnSubheading", "secondColumnSubheading", "thirdColumnSubheading", "firstRowSubheading", "secondRowSubheading", "thirdRowSubheading", "pageFieldLabels", "pageFieldValues"]

---

TableStyle

_interface

A custom table style, ready to be registered on a workbook and named by a table's TableStyleInfo.name.

Elements are applied in the order ECMA-376 fixes, not the order they are written here: whole table, then the column stripes, then the row stripes, then last/first column, header row, total row, and the four corner cells. So a row stripe wins over a column stripe, and both win over the whole-table formatting, which is worth knowing when a stripe colour appears not to take.

interface TableStyle {
  /** The name a table references, and the name Excel shows in its style gallery. */
  readonly name: string;
  /** The regions this style formats. An element left out is not styled by it. */
  readonly elements: Readonly<Partial<Record<TableStyleElementType, TableStyleElement>>>;
  /** Whether the style is offered for tables. Defaults to true. */
  readonly table?: boolean | undefined;
  /** Whether the style is offered for pivot tables. Defaults to true. */
  readonly pivot?: boolean | undefined;
}

---

TableStyleElement

_interface

How one region of a table is formatted: a DifferentialStyle laid over whatever the cells already carry, plus, for a stripe, how many rows or columns wide one band is.

A numFmt here is carried faithfully but has no visible effect: Excel's own table-style element exposes a font, an interior and borders, and nothing for a number format. See DifferentialStyle.

interface TableStyleElement extends DifferentialStyle {
  /**
   * The band width, in rows or columns, for a striped element: `2` makes each band two rows deep.
   * Defaults to 1.
   *
   * Meaningful **only** on the four stripe types ({@link STRIPE_ELEMENT_TYPES}); ECMA-376 says so and
   * Excel ignores it elsewhere. Setting it on any other element is rejected rather than silently
   * dropped: a caller who wrote it meant something by it, and a value that vanishes into a file that
   * still opens cleanly is the kind of bug nobody finds.
   */
  readonly size?: number | undefined;
}

---

TableStyleElementType

_type

One region of a table or pivot that a table style can format.

type TableStyleElementType = (typeof TABLE_STYLE_ELEMENT_TYPES)[number];