@serenity-is/corelib / DataGrid

Class: DataGrid<TItem, P>

Type parameters

Name	Type
TItem	TItem
P

Hierarchy

• Widget<P>

  ↳ DataGrid

  ↳↳ CheckTreeEditor

  ↳↳ EntityGrid

Implements

• IDataGrid
• IReadOnly

Table of contents

Constructors

• constructor

Properties

• allColumns
• domNode
• filterBar
• idPrefix
• initialSettings
• openDialogsAsPanel
• options
• propertyItemsData
• quickFiltersBar
• quickFiltersDiv
• restoringSettings
• slickContainer
• slickGrid
• titleDiv
• toolbar
• uniqueName
• view
• defaultColumnWidthDelta
• defaultColumnWidthScale
• defaultHeaderHeight
• defaultPersistanceStorage
• defaultRowHeight
• typeInfo

Accessors

• element
• props
• readOnly

Methods

• addBooleanFilter
• addCssClass
• addDateRangeFilter
• addDateTimeRangeFilter
• addFilterSeparator
• addQuickFilter
• addValidationRule
• afterInit
• bindToSlickEvents
• bindToViewEvents
• booleanQuickFilter
• canFilterColumn
• canShowColumn
• change
• changeSelect2
• createFilterBar
• createIncludeDeletedButton
• createPager
• createQuickFilters
• createQuickSearchInput
• createSlickContainer
• createSlickGrid
• createToolbar
• createToolbarExtensions
• createView
• dateRangeQuickFilter
• dateTimeRangeQuickFilter
• destroy
• determineText
• editItem
• editItemOfType
• enableFiltering
• ensureQuickFilterBar
• findQuickFilter
• getAddButtonCaption
• getButtons
• getColumnWidthDelta
• getColumnWidthScale
• getColumns
• getColumnsKey
• getCssClass
• getCurrentSettings
• getCustomAttribute
• getDefaultSortBy
• getElement
• getFieldElement
• getFilterStore
• getGrid
• getGridCanLoad
• getGridField
• getIdProperty
• getIncludeColumns
• getInitialTitle
• getIsActiveProperty
• getIsDeletedProperty
• getItemCssClass
• getItemMetadata
• getItemType
• getItems
• getLocalTextDbPrefix
• getLocalTextPrefix
• getPagerOptions
• getPersistanceKey
• getPersistanceStorage
• getPersistedSettings
• getPropertyItems
• getPropertyItemsData
• getPropertyItemsDataAsync
• getQuickFilters
• getQuickSearchFields
• getRowDefinition
• getSlickOptions
• getTitle
• getView
• getViewOptions
• get_readOnly
• gridPersistanceFlags
• init
• initialPopulate
• initializeFilterBar
• internalInit
• internalRefresh
• internalRenderContents
• invokeSubmitHandlers
• itemAt
• itemLink
• layout
• markupReady
• onClick
• onViewFilter
• onViewProcessData
• onViewSubmit
• persistSettings
• populateLock
• populateUnlock
• populateWhenVisible
• postProcessColumns
• propertyItemsReady
• propertyItemsToSlickColumns
• quickFilterChange
• refresh
• refreshIfNeeded
• render
• renderContents
• resizeCanvas
• restoreSettings
• restoreSettingsFrom
• rowCount
• setCriteriaParameter
• setEquality
• setIncludeColumnsParameter
• setInitialSortOrder
• setIsDisabled
• setItems
• setTitle
• set_readOnly
• subDialogDataChange
• syncOrAsyncThen
• tryFindQuickFilter
• updateDisabledState
• updateInterface
• useAsync
• useIdPrefix
• useLayoutTimer
• usePager
• viewDataChanged
• wrapFormatterWithEditLink
• create
• createDefaultElement
• getWidgetName
• propertyItemToQuickFilter

Constructors

constructor

• new DataGrid<TItem, P>(props): DataGrid<TItem, P>

Type parameters

Name	Type
TItem	TItem
P

Parameters

Name	Type
props	WidgetProps<P>

Returns

DataGrid<TItem, P>

