RevGrid - v0.9.3
    Preparing search index...
    interface RevSimpleBehavioredColumnSettings {
        backgroundColor: string;
        cellFocusedBorderColor: undefined | string;
        cellHoverBackgroundColor: undefined | string;
        cellPadding: number;
        color: string;
        columnAutoSizingMax: undefined | number;
        columnClip: undefined | boolean;
        columnHeaderBackgroundColor: undefined | string;
        columnHeaderFont: undefined | string;
        columnHeaderForegroundColor: undefined | string;
        columnHeaderHorizontalAlign: RevHorizontalAlign;
        columnHeaderHorizontalAlignId: RevHorizontalAlignId;
        columnHeaderSelectionBackgroundColor: undefined | string;
        columnHeaderSelectionFont: undefined | string;
        columnHeaderSelectionForegroundColor: undefined | string;
        columnHoverBackgroundColor: undefined | string;
        defaultColumnAutoSizing: boolean;
        defaultColumnWidth: number;
        editable: boolean;
        editOnClick: boolean;
        editOnDoubleClick: boolean;
        editOnFocusCell: boolean;
        editOnKeyDown: boolean;
        editorClickableCursorName: undefined | string;
        filterable: boolean;
        font: string;
        gridSettings: RevOnlyGridSettings;
        horizontalAlign: RevHorizontalAlign;
        horizontalAlignId: RevHorizontalAlignId;
        maximumColumnWidth: undefined | number;
        minimumColumnWidth: number;
        resizeColumnInPlace: boolean;
        sortOnClick: boolean;
        sortOnDoubleClick: boolean;
        textStrikeThrough: boolean;
        textTruncateType: undefined | RevTextTruncateType;
        textTruncateTypeId: undefined | RevTextTruncateTypeId;
        verticalOffset: number;
        beginChange(): void;
        clone(overrideGrid: boolean): RevSimpleBehavioredColumnSettings;
        endChange(): boolean;
        merge(
            settings: Partial<RevSimpleColumnSettings>,
            overrideGrid: boolean,
        ): boolean;
        subscribeChangedEvent(
            handler: RevBehavioredSettings.ChangedEventHandler,
        ): void;
        unsubscribeChangedEvent(
            handler: RevBehavioredSettings.ChangedEventHandler,
        ): void;
    }

    Hierarchy (View Summary)

    Implemented by

    Index

    Properties

    backgroundColor: string
    cellFocusedBorderColor: undefined | string
    cellHoverBackgroundColor: undefined | string
    cellPadding: number

    Padding to left and right of cell content

    color: string
    columnAutoSizingMax: undefined | number

    The widest the column will be auto-sized to.

    columnClip: undefined | boolean

    Set up a clipping region around each column before painting cells. This will be interpretted differently by grid painters according to their algorithm

    columnHeaderBackgroundColor: undefined | string
    columnHeaderFont: undefined | string
    columnHeaderForegroundColor: undefined | string
    columnHeaderHorizontalAlign: RevHorizontalAlign
    columnHeaderHorizontalAlignId: RevHorizontalAlignId
    columnHeaderSelectionBackgroundColor: undefined | string
    columnHeaderSelectionFont: undefined | string

    Font style for selected columns' headers.

    columnHeaderSelectionForegroundColor: undefined | string
    columnHoverBackgroundColor: undefined | string
    defaultColumnAutoSizing: boolean

    Whether to automatically expand column width to accommodate widest rendered value.

    defaultColumnWidth: number

    This default column width is used when width property is undefined. (width is defined on column creation unless defaultColumnAutoSizing has been set to false.)

    editable: boolean
    editOnClick: boolean

    Open cell editor for cell when clicked by mouse

    editOnDoubleClick: boolean

    Open cell editor for cell when double clicked by mouse

    editOnFocusCell: boolean

    Open cell editor for cell when cell gains focus

    editOnKeyDown: boolean

    Open cell editor for cell when cell focus and certain keys are pushed down

    editorClickableCursorName: undefined | string

    Cursor to display when cell editor can be clicked

    filterable: boolean

    Validation failure feedback.

    font: string
    gridSettings: RevOnlyGridSettings
    horizontalAlign: RevHorizontalAlign
    horizontalAlignId: RevHorizontalAlignId

    Horizontal alignment of content of each cell.

    maximumColumnWidth: undefined | number

    Maximum column width. When defined, column width is clamped to this value. Ignored when falsy. Respects resizeColumnInPlace but may cause user confusion when user can't make column narrower due to next column having reached its maximum.

    minimumColumnWidth: number

    Minimum column width. Adjust this value for different fonts/sizes or exotic cell renderers. The default (5) is enough room for an ellipsis with default font size.

    resizeColumnInPlace: boolean
    sortOnClick: boolean

    Column can be sorted with mouse click on column header

    sortOnDoubleClick: boolean

    Sort column on double-click rather than single-click.

    textStrikeThrough: boolean

    Display cell font with strike-through line drawn over it.

    textTruncateType: undefined | RevTextTruncateType
    textTruncateTypeId: undefined | RevTextTruncateTypeId
    verticalOffset: number

    Vertical offset from top of cell of content of each cell.

    Methods