@serenity-is/corelib / EntityGrid

Class: EntityGrid<TItem, P>

Type parameters

Name	Type
TItem	TItem
P

Hierarchy

• DataGrid<TItem, P>

  ↳ EntityGrid

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
• addButtonClick
• addCssClass
• addDateRangeFilter
• addDateTimeRangeFilter
• addFilterSeparator
• addQuickFilter
• addValidationRule
• afterInit
• bindToSlickEvents
• bindToViewEvents
• booleanQuickFilter
• canFilterColumn
• canShowColumn
• change
• changeSelect2
• createEntityDialog
• 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
• getDialogOptions
• getDialogOptionsFor
• getDialogType
• getDialogTypeFor
• getDisplayName
• getElement
• getEntityType
• getFieldElement
• getFilterStore
• getGrid
• getGridCanLoad
• getGridField
• getIdProperty
• getIncludeColumns
• getInitialTitle
• getInsertPermission
• getIsActiveProperty
• getIsDeletedProperty
• getItemCssClass
• getItemMetadata
• getItemName
• getItemType
• getItems
• getLocalTextDbPrefix
• getLocalTextPrefix
• getPagerOptions
• getPersistanceKey
• getPersistanceStorage
• getPersistedSettings
• getPropertyItems
• getPropertyItemsData
• getPropertyItemsDataAsync
• getQuickFilters
• getQuickSearchFields
• getRowDefinition
• getService
• getSlickOptions
• getTitle
• getView
• getViewOptions
• get_readOnly
• gridPersistanceFlags
• handleRoute
• hasInsertPermission
• init
• initDialog
• initEntityDialog
• initialPopulate
• initializeFilterBar
• internalInit
• internalRefresh
• internalRenderContents
• invokeSubmitHandlers
• itemAt
• itemLink
• layout
• markupReady
• newRefreshButton
• onClick
• onViewFilter
• onViewProcessData
• onViewSubmit
• persistSettings
• populateLock
• populateUnlock
• populateWhenVisible
• postProcessColumns
• propertyItemsReady
• propertyItemsToSlickColumns
• quickFilterChange
• refresh
• refreshIfNeeded
• render
• renderContents
• resizeCanvas
• restoreSettings
• restoreSettingsFrom
• routeDialog
• rowCount
• setCriteriaParameter
• setEquality
• setIncludeColumnsParameter
• setInitialSortOrder
• setIsDisabled
• setItems
• setTitle
• set_readOnly
• subDialogDataChange
• syncOrAsyncThen
• transferDialogReadOnly
• tryFindQuickFilter
• updateDisabledState
• updateInterface
• useAsync
• useIdPrefix
• useLayoutTimer
• usePager
• viewDataChanged
• wrapFormatterWithEditLink
• create
• createDefaultElement
• getWidgetName
• propertyItemToQuickFilter

Constructors

constructor

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

Type parameters

Name	Type
TItem	TItem
P

Parameters

Name	Type
props	WidgetProps<P>

Returns

EntityGrid<TItem, P>

Overrides

DataGrid.constructor

Defined in

src/ui/datagrid/entitygrid.ts:18

Properties

allColumns

• Protected allColumns: Column<any>[]

Inherited from

DataGrid.allColumns

Defined in

src/ui/datagrid/datagrid.ts:75

---

domNode

• Readonly domNode: HTMLElement

Inherited from

DataGrid.domNode

Defined in

src/ui/widgets/widget.ts:18

---

filterBar

• Protected filterBar: FilterDisplayBar<>

Inherited from

DataGrid.filterBar

Defined in

src/ui/datagrid/datagrid.ts:71

---

idPrefix

• Readonly idPrefix: string

Inherited from

DataGrid.idPrefix

Defined in

src/ui/widgets/widget.ts:17

---

initialSettings

• Protected initialSettings: PersistedGridSettings

Inherited from

DataGrid.initialSettings

Defined in

src/ui/datagrid/datagrid.ts:77

---

openDialogsAsPanel

• openDialogsAsPanel: boolean

Inherited from

DataGrid.openDialogsAsPanel

Defined in

src/ui/datagrid/datagrid.ts:81

---

options

• Protected Readonly options: WidgetProps<P>

