BaseColumnHeaderContext

Common properties for Column Header Context

TypeScript

export interface BaseColumnHeaderContext extends

Extends

BaseContext

Properties

Property	Type	Description
colDefHeaderName	`string`	Original header name from the Column Definition (`headerName`, or a humanised `field` when `headerName` is not set). Never affected by Layout-specific headers.
currentLayout	`Layout`	Current Layout
currentLayoutName	`string`	Name of Current Layout
currentLayoutType	`'table' \| 'pivot'`	Type (table/pivot) of Current Layout
defaultHeaderName	`string`	Resolved header name for the Column — the layout-specific header if one is defined, otherwise the ColDef header. This is the value that would be displayed when no `columnHeader` function is provided.
layoutSpecificHeaderName	`string`	Layout-specific header name for the Column, when one is defined in the current Layout's `ColumnHeaders`.
adaptableContext	`any`	Custom application Context provided in `AdaptableOptions.adaptableContext`

Property Details

colDefHeaderName

Original header name from the Column Definition (headerName, or a humanised field when headerName is not set). Never affected by Layout-specific headers.

TypeScript

colDefHeaderName: string;

Property Value

string

currentLayout

Current Layout

TypeScript

currentLayout: Layout;

Property Value

Layout

currentLayoutName

Name of Current Layout

TypeScript

currentLayoutName: string;

Property Value

string

currentLayoutType

Type (table/pivot) of Current Layout

TypeScript

currentLayoutType: 'table' | 'pivot';

Property Value

'table' | 'pivot'

defaultHeaderName

Resolved header name for the Column — the layout-specific header if one is defined, otherwise the ColDef header. This is the value that would be displayed when no columnHeader function is provided.

TypeScript

defaultHeaderName: string;

Property Value

string

layoutSpecificHeaderName

Layout-specific header name for the Column, when one is defined in the current Layout's ColumnHeaders.

TypeScript

layoutSpecificHeaderName?: string;

Property Value

string

adaptableContext

Inherited from BaseContext

Custom application Context provided in AdaptableOptions.adaptableContext

TypeScript

adaptableContext: any;

Property Value

any

PreviousBarStyleMarker NextBaseContext