Overrides

Widget.constructor

Defined in

src/ui/datagrid/datagrid.ts:89

Properties

allColumns

• Protected allColumns: Column<any>[]

Defined in

src/ui/datagrid/datagrid.ts:75

---

domNode

• Readonly domNode: HTMLElement

Inherited from

Widget.domNode

Defined in

src/ui/widgets/widget.ts:18

---

filterBar

• Protected filterBar: FilterDisplayBar<>

Defined in

src/ui/datagrid/datagrid.ts:71

---

idPrefix

• Readonly idPrefix: string

Inherited from

Widget.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

initialSettings

• Protected initialSettings: PersistedGridSettings

Defined in

src/ui/datagrid/datagrid.ts:77

---

openDialogsAsPanel

• openDialogsAsPanel: boolean

Defined in

src/ui/datagrid/datagrid.ts:81

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

Widget.options

Defined in

src/ui/widgets/widget.ts:15

---

propertyItemsData

• Protected propertyItemsData: PropertyItemsData

Defined in

src/ui/datagrid/datagrid.ts:76

---

quickFiltersBar

• Protected quickFiltersBar: QuickFilterBar<QuickFilterBarOptions>

Defined in

src/ui/datagrid/datagrid.ts:73

---

quickFiltersDiv

• Protected quickFiltersDiv: Fluent<HTMLElement>

Defined in

src/ui/datagrid/datagrid.ts:72

---

restoringSettings

• Protected restoringSettings: number = 0

Defined in

src/ui/datagrid/datagrid.ts:78

---

slickContainer

• Protected slickContainer: Fluent<HTMLElement>

Defined in

src/ui/datagrid/datagrid.ts:74

---

slickGrid

• slickGrid: Grid<any>

Defined in

src/ui/datagrid/datagrid.ts:80

---

titleDiv

• Protected titleDiv: Fluent<HTMLElement>

Defined in

src/ui/datagrid/datagrid.ts:69

---

toolbar

• Protected toolbar: Toolbar<ToolbarOptions>

Defined in

src/ui/datagrid/datagrid.ts:70

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

Widget.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

view

• view: RemoteView<TItem>

Defined in

src/ui/datagrid/datagrid.ts:79

---

defaultColumnWidthDelta

▪ Static defaultColumnWidthDelta: number

Defined in

src/ui/datagrid/datagrid.ts:87

---

defaultColumnWidthScale

▪ Static defaultColumnWidthScale: number

Defined in

src/ui/datagrid/datagrid.ts:86

---

defaultHeaderHeight

▪ Static defaultHeaderHeight: number

Defined in

src/ui/datagrid/datagrid.ts:84

---

defaultPersistanceStorage

▪ Static defaultPersistanceStorage: SettingStorage

Defined in

src/ui/datagrid/datagrid.ts:85

---

defaultRowHeight

▪ Static defaultRowHeight: number

Defined in

src/ui/datagrid/datagrid.ts:83

---

typeInfo

▪ Static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

Widget.typeInfo

Defined in

src/ui/widgets/widget.ts:12

Accessors

element

• get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

Widget.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

Widget.props

Defined in

src/ui/widgets/widget.ts:182

---

readOnly