Inherited from

DataGrid.options

Defined in

src/ui/widgets/widget.ts:15

---

propertyItemsData

• Protected propertyItemsData: PropertyItemsData

Inherited from

DataGrid.propertyItemsData

Defined in

src/ui/datagrid/datagrid.ts:76

---

quickFiltersBar

• Protected quickFiltersBar: QuickFilterBar<QuickFilterBarOptions>

Inherited from

DataGrid.quickFiltersBar

Defined in

src/ui/datagrid/datagrid.ts:73

---

quickFiltersDiv

• Protected quickFiltersDiv: Fluent<HTMLElement>

Inherited from

DataGrid.quickFiltersDiv

Defined in

src/ui/datagrid/datagrid.ts:72

---

restoringSettings

• Protected restoringSettings: number = 0

Inherited from

DataGrid.restoringSettings

Defined in

src/ui/datagrid/datagrid.ts:78

---

slickContainer

• Protected slickContainer: Fluent<HTMLElement>

Inherited from

DataGrid.slickContainer

Defined in

src/ui/datagrid/datagrid.ts:74

---

slickGrid

• slickGrid: Grid<any>

Inherited from

DataGrid.slickGrid

Defined in

src/ui/datagrid/datagrid.ts:80

---

titleDiv

• Protected titleDiv: Fluent<HTMLElement>

Inherited from

DataGrid.titleDiv

Defined in

src/ui/datagrid/datagrid.ts:69

---

toolbar

• Protected toolbar: Toolbar<ToolbarOptions>

Inherited from

DataGrid.toolbar

Defined in

src/ui/datagrid/datagrid.ts:70

---

uniqueName

• Protected Readonly uniqueName: string

Inherited from

DataGrid.uniqueName

Defined in

src/ui/widgets/widget.ts:16

---

view

• view: RemoteView<TItem>

Inherited from

DataGrid.view

Defined in

src/ui/datagrid/datagrid.ts:79

---

defaultColumnWidthDelta

▪ Static defaultColumnWidthDelta: number

Inherited from

DataGrid.defaultColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.ts:87

---

defaultColumnWidthScale

▪ Static defaultColumnWidthScale: number

Inherited from

DataGrid.defaultColumnWidthScale

Defined in

src/ui/datagrid/datagrid.ts:86

---

defaultHeaderHeight

▪ Static defaultHeaderHeight: number

Inherited from

DataGrid.defaultHeaderHeight

Defined in

src/ui/datagrid/datagrid.ts:84

---

defaultPersistanceStorage

▪ Static defaultPersistanceStorage: SettingStorage

Inherited from

DataGrid.defaultPersistanceStorage

Defined in

src/ui/datagrid/datagrid.ts:85

---

defaultRowHeight

▪ Static defaultRowHeight: number

Inherited from

DataGrid.defaultRowHeight

Defined in

src/ui/datagrid/datagrid.ts:83

---

typeInfo

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

Inherited from

DataGrid.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

DataGrid.element

Defined in

src/ui/widgets/widget.ts:67

---

props

• get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

DataGrid.props

Defined in

src/ui/widgets/widget.ts:182

---

readOnly

• get readOnly(): boolean

Returns

boolean

Inherited from

DataGrid.readOnly

Defined in

src/ui/datagrid/datagrid.ts:976

• set readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

DataGrid.readOnly

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>

Inherited from

DataGrid.addBooleanFilter

Defined in

src/ui/datagrid/datagrid.ts:1111

---

addButtonClick

▸ addButtonClick(): void

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:208

---

addCssClass

▸ addCssClass(): void

Returns

void

Inherited from

DataGrid.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>

Inherited from

DataGrid.addDateRangeFilter

Defined in

src/ui/datagrid/datagrid.ts:1095

---

addDateTimeRangeFilter

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

Parameters

Name	Type
field	string
title?	string

Returns

DateTimeEditor<DateTimeEditorOptions>

Inherited from

DataGrid.addDateTimeRangeFilter

Defined in

src/ui/datagrid/datagrid.ts:1103

---

addFilterSeparator

▸ addFilterSeparator(): void

Returns

void

Inherited from

DataGrid.addFilterSeparator

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

Inherited from

