Class DrawGridAbstract

DrawGrid

Classdesc

cheetahGrid.core.DrawGrid

Memberof

cheetahGrid.core

Hierarchy (view full)

Implements

Constructors

constructor

Accessors

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

Methods

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

Constructors

constructor

  • new DrawGrid(options?): DrawGrid

  • Parameters

    • options: DrawGridConstructorOptions = {}

    Returns DrawGrid

Accessors

canvas

  • get canvas(): HTMLCanvasElement

  • Get canvas element.

    Returns HTMLCanvasElement

colCount

  • get colCount(): number

  • Get the number of columns.

    Returns number

  • set colCount(colCount): void

  • Set the number of columns.

    Parameters

    • colCount: number

    Returns void

defaultColWidth

  • get defaultColWidth(): string | number

  • Get the default column width.

    Returns string | number

  • set defaultColWidth(defaultColWidth): void

  • Set the default column width.

    Parameters

    • defaultColWidth: string | number

    Returns void

defaultRowHeight

  • get defaultRowHeight(): number

  • Get the default row height.

    Returns number

  • set defaultRowHeight(defaultRowHeight): void

  • Set the default row height.

    Parameters

    • defaultRowHeight: number

    Returns void

font

  • get font(): undefined | string

  • Get the font definition as a string.

    Returns undefined | string

  • set font(font): void

  • Set the font definition with the given string.

    Parameters

    • font: undefined | string

    Returns void

frozenColCount

  • get frozenColCount(): number

  • Get the number of frozen columns.

    Returns number

  • set frozenColCount(frozenColCount): void

  • Set the number of frozen columns.

    Parameters

    • frozenColCount: number

    Returns void

frozenRowCount

  • get frozenRowCount(): number

  • Get the number of frozen rows.

    Returns number

  • set frozenRowCount(frozenRowCount): void

  • Set the number of frozen rows.

    Parameters

    • frozenRowCount: number

    Returns void

keyboardOptions

leftCol

  • get leftCol(): number

  • Get the index of the first column in the scrollable region that is visible.

    Returns number

rowCount

  • get rowCount(): number

  • Get the number of rows.

    Returns number

  • set rowCount(rowCount): void

  • Set the number of rows.

    Parameters

    • rowCount: number

    Returns void

scrollLeft

  • get scrollLeft(): number

  • gets or sets the number of pixels that an element's content is scrolled from its left edge

    Returns number

  • set scrollLeft(scrollLeft): void

  • Parameters

    • scrollLeft: number

    Returns void

scrollTop

  • get scrollTop(): number

  • gets or sets the number of pixels that an element's content is scrolled vertically

    Returns number

  • set scrollTop(scrollTop): void

  • Parameters

    • scrollTop: number

    Returns void

selection

  • get selection(): Selection

  • Get the selection instance.

    Returns Selection

topRow

  • get topRow(): number

  • Get the index of the first row in the scrollable region that is visible.

    Returns number

trimOnPaste

  • get trimOnPaste(): boolean

  • If set to true, trim the pasted text on pasting.

    Returns boolean

  • set trimOnPaste(trimOnPaste): void

  • Parameters

    • trimOnPaste: boolean

    Returns void

underlayBackgroundColor

  • get underlayBackgroundColor(): undefined | string

  • Get the background color of the underlay.

    Returns undefined | string

  • set underlayBackgroundColor(underlayBackgroundColor): void

  • Set the background color of the underlay.

    Parameters

    • underlayBackgroundColor: undefined | string

    Returns void

visibleColCount

  • get visibleColCount(): number

  • Get the number of scrollable columns fully visible in the grid. visibleColCount does not include the frozen columns counted by the frozenColCount property. It does not include any partially visible columns on the right of the grid.

    Returns number

visibleRowCount

  • get visibleRowCount(): number

  • Get the number of scrollable rows fully visible in the grid. visibleRowCount does not include the frozen rows counted by the frozenRowCount property. It does not include any partially visible rows on the bottom of the grid.

    Returns number

StaticEVENT_TYPE

  • get EVENT_TYPE(): DrawGridEvents

  • Returns DrawGridEvents

Methods

addDisposable

  • addDisposable(disposable): void

  • Parameters

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

        • Returns void

    Returns void

addEventListener

  • addEventListener(type, listener): void

  • Parameters

    Returns void

configure

  • configure(name, value?): boolean

  • Parameters

    • name: "fadeinWhenCallbackInPromise"
    • Optionalvalue: boolean

    Returns boolean

dispose

  • dispose(): void

  • Dispose the grid instance.

    Returns void

fireListeners

focus

focusCell

  • focusCell(col, row): void

  • Focus the cell.

    Parameters

    • col: number

      The column index.

    • row: number

      The row index

    Returns void

getAttachCellsArea

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

  • Parameters

    Returns {
        element: HTMLElement;
        rect: Rect;
    }

    • element: HTMLElement
    • rect: Rect

getCellAt

