SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface ColumnButtonConfigProps

    The column (filter/sort) button configuration.

    Rides the shared propsCellRender channel. Consumed by the in-grid button layer (SheetColumnButtonLayer) and the header-strip renderer (SheetHeaderRenderer) — NOT by the text cell renderer (which is now just text).

    interface ColumnButtonConfigProps {
        onColumnButtonMouseDown?: (
            event: MouseEvent<HTMLDivElement, MouseEvent>,
            column: IColumn,
        ) => void;
        propsColumnButton?: ColumnButtonProps;
        renderColumnButton?: (props: ColumnButtonProps) => ReactElement;
    }
    Index
    onColumnButtonMouseDown? propsColumnButton? renderColumnButton?
    onColumnButtonMouseDown?: (
        event: MouseEvent<HTMLDivElement, MouseEvent>,
        column: IColumn,
    ) => void

    Callback for when a column (filter/sort) button has been pressed.

    Type Declaration

      • (event: MouseEvent<HTMLDivElement, MouseEvent>, column: IColumn): void

      • Parameters

        • event: MouseEvent<HTMLDivElement, MouseEvent>

          The mouse event (its currentTarget anchors the menu)

        • column: IColumn

          The table column the button belongs to

        Returns void

    propsColumnButton?: ColumnButtonProps

    Custom properties for the column button.

    renderColumnButton?: (props: ColumnButtonProps) => ReactElement

    Callback for creating a custom column button.

    Type Declaration

    Settings
    Member Visibility

    On This Page
    Properties