@serenity-is/corelib / EntityGrid

Class: EntityGrid<TItem, TOptions>

Type parameters

Name
TItem
TOptions

Hierarchy

• DataGrid<TItem, TOptions>

  ↳ EntityGrid

Table of contents

Constructors

• constructor

Properties

• _dialogType
• _displayName
• _entityType
• _itemName
• _service
• allColumns
• element
• filterBar
• idPrefix
• initialSettings
• openDialogsAsPanel
• options
• propertyItemsData
• quickFiltersBar
• quickFiltersDiv
• restoringSettings
• slickContainer
• slickGrid
• titleDiv
• toolbar
• uniqueName
• view
• widgetName
• defaultColumnWidthDelta
• defaultColumnWidthScale
• defaultHeaderHeight
• defaultPersistanceStorage
• defaultRowHeight

Accessors

• readOnly

Methods

• addBooleanFilter
• addButtonClick
• addCssClass
• addDateRangeFilter
• addDateTimeRangeFilter
• addFilterSeparator
• addQuickFilter
• addValidationRule
• afterInit
• attrs
• 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
• getDefaultSortBy
• getDialogOptions
• getDialogOptionsFor
• getDialogType
• getDialogTypeFor
• getDisplayName
• getElement
• getEntityType
• 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
• initAsync
• initDialog
• initEntityDialog
• initSync
• initialPopulate
• initialize
• initializeFilterBar
• internalInit
• internalRefresh
• invokeSubmitHandlers
• itemAt
• itemLink
• layout
• markupReady
• newRefreshButton
• onClick
• onViewFilter
• onViewProcessData
• onViewSubmit
• persistSettings
• populateLock
• populateUnlock
• populateWhenVisible
• postProcessColumns
• propertyItemsToSlickColumns
• quickFilterChange
• refresh
• refreshIfNeeded
• renderContents
• resizeCanvas
• restoreSettings
• restoreSettingsFrom
• routeDialog
• rowCount
• setCriteriaParameter
• setEquality
• setIncludeColumnsParameter
• setInitialSortOrder
• setIsDisabled
• setItems
• setTitle
• set_readOnly
• subDialogDataChange
• transferDialogReadOnly
• tryFindQuickFilter
• updateDisabledState
• updateInterface
• useAsync
• useLayoutTimer
• usePager
• viewDataChanged
• create
• elementFor
• getWidgetName
• propertyItemToQuickFilter

Constructors

constructor

• new EntityGrid<TItem, TOptions>(container, options?)

Type parameters

Name
TItem
TOptions

Parameters

Name	Type
container	JQuery
options?	TOptions

Overrides

DataGrid.constructor

Defined in

src/ui/datagrid/entitygrid.ts:17

Properties

_dialogType

• Private _dialogType: WidgetDialogClass<object>

Defined in

src/ui/datagrid/entitygrid.ts:345

---

_displayName

• Private _displayName: string

Defined in

src/ui/datagrid/entitygrid.ts:113

---

_entityType

• Private _entityType: string

Defined in

src/ui/datagrid/entitygrid.ts:82

---

_itemName

• Private _itemName: string

Defined in

src/ui/datagrid/entitygrid.ts:133

---

_service

• Private _service: string

Defined in

src/ui/datagrid/entitygrid.ts:233

---

allColumns

• Protected allColumns: Column<any>[]

Inherited from

DataGrid.allColumns

Defined in

src/ui/datagrid/datagrid.ts:103

---

element

• element: JQuery

Inherited from

DataGrid.element

Defined in

src/ui/widgets/widget.ts:61

---

filterBar

• Protected filterBar: FilterDisplayBar

Inherited from

DataGrid.filterBar

Defined in

src/ui/datagrid/datagrid.ts:99

---

idPrefix

• Readonly idPrefix: string

Inherited from

DataGrid.idPrefix

Defined in

src/ui/widgets/widget.ts:65

---

initialSettings

• Protected initialSettings: PersistedGridSettings

Inherited from

DataGrid.initialSettings

Defined in

src/ui/datagrid/datagrid.ts:105

---

openDialogsAsPanel

• openDialogsAsPanel: boolean

Inherited from

DataGrid.openDialogsAsPanel

Defined in

src/ui/datagrid/datagrid.ts:109

---

options

• Protected options: TOptions

Inherited from

DataGrid.options

Defined in

src/ui/widgets/widget.ts:62

---

propertyItemsData

• Protected propertyItemsData: PropertyItemsData

Inherited from

DataGrid.propertyItemsData

Defined in

src/ui/datagrid/datagrid.ts:104

