@timlassiter11/yatl
    Preparing search index...

    Interface DisplayColumnOptions<T>

    Column options for the table.

    interface DisplayColumnOptions<T extends object = UnspecifiedRecord> {
        cellParts?: CellPartsCallback<T>;
        cellRenderer?: CellRenderCallback<T>;
        editor?: CellEditor<T>;
        field: NestedKeyOf<T>;
        filter?: ColumnFilterCallback;
        nullsLast?: boolean;
        primary?: boolean;
        resizable?: boolean;
        role?: "display";
        searchable?: boolean;
        searchTokenizer?: TokenizerCallback;
        sortable?: boolean;
        sorter?: SortValueCallback;
        title?: string;
        tokenize?: boolean;
        valueFormatter?: ValueFormatterCallback<T>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    cellParts? cellRenderer? editor? field filter? nullsLast? primary? resizable? role? searchable? searchTokenizer? sortable? sorter? title? tokenize? valueFormatter?

    Properties

    cellParts?: CellPartsCallback<T>

    A function for conditinally adding classes to a cell.

    cellRenderer?: CellRenderCallback<T>

    A function for rendering the contents of a cell. NOTE: Search highlighting will not work for this cell when used.

    editor?: CellEditor<T>

    Wheter the column's cells can be edited or not.

    field: NestedKeyOf<T>

    The field name in the data object.

    filter?: ColumnFilterCallback

    A custom function to determine if a cell's value in this column matches a given filter criterion. This is used when DataTable.filter() is called with an object-based filter that targets this column's field.

    nullsLast?: boolean

    If true, null and undefined values will always be sorted to the end of the data, regardless of sort order.

    primary?: boolean

    If true, this column will be used to generate a unique ID for each row.

    resizable?: boolean

    Whether the column should be resizable.

    role?: "display"

    Determines if a column is intended to be displayed, or just for searching and filtering.

    searchable?: boolean

    Whether the column is searchable.

    searchTokenizer?: TokenizerCallback

    A function for tokenizing this column's data. Fallback to the main table tokenizer if not provided.

    sortable?: boolean

    Whether the column is sortable.

    sorter?: SortValueCallback

    A function to use for sorting the column. This overrides the default sorting behavior.

    title?: string

    The title to display in the header.

    tokenize?: boolean

    Whether the column's data should be tokenized for searching.

    valueFormatter?: ValueFormatterCallback<T>

    A function to format the value for display.

    Settings

    Member Visibility

    On This Page

    Properties