Class RevDataExtractBehavior<BGS, BCS, SF>

Type Parameters

Implements

RevClientObject

Index

Properties

clientId internalParent

Methods

convertDataValueArraysToTsv getColumnSelectionMatrix getDynamicAllSelectionMatrix getLastSelectionRectangleTopRowValues getRowIndicesMatrix getRowSelectionData getRowSelectionMatrix getSelectedColumnsValues getSelectedValuesByRectangleAndColumn getSelectedValuesByRectangleColumnRowMatrix getSelectionAsTSV

Properties

`Readonly`clientId

clientId: string

A unique string allowing you to identify different instances

`Readonly`internalParent

internalParent: RevClientObject

The parent of an object allowing you to easily navigate during debugging

Methods

convertDataValueArraysToTsv

convertDataValueArraysToTsv(dataValueArrays: unknown[][]): string
Parameters
- dataValueArrays: unknown[][]
Returns string

getColumnSelectionMatrix

getColumnSelectionMatrix(subgrid: RevSubgrid<BCS, SF>): unknown[][]
Parameters
- subgrid: RevSubgrid<BCS, SF>
Returns unknown[][]

getDynamicAllSelectionMatrix

getDynamicAllSelectionMatrix(subgrid?: RevSubgrid<BCS, SF>): unknown[][]
Parameters
- Optionalsubgrid: RevSubgrid<BCS, SF>
Returns unknown[][]

getLastSelectionRectangleTopRowValues

getLastSelectionRectangleTopRowValues(): undefined | Record<string, unknown>
Returns undefined | Record<string, unknown>
An object that represents the currently selection row.

getRowIndicesMatrix

getRowIndicesMatrix(
    subgrid: RevSubgrid<BCS, SF>,
    rowIndices: number[],
    hiddenColumns?: boolean | string[] | number[],
): unknown[][]
Parameters
- subgrid: RevSubgrid<BCS, SF>
- rowIndices: number[]
- OptionalhiddenColumns: boolean | string[] | number[]
Returns unknown[][]

getRowSelectionData

getRowSelectionData(
subgrid: RevSubgrid<BCS, SF>,
hiddenColumns: boolean | string[] | number[],
): ViewRow
Parameters
- subgrid: RevSubgrid<BCS, SF>
- hiddenColumns: boolean | string[] | number[]
Returns ViewRow

getRowSelectionMatrix

getRowSelectionMatrix(
subgrid?: RevSubgrid<BCS, SF>,
hiddenColumns?: boolean | string[] | number[],
): unknown[][]
Parameters
- Optionalsubgrid: RevSubgrid<BCS, SF>
- OptionalhiddenColumns: boolean | string[] | number[]
Returns unknown[][]

getSelectedColumnsValues

getSelectedColumnsValues(subgrid: RevSubgrid<BCS, SF>): ObjectViewRow
Parameters
- subgrid: RevSubgrid<BCS, SF>
Returns ObjectViewRow

getSelectedValuesByRectangleAndColumn

getSelectedValuesByRectangleAndColumn(
subgrid: RevSubgrid<BCS, SF>,
): ObjectViewRow[]
Parameters
- subgrid: RevSubgrid<BCS, SF>
Returns ObjectViewRow[]

getSelectedValuesByRectangleColumnRowMatrix

getSelectedValuesByRectangleColumnRowMatrix(
subgrid: RevSubgrid<BCS, SF>,
): unknown[][][]
Parameters
- subgrid: RevSubgrid<BCS, SF>
Returns unknown[][][]

getSelectionAsTSV

getSelectionAsTSV(): string
Returns string
Tab separated value string from the selection and our data.