ExcelCellCustomizeArgs

Event arguments passed to the Excel query cell info callback. Allows customization of individual cells during export via callback.

Props

The following table outlines the props for the ExcelCellCustomizeArgs:

NameTypeDefaultDescription
colIndex
number
-

Zero-based column index

colSpan
number
1

Merge cells horizontally (across columns). Must be at least 1. No overlapping merges allowed.

column
Record<string, unknown>
-

The column definition containing field, type, format, etc.

data
T
-

The current cell data object (full row data)

groupLevel
number
0

Group nesting level (0 = top-level group). Affects indentation and styling of group headers.

hyperLink
-

Set to convert cell to hyperlink. The cell value is displayed as link text unless overridden by displayText.

image
-

Set to customize cell image (replaces cell value with image). Image takes precedence over cell value and hyperlink.

isGroupHeader
boolean
false

Indicates if this row is a group header. Group headers receive special styling and indentation.

numberFormat
string
undefined (auto-detect based on value type)

Excel number format string for numeric values. Takes precedence over auto-detected format.

rowIndex
number
-

Zero-based row index in the current view

rowSpan
number
1

Merge cells vertically (across rows). Must be at least 1. No overlapping merges allowed.

style
CellStyle
-

Cell style including colors, fonts, borders, alignment, etc. Use to apply custom styling beyond default group header formatting.

value
string | number | Date | null
-

The cell value (current display value)