Interface DrawGridAPI

interface DrawGridAPI {
    canvas: HTMLCanvasElement;
    colCount: number;
    defaultColWidth: string | number;
    defaultRowHeight: number;
    font?: string;
    frozenColCount: number;
    frozenRowCount: number;
    keyboardOptions: null | DrawGridKeyboardOptions;
    leftCol: number;
    rowCount: number;
    scrollLeft: number;
    scrollTop: number;
    selection: Selection;
    topRow: number;
    trimOnPaste: boolean;
    underlayBackgroundColor?: string;
    visibleColCount: number;
    visibleRowCount: number;
    addDisposable(disposable: {
        dispose(): void;
    }): void;
    configure(name: "fadeinWhenCallbackInPromise", value?: boolean): boolean;
    dispose(): void;
    focus(): void;
    focusCell(col: number, row: number): void;
    getAttachCellsArea(range: CellRange): {
        element: HTMLElement;
        rect: RectProps;
    };
    getCellAt(absoluteX: number, absoluteY: number): CellAddress;
    getCellOverflowText(col: number, row: number): null | string;
    getCellRangeRect(cellRange: CellRange): RectProps;
    getCellRect(col: number, row: number): RectProps;
    getCellRelativeRect(col: number, row: number): RectProps;
    getCellsRect(startCol: number, startRow: number, endCol: number, endRow: number): RectProps;
    getColAt(absoluteX: number): number;
    getColWidth(col: number): number;
    getElement(): HTMLElement;
    getMaxColWidth(col: number): undefined | string | number;
    getMinColWidth(col: number): undefined | string | number;
    getRowAt(absoluteY: number): number;
    getRowHeight(row: number): number;
    hasFocusGrid(): boolean;
    invalidate(): void;
    invalidateCell(col: number, row: number): void;
    invalidateCellRange(cellRange: CellRange): void;
    invalidateGridRect(startCol: number, startRow: number, endCol?: number, endRow?: number): void;
    isFrozenCell(col: number, row: number): null | {
        col: boolean;
        row: boolean;
    };
    listen<TYPE>(type: TYPE, listener: ((...event: DrawGridEventHandlersEventMap[TYPE]) => DrawGridEventHandlersReturnMap[TYPE])): number;
    listen(type: string, listener: AnyFunction): number;
    makeVisibleCell(col: number, row: number): void;
    onKeyDownMove(evt: KeyboardEvent): void;
    setCellOverflowText(col: number, row: number, overflowText: string | false): void;
    setColWidth(col: number, width: null | string | number): void;
    setFocusCursor(col: number, row: number): void;
    setMaxColWidth(col: number, maxwidth: string | number): void;
    setMinColWidth(col: number, minwidth: string | number): void;
    setRowHeight(row: number, height: number): void;
    updateScroll(): boolean;
    updateSize(): void;
}

Hierarchy (view full)

Implemented by

Properties

canvas colCount defaultColWidth defaultRowHeight font? frozenColCount frozenRowCount keyboardOptions leftCol rowCount scrollLeft scrollTop selection topRow trimOnPaste underlayBackgroundColor? visibleColCount visibleRowCount

Methods

addDisposable configure dispose focus focusCell getAttachCellsArea getCellAt getCellOverflowText getCellRangeRect getCellRect getCellRelativeRect getCellsRect getColAt getColWidth getElement getMaxColWidth getMinColWidth getRowAt getRowHeight hasFocusGrid invalidate invalidateCell invalidateCellRange invalidateGridRect isFrozenCell listen makeVisibleCell onKeyDownMove setCellOverflowText setColWidth setFocusCursor setMaxColWidth setMinColWidth setRowHeight updateScroll updateSize

Properties

Readonlycanvas

canvas: HTMLCanvasElement

colCount

colCount: number

defaultColWidth

defaultColWidth: string | number

defaultRowHeight

defaultRowHeight: number

Optionalfont

font?: string

frozenColCount

frozenColCount: number

frozenRowCount

frozenRowCount: number

keyboardOptions

keyboardOptions: null | DrawGridKeyboardOptions

ReadonlyleftCol

leftCol: number

rowCount

rowCount: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonlyselection

selection: Selection

ReadonlytopRow

topRow: number

trimOnPaste

trimOnPaste: boolean

