Interface ListGridConstructorOptions<T>

interface ListGridConstructorOptions<T> {
    allowRangePaste?: boolean;
    colCount?: undefined;
    dataSource?: DataSource<T>;
    defaultColWidth?: string | number;
    defaultRowHeight?: number;
    disableColumnResize?: boolean;
    font?: string;
    frozenColCount?: number;
    frozenRowCount?: undefined;
    header?: HeadersDefine<T>;
    headerRowHeight?: number | number[];
    keyboardOptions?: DrawGridKeyboardOptions;
    layout?: LayoutDefine<T>;
    parentElement?: null | HTMLElement;
    records?: T[];
    rowCount?: undefined;
    theme?: string | ThemeDefine;
    trimOnPaste?: boolean;
    underlayBackgroundColor?: string;
}

Type Parameters

  • T

Hierarchy

  • DrawGridConstructorOptions
    • ListGridConstructorOptions

Properties

allowRangePaste? colCount? dataSource? defaultColWidth? defaultRowHeight? disableColumnResize? font? frozenColCount? frozenRowCount? header? headerRowHeight? keyboardOptions? layout? parentElement? records? rowCount? theme? trimOnPaste? underlayBackgroundColor?

Properties

OptionalallowRangePaste

allowRangePaste?: boolean

If set to true to allow pasting of ranges. default false

OptionalcolCount

colCount?: undefined

Deprecated

Cannot be used with ListGrid.

OptionaldataSource

dataSource?: DataSource<T>

Records data source

OptionaldefaultColWidth

defaultColWidth?: string | number

Default grid col width. default 80

OptionaldefaultRowHeight

defaultRowHeight?: number

Default grid row height. default 40

OptionaldisableColumnResize

disableColumnResize?: boolean

Disable column resizing

Optionalfont

font?: string

OptionalfrozenColCount

frozenColCount?: number

OptionalfrozenRowCount

frozenRowCount?: undefined

Deprecated

Cannot be used with ListGrid.

Optionalheader

header?: HeadersDefine<T>

Simple header property

OptionalheaderRowHeight

headerRowHeight?: number | number[]

Header row height(s)

OptionalkeyboardOptions

keyboardOptions?: DrawGridKeyboardOptions

Optionallayout

layout?: LayoutDefine<T>

Layout property

OptionalparentElement

parentElement?: null | HTMLElement

Canvas parent element

Optionalrecords

records?: T[]

Simple records data

OptionalrowCount

rowCount?: undefined

Deprecated

Cannot be used with ListGrid.

Optionaltheme

theme?: string | ThemeDefine

Theme

OptionaltrimOnPaste

trimOnPaste?: boolean

If set to true, trim the pasted text on pasting.

OptionalunderlayBackgroundColor

underlayBackgroundColor?: string

Settings

Member Visibility

On This Page

Properties