DataGrid.addQuickFilter

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

DataGrid.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

DataGrid.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterInit

▸ afterInit(): void

Returns

void

Inherited from

DataGrid.afterInit

Defined in

src/ui/datagrid/datagrid.ts:154

---

bindToSlickEvents

▸ bindToSlickEvents(): void

Returns

void

Inherited from

DataGrid.bindToSlickEvents

Defined in

src/ui/datagrid/datagrid.ts:519

---

bindToViewEvents

▸ bindToViewEvents(): void

Returns

void

Inherited from

DataGrid.bindToViewEvents

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>

Inherited from

DataGrid.booleanQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:1115

---

canFilterColumn

▸ canFilterColumn(column): boolean

Parameters

Name	Type
column	Column<any>

Returns

boolean

Inherited from

DataGrid.canFilterColumn

Defined in

src/ui/datagrid/datagrid.ts:436

---

canShowColumn

▸ canShowColumn(column): boolean

Parameters

Name	Type
column	Column<any>

Returns

boolean

Inherited from

DataGrid.canShowColumn

Defined in

src/ui/datagrid/datagrid.ts:1150

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

DataGrid.change

Defined in

src/ui/widgets/widget.ts:114

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: Event) => void

Returns

void

Inherited from

DataGrid.changeSelect2

Defined in

src/ui/widgets/widget.ts:118

---

createEntityDialog

▸ createEntityDialog(itemType, callback?): Widget<any>

Parameters

Name	Type
itemType	string
callback?	(dlg: Widget<any>) => void

Returns

Widget<any>

Defined in

src/ui/datagrid/entitygrid.ts:328

---

createFilterBar

▸ createFilterBar(): void

Returns

void

Inherited from

DataGrid.createFilterBar

Defined in

src/ui/datagrid/datagrid.ts:747

---

createIncludeDeletedButton

▸ createIncludeDeletedButton(): void

Returns

void

Inherited from

DataGrid.createIncludeDeletedButton

Defined in

src/ui/datagrid/datagrid.ts:303

---

createPager

▸ createPager(): void

Returns

void

Inherited from

DataGrid.createPager

Defined in

src/ui/datagrid/datagrid.ts:762

---

createQuickFilters

▸ createQuickFilters(filters?): void

Parameters

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

Returns

void

Inherited from

DataGrid.createQuickFilters

Defined in

src/ui/datagrid/datagrid.ts:202

---

createQuickSearchInput

▸ createQuickSearchInput(): void

Returns

void

Inherited from

DataGrid.createQuickSearchInput

Defined in

src/ui/datagrid/datagrid.ts:312

---

createSlickContainer

