apex-grid
    Preparing search index...

    Interface BaseColumnConfiguration<T, K>

    Configuration object for grid columns.

    interface BaseColumnConfiguration<T extends object, K extends Keys<T> = Keys<T>> {
        cellTemplate?: (params: ApexCellContext<T, K>) => unknown;
        filter?: boolean | ColumnFilterConfiguration;
        headerTemplate?: (params: ApexHeaderContext<T>) => unknown;
        headerText?: string;
        hidden?: boolean;
        key: K;
        resizable?: boolean;
        sort?: boolean | ColumnSortConfiguration<T, K>;
        type?: DataType;
        width?: string;
    }

    Type Parameters

    Index

    Properties

    cellTemplate? filter? headerTemplate? headerText? hidden? key resizable? sort? type? width?

    Properties

    cellTemplate?: (params: ApexCellContext<T, K>) => unknown

    Cell template callback.

    filter?: boolean | ColumnFilterConfiguration

    Whether filter operation can be applied on the column or not.

    headerTemplate?: (params: ApexHeaderContext<T>) => unknown

    Header template callback.

    headerText?: string

    Optional text to display in the column header. By default, the column key is used to render the header text.

    hidden?: boolean

    Whether the column is hidden or not.

    key: K

    The field for from the data the this column will reference.

    resizable?: boolean

    Whether the the column can be resized or not.

    sort?: boolean | ColumnSortConfiguration<T, K>

    Whether the column can be sorted or not.

    type?: DataType

    The type of data this column will reference.

    Affects the default filter operands if the column is with filtering enabled.

    If not passed, string is assumed to be the default type.

    width?: string

    Width for the current column.

    Accepts most CSS units for controlling width.

    If not passed, the column will try to size itself based on the number of other columns and the total width of the grid.

    Settings

    Member Visibility

    On This Page

    Properties