• get readOnly(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:976

• set readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:980

Methods

addBooleanFilter

▸ addBooleanFilter(field, title?, yes?, no?): SelectEditor<SelectEditorOptions>

Parameters

Name	Type
field	string
title?	string
yes?	string
no?	string

Returns

SelectEditor<SelectEditorOptions>

Defined in

src/ui/datagrid/datagrid.ts:1111

---

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

Widget.addCssClass

Defined in

src/ui/widgets/widget.ts:71

---

addDateRangeFilter

▸ addDateRangeFilter(field, title?): DateEditor<DateEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

DateEditor<DateEditorOptions>

Defined in

src/ui/datagrid/datagrid.ts:1095

---

addDateTimeRangeFilter

▸ addDateTimeRangeFilter(field, title?): DateTimeEditor<DateTimeEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

DateTimeEditor<DateTimeEditorOptions>

Defined in

src/ui/datagrid/datagrid.ts:1103

---

addFilterSeparator

▸ addFilterSeparator(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1075

---

addQuickFilter

▸ addQuickFilter<TWidget, P>(opt): TWidget

Type parameters

Name	Type
TWidget	extends Widget<any>
P	P

Parameters

Name	Type
opt	QuickFilter<TWidget, P>

Returns

TWidget

Defined in

src/ui/datagrid/datagrid.ts:1091

---

addValidationRule

▸ addValidationRule(rule, uniqueName?): void

Parameters

Name	Type
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string
uniqueName?	string

Returns

void

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

▸ addValidationRule(uniqueName, rule): void

Parameters

Name	Type
uniqueName	string
rule	(input: HTMLInputElement | HTMLSelectElement | HTMLTextAreaElement) => string

Returns

void

Inherited from

Widget.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterInit

▸ afterInit(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:154

---

bindToSlickEvents

▸ bindToSlickEvents(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:519

---

bindToViewEvents

▸ bindToViewEvents(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:619

---

booleanQuickFilter

▸ booleanQuickFilter(field, title?, yes?, no?): QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Parameters

Name	Type
field	string
title?	string
yes?	string
no?	string

Returns

QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Defined in

src/ui/datagrid/datagrid.ts:1115

---

canFilterColumn

▸ canFilterColumn(column): boolean

Parameters

Name	Type
column	Column<any>

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:436

---

canShowColumn

▸ canShowColumn(column): boolean

Parameters

Name	Type
column	Column<any>

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:1150

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

Widget.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

Widget.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

createFilterBar

▸ createFilterBar(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:747

---

createIncludeDeletedButton

▸ createIncludeDeletedButton(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:303

---

createPager

▸ createPager(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:762

---

createQuickFilters

▸ createQuickFilters(filters?): void

Parameters

Name	Type
filters?	QuickFilter<Widget<any>, any>[]

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:202

---

createQuickSearchInput

▸ createQuickSearchInput(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:312

---

createSlickContainer

▸ createSlickContainer(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Defined in

src/ui/datagrid/datagrid.ts:701

---

createSlickGrid

▸ createSlickGrid(): Grid<any>

Returns

Grid<any>

Defined in

src/ui/datagrid/datagrid.ts:459

---

createToolbar

▸ createToolbar(buttons): void

Parameters

Name	Type
buttons	ToolButton[]

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:788

---

createToolbarExtensions

▸ createToolbarExtensions(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:191

---

createView

▸ createView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Defined in

src/ui/datagrid/datagrid.ts:705

---

dateRangeQuickFilter

▸ dateRangeQuickFilter(field, title?): QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Defined in

src/ui/datagrid/datagrid.ts:1099

---

dateTimeRangeQuickFilter

▸ dateTimeRangeQuickFilter(field, title?): QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Parameters

Name	Type
field	string
title?	string

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Defined in

src/ui/datagrid/datagrid.ts:1107

---

destroy

▸ destroy(): void

Returns

void

Overrides

Widget.destroy

Defined in

src/ui/datagrid/datagrid.ts:317

---

determineText

▸ determineText(getKey): string

Parameters

Name	Type
getKey	(prefix: string) => string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1079

---

editItem

▸ editItem(entityOrId): void

Parameters

Name	Type
entityOrId	any

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:585

---

editItemOfType

▸ editItemOfType(itemType, entityOrId): void

Parameters

Name	Type
itemType	string
entityOrId	any

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:589

---

enableFiltering

▸ enableFiltering(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:739

---

ensureQuickFilterBar

▸ ensureQuickFilterBar(): QuickFilterBar<QuickFilterBarOptions>

Returns

QuickFilterBar<QuickFilterBarOptions>

Defined in

src/ui/datagrid/datagrid.ts:194

---

findQuickFilter

▸ findQuickFilter<TWidget>(type, field): TWidget

Type parameters

Name
TWidget

Parameters

Name	Type
type	(...args: any[]) => TWidget
field	string

Returns

TWidget

Defined in

src/ui/datagrid/datagrid.ts:289

---

getAddButtonCaption

▸ getAddButtonCaption(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:577

---

getButtons

▸ getButtons(): ToolButton[]

Returns

ToolButton[]

Defined in

src/ui/datagrid/datagrid.ts:581

---

getColumnWidthDelta

▸ getColumnWidthDelta(): number

Returns

number

Defined in

src/ui/datagrid/datagrid.ts:413

---

getColumnWidthScale

▸ getColumnWidthScale(): number

Returns

number

Defined in

src/ui/datagrid/datagrid.ts:417

---

getColumns

▸ getColumns(): Column<TItem>[]

Returns

Column<TItem>[]

Defined in

src/ui/datagrid/datagrid.ts:881

---

getColumnsKey

▸ getColumnsKey(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:844

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

Widget.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCurrentSettings

▸ getCurrentSettings(flags?): PersistedGridSettings

Parameters

Name	Type
flags?	GridPersistanceFlags

Returns

PersistedGridSettings

Defined in

src/ui/datagrid/datagrid.ts:1363

---

getCustomAttribute

▸ getCustomAttribute<TAttr>(attrType, inherit?): TAttr

Type parameters

Name
TAttr

Parameters

Name	Type	Default value
attrType	(...args: any[]) => TAttr	undefined
inherit	boolean	true

Returns

TAttr

Inherited from

Widget.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getDefaultSortBy

▸ getDefaultSortBy(): any[]

Returns

any[]

Defined in

src/ui/datagrid/datagrid.ts:710

---

getElement

▸ getElement(): HTMLElement

Returns

HTMLElement

Implementation of

IDataGrid.getElement

Defined in

src/ui/datagrid/datagrid.ts:1453

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getFilterStore

▸ getFilterStore(): FilterStore

Returns

FilterStore

Implementation of

IDataGrid.getFilterStore

Defined in

src/ui/datagrid/datagrid.ts:1465

---

getGrid

▸ getGrid(): Grid<any>

Returns

Grid<any>

Implementation of

IDataGrid.getGrid

Defined in

src/ui/datagrid/datagrid.ts:1457

---

getGridCanLoad

▸ getGridCanLoad(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:935

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

Widget.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getIdProperty

▸ getIdProperty(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1027

---

getIncludeColumns

▸ getIncludeColumns(include): void

Parameters

Name	Type
include	Object

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:647

---

getInitialTitle

▸ getInitialTitle(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:187

---

getIsActiveProperty

▸ getIsActiveProperty(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1048

---

getIsDeletedProperty

▸ getIsDeletedProperty(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1042

---

getItemCssClass

▸ getItemCssClass(item, index): string

Parameters

Name	Type
item	TItem
index	number

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:351

---

getItemMetadata

▸ getItemMetadata(item, index): any

Parameters

Name	Type
item	TItem
index	number

Returns

any

Defined in

src/ui/datagrid/datagrid.ts:384

---

getItemType

▸ getItemType(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:826

---

getItems

▸ getItems(): TItem[]

Returns

TItem[]

Defined in

src/ui/datagrid/datagrid.ts:511

---

getLocalTextDbPrefix

▸ getLocalTextDbPrefix(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1005

---

getLocalTextPrefix

▸ getLocalTextPrefix(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1017

---

getPagerOptions

▸ getPagerOptions(): PagerOptions

Returns

PagerOptions

Defined in

src/ui/datagrid/datagrid.ts:754

---

getPersistanceKey

▸ getPersistanceKey(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:1135

---

getPersistanceStorage

▸ getPersistanceStorage(): SettingStorage

Returns

SettingStorage

Defined in

src/ui/datagrid/datagrid.ts:1131

---

getPersistedSettings

▸ getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Defined in

src/ui/datagrid/datagrid.ts:1171

---

getPropertyItems

▸ getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Defined in

src/ui/datagrid/datagrid.ts:848

---

getPropertyItemsData

▸ getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Defined in

src/ui/datagrid/datagrid.ts:852

---

getPropertyItemsDataAsync

▸ getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Defined in

src/ui/datagrid/datagrid.ts:872

---

getQuickFilters

▸ getQuickFilters(): QuickFilter<Widget<any>, any>[]

Returns

QuickFilter<Widget<any>, any>[]

Defined in

src/ui/datagrid/datagrid.ts:225

---

getQuickSearchFields

▸ getQuickSearchFields(): QuickSearchField[]

Returns

QuickSearchField[]

Defined in

src/ui/datagrid/datagrid.ts:308

---

getRowDefinition

▸ getRowDefinition(): IRowDefinition

Returns

IRowDefinition

Defined in

src/ui/datagrid/datagrid.ts:999

---

getSlickOptions

▸ getSlickOptions(): GridOptions<any>

Returns

GridOptions<any>

Defined in

src/ui/datagrid/datagrid.ts:911

---

getTitle

▸ getTitle(): string

Returns

string

Defined in

src/ui/datagrid/datagrid.ts:796

---

getView

▸ getView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Implementation of

IDataGrid.getView

Defined in

src/ui/datagrid/datagrid.ts:1461

---

getViewOptions

▸ getViewOptions(): RemoteViewOptions

Returns

RemoteViewOptions

Defined in

src/ui/datagrid/datagrid.ts:766

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Implementation of

IReadOnly.get_readOnly

Defined in

src/ui/datagrid/datagrid.ts:984

---

gridPersistanceFlags

▸ gridPersistanceFlags(): GridPersistanceFlags

Returns

GridPersistanceFlags

Defined in

src/ui/datagrid/datagrid.ts:1146

---

init

▸ init(): this

Returns

this

Inherited from

Widget.init

Defined in

src/ui/widgets/widget.ts:146

---

initialPopulate

▸ initialPopulate(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:421

---

initializeFilterBar

▸ initializeFilterBar(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:443

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

Widget.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRefresh

▸ internalRefresh(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:959

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

Widget.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

invokeSubmitHandlers

▸ invokeSubmitHandlers(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1119

---

itemAt

▸ itemAt(row): TItem

Parameters

Name	Type
row	number

Returns

TItem

Defined in

src/ui/datagrid/datagrid.ts:503

---

itemLink

▸ itemLink(itemType?, idField?, text?, cssClass?, encode?): Format<TItem>

Parameters

Name	Type	Default value
itemType?	string	undefined
idField?	string	undefined
text?	Format<TItem>	undefined
cssClass?	(ctx: FormatterContext<any>) => string	undefined
encode	boolean	true

Returns

Format<TItem>

Defined in

src/ui/datagrid/datagrid.ts:830

---

layout

▸ layout(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:165

---

markupReady

▸ markupReady(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:698

---

onClick

▸ onClick(e, row, cell): void

Parameters

Name	Type
e	Event
row	number
cell	number

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:598

---

onViewFilter

▸ onViewFilter(item): boolean

Parameters

Name	Type
item	TItem

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:643

---

onViewProcessData

▸ onViewProcessData(response): ListResponse<TItem>

Parameters

Name	Type
response	ListResponse<TItem>

Returns

ListResponse<TItem>

Defined in

src/ui/datagrid/datagrid.ts:639

---

onViewSubmit

▸ onViewSubmit(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:686

---

persistSettings

▸ persistSettings(flags?): void | Promise<void>

Parameters

Name	Type
flags?	GridPersistanceFlags

Returns

void | Promise<void>

Defined in

src/ui/datagrid/datagrid.ts:1353

---

populateLock

▸ populateLock(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:927

---

populateUnlock

▸ populateUnlock(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:931

---

populateWhenVisible

▸ populateWhenVisible(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:743

---

postProcessColumns

▸ postProcessColumns(columns): Column<any>[]

Parameters

Name	Type
columns	Column<any>[]

Returns

Column<any>[]

Defined in

src/ui/datagrid/datagrid.ts:392

---

propertyItemsReady

▸ propertyItemsReady(itemsData): void

Parameters

Name	Type
itemsData	PropertyItemsData

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:121

---

propertyItemsToSlickColumns

▸ propertyItemsToSlickColumns(propertyItems): Column<any>[]

Parameters

Name	Type
propertyItems	PropertyItem[]

Returns

Column<any>[]

Defined in

src/ui/datagrid/datagrid.ts:900

---

quickFilterChange

▸ quickFilterChange(e): void

Parameters

Name	Type
e	Event

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1125

---

refresh

▸ refresh(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:939

---

refreshIfNeeded

▸ refreshIfNeeded(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:952

---

render

▸ render(): any

Returns the main element for this widget or the document fragment. As widgets may get their elements from props unlike regular JSX widgets, this method should not be overridden. Override renderContents() instead.

Returns

any

Inherited from

Widget.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): any

Returns

any

Inherited from

Widget.renderContents

Defined in

src/ui/widgets/widget.ts:178

---

resizeCanvas

▸ resizeCanvas(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1067

---

restoreSettings

▸ restoreSettings(settings?, flags?): void | Promise<void>

Parameters

Name	Type
settings?	PersistedGridSettings
flags?	GridPersistanceFlags

Returns

void | Promise<void>

Defined in

src/ui/datagrid/datagrid.ts:1190

---

restoreSettingsFrom

▸ restoreSettingsFrom(settings, flags?): void

Parameters

Name	Type
settings	PersistedGridSettings
flags?	GridPersistanceFlags

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1201

---

rowCount

▸ rowCount(): number

Returns

number

Defined in

src/ui/datagrid/datagrid.ts:507

---

setCriteriaParameter

▸ setCriteriaParameter(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:662

---

setEquality

▸ setEquality(field, value): void

Parameters

Name	Type
field	string
value	any

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:672

---

setIncludeColumnsParameter

▸ setIncludeColumnsParameter(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:676

---

setInitialSortOrder

▸ setInitialSortOrder(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:478

---

setIsDisabled

▸ setIsDisabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:963

---

setItems

▸ setItems(value): void

Parameters

Name	Type
value	TItem[]

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:515

---

setTitle

▸ setTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:804

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Implementation of

IReadOnly.set_readOnly

Defined in

src/ui/datagrid/datagrid.ts:988

---

subDialogDataChange

▸ subDialogDataChange(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1071

---

syncOrAsyncThen

▸ syncOrAsyncThen<T>(syncMethod, asyncMethod, then): void

Type parameters

Name
T

Parameters

Name	Type
syncMethod	() => T
asyncMethod	() => PromiseLike<T>
then	(v: T) => void

Returns

void

Inherited from

Widget.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

tryFindQuickFilter

▸ tryFindQuickFilter<TWidget>(type, field): TWidget

Type parameters

Name
TWidget

Parameters

Name	Type
type	(...args: any[]) => TWidget
field	string

Returns

TWidget

Defined in

src/ui/datagrid/datagrid.ts:296

---

updateDisabledState

▸ updateDisabledState(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:1063

---

updateInterface

▸ updateInterface(): void

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:995

---

useAsync

▸ useAsync(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:157

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

Widget.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

useLayoutTimer

▸ useLayoutTimer(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:161

---

usePager

▸ usePager(): boolean

Returns

boolean

Defined in

src/ui/datagrid/datagrid.ts:735

---

viewDataChanged

▸ viewDataChanged(e, rows): void

Parameters

Name	Type
e	any
rows	TItem[]

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:614

---

wrapFormatterWithEditLink

▸ wrapFormatterWithEditLink(column, item): void

Parameters

Name	Type
column	Column<any>
item	PropertyItem

Returns

void

Defined in

src/ui/datagrid/datagrid.ts:885

---

create

▸ create<TWidget, P>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<P>
P	P

Parameters

Name	Type
params	CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

Widget.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

Widget.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

Widget.getWidgetName

Defined in

src/ui/widgets/widget.ts:95

---

propertyItemToQuickFilter

▸ propertyItemToQuickFilter(item): any

Parameters

Name	Type
item	PropertyItem

Returns

any

Defined in

src/ui/datagrid/datagrid.ts:235