▸ createSlickContainer(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

DataGrid.createSlickContainer

Defined in

src/ui/datagrid/datagrid.ts:701

---

createSlickGrid

▸ createSlickGrid(): Grid<any>

Returns

Grid<any>

Inherited from

DataGrid.createSlickGrid

Defined in

src/ui/datagrid/datagrid.ts:459

---

createToolbar

▸ createToolbar(buttons): void

Parameters

Name	Type
buttons	ToolButton[]

Returns

void

Inherited from

DataGrid.createToolbar

Defined in

src/ui/datagrid/datagrid.ts:788

---

createToolbarExtensions

▸ createToolbarExtensions(): void

Returns

void

Overrides

DataGrid.createToolbarExtensions

Defined in

src/ui/datagrid/entitygrid.ts:81

---

createView

▸ createView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Inherited from

DataGrid.createView

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>

Inherited from

DataGrid.dateRangeQuickFilter

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>

Inherited from

DataGrid.dateTimeRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:1107

---

destroy

▸ destroy(): void

Returns

void

Overrides

DataGrid.destroy

Defined in

src/ui/datagrid/entitygrid.ts:24

---

determineText

▸ determineText(getKey): string

Parameters

Name	Type
getKey	(prefix: string) => string

Returns

string

Inherited from

DataGrid.determineText

Defined in

src/ui/datagrid/datagrid.ts:1079

---

editItem

▸ editItem(entityOrId): void

Parameters

Name	Type
entityOrId	any

Returns

void

Overrides

DataGrid.editItem

Defined in

src/ui/datagrid/entitygrid.ts:212

---

editItemOfType

▸ editItemOfType(itemType, entityOrId): void

Parameters

Name	Type
itemType	string
entityOrId	any

Returns

void

Overrides

DataGrid.editItemOfType

Defined in

src/ui/datagrid/entitygrid.ts:229

---

enableFiltering

▸ enableFiltering(): boolean

Returns

boolean

Inherited from

DataGrid.enableFiltering

Defined in

src/ui/datagrid/datagrid.ts:739

---

ensureQuickFilterBar

▸ ensureQuickFilterBar(): QuickFilterBar<QuickFilterBarOptions>

Returns

QuickFilterBar<QuickFilterBarOptions>

Inherited from

DataGrid.ensureQuickFilterBar

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

Inherited from

DataGrid.findQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:289

---

getAddButtonCaption

▸ getAddButtonCaption(): string

Returns

string

Overrides

DataGrid.getAddButtonCaption

Defined in

src/ui/datagrid/entitygrid.ts:170

---

getButtons

▸ getButtons(): ToolButton[]

Returns

ToolButton[]

Overrides

DataGrid.getButtons

Defined in

src/ui/datagrid/entitygrid.ts:174

---

getColumnWidthDelta

▸ getColumnWidthDelta(): number

Returns

number

Inherited from

DataGrid.getColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.ts:413

---

getColumnWidthScale

▸ getColumnWidthScale(): number

Returns

number

Inherited from

DataGrid.getColumnWidthScale

Defined in

src/ui/datagrid/datagrid.ts:417

---

getColumns

▸ getColumns(): Column<TItem>[]

Returns

Column<TItem>[]

Inherited from

DataGrid.getColumns

Defined in

src/ui/datagrid/datagrid.ts:881

---

getColumnsKey

▸ getColumnsKey(): string

Returns

string

Inherited from

DataGrid.getColumnsKey

Defined in

src/ui/datagrid/datagrid.ts:844

---

getCssClass

▸ getCssClass(): string

Returns

string

Inherited from

DataGrid.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCurrentSettings

▸ getCurrentSettings(flags?): PersistedGridSettings

Parameters

Name	Type
flags?	GridPersistanceFlags

Returns

PersistedGridSettings

Inherited from

DataGrid.getCurrentSettings

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

DataGrid.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:138

---

getDefaultSortBy

▸ getDefaultSortBy(): any[]

Returns

any[]

Inherited from

DataGrid.getDefaultSortBy

Defined in

src/ui/datagrid/datagrid.ts:710

---

getDialogOptions

▸ getDialogOptions(): any

Returns

any

Defined in

src/ui/datagrid/entitygrid.ts:338

---

getDialogOptionsFor

▸ getDialogOptionsFor(itemType): any

Parameters

Name	Type
itemType	string

Returns

any

Defined in

src/ui/datagrid/entitygrid.ts:342

---

getDialogType

▸ getDialogType(): (...args: any[]) => Widget<any>

Returns

fn

• new getDialogType(...args): Widget<any>

Parameters

Name	Type
...args	any[]

Returns

Widget<any>

Defined in

src/ui/datagrid/entitygrid.ts:360

---

getDialogTypeFor

▸ getDialogTypeFor(itemType): (...args: any[]) => Widget<any>

Parameters

Name	Type
itemType	string

Returns

fn

• new getDialogTypeFor(...args): Widget<any>

Parameters

Name	Type
...args	any[]

Returns

Widget<any>

Defined in

src/ui/datagrid/entitygrid.ts:349

---

getDisplayName

▸ getDisplayName(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:132

---

getElement

▸ getElement(): HTMLElement

Returns

HTMLElement

Inherited from

DataGrid.getElement

Defined in

src/ui/datagrid/datagrid.ts:1453

---

getEntityType

▸ getEntityType(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:102

---

getFieldElement

▸ getFieldElement(): HTMLElement

Returns

HTMLElement

Inherited from

DataGrid.getFieldElement

Defined in

src/ui/widgets/widget.ts:106

---

getFilterStore

▸ getFilterStore(): FilterStore

Returns

FilterStore

Inherited from

DataGrid.getFilterStore

Defined in

src/ui/datagrid/datagrid.ts:1465

---

getGrid

▸ getGrid(): Grid<any>

Returns

Grid<any>

Inherited from

DataGrid.getGrid

Defined in

src/ui/datagrid/datagrid.ts:1457

---

getGridCanLoad

▸ getGridCanLoad(): boolean

Returns

boolean

Inherited from

DataGrid.getGridCanLoad

Defined in

src/ui/datagrid/datagrid.ts:935

---

getGridField

▸ getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

DataGrid.getGridField

Defined in

src/ui/widgets/widget.ts:110

---

getIdProperty

▸ getIdProperty(): string

Returns

string

Inherited from

DataGrid.getIdProperty

Defined in

src/ui/datagrid/datagrid.ts:1027

---

getIncludeColumns

▸ getIncludeColumns(include): void

Parameters

Name	Type
include	Object

Returns

void

Inherited from

DataGrid.getIncludeColumns

Defined in

src/ui/datagrid/datagrid.ts:647

---

getInitialTitle

▸ getInitialTitle(): string

Returns

string

Overrides

DataGrid.getInitialTitle

Defined in

src/ui/datagrid/entitygrid.ts:86

---

getInsertPermission

▸ getInsertPermission(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:291

---

getIsActiveProperty

▸ getIsActiveProperty(): string

Returns

string

Inherited from

DataGrid.getIsActiveProperty

Defined in

src/ui/datagrid/datagrid.ts:1048

---

getIsDeletedProperty

▸ getIsDeletedProperty(): string

Returns

string

Inherited from

DataGrid.getIsDeletedProperty

Defined in

src/ui/datagrid/datagrid.ts:1042

---

getItemCssClass

▸ getItemCssClass(item, index): string

Parameters

Name	Type
item	TItem
index	number

Returns

string

Inherited from

DataGrid.getItemCssClass

Defined in

src/ui/datagrid/datagrid.ts:351

---

getItemMetadata

▸ getItemMetadata(item, index): any

Parameters

Name	Type
item	TItem
index	number

Returns

any

Inherited from

DataGrid.getItemMetadata

Defined in

src/ui/datagrid/datagrid.ts:384

---

getItemName

▸ getItemName(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:152

---

getItemType

▸ getItemType(): string

Returns

string

Overrides

DataGrid.getItemType

Defined in

src/ui/datagrid/entitygrid.ts:271

---

getItems

▸ getItems(): TItem[]

Returns

TItem[]

Inherited from

DataGrid.getItems

Defined in

src/ui/datagrid/datagrid.ts:511

---

getLocalTextDbPrefix

▸ getLocalTextDbPrefix(): string

Returns

string

Inherited from

DataGrid.getLocalTextDbPrefix

Defined in

src/ui/datagrid/datagrid.ts:1005

---

getLocalTextPrefix

▸ getLocalTextPrefix(): string

Returns

string

Overrides

DataGrid.getLocalTextPrefix

Defined in

src/ui/datagrid/entitygrid.ts:90

---

getPagerOptions

▸ getPagerOptions(): PagerOptions

Returns

PagerOptions

Inherited from

DataGrid.getPagerOptions

Defined in

src/ui/datagrid/datagrid.ts:754

---

getPersistanceKey

▸ getPersistanceKey(): string

Returns

string

Inherited from

DataGrid.getPersistanceKey

Defined in

src/ui/datagrid/datagrid.ts:1135

---

getPersistanceStorage

▸ getPersistanceStorage(): SettingStorage

Returns

SettingStorage

Inherited from

DataGrid.getPersistanceStorage

Defined in

src/ui/datagrid/datagrid.ts:1131

---

getPersistedSettings

▸ getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

DataGrid.getPersistedSettings

Defined in

src/ui/datagrid/datagrid.ts:1171

---

getPropertyItems

▸ getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Inherited from

DataGrid.getPropertyItems

Defined in

src/ui/datagrid/datagrid.ts:848

---

getPropertyItemsData

▸ getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Inherited from

DataGrid.getPropertyItemsData

Defined in

src/ui/datagrid/datagrid.ts:852

---

getPropertyItemsDataAsync

▸ getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Inherited from

DataGrid.getPropertyItemsDataAsync

Defined in

src/ui/datagrid/datagrid.ts:872

---

getQuickFilters

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

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

DataGrid.getQuickFilters

Defined in

src/ui/datagrid/datagrid.ts:225

---

getQuickSearchFields

▸ getQuickSearchFields(): QuickSearchField[]

Returns

QuickSearchField[]

Inherited from

DataGrid.getQuickSearchFields

Defined in

src/ui/datagrid/datagrid.ts:308

---

getRowDefinition

▸ getRowDefinition(): IRowDefinition

Returns

IRowDefinition

Inherited from

DataGrid.getRowDefinition

Defined in

src/ui/datagrid/datagrid.ts:999

---

getService

▸ getService(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:252

---

getSlickOptions

▸ getSlickOptions(): GridOptions<any>

Returns

GridOptions<any>

Inherited from

DataGrid.getSlickOptions

Defined in

src/ui/datagrid/datagrid.ts:911

---

getTitle

▸ getTitle(): string

Returns

string

Inherited from

DataGrid.getTitle

Defined in

src/ui/datagrid/datagrid.ts:796

---

getView

▸ getView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Inherited from

DataGrid.getView

Defined in

src/ui/datagrid/datagrid.ts:1461

---

getViewOptions

▸ getViewOptions(): RemoteViewOptions

Returns

RemoteViewOptions

Overrides

DataGrid.getViewOptions

Defined in

src/ui/datagrid/entitygrid.ts:265

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Inherited from

DataGrid.get_readOnly

Defined in

src/ui/datagrid/datagrid.ts:984

---

gridPersistanceFlags

▸ gridPersistanceFlags(): GridPersistanceFlags

Returns

GridPersistanceFlags

Inherited from

DataGrid.gridPersistanceFlags

Defined in

src/ui/datagrid/datagrid.ts:1146

---

handleRoute

▸ handleRoute(e): void

Parameters

Name	Type
e	HandleRouteEvent

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:29

---

hasInsertPermission

▸ hasInsertPermission(): boolean

Returns

boolean

Defined in

src/ui/datagrid/entitygrid.ts:295

---

init

▸ init(): this

Returns

this

Inherited from

DataGrid.init

Defined in

src/ui/widgets/widget.ts:146

---

initDialog

▸ initDialog(dialog): void

Parameters

Name	Type
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:305

---

initEntityDialog

▸ initEntityDialog(itemType, dialog): void

Parameters

Name	Type
itemType	string
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:314

---

initialPopulate

▸ initialPopulate(): void

Returns

void

Inherited from

DataGrid.initialPopulate

Defined in

src/ui/datagrid/datagrid.ts:421

---

initializeFilterBar

▸ initializeFilterBar(): void

Returns

void

Inherited from

DataGrid.initializeFilterBar

Defined in

src/ui/datagrid/datagrid.ts:443

---

internalInit

▸ internalInit(): void

Returns

void

Inherited from

DataGrid.internalInit

Defined in

src/ui/widgets/widget.ts:142

---

internalRefresh

▸ internalRefresh(): void

Returns

void

Inherited from

DataGrid.internalRefresh

Defined in

src/ui/datagrid/datagrid.ts:959

---

internalRenderContents

▸ internalRenderContents(): void

Returns

void

Inherited from

DataGrid.internalRenderContents

Defined in

src/ui/widgets/widget.ts:169

---

invokeSubmitHandlers

▸ invokeSubmitHandlers(): void

Returns

void

Inherited from

DataGrid.invokeSubmitHandlers

Defined in

src/ui/datagrid/datagrid.ts:1119

---

itemAt

▸ itemAt(row): TItem

Parameters

Name	Type
row	number

Returns

TItem

Inherited from

DataGrid.itemAt

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>

Inherited from

DataGrid.itemLink

Defined in

src/ui/datagrid/datagrid.ts:830

---

layout

▸ layout(): void

Returns

void

Inherited from

DataGrid.layout

Defined in

src/ui/datagrid/datagrid.ts:165

---

markupReady

▸ markupReady(): void

Returns

void

Inherited from

DataGrid.markupReady

Defined in

src/ui/datagrid/datagrid.ts:698

---

newRefreshButton

▸ newRefreshButton(noText?): ToolButton

Parameters

Name	Type
noText?	boolean

Returns

ToolButton

Defined in

src/ui/datagrid/entitygrid.ts:195

---

onClick

▸ onClick(e, row, cell): void

Parameters

Name	Type
e	Event
row	number
cell	number

Returns

void

Inherited from

DataGrid.onClick

Defined in

src/ui/datagrid/datagrid.ts:598

---

onViewFilter

▸ onViewFilter(item): boolean

Parameters

Name	Type
item	TItem

Returns

boolean

Inherited from

DataGrid.onViewFilter

Defined in

src/ui/datagrid/datagrid.ts:643

---

onViewProcessData

▸ onViewProcessData(response): ListResponse<TItem>

Parameters

Name	Type
response	ListResponse<TItem>

Returns

ListResponse<TItem>

Inherited from

DataGrid.onViewProcessData

Defined in

src/ui/datagrid/datagrid.ts:639

---

onViewSubmit

▸ onViewSubmit(): boolean

Returns

boolean

Inherited from

DataGrid.onViewSubmit

Defined in

src/ui/datagrid/datagrid.ts:686

---

persistSettings

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

Parameters

Name	Type
flags?	GridPersistanceFlags

Returns

void | Promise<void>

Inherited from

DataGrid.persistSettings

Defined in

src/ui/datagrid/datagrid.ts:1353

---

populateLock

▸ populateLock(): void

Returns

void

Inherited from

DataGrid.populateLock

Defined in

src/ui/datagrid/datagrid.ts:927

---

populateUnlock

▸ populateUnlock(): void

Returns

void

Inherited from

DataGrid.populateUnlock

Defined in

src/ui/datagrid/datagrid.ts:931

---

populateWhenVisible

▸ populateWhenVisible(): boolean

Returns

boolean

Inherited from

DataGrid.populateWhenVisible

Defined in

src/ui/datagrid/datagrid.ts:743

---

postProcessColumns

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

Parameters

Name	Type
columns	Column<any>[]

Returns

Column<any>[]

Inherited from

DataGrid.postProcessColumns

Defined in

src/ui/datagrid/datagrid.ts:392

---

propertyItemsReady

▸ propertyItemsReady(itemsData): void

Parameters

Name	Type
itemsData	PropertyItemsData

Returns

void

Inherited from

DataGrid.propertyItemsReady

Defined in

src/ui/datagrid/datagrid.ts:121

---

propertyItemsToSlickColumns

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

Parameters

Name	Type
propertyItems	PropertyItem[]

Returns

Column<any>[]

Inherited from

DataGrid.propertyItemsToSlickColumns

Defined in

src/ui/datagrid/datagrid.ts:900

---

quickFilterChange

▸ quickFilterChange(e): void

Parameters

Name	Type
e	Event

Returns

void

Inherited from

DataGrid.quickFilterChange

Defined in

src/ui/datagrid/datagrid.ts:1125

---

refresh

▸ refresh(): void

Returns

void

Inherited from

DataGrid.refresh

Defined in

src/ui/datagrid/datagrid.ts:939

---

refreshIfNeeded

▸ refreshIfNeeded(): void

Returns

void

Inherited from

DataGrid.refreshIfNeeded

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

DataGrid.render

Defined in

src/ui/widgets/widget.ts:159

---

renderContents

▸ renderContents(): any

Returns

any

Inherited from

DataGrid.renderContents

Defined in

src/ui/widgets/widget.ts:178

---

resizeCanvas

▸ resizeCanvas(): void

Returns

void

Inherited from

DataGrid.resizeCanvas

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>

Inherited from

DataGrid.restoreSettings

Defined in

src/ui/datagrid/datagrid.ts:1190

---

restoreSettingsFrom

▸ restoreSettingsFrom(settings, flags?): void

Parameters

Name	Type
settings	PersistedGridSettings
flags?	GridPersistanceFlags

Returns

void

Inherited from

DataGrid.restoreSettingsFrom

Defined in

src/ui/datagrid/datagrid.ts:1201

---

routeDialog

▸ routeDialog(itemType, dialog): void

Parameters

Name	Type
itemType	string
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:275

---

rowCount

▸ rowCount(): number

Returns

number

Inherited from

DataGrid.rowCount

Defined in

src/ui/datagrid/datagrid.ts:507

---

setCriteriaParameter

▸ setCriteriaParameter(): void

Returns

void

Inherited from

DataGrid.setCriteriaParameter

Defined in

src/ui/datagrid/datagrid.ts:662

---

setEquality

▸ setEquality(field, value): void

Parameters

Name	Type
field	string
value	any

Returns

void

Inherited from

DataGrid.setEquality

Defined in

src/ui/datagrid/datagrid.ts:672

---

setIncludeColumnsParameter

▸ setIncludeColumnsParameter(): void

Returns

void

Inherited from

DataGrid.setIncludeColumnsParameter

Defined in

src/ui/datagrid/datagrid.ts:676

---

setInitialSortOrder

▸ setInitialSortOrder(): void

Returns

void

Inherited from

DataGrid.setInitialSortOrder

Defined in

src/ui/datagrid/datagrid.ts:478

---

setIsDisabled

▸ setIsDisabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

DataGrid.setIsDisabled

Defined in

src/ui/datagrid/datagrid.ts:963

---

setItems

▸ setItems(value): void

Parameters

Name	Type
value	TItem[]

Returns

void

Inherited from

DataGrid.setItems

Defined in

src/ui/datagrid/datagrid.ts:515

---

setTitle

▸ setTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

DataGrid.setTitle

Defined in

src/ui/datagrid/datagrid.ts:804

---

set_readOnly

▸ set_readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

DataGrid.set_readOnly

Defined in

src/ui/datagrid/datagrid.ts:988

---

subDialogDataChange

▸ subDialogDataChange(): void

Returns

void

Inherited from

DataGrid.subDialogDataChange

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

DataGrid.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:186

---

transferDialogReadOnly

▸ transferDialogReadOnly(dialog): void

Parameters

Name	Type
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:300

---

tryFindQuickFilter

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

Type parameters

Name
TWidget

Parameters

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

Returns

TWidget

Inherited from

DataGrid.tryFindQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:296

---

updateDisabledState

▸ updateDisabledState(): void

Returns

void

Inherited from

DataGrid.updateDisabledState

Defined in

src/ui/datagrid/datagrid.ts:1063

---

updateInterface

▸ updateInterface(): void

Returns

void

Inherited from

DataGrid.updateInterface

Defined in

src/ui/datagrid/datagrid.ts:995

---

useAsync

▸ useAsync(): boolean

Returns

boolean

Inherited from

DataGrid.useAsync

Defined in

src/ui/datagrid/datagrid.ts:157

---

useIdPrefix

▸ useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

DataGrid.useIdPrefix

Defined in

src/ui/widgets/widget.ts:193

---

useLayoutTimer

▸ useLayoutTimer(): boolean

Returns

boolean

Inherited from

DataGrid.useLayoutTimer

Defined in

src/ui/datagrid/datagrid.ts:161

---

usePager

▸ usePager(): boolean

Returns

boolean

Overrides

DataGrid.usePager

Defined in

src/ui/datagrid/entitygrid.ts:77

---

viewDataChanged

▸ viewDataChanged(e, rows): void

Parameters

Name	Type
e	any
rows	TItem[]

Returns

void

Inherited from

DataGrid.viewDataChanged

Defined in

src/ui/datagrid/datagrid.ts:614

---

wrapFormatterWithEditLink

▸ wrapFormatterWithEditLink(column, item): void

Parameters

Name	Type
column	Column<any>
item	PropertyItem

Returns

void

Inherited from

DataGrid.wrapFormatterWithEditLink

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

DataGrid.create

Defined in

src/ui/widgets/widget.ts:126

---

createDefaultElement

▸ createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

DataGrid.createDefaultElement

Defined in

src/ui/widgets/widget.ts:60

---

getWidgetName

▸ getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

DataGrid.getWidgetName

Defined in

src/ui/widgets/widget.ts:95

---

propertyItemToQuickFilter

▸ propertyItemToQuickFilter(item): any

Parameters

Name	Type
item	PropertyItem

Returns

any

Inherited from

DataGrid.propertyItemToQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:235