Interface DataGrid

See: relevant section in reference guide

interface DataGrid {
    $CreationOptions?: DataGridCreationOptions;
    $ID: string;
    $Type: "Pages$DataGrid";
    appearance: Appearance;
    caption: ClientTemplate;
    columns: GridColumn[];
    conditionalVisibilitySettings: null | ConditionalVisibilitySettings;
    controlBar: GridControlBar;
    dataSource: DataSource;
    defaultButtonTrigger: ClickTypeType;
    isControlBarVisible: boolean;
    name: string;
    numberOfRows: number;
    refreshTime: number;
    selectFirst: boolean;
    selectionMode: GridSelectionMode;
    showEmptyRows: boolean;
    showPagingBar: ShowPagingBarType;
    tabIndex: number;
    tooltipPage: null | string;
    widthUnit: UnitEnum;
    addGridColumn(options: GridColumnCreationOptions): Promise<GridColumn>;
    getGridColumn(name: string): GridColumn;
}

Hierarchy (view full)

ColumnGridBase
- DataGrid

Properties

`Optional`$CreationOptions

$CreationOptions?: DataGridCreationOptions

Options to pass during the element creation

$ID

$ID: string

The unique id of the element.

$Type

$Type

The type of the element.

appearance

appearance: Appearance

caption

caption: ClientTemplate

columns

columns: GridColumn[]

conditionalVisibilitySettings

conditionalVisibilitySettings: null | ConditionalVisibilitySettings

controlBar

controlBar: GridControlBar

dataSource

dataSource: DataSource

defaultButtonTrigger

defaultButtonTrigger: ClickTypeType

isControlBarVisible

isControlBarVisible: boolean

name

name: string

numberOfRows

numberOfRows: number

refreshTime

refreshTime: number

selectFirst

selectFirst: boolean

selectionMode

selectionMode: GridSelectionMode

showEmptyRows

showEmptyRows: boolean

showPagingBar

showPagingBar: ShowPagingBarType

tabIndex

tabIndex: number

tooltipPage

tooltipPage: null | string

widthUnit

widthUnit: UnitEnum

Methods

addGridColumn

addGridColumn(options): Promise<GridColumn>
Parameters
- options: GridColumnCreationOptions
Returns Promise<GridColumn>
Inherited from ColumnGridBase.addGridColumn

getGridColumn

getGridColumn(name): GridColumn
Parameters
- name: string
Returns GridColumn
Inherited from ColumnGridBase.getGridColumn