Member Junction
    Preparing search index...

    Interface GridColumnConfig

    Configuration for a single grid column

    interface GridColumnConfig {
        align?: "left" | "right" | "center";
        cellClass?:
            | string
            | ((row: Record<string, unknown>, column: GridColumnConfig) => string);
        cellStyle?: (
            row: Record<string, unknown>,
            column: GridColumnConfig,
        ) => Record<string, string>;
        cellTemplate?: TemplateRef<GridCellTemplateContext>;
        editable?: boolean;
        editorTemplate?: TemplateRef<GridEditorTemplateContext>;
        field: string;
        filterable?: boolean;
        filterOptions?: { label: string; value: unknown }[];
        flex?: number;
        format?: string;
        formatter?: (
            value: unknown,
            row: Record<string, unknown>,
            column: GridColumnConfig,
        ) => string;
        frozen?: false | "left" | "right";
        group?: string;
        headerAlign?: "left" | "right" | "center";
        headerClass?: string;
        headerTemplate?: TemplateRef<GridHeaderTemplateContext>;
        maxWidth?: number;
        minWidth?: number;
        pinned?: "left" | "right" | null;
        reorderable?: boolean;
        resizable?: boolean;
        showTooltip?: boolean;
        sortable?: boolean;
        sortDirection?: "asc" | "desc";
        sortIndex?: number;
        title?: string;
        tooltip?:
            | string
            | ((row: Record<string, unknown>, column: GridColumnConfig) => string);
        type?: GridColumnType;
        visible?: boolean;
        width?: number | "auto";
    }
    Index

    Properties

    align? cellClass? cellStyle? cellTemplate? editable? editorTemplate? field filterable? filterOptions? flex? format? formatter? frozen? group? headerAlign? headerClass? headerTemplate? maxWidth? minWidth? pinned? reorderable? resizable? showTooltip? sortable? sortDirection? sortIndex? title? tooltip? type? visible? width?

    Properties

    align?: "left" | "right" | "center"

    Text alignment

    cellClass?:
        | string
        | ((row: Record<string, unknown>, column: GridColumnConfig) => string)

    CSS class for cells - can be string or function

    cellStyle?: (
        row: Record<string, unknown>,
        column: GridColumnConfig,
    ) => Record<string, string>

    Cell style function

    cellTemplate?: TemplateRef<GridCellTemplateContext>

    Custom cell template reference

    editable?: boolean

    Column is editable

    editorTemplate?: TemplateRef<GridEditorTemplateContext>

    Custom editor template reference

    field: string

    Field name on the entity

    filterable?: boolean

    Column is filterable

    filterOptions?: { label: string; value: unknown }[]

    Filter options for dropdown filters

    flex?: number

    Flex grow factor for auto-sizing columns

    format?: string

    Format string (e.g., 'yyyy-MM-dd' for dates, '#,##0.00' for numbers)

    formatter?: (
        value: unknown,
        row: Record<string, unknown>,
        column: GridColumnConfig,
    ) => string

    Cell value formatter function

    frozen?: false | "left" | "right"

    Frozen column position (alias for pinned, for backward compatibility)

    group?: string

    Column group (for grouped headers)

    headerAlign?: "left" | "right" | "center"

    Header alignment (defaults to align)

    headerClass?: string

    CSS class for header

    headerTemplate?: TemplateRef<GridHeaderTemplateContext>

    Custom header template reference

    maxWidth?: number

    Maximum width for resizing

    minWidth?: number

    Minimum width for resizing

    pinned?: "left" | "right" | null

    Column pinning position (AG Grid terminology)

    reorderable?: boolean

    Column is reorderable

    resizable?: boolean

    Column is resizable

    showTooltip?: boolean

    Whether to show tooltip on hover

    sortable?: boolean

    Column is sortable

    sortDirection?: "asc" | "desc"

    Sort direction (for default sort)

    sortIndex?: number

    Sort order index (for default multi-sort)

    title?: string

    Display title (defaults to field name)

    tooltip?:
        | string
        | ((row: Record<string, unknown>, column: GridColumnConfig) => string)

    Custom tooltip content

    type?: GridColumnType

    Data type for formatting and editing

    visible?: boolean

    Column is visible

    width?: number | "auto"

    Column width in pixels (or 'auto')

    Settings

    Member Visibility

    On This Page

    Properties