Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListGridAPI<T>

Type parameters

  • T

Hierarchy

Implemented by

Index

Properties

Readonly canvas

canvas: HTMLCanvasElement

colCount

colCount: number

dataSource

dataSource: DataSourceAPI<T>

defaultColWidth

defaultColWidth: string | number

defaultRowHeight

defaultRowHeight: number

disabled

disabled: boolean

Optional font

font: undefined | string

frozenColCount

frozenColCount: number

frozenRowCount

frozenRowCount: number

headerValues

headerValues: HeaderValues

keyboardOptions

keyboardOptions: DrawGridKeyboardOptions | null

Readonly leftCol

leftCol: number

readOnly

readOnly: boolean

recordRowCount

recordRowCount: number

records

records: T[] | null

rowCount

rowCount: number

scrollLeft

scrollLeft: number

scrollTop

scrollTop: number

Readonly selection

selection: Selection

sortState

sortState: SortState | null

theme

theme: RequiredThemeDefine | null

Readonly topRow

topRow: number

Optional underlayBackgroundColor

underlayBackgroundColor: undefined | string

Readonly visibleColCount

visibleColCount: number

Readonly visibleRowCount

visibleRowCount: number

Methods

addDisposable

  • addDisposable(disposable: { dispose: any }): void
  • Parameters

    • disposable: { dispose: any }
      • dispose: function
        • dispose(): void
        • Returns void

    Returns void

configure

  • configure(name: "fadeinWhenCallbackInPromise", value?: undefined | false | true): boolean
  • Parameters

    • name: "fadeinWhenCallbackInPromise"
    • Optional value: undefined | false | true

    Returns boolean

dispose

  • dispose(): void

doChangeValue

  • doChangeValue(col: number, row: number, changeValueCallback: (before: any) => any): MaybePromise<boolean>
  • Parameters

    • col: number
    • row: number
    • changeValueCallback: (before: any) => any
        • (before: any): any
        • Parameters

          • before: any

          Returns any

    Returns MaybePromise<boolean>

doGetCellValue

  • doGetCellValue(col: number, row: number, valueCallback: (value: any) => void): boolean
  • Parameters

    • col: number
    • row: number
    • valueCallback: (value: any) => void
        • (value: any): void
        • Parameters

          • value: any

          Returns void

    Returns boolean

doSetPasteValue

  • doSetPasteValue(text: string): void
  • doSetPasteValue(text: string, test: (data: SetPasteValueTestData<T>) => boolean): void

focus

  • focus(): void

focusCell

  • focusCell(col: number, row: number): void

focusGridCell

  • focusGridCell(field: FieldDef<T>, index: number): void
  • Parameters

    Returns void

getAttachCellsArea

getCellAt

  • getCellAt(absoluteX: number, absoluteY: number): CellAddress

getCellOverflowText

  • getCellOverflowText(col: number, row: number): string | null

getCellRange

  • getCellRange(col: number, row: number): CellRange
  • Parameters

    • col: number
    • row: number

    Returns CellRange

getCellRangeByField

getCellRangeRect

getCellRect

  • getCellRect(col: number, row: number): RectProps

getCellRelativeRect

  • getCellRelativeRect(col: number, row: number): RectProps

getCellsRect

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

getColAt

  • getColAt(absoluteX: number): number

getColWidth

  • getColWidth(col: number): number

getColumnType

getElement

  • getElement(): HTMLElement

getField

  • getField(col: number, row: number): FieldDef<T> | undefined
  • Parameters

    • col: number
    • row: number

    Returns FieldDef<T> | undefined

getGridCanvasHelper

getHeaderField

  • getHeaderField(col: number, row: number): any | undefined
  • Parameters

    • col: number
    • row: number

    Returns any | undefined

getHeaderValue

  • getHeaderValue(col: number, row: number): any | undefined
  • Parameters

    • col: number
    • row: number

    Returns any | undefined

getLayoutCellId

getMaxColWidth

  • getMaxColWidth(col: number): string | number | undefined

getMinColWidth

  • getMinColWidth(col: number): string | number | undefined

getRecordIndexByRow

  • getRecordIndexByRow(row: number): number
  • Parameters

    • row: number

    Returns number

getRecordStartRowByRecordIndex

  • getRecordStartRowByRecordIndex(index: number): number
  • Parameters

    • index: number

    Returns number

getRowAt

  • getRowAt(absoluteY: number): number

getRowHeight

  • getRowHeight(row: number): number

getRowRecord

hasFocusGrid

  • hasFocusGrid(): boolean

invalidate

  • invalidate(): void

invalidateCell

  • invalidateCell(col: number, row: number): void

invalidateCellRange

  • invalidateCellRange(cellRange: CellRange): void

invalidateGridRect

  • invalidateGridRect(startCol: number, startRow: number, endCol?: undefined | number, endRow?: undefined | number): void
  • Parameters

    • startCol: number
    • startRow: number
    • Optional endCol: undefined | number
    • Optional endRow: undefined | number

    Returns void

isFrozenCell

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

    • col: number
    • row: number

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

listen

  • listen<TYPE>(type: TYPE, listener: (...event: ListGridEventHandlersEventMap<T>[TYPE]) => ListGridEventHandlersReturnMap[TYPE]): EventListenerId
  • Type parameters

    Parameters

    • type: TYPE
    • listener: (...event: ListGridEventHandlersEventMap<T>[TYPE]) => ListGridEventHandlersReturnMap[TYPE]
        • (...event: ListGridEventHandlersEventMap<T>[TYPE]): ListGridEventHandlersReturnMap[TYPE]
        • Parameters

          • Rest ...event: ListGridEventHandlersEventMap<T>[TYPE]

          Returns ListGridEventHandlersReturnMap[TYPE]

    Returns EventListenerId

makeVisibleCell

  • makeVisibleCell(col: number, row: number): void

makeVisibleGridCell

  • makeVisibleGridCell(field: FieldDef<T>, index: number): void
  • Parameters

    Returns void

onKeyDownMove

  • onKeyDownMove(evt: KeyboardEvent): void

setCellOverflowText

  • setCellOverflowText(col: number, row: number, overflowText: false | string): void

setColWidth

  • setColWidth(col: number, width: number): void

setFocusCursor

  • setFocusCursor(col: number, row: number): void

setHeaderValue

  • setHeaderValue(col: number, row: number, newValue: any): void
  • Parameters

    • col: number
    • row: number
    • newValue: any

    Returns void

setMaxColWidth

  • setMaxColWidth(col: number, maxwidth: string | number): void

setMinColWidth

  • setMinColWidth(col: number, minwidth: string | number): void

setRowHeight

  • setRowHeight(row: number, height: number): void

updateScroll

  • updateScroll(): boolean

updateSize

  • updateSize(): void

Generated using TypeDoc