OptionalunderlayBackgroundColor

underlayBackgroundColor?: string

ReadonlyvisibleColCount

visibleColCount: number

ReadonlyvisibleRowCount

visibleRowCount: number

Methods

addDisposable

  • addDisposable(disposable): void

  • Parameters

    • disposable: {
          dispose(): void;
      }
      • dispose:function
        • dispose(): void

        • Returns void

    Returns void

configure

  • configure(name, value?): boolean

  • Parameters

    • name: "fadeinWhenCallbackInPromise"
    • Optionalvalue: boolean

    Returns boolean

dispose

  • dispose(): void

  • Returns void

focus

  • focus(): void

  • Returns void

focusCell

  • focusCell(col, row): void

  • Parameters

    • col: number
    • row: number

    Returns void

getAttachCellsArea

  • getAttachCellsArea(range): {
        element: HTMLElement;
        rect: RectProps;
    }

  • Parameters

    Returns {
        element: HTMLElement;
        rect: RectProps;
    }

getCellAt

getCellOverflowText

  • getCellOverflowText(col, row): null | string

  • Parameters

    • col: number
    • row: number

    Returns null | string

getCellRangeRect

getCellRect

getCellRelativeRect

getCellsRect

  • getCellsRect(startCol, startRow, endCol, endRow): RectProps

  • Parameters

    • startCol: number
    • startRow: number
    • endCol: number
    • endRow: number

    Returns RectProps

getColAt

  • getColAt(absoluteX): number

  • Parameters

    • absoluteX: number

    Returns number

getColWidth

  • getColWidth(col): number

  • Parameters

    • col: number

    Returns number

getElement

  • getElement(): HTMLElement

  • Returns HTMLElement

getMaxColWidth

  • getMaxColWidth(col): undefined | string | number

  • Parameters

    • col: number

    Returns undefined | string | number

getMinColWidth

  • getMinColWidth(col): undefined | string | number

  • Parameters

    • col: number

    Returns undefined | string | number

getRowAt

  • getRowAt(absoluteY): number

  • Parameters

    • absoluteY: number

    Returns number

getRowHeight

  • getRowHeight(row): number

  • Parameters

    • row: number

    Returns number

hasFocusGrid

  • hasFocusGrid(): boolean

  • Returns boolean

invalidate

  • invalidate(): void

  • Returns void

invalidateCell

  • invalidateCell(col, row): void

  • Parameters

    • col: number
    • row: number

    Returns void

invalidateCellRange

  • invalidateCellRange(cellRange): void

  • Parameters

    Returns void

invalidateGridRect

  • invalidateGridRect(startCol, startRow, endCol?, endRow?): void

  • Parameters

    • startCol: number
    • startRow: number
    • OptionalendCol: number
    • OptionalendRow: number

    Returns void

isFrozenCell

  • isFrozenCell(col, row): null | {
        col: boolean;
        row: boolean;
    }

  • Parameters

    • col: number
    • row: number

    Returns null | {
        col: boolean;
        row: boolean;
    }

listen

makeVisibleCell

  • makeVisibleCell(col, row): void

  • Parameters

    • col: number
    • row: number

    Returns void

onKeyDownMove

  • onKeyDownMove(evt): void

  • Parameters

    • evt: KeyboardEvent

    Returns void

setCellOverflowText

  • setCellOverflowText(col, row, overflowText): void

  • Parameters

    • col: number
    • row: number
    • overflowText: string | false

    Returns void

setColWidth

  • setColWidth(col, width): void

  • Parameters

    • col: number
    • width: null | string | number

    Returns void

setFocusCursor

  • setFocusCursor(col, row): void

  • Parameters

    • col: number
    • row: number

    Returns void

setMaxColWidth

  • setMaxColWidth(col, maxwidth): void

  • Parameters

    • col: number
    • maxwidth: string | number

    Returns void

setMinColWidth

  • setMinColWidth(col, minwidth): void

  • Parameters

    • col: number
    • minwidth: string | number

    Returns void

setRowHeight

  • setRowHeight(row, height): void

  • Parameters

    • row: number
    • height: number

    Returns void

updateScroll

  • updateScroll(): boolean

  • Returns boolean

updateSize

  • updateSize(): void

  • Returns void

Settings

Member Visibility

On This Page

Properties
Methods