@timlassiter11/yatl
    Preparing search index...

    Interface BaseColumnOptions<T>

    Shared options between both internal and displayed columns.

    interface BaseColumnOptions<T extends object = UnspecifiedRecord> {
        field: NestedKeyOf<T>;
        filter?: ColumnFilterCallback;
        nullsLast?: boolean;
        primary?: boolean;
        role?: ColumnRole;
        searchable?: boolean;
        searchTokenizer?: TokenizerCallback;
        sortable?: boolean;
        sorter?: SortValueCallback;
        tokenize?: boolean;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    field filter? nullsLast? primary? role? searchable? searchTokenizer? sortable? sorter? tokenize?

    Properties

    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.

    role?: ColumnRole

    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.

    tokenize?: boolean

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

    Settings

    Member Visibility

    On This Page

    Properties