---

quickFiltersBar

• Protected quickFiltersBar: QuickFilterBar

Inherited from

DataGrid.quickFiltersBar

Defined in

src/ui/datagrid/datagrid.ts:101

---

quickFiltersDiv

• Protected quickFiltersDiv: JQuery

Inherited from

DataGrid.quickFiltersDiv

Defined in

src/ui/datagrid/datagrid.ts:100

---

restoringSettings

• Protected restoringSettings: number = 0

Inherited from

DataGrid.restoringSettings

Defined in

src/ui/datagrid/datagrid.ts:106

---

slickContainer

• Protected slickContainer: JQuery

Inherited from

DataGrid.slickContainer

Defined in

src/ui/datagrid/datagrid.ts:102

---

slickGrid

• slickGrid: Grid<any>

Inherited from

DataGrid.slickGrid

Defined in

src/ui/datagrid/datagrid.ts:108

---

titleDiv

• Protected titleDiv: JQuery

Inherited from

DataGrid.titleDiv

Defined in

src/ui/datagrid/datagrid.ts:97

---

toolbar

• Protected toolbar: Toolbar

Inherited from

DataGrid.toolbar

Defined in

src/ui/datagrid/datagrid.ts:98

---

uniqueName

• Protected uniqueName: string

Inherited from

DataGrid.uniqueName

Defined in

src/ui/widgets/widget.ts:64

---

view

• view: RemoteView<TItem>

Inherited from

DataGrid.view

Defined in

src/ui/datagrid/datagrid.ts:107

---

widgetName

• Protected widgetName: string

Inherited from

DataGrid.widgetName

Defined in

src/ui/widgets/widget.ts:63

---

defaultColumnWidthDelta

▪ Static defaultColumnWidthDelta: number

Inherited from

DataGrid.defaultColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.ts:115

---

defaultColumnWidthScale

▪ Static defaultColumnWidthScale: number

Inherited from

DataGrid.defaultColumnWidthScale

Defined in

src/ui/datagrid/datagrid.ts:114

---

defaultHeaderHeight

▪ Static defaultHeaderHeight: number

Inherited from

DataGrid.defaultHeaderHeight

Defined in

src/ui/datagrid/datagrid.ts:112

---

defaultPersistanceStorage

▪ Static defaultPersistanceStorage: SettingStorage

Inherited from

DataGrid.defaultPersistanceStorage

Defined in

src/ui/datagrid/datagrid.ts:113

---

defaultRowHeight

▪ Static defaultRowHeight: number

Inherited from

DataGrid.defaultRowHeight

Defined in

src/ui/datagrid/datagrid.ts:111

Accessors

readOnly

• get readOnly(): boolean

Returns

boolean

Inherited from

DataGrid.readOnly

Defined in

src/ui/datagrid/datagrid.ts:1027

• set readOnly(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

DataGrid.readOnly

Defined in

src/ui/datagrid/datagrid.ts:1031

Methods

addBooleanFilter

▸ Protected addBooleanFilter(field, title?, yes?, no?): SelectEditor

Parameters

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

Returns

SelectEditor

Inherited from

DataGrid.addBooleanFilter

Defined in

src/ui/datagrid/datagrid.ts:1165

---

addButtonClick

▸ Protected addButtonClick(): void

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:191

---

addCssClass

▸ Protected addCssClass(): void

Returns

void

Inherited from

DataGrid.addCssClass

Defined in

src/ui/widgets/widget.ts:100

---

addDateRangeFilter

▸ Protected addDateRangeFilter(field, title?): DateEditor

Parameters

Name	Type
field	string
title?	string

Returns

DateEditor

Inherited from

DataGrid.addDateRangeFilter

Defined in

src/ui/datagrid/datagrid.ts:1149

---

addDateTimeRangeFilter

▸ Protected addDateTimeRangeFilter(field, title?): DateTimeEditor

Parameters

Name	Type
field	string
title?	string

Returns

DateTimeEditor

Inherited from

DataGrid.addDateTimeRangeFilter

Defined in

src/ui/datagrid/datagrid.ts:1157

---

addFilterSeparator

▸ Protected addFilterSeparator(): void

Returns

void

Inherited from

DataGrid.addFilterSeparator

Defined in

src/ui/datagrid/datagrid.ts:1129

---

addQuickFilter

▸ Protected addQuickFilter<TWidget, TOptions>(opt): TWidget

Type parameters

Name	Type
TWidget	extends Widget<any, TWidget>
TOptions	TOptions

Parameters

Name	Type
opt	QuickFilter<TWidget, TOptions>

Returns

TWidget

Inherited from

DataGrid.addQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:1145

---

addValidationRule

▸ addValidationRule(eventClass, rule): JQuery

Parameters

Name	Type
eventClass	string
rule	(p1: JQuery) => string

Returns

JQuery

Inherited from

DataGrid.addValidationRule

Defined in

src/ui/widgets/widget.ts:134

---

afterInit

▸ Protected afterInit(): void

Returns

void

Inherited from

DataGrid.afterInit

Defined in

src/ui/datagrid/datagrid.ts:194

---

attrs

▸ Protected attrs<TAttr>(attrType): TAttr[]

Type parameters

Name
TAttr

Parameters

Name	Type
attrType	(...args: any[]) => TAttr

Returns

TAttr[]

Inherited from

DataGrid.attrs

Defined in

src/ui/datagrid/datagrid.ts:205

---

bindToSlickEvents

▸ Protected bindToSlickEvents(): void

Returns

void

Inherited from

DataGrid.bindToSlickEvents

Defined in

src/ui/datagrid/datagrid.ts:569

---

bindToViewEvents

▸ Protected bindToViewEvents(): void

Returns

void

Inherited from

DataGrid.bindToViewEvents

Defined in

src/ui/datagrid/datagrid.ts:669

---

booleanQuickFilter

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

Parameters

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

Returns

QuickFilter<SelectEditor, SelectEditorOptions>

Inherited from

DataGrid.booleanQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:1169

---

canFilterColumn

▸ Protected canFilterColumn(column): boolean

Parameters

Name	Type
column	Column<any>

Returns

boolean

Inherited from

DataGrid.canFilterColumn

Defined in

src/ui/datagrid/datagrid.ts:486

---

canShowColumn

▸ Protected canShowColumn(column): boolean

Parameters

Name	Type
column	Column<any>

Returns

boolean

Inherited from

DataGrid.canShowColumn

Defined in

src/ui/datagrid/datagrid.ts:1204

---

change

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

DataGrid.change

Defined in

src/ui/widgets/widget.ts:142

▸ change(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

DataGrid.change

Defined in

src/ui/widgets/widget.ts:259

---

changeSelect2

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

DataGrid.changeSelect2

Defined in

src/ui/widgets/widget.ts:146

▸ changeSelect2(handler): void

Parameters

Name	Type
handler	(e: JQueryEventObject) => void

Returns

void

Inherited from

DataGrid.changeSelect2

Defined in

src/ui/widgets/widget.ts:260

---

createEntityDialog

▸ Protected 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:311

---

createFilterBar

▸ Protected createFilterBar(): void

Returns

void

Inherited from

DataGrid.createFilterBar

Defined in

src/ui/datagrid/datagrid.ts:798

---

createIncludeDeletedButton

▸ Protected createIncludeDeletedButton(): void

Returns

void

Inherited from

DataGrid.createIncludeDeletedButton

Defined in

src/ui/datagrid/datagrid.ts:350

---

createPager

▸ Protected createPager(): void

Returns

void

Inherited from

DataGrid.createPager

Defined in

src/ui/datagrid/datagrid.ts:812

---

createQuickFilters

▸ Protected createQuickFilters(filters?): void

Parameters

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

Returns

void

Inherited from

DataGrid.createQuickFilters

Defined in

src/ui/datagrid/datagrid.ts:246

---

createQuickSearchInput

▸ Protected createQuickSearchInput(): void

Returns

void

Inherited from

DataGrid.createQuickSearchInput

Defined in

src/ui/datagrid/datagrid.ts:361

---

createSlickContainer

▸ Protected createSlickContainer(): JQuery

Returns

JQuery

Inherited from

DataGrid.createSlickContainer

Defined in

src/ui/datagrid/datagrid.ts:751

---

createSlickGrid

▸ Protected createSlickGrid(): Grid<any>

Returns

Grid<any>

Inherited from

DataGrid.createSlickGrid

Defined in

src/ui/datagrid/datagrid.ts:509

---

createToolbar

▸ Protected createToolbar(buttons): void

Parameters

Name	Type
buttons	ToolButton[]

Returns

void

Inherited from

DataGrid.createToolbar

Defined in

src/ui/datagrid/datagrid.ts:839

---

createToolbarExtensions

▸ Protected createToolbarExtensions(): void

Returns

void

Overrides

DataGrid.createToolbarExtensions

Defined in

src/ui/datagrid/entitygrid.ts:63

---

createView

▸ Protected createView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Inherited from

DataGrid.createView

Defined in

src/ui/datagrid/datagrid.ts:755

---

dateRangeQuickFilter

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

Parameters

Name	Type
field	string
title?	string

Returns

QuickFilter<DateEditor, DateTimeEditorOptions>

Inherited from

DataGrid.dateRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:1153

---

dateTimeRangeQuickFilter

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

Parameters

Name	Type
field	string
title?	string

Returns

QuickFilter<DateTimeEditor, DateTimeEditorOptions>

Inherited from

DataGrid.dateTimeRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:1161

---

destroy

▸ destroy(): void

Returns

void

Inherited from

DataGrid.destroy

Defined in

src/ui/datagrid/datagrid.ts:366

---

determineText

▸ Protected determineText(getKey): string

Parameters

Name	Type
getKey	(prefix: string) => string

Returns

string

Inherited from

DataGrid.determineText

Defined in

src/ui/datagrid/datagrid.ts:1133

---

editItem

▸ Protected editItem(entityOrId): void

Parameters

Name	Type
entityOrId	any

Returns

void

Overrides

DataGrid.editItem

Defined in

src/ui/datagrid/entitygrid.ts:195

---

editItemOfType

▸ Protected editItemOfType(itemType, entityOrId): void

Parameters

Name	Type
itemType	string
entityOrId	any

Returns

void

Overrides

DataGrid.editItemOfType

Defined in

src/ui/datagrid/entitygrid.ts:212

---

enableFiltering

▸ Protected enableFiltering(): boolean

Returns

boolean

Inherited from

DataGrid.enableFiltering

Defined in

src/ui/datagrid/datagrid.ts:789

---

ensureQuickFilterBar

▸ Protected ensureQuickFilterBar(): QuickFilterBar

Returns

QuickFilterBar

Inherited from

DataGrid.ensureQuickFilterBar

Defined in

src/ui/datagrid/datagrid.ts:238

---

findQuickFilter

▸ Protected 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:332

---

getAddButtonCaption

▸ Protected getAddButtonCaption(): string

Returns

string

Overrides

DataGrid.getAddButtonCaption

Defined in

src/ui/datagrid/entitygrid.ts:153

---

getButtons

▸ Protected getButtons(): ToolButton[]

Returns

ToolButton[]

Overrides

DataGrid.getButtons

Defined in

src/ui/datagrid/entitygrid.ts:157

---

getColumnWidthDelta

▸ Protected getColumnWidthDelta(): number

Returns

number

Inherited from

DataGrid.getColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.ts:463

---

getColumnWidthScale

▸ Protected getColumnWidthScale(): number

Returns

number

Inherited from

DataGrid.getColumnWidthScale

Defined in

src/ui/datagrid/datagrid.ts:467

---

getColumns

▸ Protected getColumns(): Column<TItem>[]

Returns

Column<TItem>[]

Inherited from

DataGrid.getColumns

Defined in

src/ui/datagrid/datagrid.ts:932

---

getColumnsKey

▸ Protected getColumnsKey(): string

Returns

string

Inherited from

DataGrid.getColumnsKey

Defined in

src/ui/datagrid/datagrid.ts:890

---

getCssClass

▸ Protected getCssClass(): string

Returns

string

Inherited from

DataGrid.getCssClass

Defined in

src/ui/widgets/widget.ts:104

---

getCurrentSettings

▸ Protected getCurrentSettings(flags?): PersistedGridSettings

Parameters

Name	Type
flags?	GridPersistanceFlags

Returns

PersistedGridSettings

Inherited from

DataGrid.getCurrentSettings

Defined in

src/ui/datagrid/datagrid.ts:1417

---

getDefaultSortBy

▸ Protected getDefaultSortBy(): any[]

Returns

any[]

Inherited from

DataGrid.getDefaultSortBy

Defined in

src/ui/datagrid/datagrid.ts:760

---

getDialogOptions

▸ Protected getDialogOptions(): any

Returns

any

Defined in

src/ui/datagrid/entitygrid.ts:325

---

getDialogOptionsFor

▸ Protected getDialogOptionsFor(itemType): any

Parameters

Name	Type
itemType	string

Returns

any

Defined in

src/ui/datagrid/entitygrid.ts:329

---

getDialogType

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

Returns

fn

• new getDialogType(...args)

Parameters

Name	Type
...args	any[]

Defined in

src/ui/datagrid/entitygrid.ts:347

---

getDialogTypeFor

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

Parameters

Name	Type
itemType	string

Returns

fn

• new getDialogTypeFor(...args)

Parameters

Name	Type
...args	any[]

Defined in

src/ui/datagrid/entitygrid.ts:336

---

getDisplayName

▸ Protected getDisplayName(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:115

---

getElement

▸ getElement(): JQuery

Returns

JQuery

Inherited from

DataGrid.getElement

Defined in

src/ui/datagrid/datagrid.ts:1507

---

getEntityType

▸ Protected getEntityType(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:84

---

getFilterStore

▸ getFilterStore(): FilterStore

Returns

FilterStore

Inherited from

DataGrid.getFilterStore

Defined in

src/ui/datagrid/datagrid.ts:1519

---

getGrid

▸ getGrid(): Grid<any>

Returns

Grid<any>

Inherited from

DataGrid.getGrid

Defined in

src/ui/datagrid/datagrid.ts:1511

---

getGridCanLoad

▸ Protected getGridCanLoad(): boolean

Returns

boolean

Inherited from

DataGrid.getGridCanLoad

Defined in

src/ui/datagrid/datagrid.ts:986

---

getGridField

▸ getGridField(): JQuery

Returns

JQuery

Inherited from

DataGrid.getGridField

Defined in

src/ui/widgets/widget.ts:138

---

getIdProperty

▸ Protected getIdProperty(): string

Returns

string

Inherited from

DataGrid.getIdProperty

Defined in

src/ui/datagrid/datagrid.ts:1081

---

getIncludeColumns

▸ Protected getIncludeColumns(include): void

Parameters

Name	Type
include	Object

Returns

void

Inherited from

DataGrid.getIncludeColumns

Defined in

src/ui/datagrid/datagrid.ts:697

---

getInitialTitle

▸ Protected getInitialTitle(): string

Returns

string

Overrides

DataGrid.getInitialTitle

Defined in

src/ui/datagrid/entitygrid.ts:68

---

getInsertPermission

▸ Protected getInsertPermission(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:274

---

getIsActiveProperty

▸ Protected getIsActiveProperty(): string

Returns

string

Inherited from

DataGrid.getIsActiveProperty

Defined in

src/ui/datagrid/datagrid.ts:1102

---

getIsDeletedProperty

▸ Protected getIsDeletedProperty(): string

Returns

string

Inherited from

DataGrid.getIsDeletedProperty

Defined in

src/ui/datagrid/datagrid.ts:1096

---

getItemCssClass

▸ Protected getItemCssClass(item, index): string

Parameters

Name	Type
item	TItem
index	number

Returns

string

Inherited from

DataGrid.getItemCssClass

Defined in

src/ui/datagrid/datagrid.ts:400

---

getItemMetadata

▸ Protected getItemMetadata(item, index): any

Parameters

Name	Type
item	TItem
index	number

Returns

any

Inherited from

DataGrid.getItemMetadata

Defined in

src/ui/datagrid/datagrid.ts:434

---

getItemName

▸ Protected getItemName(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:135

---

getItemType

▸ Protected getItemType(): string

Returns

string

Overrides

DataGrid.getItemType

Defined in

src/ui/datagrid/entitygrid.ts:254

---

getItems

▸ getItems(): TItem[]

Returns

TItem[]

Inherited from

DataGrid.getItems

Defined in

src/ui/datagrid/datagrid.ts:561

---

getLocalTextDbPrefix

▸ Protected getLocalTextDbPrefix(): string

Returns

string

Inherited from

DataGrid.getLocalTextDbPrefix

Defined in

src/ui/datagrid/datagrid.ts:1056

---

getLocalTextPrefix

▸ Protected getLocalTextPrefix(): string

Returns

string

Overrides

DataGrid.getLocalTextPrefix

Defined in

src/ui/datagrid/entitygrid.ts:72

---

getPagerOptions

▸ Protected getPagerOptions(): PagerOptions

Returns

PagerOptions

Inherited from

DataGrid.getPagerOptions

Defined in

src/ui/datagrid/datagrid.ts:804

---

getPersistanceKey

▸ Protected getPersistanceKey(): string

Returns

string

Inherited from

DataGrid.getPersistanceKey

Defined in

src/ui/datagrid/datagrid.ts:1189

---

getPersistanceStorage

▸ Protected getPersistanceStorage(): SettingStorage

Returns

SettingStorage

Inherited from

DataGrid.getPersistanceStorage

Defined in

src/ui/datagrid/datagrid.ts:1185

---

getPersistedSettings

▸ Protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

DataGrid.getPersistedSettings

Defined in

src/ui/datagrid/datagrid.ts:1225

---

getPropertyItems

▸ Protected getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Inherited from

DataGrid.getPropertyItems

Defined in

src/ui/datagrid/datagrid.ts:899

---

getPropertyItemsData

▸ Protected getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Inherited from

DataGrid.getPropertyItemsData

Defined in

src/ui/datagrid/datagrid.ts:903

---

getPropertyItemsDataAsync

▸ Protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Inherited from

DataGrid.getPropertyItemsDataAsync

Defined in

src/ui/datagrid/datagrid.ts:923

---

getQuickFilters

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

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

DataGrid.getQuickFilters

Defined in

src/ui/datagrid/datagrid.ts:268

---

getQuickSearchFields

▸ Protected getQuickSearchFields(): QuickSearchField[]

Returns

QuickSearchField[]

Inherited from

DataGrid.getQuickSearchFields

Defined in

src/ui/datagrid/datagrid.ts:357

---

getRowDefinition

▸ Protected getRowDefinition(): IRowDefinition

Returns

IRowDefinition

Inherited from

DataGrid.getRowDefinition

Defined in

src/ui/datagrid/datagrid.ts:1050

---

getService

▸ Protected getService(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:235

---

getSlickOptions

▸ Protected getSlickOptions(): GridOptions<any>

Returns

GridOptions<any>

Inherited from

DataGrid.getSlickOptions

Defined in

src/ui/datagrid/datagrid.ts:966

---

getTitle

▸ getTitle(): string

Returns

string

Inherited from

DataGrid.getTitle

Defined in

src/ui/datagrid/datagrid.ts:844

---

getView

▸ getView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Inherited from

DataGrid.getView

Defined in

src/ui/datagrid/datagrid.ts:1515

---

getViewOptions

▸ Protected getViewOptions(): RemoteViewOptions

Returns

RemoteViewOptions

Overrides

DataGrid.getViewOptions

Defined in

src/ui/datagrid/entitygrid.ts:248

---

get_readOnly

▸ get_readOnly(): boolean

Returns

boolean

Inherited from

DataGrid.get_readOnly

Defined in

src/ui/datagrid/datagrid.ts:1035

---

gridPersistanceFlags

▸ Protected gridPersistanceFlags(): GridPersistanceFlags

Returns

GridPersistanceFlags

Inherited from

DataGrid.gridPersistanceFlags

Defined in

src/ui/datagrid/datagrid.ts:1200

---

handleRoute

▸ Protected handleRoute(args): void

Parameters

Name	Type
args	HandleRouteEventArgs

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:24

---

hasInsertPermission

▸ Protected hasInsertPermission(): boolean

Returns

boolean

Defined in

src/ui/datagrid/entitygrid.ts:278

---

init

▸ init(action?): EntityGrid<TItem, TOptions>

Parameters

Name	Type
action?	(widget: any) => void

Returns

EntityGrid<TItem, TOptions>

Inherited from

DataGrid.init

Defined in

src/ui/widgets/widget.ts:179

---

initAsync

▸ Protected initAsync(): Promise<void>

Returns

Promise<void>

Inherited from

DataGrid.initAsync

Defined in

src/ui/datagrid/datagrid.ts:188

---

initDialog

▸ Protected initDialog(dialog): void

Parameters

Name	Type
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:288

---

initEntityDialog

▸ Protected initEntityDialog(itemType, dialog): void

Parameters

Name	Type
itemType	string
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:297

---

initSync

▸ Protected initSync(): void

Returns

void

Inherited from

DataGrid.initSync

Defined in

src/ui/datagrid/datagrid.ts:182

---

initialPopulate

▸ Protected initialPopulate(): void

Returns

void

Inherited from

DataGrid.initialPopulate

Defined in

src/ui/datagrid/datagrid.ts:471

---

initialize

▸ initialize(): void

Returns

void

Inherited from

DataGrid.initialize

Defined in

src/ui/widgets/widget.ts:176

---

initializeFilterBar

▸ Protected initializeFilterBar(): void

Returns

void

Inherited from

DataGrid.initializeFilterBar

Defined in

src/ui/datagrid/datagrid.ts:493

---

internalInit

▸ Protected internalInit(): void

Returns

void

Inherited from

DataGrid.internalInit

Defined in

src/ui/datagrid/datagrid.ts:150

---

internalRefresh

▸ Protected internalRefresh(): void

Returns

void

Inherited from

DataGrid.internalRefresh

Defined in

src/ui/datagrid/datagrid.ts:1010

---

invokeSubmitHandlers

▸ Protected invokeSubmitHandlers(): void

Returns

void

Inherited from

DataGrid.invokeSubmitHandlers

Defined in

src/ui/datagrid/datagrid.ts:1173

---

itemAt

▸ itemAt(row): TItem

Parameters

Name	Type
row	number

Returns

TItem

Inherited from

DataGrid.itemAt

Defined in

src/ui/datagrid/datagrid.ts:553

---

itemLink

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

Parameters

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

Returns

Format<TItem>

Inherited from

DataGrid.itemLink

Defined in

src/ui/datagrid/datagrid.ts:876

---

layout

▸ Protected layout(): void

Returns

void

Inherited from

DataGrid.layout

Defined in

src/ui/datagrid/datagrid.ts:209

---

markupReady

▸ Protected markupReady(): void

Returns

void

Inherited from

DataGrid.markupReady

Defined in

src/ui/datagrid/datagrid.ts:748

---

newRefreshButton

▸ Protected newRefreshButton(noText?): ToolButton

Parameters

Name	Type
noText?	boolean

Returns

ToolButton

Defined in

src/ui/datagrid/entitygrid.ts:178

---

onClick

▸ Protected onClick(e, row, cell): void

Parameters

Name	Type
e	JQueryEventObject
row	number
cell	number

Returns

void

Inherited from

DataGrid.onClick

Defined in

src/ui/datagrid/datagrid.ts:648

---

onViewFilter

▸ Protected onViewFilter(item): boolean

Parameters

Name	Type
item	TItem

Returns

boolean

Inherited from

DataGrid.onViewFilter

Defined in

src/ui/datagrid/datagrid.ts:693

---

onViewProcessData

▸ Protected onViewProcessData(response): ListResponse<TItem>

Parameters

Name	Type
response	ListResponse<TItem>

Returns

ListResponse<TItem>

Inherited from

DataGrid.onViewProcessData

Defined in

src/ui/datagrid/datagrid.ts:689

---

onViewSubmit

▸ Protected onViewSubmit(): boolean

Returns

boolean

Inherited from

DataGrid.onViewSubmit

Defined in

src/ui/datagrid/datagrid.ts:736

---

persistSettings

▸ Protected 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:1407

---

populateLock

▸ Protected populateLock(): void

Returns

void

Inherited from

DataGrid.populateLock

Defined in

src/ui/datagrid/datagrid.ts:978

---

populateUnlock

▸ Protected populateUnlock(): void

Returns

void

Inherited from

DataGrid.populateUnlock

Defined in

src/ui/datagrid/datagrid.ts:982

---

populateWhenVisible

▸ Protected populateWhenVisible(): boolean

Returns

boolean

Inherited from

DataGrid.populateWhenVisible

Defined in

src/ui/datagrid/datagrid.ts:794

---

postProcessColumns

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

Parameters

Name	Type
columns	Column<any>[]

Returns

Column<any>[]

Inherited from

DataGrid.postProcessColumns

Defined in

src/ui/datagrid/datagrid.ts:442

---

propertyItemsToSlickColumns

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

Parameters

Name	Type
propertyItems	PropertyItem[]

Returns

Column<any>[]

Inherited from

DataGrid.propertyItemsToSlickColumns

Defined in

src/ui/datagrid/datagrid.ts:936

---

quickFilterChange

▸ Protected quickFilterChange(e): void

Parameters

Name	Type
e	JQueryEventObject

Returns

void

Inherited from

DataGrid.quickFilterChange

Defined in

src/ui/datagrid/datagrid.ts:1179

---

refresh

▸ refresh(): void

Returns

void

Inherited from

DataGrid.refresh

Defined in

src/ui/datagrid/datagrid.ts:990

---

refreshIfNeeded

▸ Protected refreshIfNeeded(): void

Returns

void

Inherited from

DataGrid.refreshIfNeeded

Defined in

src/ui/datagrid/datagrid.ts:1003

---

renderContents

▸ Protected renderContents(): void

Returns

void

Inherited from

DataGrid.renderContents

Defined in

src/ui/widgets/widget.ts:184

---

resizeCanvas

▸ Protected resizeCanvas(): void

Returns

void

Inherited from

DataGrid.resizeCanvas

Defined in

src/ui/datagrid/datagrid.ts:1121

---

restoreSettings

▸ Protected 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:1244

---

restoreSettingsFrom

▸ Protected restoreSettingsFrom(settings, flags?): void

Parameters

Name	Type
settings	PersistedGridSettings
flags?	GridPersistanceFlags

Returns

void

Inherited from

DataGrid.restoreSettingsFrom

Defined in

src/ui/datagrid/datagrid.ts:1255

---

routeDialog

▸ Protected routeDialog(itemType, dialog): void

Parameters

Name	Type
itemType	string
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:258

---

rowCount

▸ rowCount(): number

Returns

number

Inherited from

DataGrid.rowCount

Defined in

src/ui/datagrid/datagrid.ts:557

---

setCriteriaParameter

▸ Protected setCriteriaParameter(): void

Returns

void

Inherited from

DataGrid.setCriteriaParameter

Defined in

src/ui/datagrid/datagrid.ts:712

---

setEquality

▸ Protected setEquality(field, value): void

Parameters

Name	Type
field	string
value	any

Returns

void

Inherited from

DataGrid.setEquality

Defined in

src/ui/datagrid/datagrid.ts:722

---

setIncludeColumnsParameter

▸ Protected setIncludeColumnsParameter(): void

Returns

void

Inherited from

DataGrid.setIncludeColumnsParameter

Defined in

src/ui/datagrid/datagrid.ts:726

---

setInitialSortOrder

▸ Protected setInitialSortOrder(): void

Returns

void

Inherited from

DataGrid.setInitialSortOrder

Defined in

src/ui/datagrid/datagrid.ts:528

---

setIsDisabled

▸ setIsDisabled(value): void

Parameters

Name	Type
value	boolean

Returns

void

Inherited from

DataGrid.setIsDisabled

Defined in

src/ui/datagrid/datagrid.ts:1014

---

setItems

▸ setItems(value): void

Parameters

Name	Type
value	TItem[]

Returns

void

Inherited from

DataGrid.setItems

Defined in

src/ui/datagrid/datagrid.ts:565

---

setTitle

▸ setTitle(value): void

Parameters

Name	Type
value	string

Returns

void

Inherited from

DataGrid.setTitle

Defined in

src/ui/datagrid/datagrid.ts:852

---

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:1039

---

subDialogDataChange

▸ Protected subDialogDataChange(): void

Returns

void

Inherited from

DataGrid.subDialogDataChange

Defined in

src/ui/datagrid/datagrid.ts:1125

---

transferDialogReadOnly

▸ Protected transferDialogReadOnly(dialog): void

Parameters

Name	Type
dialog	Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:283

---

tryFindQuickFilter

▸ Protected 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:339

---

updateDisabledState

▸ Protected updateDisabledState(): void

Returns

void

Inherited from

DataGrid.updateDisabledState

Defined in

src/ui/datagrid/datagrid.ts:1117

---

updateInterface

▸ updateInterface(): void

Returns

void

Inherited from

DataGrid.updateInterface

Defined in

src/ui/datagrid/datagrid.ts:1046

---

useAsync

▸ Protected useAsync(): boolean

Returns

boolean

Inherited from

DataGrid.useAsync

Defined in

src/ui/datagrid/datagrid.ts:197

---

useLayoutTimer

▸ Protected useLayoutTimer(): boolean

Returns

boolean

Inherited from

DataGrid.useLayoutTimer

Defined in

src/ui/datagrid/datagrid.ts:201

---

usePager

▸ Protected usePager(): boolean

Returns

boolean

Overrides

DataGrid.usePager

Defined in

src/ui/datagrid/entitygrid.ts:59

---

viewDataChanged

▸ Protected viewDataChanged(e, rows): void

Parameters

Name	Type
e	any
rows	TItem[]

Returns

void

Inherited from

DataGrid.viewDataChanged

Defined in

src/ui/datagrid/datagrid.ts:664

---

create

▸ Static create<TWidget, TOpt>(params): TWidget

Type parameters

Name	Type
TWidget	extends Widget<TOpt, TWidget>
TOpt	TOpt

Parameters

Name	Type
params	CreateWidgetParams<TWidget, TOpt>

Returns

TWidget

Inherited from

DataGrid.create

Defined in

src/ui/widgets/widget.ts:153

---

elementFor

▸ Static elementFor<TWidget>(editorType): JQuery

Type parameters

Name
TWidget

Parameters

Name	Type
editorType	(...args: any[]) => TWidget

Returns

JQuery

Inherited from

DataGrid.elementFor

Defined in

src/ui/widgets/widget.ts:128

---

getWidgetName

▸ Static getWidgetName(type): string

Parameters

Name	Type
type	Function

Returns

string

Inherited from

DataGrid.getWidgetName

Defined in

src/ui/widgets/widget.ts:124

---

propertyItemToQuickFilter

▸ Static propertyItemToQuickFilter(item): any

Parameters

Name	Type
item	PropertyItem

Returns

any

Inherited from

DataGrid.propertyItemToQuickFilter

Defined in

src/ui/datagrid/datagrid.ts:278