Interface RevSubgrid<BCS, SF>

interface RevSubgrid<
    BCS extends RevBehavioredColumnSettings,
    SF extends RevSchemaField,
> {
    dataServer: RevDataServer<SF>;
    firstViewableSubgridRowIndex: number;
    firstViewRowIndex: number;
    fixedRowCount: number;
    focusable: boolean;
    getCellPainterEventer: GetCellPainterEventer<BCS, SF>;
    isFilter: boolean;
    isFooter: boolean;
    isHeader: boolean;
    isMain: boolean;
    isSummary: boolean;
    metaServer: undefined | RevMetaServer;
    role: RevSubgrid.Role;
    rowHeightsCanDiffer: boolean;
    schemaServer: RevSchemaServer<SF>;
    scrollable: boolean;
    selectable: boolean;
    viewRowCount: number;
    generateAllRowIndicesArray(): number[];
    getDefaultRowHeight(): number;
    getRowCount(): number;
    getRowHeight(subgridRowIndex: number): number;
    getRowMetadata(subgridRowIndex: number): undefined | RowMetadata;
    getRowProperties(subgridRowIndex: number): undefined | RowProperties;
    getRowProperty(subgridRowIndex: number, key: string): unknown;
    getSingletonViewDataRow(subgridRowIndex: number): ViewRow;
    getViewValue(column: RevColumn<BCS, SF>, subgridRowIndex: number): unknown;
    getViewValueFromDataRowAtColumn(
        dataRow: ViewRow,
        column: RevColumn<BCS, SF>,
    ): unknown;
    isRowFixed(subgridRowIndex: number): boolean;
    setRowMetadata(
        subgridRowIndex: number,
        newMetadata: undefined | RowMetadata,
    ): void;
    setRowProperties(
        subgridRowIndex: number,
        properties: undefined | RowProperties,
    ): boolean;
    setRowProperty(
        subgridRowIndex: number,
        key: string,
        isHeight: boolean,
        value: unknown,
    ): boolean;
}

Type Parameters

BCS extends RevBehavioredColumnSettings
SF extends RevSchemaField

Hierarchy (View Summary)

RevSubgrid
- RevMainSubgrid

Properties

`Readonly`dataServer

dataServer: RevDataServer<SF>

`Readonly`firstViewableSubgridRowIndex

firstViewableSubgridRowIndex: number

Only valid if viewRowCount > 0

`Readonly`firstViewRowIndex

firstViewRowIndex: number

Only valid if viewRowCount > 0

`Readonly`fixedRowCount

fixedRowCount: number

`Readonly`focusable

focusable: boolean

getCellPainterEventer

getCellPainterEventer: GetCellPainterEventer<BCS, SF>

`Readonly`isFilter

isFilter: boolean

`Readonly`isFooter

isFooter: boolean

`Readonly`isHeader

isHeader: boolean

`Readonly`isMain

isMain: boolean

`Readonly`isSummary

isSummary: boolean

`Readonly`metaServer

metaServer: undefined | RevMetaServer

`Readonly`role

role: RevSubgrid.Role

`Readonly`rowHeightsCanDiffer

rowHeightsCanDiffer: boolean

`Readonly`schemaServer

schemaServer: RevSchemaServer<SF>

`Readonly`scrollable

scrollable: boolean

`Readonly`selectable

selectable: boolean

`Readonly`viewRowCount

viewRowCount: number

Number of Subgrid rows visible in viewport

Methods

generateAllRowIndicesArray

generateAllRowIndicesArray(): number[]
Returns number[]

getDefaultRowHeight

getDefaultRowHeight(): number
Returns number

getRowCount

getRowCount(): number
Returns number

getRowHeight

getRowHeight(subgridRowIndex: number): number
Parameters
- subgridRowIndex: number
Returns number

getRowMetadata

getRowMetadata(subgridRowIndex: number): undefined | RowMetadata
Parameters
- subgridRowIndex: number
Returns undefined | RowMetadata

getRowProperties

getRowProperties(subgridRowIndex: number): undefined | RowProperties
Parameters
- subgridRowIndex: number
Returns undefined | RowProperties

getRowProperty

getRowProperty(subgridRowIndex: number, key: string): unknown
Parameters
- subgridRowIndex: number
- key: string
Returns unknown

getSingletonViewDataRow

getSingletonViewDataRow(subgridRowIndex: number): ViewRow
Parameters
- subgridRowIndex: number
Returns ViewRow

getViewValue

getViewValue(column: RevColumn<BCS, SF>, subgridRowIndex: number): unknown
Parameters
- column: RevColumn<BCS, SF>
- subgridRowIndex: number
Returns unknown

getViewValueFromDataRowAtColumn

getViewValueFromDataRowAtColumn(
dataRow: ViewRow,
column: RevColumn<BCS, SF>,
): unknown
Parameters
- dataRow: ViewRow
- column: RevColumn<BCS, SF>
Returns unknown

isRowFixed

isRowFixed(subgridRowIndex: number): boolean
Parameters
- subgridRowIndex: number
Returns boolean

setRowMetadata

setRowMetadata(
subgridRowIndex: number,
newMetadata: undefined | RowMetadata,
): void
Parameters
- subgridRowIndex: number
- newMetadata: undefined | RowMetadata
Returns void

setRowProperties

setRowProperties(
subgridRowIndex: number,
properties: undefined | RowProperties,
): boolean
Parameters
- subgridRowIndex: number
- properties: undefined | RowProperties
Returns boolean

setRowProperty

setRowProperty(
    subgridRowIndex: number,
    key: string,
    isHeight: boolean,
    value: unknown,
): boolean
Parameters
- subgridRowIndex: number
- key: string
- isHeight: boolean
- value: unknown
Returns boolean