getDataTableHeadersDefaultItem

Commons
stable

Returns the built-in header descriptor preset for a DataTable special column key (data-table-group, data-table-expand, data-table-select). Returns undefined for regular user-defined columns.

API

Signature

Full TypeScript signature sourced from the util file.

typescript

API

Parameters

Input parameters accepted by this util.

item
required
IDataTableHeader
The raw header descriptor supplied by the consumer. Its key property is checked against the three reserved column keys.

API

Return value

The value returned by this util.

A preset IInternalDataTableHeader (DEFAULT_HEADER or DEFAULT_ACTION_HEADER) for reserved keys, or undefined for regular columns.

Usage

Examples

Ready-to-paste usage snippets.

Check a header against built-in presets

typescript