RevGrid - v0.9.3
    Preparing search index...

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

    Properties

    gridSettings: RevSimpleGridSettings

    Accessors

    • get backgroundColor(): string

      Returns string

    • set backgroundColor(value: string): void

      Parameters

      • value: string

      Returns void

    • get cellPadding(): number

      Padding to left and right of cell content

      Returns number

    • set cellPadding(value: number): void

      Padding to left and right of cell content

      Parameters

      • value: number

      Returns void

    • get color(): string

      Returns string

    • set color(value: string): void

      Parameters

      • value: string

      Returns void

    • get columnAutoSizingMax(): undefined | number

      The widest the column will be auto-sized to.

      Returns undefined | number

    • set columnAutoSizingMax(value: undefined | number): void

      The widest the column will be auto-sized to.

      Parameters

      • value: undefined | number

      Returns void

    • get 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

      Returns undefined | boolean

    • set columnClip(value: undefined | boolean): void

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

      Parameters

      • value: undefined | boolean

      Returns void

    • get defaultColumnAutoSizing(): boolean

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

      Returns boolean

    • set defaultColumnAutoSizing(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get 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.)

      Returns number

    • set defaultColumnWidth(value: number): void

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

      Parameters

      • value: number

      Returns void

    • get editable(): boolean

      Returns boolean

    • set editable(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get editOnClick(): boolean

      Open cell editor for cell when clicked by mouse

      Returns boolean

    • set editOnClick(value: boolean): void

      Open cell editor for cell when clicked by mouse

      Parameters

      • value: boolean

      Returns void

    • get editOnDoubleClick(): boolean

      Open cell editor for cell when double clicked by mouse

      Returns boolean

    • set editOnDoubleClick(value: boolean): void

      Open cell editor for cell when double clicked by mouse

      Parameters

      • value: boolean

      Returns void

    • get editOnFocusCell(): boolean

      Open cell editor for cell when cell gains focus

      Returns boolean

    • set editOnFocusCell(value: boolean): void

      Open cell editor for cell when cell gains focus

      Parameters

      • value: boolean

      Returns void

    • get editOnKeyDown(): boolean

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

      Returns boolean

    • set editOnKeyDown(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get editorClickableCursorName(): undefined | string

      Cursor to display when cell editor can be clicked

      Returns undefined | string

    • set editorClickableCursorName(value: undefined | string): void

      Cursor to display when cell editor can be clicked

      Parameters

      • value: undefined | string

      Returns void

    • get filterable(): boolean

      Validation failure feedback.

      Returns boolean

    • set filterable(value: boolean): void

      Validation failure feedback.

      Parameters

      • value: boolean

      Returns void

    • get 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.

      Returns undefined | number

    • set maximumColumnWidth(value: undefined | number): void

      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.

      Parameters

      • value: undefined | number

      Returns void

    • get 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.

      Returns number

    • set minimumColumnWidth(value: number): void

      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.

      Parameters

      • value: number

      Returns void

    • get resizeColumnInPlace(): boolean

      Returns boolean

    • set resizeColumnInPlace(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get sortOnClick(): boolean

      Column can be sorted with mouse click on column header

      Returns boolean

    • set sortOnClick(value: boolean): void

      Column can be sorted with mouse click on column header

      Parameters

      • value: boolean

      Returns void

    • get sortOnDoubleClick(): boolean

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

      Returns boolean

    • set sortOnDoubleClick(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get textStrikeThrough(): boolean

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

      Returns boolean

    • set textStrikeThrough(value: boolean): void

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

      Parameters

      • value: boolean

      Returns void

    • get verticalOffset(): number

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

      Returns number

    • set verticalOffset(value: number): void

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

      Parameters

      • value: number

      Returns void

    Methods