getCellOverflowText

  • getCellOverflowText(col, row): null | string

  • Get the overflowed text in the cell rectangle, from the given cell.

    Parameters

    • col: number

      The column index.

    • row: number

      The row index

    Returns null | string

    The text overflowing the cell rect.

getCellRangeRect

getCellRect

  • getCellRect(col, row): Rect

  • Get the rect of the cell.

    Parameters

    • col: number

      index of column, of the cell

    • row: number

      index of row, of the cell

    Returns Rect

    the rect of the cell.

getCellRelativeRect

  • getCellRelativeRect(col, row): Rect

  • Get the relative rectangle of the cell.

    Parameters

    • col: number

      index of column, of the cell

    • row: number

      index of row, of the cell

    Returns Rect

    the rect of the cell.

getCellsRect

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

  • Get the rectangle of the cells area.

    Parameters

    • startCol: number

      index of the starting column, of the cell

    • startRow: number

      index of the starting row, of the cell

    • endCol: number

      index of the ending column, of the cell

    • endRow: number

      index of the ending row, of the cell

    Returns Rect

    the rect of the cells.

getColAt

  • getColAt(absoluteX): number

  • Parameters

    • absoluteX: number

    Returns number

getColWidth

  • getColWidth(col): number

  • Get the column width of the given the column index.

    Parameters

    • col: number

      The column index

    Returns number

    The column width

getElement

  • getElement(): HTMLElement

  • Get root element.

    Returns HTMLElement

    root element

getMaxColWidth

  • getMaxColWidth(col): undefined | string | number

  • Get the column max width of the given the column index.

    Parameters

    • col: number

      The column index

    Returns undefined | string | number

    The column max width

getMinColWidth

  • getMinColWidth(col): undefined | string | number

  • Get the column min width of the given the column index.

    Parameters

    • col: number

      The column index

    Returns undefined | string | number

    The column min width

getRowAt

  • getRowAt(absoluteY): number

  • Parameters

    • absoluteY: number

    Returns number

getRowHeight

  • getRowHeight(row): number

  • Get the row height of the given the row index.

    Parameters

    • row: number

      The row index

    Returns number

    The row height

hasFocusGrid

hasListeners

  • hasListeners(type): boolean

  • Parameters

    • type: string

    Returns boolean

invalidate

invalidateCell

  • invalidateCell(col, row): void

  • Redraws the range of the given cell.

    Parameters

    • col: number

      The column index of cell.

    • row: number

      The row index of cell.

    Returns void

invalidateCellRange

invalidateGridRect

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

  • Redraws the range of the given cells.

    Parameters

    • startCol: number

      index of the starting column, of the cell

    • startRow: number

      index of the starting row, of the cell

    • endCol: number = startCol

      index of the ending column, of the cell

    • endRow: number = startRow

      index of the ending row, of the cell

    Returns void

isFrozenCell

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

  • Parameters

    • col: number
    • row: number

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

listen

  • listen(type, listener): number

  • Adds an event listener.

    Parameters

    • type: string

      The event type id.

    • listener: AnyFunction

      Callback method.

    Returns number

    unique id for the listener.

makeVisibleCell

  • makeVisibleCell(col, row): void

  • Scroll to where cell is visible.

    Parameters

    • col: number

      The column index.

    • row: number

      The row index

    Returns void

onKeyDownMove

removeEventListener

  • removeEventListener(type, listener): void

  • Parameters

    Returns void

setCellOverflowText

  • setCellOverflowText(col, row, overflowText): void

  • Set the overflowed text in the cell rectangle, to the given cell.

    Parameters

    • col: number

      The column index.

    • row: number

      The row index

    • overflowText: string | false

      The overflowed text in the cell rectangle.

    Returns void

setColWidth

  • setColWidth(col, width): void

  • Set the column width of the given the column index.

    Parameters

    • col: number

      The column index

    • width: null | string | number

      The column width

    Returns void

setFocusCursor

  • setFocusCursor(col, row): void

  • Moves the focus cursor to the given cell.

    Parameters

    • col: number

      The column index.

    • row: number

      The row index

    Returns void

setMaxColWidth

  • setMaxColWidth(col, maxwidth): void

  • Set the column max width of the given the column index.

    Parameters

    • col: number

      The column index

    • maxwidth: null | string | number

      The column max width

    Returns void

setMinColWidth

  • setMinColWidth(col, minwidth): void

  • Set the column min width of the given the column index.

    Parameters

    • col: number

      The column index

    • minwidth: null | string | number

      The column min width

    Returns void

setRowHeight

  • setRowHeight(row, height): void

  • Set the row height of the given the row index.

    Parameters

    • row: number

      The row index

    • height: null | number

      The row height

    Returns void

unlisten

  • unlisten(id): void

  • Removes an event listener which was added with listen() by the id returned by listen().

    Parameters

    • id: number

      the id returned by listen().

    Returns void

updateScroll

  • updateScroll(): boolean

  • Apply the changed scroll size.

    Returns boolean

    true if there was a change in the scroll size

updateSize

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods