Class RevClientGrid<BGS, BCS, SF>

Type Parameters

Hierarchy (View Summary)

RevClientGrid

Index

Constructors

Constructors

constructor

new RevClientGrid<
    BGS extends RevBehavioredGridSettings,
    BCS extends RevBehavioredColumnSettings,
    SF extends RevSchemaField,
>(
    hostElement: undefined | string | HTMLElement,
    definition: RevGridDefinition<BCS, SF>,
    settings: BGS,
    getSettingsForNewColumnEventer: RevClientGrid.GetSettingsForNewColumnEventer<
        BCS,
        SF,
    >,
    options?: RevGridOptions<BGS, BCS, SF>,
): RevClientGrid<BGS, BCS, SF>
Type Parameters
- BGS extends RevBehavioredGridSettings
- BCS extends RevBehavioredColumnSettings
- SF extends RevSchemaField
Parameters
- hostElement: undefined | string | HTMLElement
- definition: RevGridDefinition<BCS, SF>
- settings: BGS
- getSettingsForNewColumnEventer: RevClientGrid.GetSettingsForNewColumnEventer<BCS, SF>
- Optionaloptions: RevGridOptions<BGS, BCS, SF>
Returns RevClientGrid<BGS, BCS, SF>

Properties

`Readonly`canvas

canvas: RevCanvas<BGS>

`Readonly`clientId

clientId: string

`Readonly`columnsManager

columnsManager: RevColumnsManager<BCS, SF>

`Readonly`externalParent

externalParent: unknown

`Readonly`focus

focus: RevFocus<BGS, BCS, SF>

`Readonly`horizontalScroller

horizontalScroller: RevScroller<BGS, BCS, SF>

`Readonly`hostElement

hostElement: HTMLElement

`Readonly`id

id: string

`Readonly`internalParent

internalParent: undefined | RevClientObject

`Readonly`mainDataServer

mainDataServer: RevDataServer<SF>

`Readonly`mainSubgrid

mainSubgrid: RevMainSubgrid<BCS, SF>

`Readonly`mouse

mouse: RevMouse<BGS, BCS, SF>

`Readonly`renderer

renderer: RevRenderer<BGS, BCS, SF>

`Readonly`schemaServer

schemaServer: RevSchemaServer<SF>

`Readonly`selection

selection: RevSelection<BGS, BCS, SF>

`Readonly`settings

settings: BGS

`Readonly`subgridsManager

subgridsManager: RevSubgridsManager<BCS, SF>

`Readonly`verticalScroller

verticalScroller: RevScroller<BGS, BCS, SF>

`Readonly`viewLayout

viewLayout: RevViewLayout<BGS, BCS, SF>

Accessors

active

get active(): boolean
Returns boolean
set active(value: boolean): void
Parameters
- value: boolean
Returns void

activeColumnCount

get activeColumnCount(): number
Returns number

activeColumns

get activeColumns(): readonly RevColumn<BCS, SF>[]
Returns readonly RevColumn<BCS, SF>[]

activeColumnsViewWidth

get activeColumnsViewWidth(): number
Returns number

columnScrollAnchorIndex

get columnScrollAnchorIndex(): number
The index of the active column which is first in view (either on left or right depending on Grid alignment)

Returns number

columnScrollAnchorOffset

get columnScrollAnchorOffset(): number
The number of pixels that the scroll anchored column is offset. Changes to allow smooth scrolling

Returns number

destroyed

get destroyed(): boolean
Returns boolean

fieldColumns

get fieldColumns(): readonly RevColumn<BCS, SF>[]
Returns readonly RevColumn<BCS, SF>[]

fixedColumnsViewWidth

get fixedColumnsViewWidth(): number
Returns number

nonFixedColumnsViewWidth

get nonFixedColumnsViewWidth(): number
Returns number

selectionAllAuto

get selectionAllAuto(): boolean
Returns boolean
set selectionAllAuto(value: boolean): void
Parameters
- value: boolean
Returns void

Methods

activate

activate(): void
Returns void

addEventListener

addEventListener(
    eventName: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions,
): void
Parameters
- eventName: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | AddEventListenerOptions
Returns void

areColumnsOrRowsSelected

areColumnsOrRowsSelected(includeAllAuto?: boolean): boolean
Parameters
- OptionalincludeAllAuto: boolean
Returns boolean

areColumnsSelected

areColumnsSelected(includeAllAuto?: boolean): boolean
Parameters
- OptionalincludeAllAuto: boolean
Returns boolean

areRowsSelected

areRowsSelected(includeAllAuto?: boolean): boolean
Parameters
- OptionalincludeAllAuto: boolean
Returns boolean

autoSizeActiveColumnWidths

autoSizeActiveColumnWidths(widenOnly: boolean): void
Parameters
- widenOnly: boolean
Returns void

autoSizeFieldColumnWidth

autoSizeFieldColumnWidth(
fieldNameOrIndex: string | number,
widenOnly: boolean,
): void
Parameters
- fieldNameOrIndex: string | number
- widenOnly: boolean
Returns void

beginSelectionChange

beginSelectionChange(): void
Call before multiple selection changes to consolidate SelectionChange events. Pair with endSelectionChange().

Returns void

calculateActiveColumnsWidth

calculateActiveColumnsWidth(): number
Returns number

calculateActiveNonFixedColumnsWidth

calculateActiveNonFixedColumnsWidth(): number
Returns number

calculateRowCount

calculateRowCount(): number
Returns number

clearColumns

clearColumns(): void
Returns void

clearFocus

clearFocus(): void
Returns void

clearSelection

clearSelection(): void
Returns void

deactivate

deactivate(): void
Returns void

deselectCell

deselectCell(x: number, y: number, subgrid: RevSubgrid<BCS, SF>): void
Parameters
- x: number
- y: number
- subgrid: RevSubgrid<BCS, SF>
Returns void

deselectColumn

deselectColumn(x: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- x: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

deselectColumns

deselectColumns(x: number, count: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- x: number
- count: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

deselectRectangle

deselectRectangle(rectangle: RevRectangle, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- rectangle: RevRectangle
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

deselectRow

deselectRow(y: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

deselectRows

deselectRows(y: number, count: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- y: number
- count: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

destroy

destroy(): void
Be a responsible citizen and call this function on instance disposal! If multiple grids are used in an application (simultaneously or not), then destroy() must be called otherwise canvase paint loop will continue to run

Returns void

endSelectionChange

endSelectionChange(): void
Call after multiple selection changes to consolidate SelectionChange events. Pair with beginSelectionChange().

Returns void

findLinedHoverCellAtCanvasOffset

findLinedHoverCellAtCanvasOffset(
offsetX: number,
offsetY: number,
): undefined | RevLinedHoverCell<BCS, SF>
Find cell under offset position in canvas
Parameters
- offsetX: number
  X position of pixel in canvas.
- offsetY: number
  Y position of pixel in canvas.
Returns undefined | RevLinedHoverCell<BCS, SF>

focusOnlySelectCell

focusOnlySelectCell(
    activeColumnIndex: number,
    subgridRowIndex: number,
    subgrid?: RevSubgrid<BCS, SF>,
    ensureFullyInView?: RevEnsureFullyInViewEnum,
): void
Parameters
- activeColumnIndex: number
- subgridRowIndex: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalensureFullyInView: RevEnsureFullyInViewEnum
Returns void

focusOnlySelectRectangle

focusOnlySelectRectangle(
    inexclusiveX: number,
    inexclusiveY: number,
    width: number,
    height: number,
    subgrid?: RevSubgrid<BCS, SF>,
    ensureFullyInView?: RevEnsureFullyInViewEnum,
): void
Parameters
- inexclusiveX: number
- inexclusiveY: number
- width: number
- height: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalensureFullyInView: RevEnsureFullyInViewEnum
Returns void

focusReplaceLastArea

focusReplaceLastArea(
    areaType: "all" | "rectangle" | "row" | "column",
    inexclusiveX: number,
    inexclusiveY: number,
    width: number,
    height: number,
    subgrid?: RevSubgrid<BCS, SF>,
    ensureFullyInView?: RevEnsureFullyInViewEnum,
): void
Parameters
- areaType: "all" | "rectangle" | "row" | "column"
- inexclusiveX: number
- inexclusiveY: number
- width: number
- height: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalensureFullyInView: RevEnsureFullyInViewEnum
Returns void

focusReplaceLastAreaWithRectangle

focusReplaceLastAreaWithRectangle(
    inexclusiveX: number,
    inexclusiveY: number,
    width: number,
    height: number,
    subgrid?: RevSubgrid<BCS, SF>,
    ensureFullyInView?: RevEnsureFullyInViewEnum,
): void
Parameters
- inexclusiveX: number
- inexclusiveY: number
- width: number
- height: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalensureFullyInView: RevEnsureFullyInViewEnum
Returns void

focusSelectCell

focusSelectCell(
    x: number,
    y: number,
    subgrid?: RevSubgrid<BCS, SF>,
    ensureFullyInView?: RevEnsureFullyInViewEnum,
): void
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalensureFullyInView: RevEnsureFullyInViewEnum
Returns void

focusToggleSelectCell

focusToggleSelectCell(
    originX: number,
    originY: number,
    subgrid?: RevSubgrid<BCS, SF>,
    ensureFullyInView?: RevEnsureFullyInViewEnum,
): boolean
Parameters
- originX: number
- originY: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalensureFullyInView: RevEnsureFullyInViewEnum
Returns boolean

getActiveColumn

getActiveColumn(activeIndex: number): RevColumn<BCS, SF>
Parameters
- activeIndex: number
Returns RevColumn<BCS, SF>

getActiveColumnIndexByFieldIndex

getActiveColumnIndexByFieldIndex(fieldIndex: number): number
Parameters
- fieldIndex: number
Returns number

getActiveColumns

getActiveColumns(begin?: number, end?: number): RevColumn<BCS, SF>[]
Parameters
- Optionalbegin: number
- Optionalend: number
Returns RevColumn<BCS, SF>[]
A copy of the active columns array by passing the params to Array.prototype.slice.

getActiveColumnSettings

getActiveColumnSettings(activeColumnIndex: number): BCS
Parameters
- activeColumnIndex: number
  Data x coordinate.
Returns BCS
The properties for a specific column.

getActiveColumnWidth

getActiveColumnWidth(activeIndex: number): number
Parameters
- activeIndex: number
  The untranslated column index.
Returns number
The width of the given column.

getAllCellSelectionAreaTypeIds

getAllCellSelectionAreaTypeIds(
    activeColumnIndex: number,
    subgridRowIndex: number,
    subgrid?: RevSubgrid<BCS, SF>,
): ("all" | "rectangle" | "row" | "column")[]
Parameters
- activeColumnIndex: number
- subgridRowIndex: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns ("all" | "rectangle" | "row" | "column")[]

getAllColumn

getAllColumn(allX: number): RevColumn<BCS, SF>
Parameters
- allX: number
Returns RevColumn<BCS, SF>

getBoundsOfCell

getBoundsOfCell(gridCell: RevPoint): RevRectangle
Parameters
- gridCell: RevPoint
  The pixel location of the mouse in physical grid coordinates.
Returns RevRectangle
The pixel based bounds rectangle given a data cell point.

getFieldColumnRange

getFieldColumnRange(begin?: number, end?: number): RevColumn<BCS, SF>[]
Parameters
- Optionalbegin: number
- Optionalend: number
Returns RevColumn<BCS, SF>[]
A copy of the all columns array by passing the params to Array.prototype.slice.

getHiddenColumns

getHiddenColumns(): RevColumn<BCS, SF>[]
Returns RevColumn<BCS, SF>[]

getHiDPI

getHiDPI(): number
Returns number
The HiDPI ratio.

getOneCellSelectionAreaType

getOneCellSelectionAreaType(
    activeColumnIndex: number,
    subgridRowIndex: number,
    subgrid?: RevSubgrid<BCS, SF>,
): undefined | "all" | "rectangle" | "row" | "column"
Parameters
- activeColumnIndex: number
- subgridRowIndex: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns undefined | "all" | "rectangle" | "row" | "column"

getRenderedData

getRenderedData(): unknown[][]
Returns unknown[][]
Objects with the values that were just rendered.

getRenderedHeight

getRenderedHeight(rowIndex: number): number
Parameters
- rowIndex: number
  The row index.
Returns number
The height of the given (recently rendered) row.

getRenderedWidth

getRenderedWidth(colIndex: number): number
Parameters
- colIndex: number
  The column index.
Returns number
The width of the given (recently rendered) column.

getRowHeight

getRowHeight(rowIndex: number, subgrid?: RevSubgrid<BCS, SF>): number
Parameters
- rowIndex: number
  The untranslated fixed column index.
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns number
The height of the given row

getSchema

getSchema(): readonly RevSchemaField[]
Returns readonly RevSchemaField[]

getSelectedAllAutoRowCount

getSelectedAllAutoRowCount(): number
Returns number

getSelectedAllAutoRowIndices

getSelectedAllAutoRowIndices(): number[]
Returns number[]

getSelectedColumnIndices

getSelectedColumnIndices(includeAllAuto?: boolean): number[]
Parameters
- OptionalincludeAllAuto: boolean
Returns number[]

getSelectedRowCount

getSelectedRowCount(includeAllAuto?: boolean): number
Parameters
- OptionalincludeAllAuto: boolean
Returns number

getSelectedRowIndices

getSelectedRowIndices(includeAllAuto?: boolean): number[]
Parameters
- OptionalincludeAllAuto: boolean
Returns number[]

getSingletonViewDataRow

getSingletonViewDataRow(y: number, subgrid?: RevSubgrid<BCS, SF>): ViewRow
Retrieve a data row from the main data model.
Parameters
- y: number
  the row index of interest
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns ViewRow
The data row object at y index.

getSubgridRowCount

getSubgridRowCount(subgrid: RevSubgrid<BCS, SF>): number
Gets the number of rows in the main subgrid.
Parameters
- subgrid: RevSubgrid<BCS, SF>
Returns number
The number of rows.

getViewData

getViewData(): readonly ViewRow[]
Retrieve all data rows from the data model. Use with caution!

Returns readonly ViewRow[]

getViewValue

getViewValue(x: number, y: number, subgrid?: RevSubgrid<BCS, SF>): unknown
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns unknown

getVisibleColumnsCount

getVisibleColumnsCount(): number
Returns number
The number of columns that were just rendered

getVisibleRowsCount

getVisibleRowsCount(): number
Returns number
The number of rows that were just rendered

hideActiveColumn

hideActiveColumn(activeColumnIndex: number, ui?: boolean): void
Parameters
- activeColumnIndex: number
- Optionalui: boolean
Returns void

isActiveDocumentElement

isActiveDocumentElement(): boolean
Returns boolean
We have focus.

isCellSelected

isCellSelected(x: number, y: number, subgrid?: RevSubgrid<BCS, SF>): boolean
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns boolean

isColumnVisible

isColumnVisible(activeIndex: number): boolean
Parameters
- activeIndex: number
  The column index in question.
Returns boolean
The given column is fully visible.

isDataRowVisible

isDataRowVisible(rowIndex: number, subgrid?: RevSubgrid<BCS, SF>): boolean
Get the visibility of the row matching the provided data row index.
Parameters
- rowIndex: number
  The data row index.
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns boolean
The given row is visible.

Remarks
Requested row may not be visible due to being scrolled out of view. Determines visibility of a row.

isDataVisible

isDataVisible(c: number, rn: number): boolean
Parameters
- c: number
  The column index in question.
- rn: number
  The grid row index in question.
Returns boolean
The given cell is fully is visible.

isOnlyThisCellSelected

isOnlyThisCellSelected(
    x: number,
    y: number,
    subgrid?: RevSubgrid<BCS, SF>,
): undefined | boolean
Returns undefined if not selected, false if selected with others, true if the only cell selected
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns undefined | boolean

isSelectedCellTheOnlySelectedCell

isSelectedCellTheOnlySelectedCell(
    activeColumnIndex: number,
    subgridRowIndex: number,
    subgrid: RevSubgrid<BCS, SF>,
    selectedType?: "all" | "rectangle" | "row" | "column",
): boolean
Parameters
- activeColumnIndex: number
- subgridRowIndex: number
- subgrid: RevSubgrid<BCS, SF>
- OptionalselectedType: "all" | "rectangle" | "row" | "column"
Returns boolean

mergeFieldColumnSettings

mergeFieldColumnSettings(
    fieldIndex: number,
    settings: Partial<BCS>,
    overrideGrid?: boolean,
): boolean
Parameters
- fieldIndex: number
- settings: Partial<BCS>
- OptionaloverrideGrid: boolean
Returns boolean

moveActiveColumn

moveActiveColumn(fromIndex: number, toIndex: number, ui: boolean): void
Parameters
- fromIndex: number
- toIndex: number
- ui: boolean
Returns void

onlySelectCell

onlySelectCell(
    x: number,
    y: number,
    subgrid?: RevSubgrid<BCS, SF>,
): RevLastSelectionArea
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns RevLastSelectionArea

onlySelectColumn

onlySelectColumn(activeColumnIndex: number): void
Parameters
- activeColumnIndex: number
Returns void

onlySelectColumns

onlySelectColumns(activeColumnIndex: number, count: number): void
Parameters
- activeColumnIndex: number
- count: number
Returns void

onlySelectRectangle

onlySelectRectangle(
    firstInexclusiveX: number,
    firstInexclusiveY: number,
    width: number,
    height: number,
    subgrid?: RevSubgrid<BCS, SF>,
): RevLastSelectionArea
Parameters
- firstInexclusiveX: number
- firstInexclusiveY: number
- width: number
- height: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns RevLastSelectionArea

onlySelectRow

onlySelectRow(subgridRowIndex: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- subgridRowIndex: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

onlySelectRows

onlySelectRows(
    subgridRowIndex: number,
    count: number,
    subgrid?: RevSubgrid<BCS, SF>,
): void
Parameters
- subgridRowIndex: number
- count: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

onlySelectViewCell

onlySelectViewCell(
viewLayoutColumnIndex: number,
viewLayoutRowIndex: number,
): void
Parameters
- viewLayoutColumnIndex: number
- viewLayoutRowIndex: number
Returns void

registerGridPainter

registerGridPainter(
key: string,
constructor: RevGridPainter.Constructor<BGS, BCS, SF>,
): void
Parameters
- key: string
- constructor: RevGridPainter.Constructor<BGS, BCS, SF>
Returns void

removeEventListener

removeEventListener(
    eventName: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions,
): void
Parameters
- eventName: string
- listener: EventListenerOrEventListenerObject
- Optionaloptions: boolean | EventListenerOptions
Returns void

reset

reset(): void
Reset all components, resize and invalidate all

Returns void

scrollBottom

scrollBottom(): boolean
Returns boolean

scrollFirstColumn

scrollFirstColumn(): boolean
Returns boolean

scrollLastColumn

scrollLastColumn(): boolean
Returns boolean

scrollTop

scrollTop(): boolean
Returns boolean

selectAllRows

selectAllRows(subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

selectCell

selectCell(
    x: number,
    y: number,
    subgrid?: RevSubgrid<BCS, SF>,
): RevLastSelectionArea
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns RevLastSelectionArea

selectColumn

selectColumn(activeColumnIndex: number): void
Parameters
- activeColumnIndex: number
Returns void

selectColumns

selectColumns(activeColumnIndex: number, count: number): void
Parameters
- activeColumnIndex: number
- count: number
Returns void

selectRectangle

selectRectangle(
    firstInexclusiveX: number,
    firstInexclusiveY: number,
    width: number,
    height: number,
    subgrid?: RevSubgrid<BCS, SF>,
): RevLastSelectionArea
Parameters
- firstInexclusiveX: number
- firstInexclusiveY: number
- width: number
- height: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns RevLastSelectionArea

selectRow

selectRow(subgridRowIndex: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- subgridRowIndex: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

selectRows

selectRows(
    subgridRowIndex: number,
    count: number,
    subgrid?: RevSubgrid<BCS, SF>,
): void
Parameters
- subgridRowIndex: number
- count: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

setActiveColumns

setActiveColumns(
    columnFieldNameOrFieldIndexArray: readonly (
        string
        | number
        | RevColumn<BCS, SF>
    )[],
): void
Parameters
- columnFieldNameOrFieldIndexArray: readonly (string | number | RevColumn<BCS, SF>)[]
Returns void

setActiveColumnsAndWidthsByFieldName

setActiveColumnsAndWidthsByFieldName(
columnNameWidths: FieldNameAndAutoSizableWidth[],
): void
Parameters
- columnNameWidths: FieldNameAndAutoSizableWidth[]
Returns void

setActiveColumnsAutoWidthSizing

setActiveColumnsAutoWidthSizing(widenOnly: boolean): void
Parameters
- widenOnly: boolean
Returns void

setActiveColumnWidth

setActiveColumnWidth(
    columnOrIndex: number | RevColumn<BCS, SF>,
    width: number,
    ui: boolean,
): boolean
Set the width of the given column.
Parameters
- columnOrIndex: number | RevColumn<BCS, SF>
  Column or index of active column whose width is to be set.
- width: number
  The width in pixels.
- ui: boolean
  Whether this was instigated by a UI action
Returns boolean
true if column width was changed

setColumnScrollAnchor

setColumnScrollAnchor(index: number, offset: number): boolean
Parameters
- index: number
- offset: number
Returns boolean

setColumnWidths

setColumnWidths(columnWidths: RevColumnAutoSizeableWidth<BCS, SF>[]): boolean
Parameters
- columnWidths: RevColumnAutoSizeableWidth<BCS, SF>[]
Returns boolean

setColumnWidthsByName

setColumnWidthsByName(columnNameWidths: FieldNameAndAutoSizableWidth[]): boolean
Parameters
- columnNameWidths: FieldNameAndAutoSizableWidth[]
Returns boolean

setFieldColumnSettings

setFieldColumnSettings(fieldIndex: number, settings: BCS): boolean
Parameters
- fieldIndex: number
- settings: BCS
Returns boolean

setRowHeight

setRowHeight(
    rowIndex: number,
    rowHeight: number,
    subgrid?: RevSubgrid<BCS, SF>,
): void
Set the height of the given row.
Parameters
- rowIndex: number
  The row index.
- rowHeight: number
  The width in pixels.
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

setValue

setValue(
    x: number,
    y: number,
    value: unknown,
    subgrid?: RevSubgrid<BCS, SF>,
): void
Parameters
- x: number
- y: number
- value: unknown
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

showHideColumns

showHideColumns(
    fieldColumnIndexes: number | number[],
    insertIndex?: number,
    allowDuplicateColumns?: boolean,
    ui?: boolean,
): void
Show inactive column(s) or move active column(s).
Parameters
- fieldColumnIndexes: number | number[]
  A column index or array of field indices which are to be shown or hidden.
- OptionalinsertIndex: number
  Active index of column to insert before. Set to undefined to add new active columns at end of list. Set to -1 to hide specified columns.
- OptionalallowDuplicateColumns: boolean
  If true, then if an existing column is already visible, it will not be removed and duplicates of that column will be present. Default: false.
- Optionalui: boolean
  Whether this was instigated by a UI action. Default: true.
Returns void
Remarks
Adds one or several columns to the "active" column list.
showHideColumns(
    indexesAreActive: boolean,
    fieldColumnIndexes?: number | number[],
    insertIndex?: number,
    allowDuplicateColumns?: boolean,
    ui?: boolean,
): void
Show inactive column(s) or move active column(s).
Parameters
- indexesAreActive: boolean
  If true, then column indices specify active column indices. Otherwise field column indices.
- OptionalfieldColumnIndexes: number | number[]
  A column index or array of indices. If undefined then all of the columns as per indexesAreActive.
- OptionalinsertIndex: number
  Active index of column to insert before. Set to undefined to add new active columns at end of list. Set to -1 to hide specified columns.
- OptionalallowDuplicateColumns: boolean
  If true, then if an existing column is already visible, it will not be removed and duplicates of that column will be present. Default: false.
- Optionalui: boolean
  Whether this was instigated by a UI action. Default: true.
Returns void
Remarks
Adds one or several columns to the "active" column list.

swapColumns

swapColumns(source: number, target: number): void
Parameters
- source: number
- target: number
Returns void

toggleSelectCell

toggleSelectCell(x: number, y: number, subgrid?: RevSubgrid<BCS, SF>): boolean
Parameters
- x: number
- y: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns boolean

toggleSelectColumn

toggleSelectColumn(activeColumnIndex: number): void
Parameters
- activeColumnIndex: number
Returns void

toggleSelectRow

toggleSelectRow(subgridRowIndex: number, subgrid?: RevSubgrid<BCS, SF>): void
Parameters
- subgridRowIndex: number
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns void

tryExtendLastSelectionAreaAsCloseAsPossibleToFocus

tryExtendLastSelectionAreaAsCloseAsPossibleToFocus(): boolean
Returns boolean

tryFocusBottom

tryFocusBottom(): boolean
Returns boolean

tryFocusFirstColumn

tryFocusFirstColumn(): boolean
Returns boolean

tryFocusLastColumn

tryFocusLastColumn(): boolean
Returns boolean

tryFocusTop

tryFocusTop(): boolean
Returns boolean

tryFocusXAndEnsureInView

tryFocusXAndEnsureInView(x: number): boolean
Parameters
- x: number
Returns boolean

tryFocusXYAndEnsureInView

tryFocusXYAndEnsureInView(
    x: number,
    y: number,
    cell?: RevViewCell<BCS, SF>,
): boolean
Parameters
- x: number
- y: number
- Optionalcell: RevViewCell<BCS, SF>
Returns boolean

tryFocusYAndEnsureInView

tryFocusYAndEnsureInView(y: number): boolean
Parameters
- y: number
Returns boolean

tryMoveFocusDown

tryMoveFocusDown(): boolean
Returns boolean

tryMoveFocusLeft

tryMoveFocusLeft(): boolean
Returns boolean

tryMoveFocusRight

tryMoveFocusRight(): boolean
Returns boolean

tryMoveFocusUp

tryMoveFocusUp(): boolean
Returns boolean

tryOnlySelectFocusedCell

tryOnlySelectFocusedCell(): boolean
Returns boolean

tryPageFocusDown

tryPageFocusDown(): boolean
Returns boolean

tryPageFocusLeft

tryPageFocusLeft(): boolean
Returns boolean

tryPageFocusRight

tryPageFocusRight(): boolean
Returns boolean

tryPageFocusUp

tryPageFocusUp(): boolean
Returns boolean

tryScrollDown

tryScrollDown(): boolean
Returns boolean

tryScrollLeft

tryScrollLeft(): boolean
Returns boolean

tryScrollPageDown

tryScrollPageDown(): boolean
Returns boolean

tryScrollPageLeft

tryScrollPageLeft(): boolean
Returns boolean

tryScrollPageRight

tryScrollPageRight(): boolean
Returns boolean

tryScrollPageUp

tryScrollPageUp(): boolean
Returns boolean

tryScrollRight

tryScrollRight(): boolean
Returns boolean

tryScrollUp

tryScrollUp(): boolean
Returns boolean

Class RevClientGrid<BGS, BCS, SF>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RevClientGrid<BGS, BCS, SF>

Properties

Readonlycanvas

ReadonlyclientId

ReadonlycolumnsManager

ReadonlyexternalParent

Readonlyfocus

ReadonlyhorizontalScroller

ReadonlyhostElement

Readonlyid

ReadonlyinternalParent

ReadonlymainDataServer

ReadonlymainSubgrid

Readonlymouse

Readonlyrenderer

ReadonlyschemaServer

Readonlyselection

Readonlysettings

ReadonlysubgridsManager

ReadonlyverticalScroller

ReadonlyviewLayout

Accessors

active

Returns boolean

Parameters

Returns void

activeColumnCount

Returns number

activeColumns

Returns readonly RevColumn<BCS, SF>[]

activeColumnsViewWidth

Returns number

columnScrollAnchorIndex

Returns number

columnScrollAnchorOffset

Returns number

destroyed

Returns boolean

fieldColumns

Returns readonly RevColumn<BCS, SF>[]

fixedColumnsViewWidth

Returns number

nonFixedColumnsViewWidth

Returns number

selectionAllAuto

Returns boolean

Parameters

Returns void

Methods

activate

Returns void

addEventListener

Parameters

Returns void

areColumnsOrRowsSelected

Parameters

Returns boolean

areColumnsSelected

Parameters

Returns boolean

areRowsSelected

Parameters

Returns boolean

autoSizeActiveColumnWidths

Parameters

Returns void

autoSizeFieldColumnWidth

Parameters

`Readonly`canvas

`Readonly`clientId

`Readonly`columnsManager

`Readonly`externalParent

`Readonly`focus

`Readonly`horizontalScroller

`Readonly`hostElement

`Readonly`id

`Readonly`internalParent

`Readonly`mainDataServer

`Readonly`mainSubgrid

`Readonly`mouse

`Readonly`renderer

`Readonly`schemaServer

`Readonly`selection

`Readonly`settings

`Readonly`subgridsManager

`Readonly`verticalScroller

`Readonly`viewLayout