@serenity-is/corelib / EntityGrid

Class: EntityGrid<TItem, P>

Extends

• DataGrid<TItem, P>

Type Parameters

• TItem

• P = {}

Constructors

new EntityGrid()

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

Parameters

props

WidgetProps<P>

Returns

EntityGrid<TItem, P>

Overrides

DataGrid.constructor

Defined in

src/ui/datagrid/entitygrid.ts:20

Properties

allColumns

protected allColumns: Column<any>[]

Inherited from

DataGrid.allColumns

Defined in

src/ui/datagrid/datagrid.tsx:75

---

domNode

readonly domNode: HTMLElement

Inherited from

DataGrid.domNode

Defined in

src/ui/widgets/widget.ts:17

---

filterBar

protected filterBar: FilterDisplayBar<object>

Inherited from

DataGrid.filterBar

Defined in

src/ui/datagrid/datagrid.tsx:71

---

idPrefix

readonly idPrefix: string

Inherited from

DataGrid.idPrefix

Defined in

src/ui/widgets/widget.ts:16

---

initialSettings

protected initialSettings: PersistedGridSettings

Inherited from

DataGrid.initialSettings

Defined in

src/ui/datagrid/datagrid.tsx:77

---

openDialogsAsPanel

openDialogsAsPanel: boolean

Inherited from

DataGrid.openDialogsAsPanel

Defined in

src/ui/datagrid/datagrid.tsx:81

---

options

protected readonly options: WidgetProps<P>

Inherited from

DataGrid.options

Defined in

src/ui/widgets/widget.ts:14

---

propertyItemsData

protected propertyItemsData: PropertyItemsData

Inherited from

DataGrid.propertyItemsData

Defined in

src/ui/datagrid/datagrid.tsx:76

---

quickFiltersBar

protected quickFiltersBar: QuickFilterBar<QuickFilterBarOptions>

Inherited from

DataGrid.quickFiltersBar

Defined in

src/ui/datagrid/datagrid.tsx:73

---

quickFiltersDiv

protected quickFiltersDiv: Fluent<HTMLElement>

Inherited from

DataGrid.quickFiltersDiv

Defined in

src/ui/datagrid/datagrid.tsx:72

---

restoringSettings

protected restoringSettings: number

Inherited from

DataGrid.restoringSettings

Defined in

src/ui/datagrid/datagrid.tsx:78

---

slickContainer

protected slickContainer: Fluent<HTMLElement>

Inherited from

DataGrid.slickContainer

Defined in

src/ui/datagrid/datagrid.tsx:74

---

slickGrid

slickGrid: Grid<any>

Inherited from

DataGrid.slickGrid

Defined in

src/ui/datagrid/datagrid.tsx:80

---

titleDiv

protected titleDiv: Fluent<HTMLElement>

Inherited from

DataGrid.titleDiv

Defined in

src/ui/datagrid/datagrid.tsx:69

---

toolbar

protected toolbar: Toolbar<ToolbarOptions>

Inherited from

DataGrid.toolbar

Defined in

src/ui/datagrid/datagrid.tsx:70

---

uniqueName

readonly uniqueName: string

Inherited from

DataGrid.uniqueName

Defined in

src/ui/widgets/widget.ts:15

---

view

view: RemoteView<TItem>

Inherited from

DataGrid.view

Defined in

src/ui/datagrid/datagrid.tsx:79

---

defaultColumnWidthDelta

static defaultColumnWidthDelta: number

Inherited from

DataGrid.defaultColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.tsx:87

---

defaultColumnWidthScale

static defaultColumnWidthScale: number

Inherited from

DataGrid.defaultColumnWidthScale

Defined in

src/ui/datagrid/datagrid.tsx:86

---

defaultHeaderHeight

static defaultHeaderHeight: number

Inherited from

DataGrid.defaultHeaderHeight

Defined in

src/ui/datagrid/datagrid.tsx:84

---

defaultPersistanceStorage

static defaultPersistanceStorage: SettingStorage

Inherited from

DataGrid.defaultPersistanceStorage

Defined in

src/ui/datagrid/datagrid.tsx:85

---

defaultRowHeight

static defaultRowHeight: number

Inherited from

DataGrid.defaultRowHeight

Defined in

src/ui/datagrid/datagrid.tsx:83

---

isComponent

readonly static isComponent: true = true

Inherited from

DataGrid.isComponent

Defined in

src/ui/widgets/widget.ts:223

---

typeInfo

static typeInfo: ClassTypeInfo<"Serenity.Widget">

Inherited from

DataGrid.typeInfo

Defined in

src/ui/widgets/widget.ts:11

Accessors

element

Get Signature

get element(): Fluent<HTMLElement>

Returns a Fluent(this.domNode) object

Returns

Fluent<HTMLElement>

Inherited from

DataGrid.element

Defined in

src/ui/widgets/widget.ts:63

---

props

Get Signature

get props(): WidgetProps<P>

Returns

WidgetProps<P>

Inherited from

DataGrid.props

Defined in

src/ui/widgets/widget.ts:207

---

readOnly

Get Signature

get readOnly(): boolean

Returns

boolean

Set Signature

set readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

DataGrid.readOnly

Defined in

src/ui/datagrid/datagrid.tsx:980

Methods

addBooleanFilter()

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

Parameters

field

string

title?

string

yes?

string

no?

string

Returns

SelectEditor<SelectEditorOptions>

Inherited from

DataGrid.addBooleanFilter

Defined in

src/ui/datagrid/datagrid.tsx:1115

---

addButtonClick()

protected addButtonClick(): void

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:210

---

addCssClass()

protected addCssClass(): void

Returns

void

Inherited from

DataGrid.addCssClass

Defined in

src/ui/widgets/widget.ts:67

---

addDateRangeFilter()

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

Parameters

field

string

title?

string

Returns

DateEditor<DateEditorOptions>

Inherited from

DataGrid.addDateRangeFilter

Defined in

src/ui/datagrid/datagrid.tsx:1099

---

addDateTimeRangeFilter()

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

Parameters

field

string

title?

string

Returns

DateTimeEditor<DateTimeEditorOptions>

Inherited from

DataGrid.addDateTimeRangeFilter

Defined in

src/ui/datagrid/datagrid.tsx:1107

---

addFilterSeparator()

protected addFilterSeparator(): void

Returns

void

Inherited from

DataGrid.addFilterSeparator

Defined in

src/ui/datagrid/datagrid.tsx:1079

---

addQuickFilter()

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

Type Parameters

• TWidget extends Widget<any>

• P

Parameters

opt

QuickFilter<TWidget, P>

Returns

TWidget

Inherited from

DataGrid.addQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1095

---

addValidationRule()

Call Signature

addValidationRule(rule, uniqueName?): void

Parameters

rule

(input) => string

uniqueName?

string

Returns

void

Inherited from

DataGrid.addValidationRule

Defined in

src/ui/widgets/widget.ts:99

Call Signature

addValidationRule(uniqueName, rule): void

Parameters

uniqueName

string

rule

(input) => string

Returns

void

Inherited from

DataGrid.addValidationRule

Defined in

src/ui/widgets/widget.ts:100

---

afterInit()

protected afterInit(): void

Returns

void

Inherited from

DataGrid.afterInit

Defined in

src/ui/datagrid/datagrid.tsx:155

---

afterRender()

protected afterRender(callback): void

Parameters

callback

() => void

Returns

void

Inherited from

DataGrid.afterRender

Defined in

src/ui/widgets/widget.ts:146

---

bindToSlickEvents()

protected bindToSlickEvents(): void

Returns

void

Inherited from

DataGrid.bindToSlickEvents

Defined in

src/ui/datagrid/datagrid.tsx:525

---

bindToViewEvents()

protected bindToViewEvents(): void

Returns

void

Inherited from

DataGrid.bindToViewEvents

Defined in

src/ui/datagrid/datagrid.tsx:625

---

booleanQuickFilter()

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

Parameters

field

string

title?

string

yes?

string

no?

string

Returns

QuickFilter<SelectEditor<SelectEditorOptions>, SelectEditorOptions>

Inherited from

DataGrid.booleanQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1119

---

byId()

protected byId<TElement>(id): Fluent<TElement>

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

Fluent<TElement>

Inherited from

DataGrid.byId

Defined in

src/ui/widgets/widget.ts:106

---

canFilterColumn()

protected canFilterColumn(column): boolean

Parameters

column

Column<any>

Returns

boolean

Inherited from

DataGrid.canFilterColumn

Defined in

src/ui/datagrid/datagrid.tsx:438

---

canShowColumn()

protected canShowColumn(column): boolean

Parameters

column

Column<any>

Returns

boolean

Inherited from

DataGrid.canShowColumn

Defined in

src/ui/datagrid/datagrid.tsx:1154

---

change()

change(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

DataGrid.change

Defined in

src/ui/widgets/widget.ts:118

---

changeSelect2()

changeSelect2(handler): void

Parameters

handler

(e) => void

Returns

void

Inherited from

DataGrid.changeSelect2

Defined in

src/ui/widgets/widget.ts:122

---

createEntityDialog()

protected createEntityDialog(itemType, callback?): Widget<any> | PromiseLike<Widget<any>>

Parameters

itemType

string

callback?

(dlg) => void

Returns

Widget<any> | PromiseLike<Widget<any>>

Defined in

src/ui/datagrid/entitygrid.ts:339

---

createFilterBar()

protected createFilterBar(): void

Returns

void

Inherited from

DataGrid.createFilterBar

Defined in

src/ui/datagrid/datagrid.tsx:753

---

createIncludeDeletedButton()

protected createIncludeDeletedButton(): void

Returns

void

Inherited from

DataGrid.createIncludeDeletedButton

Defined in

src/ui/datagrid/datagrid.tsx:305

---

createPager()

protected createPager(): void

Returns

void

Inherited from

DataGrid.createPager

Defined in

src/ui/datagrid/datagrid.tsx:768

---

createQuickFilters()

protected createQuickFilters(filters?): void

Parameters

filters?

QuickFilter<Widget<any>, any>[]

Returns

void

Inherited from

DataGrid.createQuickFilters

Defined in

src/ui/datagrid/datagrid.tsx:203

---

createQuickSearchInput()

protected createQuickSearchInput(): void

Returns

void

Inherited from

DataGrid.createQuickSearchInput

Defined in

src/ui/datagrid/datagrid.tsx:314

---

createSlickContainer()

protected createSlickContainer(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

DataGrid.createSlickContainer

Defined in

src/ui/datagrid/datagrid.tsx:707

---

createSlickGrid()

protected createSlickGrid(): Grid<any>

Returns

Grid<any>

Inherited from

DataGrid.createSlickGrid

Defined in

src/ui/datagrid/datagrid.tsx:461

---

createToolbar()

protected createToolbar(buttons): void

Parameters

buttons

ToolButton[]

Returns

void

Inherited from

DataGrid.createToolbar

Defined in

src/ui/datagrid/datagrid.tsx:794

---

createToolbarExtensions()

protected createToolbarExtensions(): void

Returns

void

Overrides

DataGrid.createToolbarExtensions

Defined in

src/ui/datagrid/entitygrid.ts:83

---

createView()

protected createView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Inherited from

DataGrid.createView

Defined in

src/ui/datagrid/datagrid.tsx:711

---

dateRangeQuickFilter()

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

Parameters

field

string

title?

string

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Inherited from

DataGrid.dateRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1103

---

dateTimeRangeQuickFilter()

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

Parameters

field

string

title?

string

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Inherited from

DataGrid.dateTimeRangeQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:1111

---

deferRender()

protected deferRender(): boolean

Returns

boolean

Inherited from

DataGrid.deferRender

Defined in

src/ui/widgets/widget.ts:71

---

destroy()

destroy(): void

Returns

void

Overrides

DataGrid.destroy

Defined in

src/ui/datagrid/entitygrid.ts:26

---

determineText()

protected determineText(getKey): string

Parameters

getKey

(prefix) => string

Returns

string

Inherited from

DataGrid.determineText

Defined in

src/ui/datagrid/datagrid.tsx:1083

---

editItem()

protected editItem(entityOrId): void

Parameters

entityOrId

any

Returns

void

Overrides

DataGrid.editItem

Defined in

src/ui/datagrid/entitygrid.ts:214

---

editItemOfType()

protected editItemOfType(itemType, entityOrId): void

Parameters

itemType

string

entityOrId

any

Returns

void

Overrides

DataGrid.editItemOfType

Defined in

src/ui/datagrid/entitygrid.ts:231

---

enableFiltering()

protected enableFiltering(): boolean

Returns

boolean

Inherited from

DataGrid.enableFiltering

Defined in

src/ui/datagrid/datagrid.tsx:745

---

ensureQuickFilterBar()

protected ensureQuickFilterBar(): QuickFilterBar<QuickFilterBarOptions>

Returns

QuickFilterBar<QuickFilterBarOptions>

Inherited from

DataGrid.ensureQuickFilterBar

Defined in

src/ui/datagrid/datagrid.tsx:195

---

findById()

protected findById<TElement>(id): TElement

Type Parameters

• TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

DataGrid.findById

Defined in

src/ui/widgets/widget.ts:110

---

findQuickFilter()

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

Type Parameters

• TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

DataGrid.findQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:289

---

get_readOnly()

get_readOnly(): boolean

Returns

boolean

Inherited from

DataGrid.get_readOnly

Defined in

src/ui/datagrid/datagrid.tsx:988

---

getAddButtonCaption()

protected getAddButtonCaption(): string

Returns

string

Overrides

DataGrid.getAddButtonCaption

Defined in

src/ui/datagrid/entitygrid.ts:172

---

getButtons()

protected getButtons(): ToolButton[]

Returns

ToolButton[]

Overrides

DataGrid.getButtons

Defined in

src/ui/datagrid/entitygrid.ts:176

---

getColumns()

protected getColumns(): Column<TItem>[]

Returns

Column<TItem>[]

Inherited from

DataGrid.getColumns

Defined in

src/ui/datagrid/datagrid.tsx:885

---

getColumnsKey()

protected getColumnsKey(): string

Returns

string

Inherited from

DataGrid.getColumnsKey

Defined in

src/ui/datagrid/datagrid.tsx:848

---

getColumnWidthDelta()

protected getColumnWidthDelta(): number

Returns

number

Inherited from

DataGrid.getColumnWidthDelta

Defined in

src/ui/datagrid/datagrid.tsx:415

---

getColumnWidthScale()

protected getColumnWidthScale(): number

Returns

number

Inherited from

DataGrid.getColumnWidthScale

Defined in

src/ui/datagrid/datagrid.tsx:419

---

getCssClass()

protected getCssClass(): string

Returns

string

Inherited from

DataGrid.getCssClass

Defined in

src/ui/widgets/widget.ts:75

---

getCurrentSettings()

protected getCurrentSettings(flags?): PersistedGridSettings

Parameters

flags?

GridPersistanceFlags

Returns

PersistedGridSettings

Inherited from

DataGrid.getCurrentSettings

Defined in

src/ui/datagrid/datagrid.tsx:1367

---

getCustomAttribute()

protected getCustomAttribute<TAttr>(attrType, inherit): TAttr

Type Parameters

• TAttr

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

DataGrid.getCustomAttribute

Defined in

src/ui/widgets/widget.ts:142

---

getDefaultSortBy()

protected getDefaultSortBy(): any[]

Returns

any[]

Inherited from

DataGrid.getDefaultSortBy

Defined in

src/ui/datagrid/datagrid.tsx:716

---

getDialogOptions()

protected getDialogOptions(): any

Returns

any

Defined in

src/ui/datagrid/entitygrid.ts:360

---

getDialogOptionsFor()

protected getDialogOptionsFor(itemType): any

Parameters

itemType

string

Returns

any

Defined in

src/ui/datagrid/entitygrid.ts:364

---

getDialogType()

protected getDialogType(): DialogType | PromiseLike<DialogType>

Returns

DialogType | PromiseLike<DialogType>

Defined in

src/ui/datagrid/entitygrid.ts:382

---

getDialogTypeFor()

protected getDialogTypeFor(itemType): DialogType | PromiseLike<DialogType>

Parameters

itemType

string

Returns

DialogType | PromiseLike<DialogType>

Defined in

src/ui/datagrid/entitygrid.ts:371

---

getDisplayName()

protected getDisplayName(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:134

---

getElement()

getElement(): HTMLElement

Returns

HTMLElement

Inherited from

DataGrid.getElement

Defined in

src/ui/datagrid/datagrid.tsx:1457

---

getEntityType()

protected getEntityType(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:104

---

getFilterStore()

getFilterStore(): FilterStore

Returns

FilterStore

Inherited from

DataGrid.getFilterStore

Defined in

src/ui/datagrid/datagrid.tsx:1469

---

getGrid()

getGrid(): Grid<any>

Returns

Grid<any>

Inherited from

DataGrid.getGrid

Defined in

src/ui/datagrid/datagrid.tsx:1461

---

getGridCanLoad()

protected getGridCanLoad(): boolean

Returns

boolean

Inherited from

DataGrid.getGridCanLoad

Defined in

src/ui/datagrid/datagrid.tsx:939

---

getGridField()

getGridField(): Fluent<HTMLElement>

Returns

Fluent<HTMLElement>

Inherited from

DataGrid.getGridField

Defined in

src/ui/widgets/widget.ts:114

---

getIdProperty()

protected getIdProperty(): string

Returns

string

Inherited from

DataGrid.getIdProperty

Defined in

src/ui/datagrid/datagrid.tsx:1031

---

getIncludeColumns()

protected getIncludeColumns(include): void

Parameters

include

Returns

void

Inherited from

DataGrid.getIncludeColumns

Defined in

src/ui/datagrid/datagrid.tsx:653

---

getInitialTitle()

protected getInitialTitle(): string

Returns

string

Overrides

DataGrid.getInitialTitle

Defined in

src/ui/datagrid/entitygrid.ts:88

---

getInsertPermission()

protected getInsertPermission(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:302

---

getIsActiveProperty()

protected getIsActiveProperty(): string

Returns

string

Inherited from

DataGrid.getIsActiveProperty

Defined in

src/ui/datagrid/datagrid.tsx:1052

---

getIsDeletedProperty()

protected getIsDeletedProperty(): string

Returns

string

Inherited from

DataGrid.getIsDeletedProperty

Defined in

src/ui/datagrid/datagrid.tsx:1046

---

getItemCssClass()

protected getItemCssClass(item, index): string

Parameters

item

TItem

index

number

Returns

string

Inherited from

DataGrid.getItemCssClass

Defined in

src/ui/datagrid/datagrid.tsx:353

---

getItemMetadata()

protected getItemMetadata(item, index): any

Parameters

item

TItem

index

number

Returns

any

Inherited from

DataGrid.getItemMetadata

Defined in

src/ui/datagrid/datagrid.tsx:386

---

getItemName()

protected getItemName(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:154

---

getItems()

getItems(): TItem[]

Returns

TItem[]

Inherited from

DataGrid.getItems

Defined in

src/ui/datagrid/datagrid.tsx:517

---

getItemType()

protected getItemType(): string

Returns

string

Overrides

DataGrid.getItemType

Defined in

src/ui/datagrid/entitygrid.ts:282

---

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

Returns

string

Inherited from

DataGrid.getLocalTextDbPrefix

Defined in

src/ui/datagrid/datagrid.tsx:1009

---

getLocalTextPrefix()

protected getLocalTextPrefix(): string

Returns

string

Overrides

DataGrid.getLocalTextPrefix

Defined in

src/ui/datagrid/entitygrid.ts:92

---

getPagerOptions()

protected getPagerOptions(): PagerOptions

Returns

PagerOptions

Inherited from

DataGrid.getPagerOptions

Defined in

src/ui/datagrid/datagrid.tsx:760

---

getPersistanceKey()

protected getPersistanceKey(): string

Returns

string

Inherited from

DataGrid.getPersistanceKey

Defined in

src/ui/datagrid/datagrid.tsx:1139

---

getPersistanceStorage()

protected getPersistanceStorage(): SettingStorage

Returns

SettingStorage

Inherited from

DataGrid.getPersistanceStorage

Defined in

src/ui/datagrid/datagrid.tsx:1135

---

getPersistedSettings()

protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

DataGrid.getPersistedSettings

Defined in

src/ui/datagrid/datagrid.tsx:1175

---

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Returns

PropertyItem[]

Inherited from

DataGrid.getPropertyItems

Defined in

src/ui/datagrid/datagrid.tsx:852

---

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

Returns

PropertyItemsData

Inherited from

DataGrid.getPropertyItemsData

Defined in

src/ui/datagrid/datagrid.tsx:856

---

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Returns

Promise<PropertyItemsData>

Inherited from

DataGrid.getPropertyItemsDataAsync

Defined in

src/ui/datagrid/datagrid.tsx:876

---

getQuickFilters()

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

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

DataGrid.getQuickFilters

Defined in

src/ui/datagrid/datagrid.tsx:225

---

getQuickSearchFields()

protected getQuickSearchFields(): QuickSearchField[]

Returns

QuickSearchField[]

Inherited from

DataGrid.getQuickSearchFields

Defined in

src/ui/datagrid/datagrid.tsx:310

---

getRowDefinition()

protected getRowDefinition(): IRowDefinition

Returns

IRowDefinition

Inherited from

DataGrid.getRowDefinition

Defined in

src/ui/datagrid/datagrid.tsx:1003

---

getService()

protected getService(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:255

---

getServiceMethod()

protected getServiceMethod(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:268

---

getServiceUrl()

protected getServiceUrl(): string

Returns

string

Defined in

src/ui/datagrid/entitygrid.ts:272

---

getSlickOptions()

protected getSlickOptions(): GridOptions<any>

Returns

GridOptions<any>

Inherited from

DataGrid.getSlickOptions

Defined in

src/ui/datagrid/datagrid.tsx:915

---

getTitle()

getTitle(): string

Returns

string

Inherited from

DataGrid.getTitle

Defined in

src/ui/datagrid/datagrid.tsx:802

---

getView()

getView(): RemoteView<TItem>

Returns

RemoteView<TItem>

Inherited from

DataGrid.getView

Defined in

src/ui/datagrid/datagrid.tsx:1465

---

getViewOptions()

protected getViewOptions(): RemoteViewOptions

Returns

RemoteViewOptions

Overrides

DataGrid.getViewOptions

Defined in

src/ui/datagrid/entitygrid.ts:276

---

gridPersistanceFlags()

protected gridPersistanceFlags(): GridPersistanceFlags

Returns

GridPersistanceFlags

Inherited from

DataGrid.gridPersistanceFlags

Defined in

src/ui/datagrid/datagrid.tsx:1150

---

handleRoute()

protected handleRoute(e): void

Parameters

e

HandleRouteEvent

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:31

---

hasInsertPermission()

protected hasInsertPermission(): boolean

Returns

boolean

Defined in

src/ui/datagrid/entitygrid.ts:306

---

init()

init(): this

Returns

this

Inherited from

DataGrid.init

Defined in

src/ui/widgets/widget.ts:157

---

initDialog()

protected initDialog(dialog): void

Parameters

dialog

Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:316

---

initEntityDialog()

protected initEntityDialog(itemType, dialog): void

Parameters

itemType

string

dialog

Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:325

---

initializeFilterBar()

protected initializeFilterBar(): void

Returns

void

Inherited from

DataGrid.initializeFilterBar

Defined in

src/ui/datagrid/datagrid.tsx:445

---

initialPopulate()

protected initialPopulate(): void

Returns

void

Inherited from

DataGrid.initialPopulate

Defined in

src/ui/datagrid/datagrid.tsx:423

---

internalRefresh()

protected internalRefresh(): void

Returns

void

Inherited from

DataGrid.internalRefresh

Defined in

src/ui/datagrid/datagrid.tsx:963

---

internalRenderContents()

internalRenderContents(): void

Returns

void

Inherited from

DataGrid.internalRenderContents

Defined in

src/ui/widgets/widget.ts:177

---

invokeSubmitHandlers()

protected invokeSubmitHandlers(): void

Returns

void

Inherited from

DataGrid.invokeSubmitHandlers

Defined in

src/ui/datagrid/datagrid.tsx:1123

---

itemAt()

itemAt(row): TItem

Parameters

row

number

Returns

TItem

Inherited from

DataGrid.itemAt

Defined in

src/ui/datagrid/datagrid.tsx:505

---

itemId()

itemId(item): any

Parameters

item

TItem

Returns

any

Inherited from

DataGrid.itemId

Defined in

src/ui/datagrid/datagrid.tsx:509

---

itemLink()

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

Parameters

itemType?

string

idField?

string

text?

Format<TItem>

cssClass?

(ctx) => string

encode?

boolean = true

Returns

Format<TItem>

Inherited from

DataGrid.itemLink

Defined in

src/ui/datagrid/datagrid.tsx:834

---

layout()

protected layout(): void

Returns

void

Inherited from

DataGrid.layout

Defined in

src/ui/datagrid/datagrid.tsx:166

---

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Returns

boolean

Inherited from

DataGrid.legacyTemplateRender

Defined in

src/ui/widgets/widget.ts:194

---

markupReady()

protected markupReady(): void

Returns

void

Inherited from

DataGrid.markupReady

Defined in

src/ui/datagrid/datagrid.tsx:704

---

newRefreshButton()

protected newRefreshButton(noText?): ToolButton

Parameters

noText?

boolean

Returns

ToolButton

Defined in

src/ui/datagrid/entitygrid.ts:197

---

onClick()

protected onClick(e, row, cell): void

Parameters

e

Event

row

number

cell

number

Returns

void

Inherited from

DataGrid.onClick

Defined in

src/ui/datagrid/datagrid.tsx:604

---

onViewFilter()

protected onViewFilter(item): boolean

Parameters

item

TItem

Returns

boolean

Inherited from

DataGrid.onViewFilter

Defined in

src/ui/datagrid/datagrid.tsx:649

---

onViewProcessData()

protected onViewProcessData(response): ListResponse<TItem>

Parameters

response

ListResponse<TItem>

Returns

ListResponse<TItem>

Inherited from

DataGrid.onViewProcessData

Defined in

src/ui/datagrid/datagrid.tsx:645

---

onViewSubmit()

protected onViewSubmit(): boolean

Returns

boolean

Inherited from

DataGrid.onViewSubmit

Defined in

src/ui/datagrid/datagrid.tsx:692

---

persistSettings()

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

Parameters

flags?

GridPersistanceFlags

Returns

void | Promise<void>

Inherited from

DataGrid.persistSettings

Defined in

src/ui/datagrid/datagrid.tsx:1357

---

populateLock()

protected populateLock(): void

Returns

void

Inherited from

DataGrid.populateLock

Defined in

src/ui/datagrid/datagrid.tsx:931

---

populateUnlock()

protected populateUnlock(): void

Returns

void

Inherited from

DataGrid.populateUnlock

Defined in

src/ui/datagrid/datagrid.tsx:935

---

populateWhenVisible()

protected populateWhenVisible(): boolean

Returns

boolean

Inherited from

DataGrid.populateWhenVisible

Defined in

src/ui/datagrid/datagrid.tsx:749

---

postProcessColumns()

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

Parameters

columns

Column<any>[]

Returns

Column<any>[]

Inherited from

DataGrid.postProcessColumns

Defined in

src/ui/datagrid/datagrid.tsx:394

---

propertyItemsReady()

protected propertyItemsReady(itemsData): void

Parameters

itemsData

PropertyItemsData

Returns

void

Inherited from

DataGrid.propertyItemsReady

Defined in

src/ui/datagrid/datagrid.tsx:122

---

propertyItemsToSlickColumns()

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

Parameters

propertyItems

PropertyItem[]

Returns

Column<any>[]

Inherited from

DataGrid.propertyItemsToSlickColumns

Defined in

src/ui/datagrid/datagrid.tsx:904

---

quickFilterChange()

protected quickFilterChange(e): void

Parameters

e

Event

Returns

void

Inherited from

DataGrid.quickFilterChange

Defined in

src/ui/datagrid/datagrid.tsx:1129

---

refresh()

refresh(): void

Returns

void

Inherited from

DataGrid.refresh

Defined in

src/ui/datagrid/datagrid.tsx:943

---

refreshIfNeeded()

protected refreshIfNeeded(): void

Returns

void

Inherited from

DataGrid.refreshIfNeeded

Defined in

src/ui/datagrid/datagrid.tsx:956

---

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

---

renderContents()

protected renderContents(): any

Returns

any

Inherited from

DataGrid.renderContents

Defined in

src/ui/widgets/widget.ts:188

---

resizeCanvas()

protected resizeCanvas(): void

Returns

void

Inherited from

DataGrid.resizeCanvas

Defined in

src/ui/datagrid/datagrid.tsx:1071

---

restoreSettings()

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

Parameters

settings?

PersistedGridSettings

flags?

GridPersistanceFlags

Returns

void | Promise<void>

Inherited from

DataGrid.restoreSettings

Defined in

src/ui/datagrid/datagrid.tsx:1194

---

restoreSettingsFrom()

protected restoreSettingsFrom(settings, flags?): void

Parameters

settings

PersistedGridSettings

flags?

GridPersistanceFlags

Returns

void

Inherited from

DataGrid.restoreSettingsFrom

Defined in

src/ui/datagrid/datagrid.tsx:1205

---

routeDialog()

protected routeDialog(itemType, dialog): void

Parameters

itemType

string

dialog

Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:286

---

rowCount()

rowCount(): number

Returns

number

Inherited from

DataGrid.rowCount

Defined in

src/ui/datagrid/datagrid.tsx:513

---

set_readOnly()

set_readOnly(value): void

Parameters

value

boolean

Returns

void

Inherited from

DataGrid.set_readOnly

Defined in

src/ui/datagrid/datagrid.tsx:992

---

setCriteriaParameter()

protected setCriteriaParameter(): void

Returns

void

Inherited from

DataGrid.setCriteriaParameter

Defined in

src/ui/datagrid/datagrid.tsx:668

---

setEquality()

protected setEquality(field, value): void

Parameters

field

string

value

any

Returns

void

Inherited from

DataGrid.setEquality

Defined in

src/ui/datagrid/datagrid.tsx:678

---

setIncludeColumnsParameter()

protected setIncludeColumnsParameter(): void

Returns

void

Inherited from

DataGrid.setIncludeColumnsParameter

Defined in

src/ui/datagrid/datagrid.tsx:682

---

setInitialSortOrder()

protected setInitialSortOrder(): void

Returns

void

Inherited from

DataGrid.setInitialSortOrder

Defined in

src/ui/datagrid/datagrid.tsx:480

---

setIsDisabled()

setIsDisabled(value): void

Parameters

value

boolean

Returns

void

Inherited from

DataGrid.setIsDisabled

Defined in

src/ui/datagrid/datagrid.tsx:967

---

setItems()

setItems(value): void

Parameters

value

TItem[]

Returns

void

Inherited from

DataGrid.setItems

Defined in

src/ui/datagrid/datagrid.tsx:521

---

setTitle()

setTitle(value): void

Parameters

value

string

Returns

void

Inherited from

DataGrid.setTitle

Defined in

src/ui/datagrid/datagrid.tsx:810

---

subDialogDataChange()

protected subDialogDataChange(): void

Returns

void

Inherited from

DataGrid.subDialogDataChange

Defined in

src/ui/datagrid/datagrid.tsx:1075

---

syncOrAsyncThen()

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

Type Parameters

• T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

DataGrid.syncOrAsyncThen

Defined in

src/ui/widgets/widget.ts:211

---

transferDialogReadOnly()

protected transferDialogReadOnly(dialog): void

Parameters

dialog

Widget<any>

Returns

void

Defined in

src/ui/datagrid/entitygrid.ts:311

---

tryFindQuickFilter()

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

Type Parameters

• TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

DataGrid.tryFindQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:297

---

updateDisabledState()

protected updateDisabledState(): void

Returns

void

Inherited from

DataGrid.updateDisabledState

Defined in

src/ui/datagrid/datagrid.tsx:1067

---

updateInterface()

updateInterface(): void

Returns

void

Inherited from

DataGrid.updateInterface

Defined in

src/ui/datagrid/datagrid.tsx:999

---

useAsync()

protected useAsync(): boolean

Returns

boolean

Inherited from

DataGrid.useAsync

Defined in

src/ui/datagrid/datagrid.tsx:158

---

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Returns

IdPrefixType

Inherited from

DataGrid.useIdPrefix

Defined in

src/ui/widgets/widget.ts:218

---

useLayoutTimer()

protected useLayoutTimer(): boolean

Returns

boolean

Inherited from

DataGrid.useLayoutTimer

Defined in

src/ui/datagrid/datagrid.tsx:162

---

usePager()

protected usePager(): boolean

Returns

boolean

Overrides

DataGrid.usePager

Defined in

src/ui/datagrid/entitygrid.ts:79

---

viewDataChanged()

protected viewDataChanged(e, rows): void

Parameters

e

any

rows

TItem[]

Returns

void

Inherited from

DataGrid.viewDataChanged

Defined in

src/ui/datagrid/datagrid.tsx:620

---

wrapFormatterWithEditLink()

protected wrapFormatterWithEditLink(column, item): void

Parameters

column

Column<any>

item

PropertyItem

Returns

void

Inherited from

DataGrid.wrapFormatterWithEditLink

Defined in

src/ui/datagrid/datagrid.tsx:889

---

create()

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

Type Parameters

• TWidget extends Widget<P>

• P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

DataGrid.create

Defined in

src/ui/widgets/widget.ts:130

---

createDefaultElement()

static createDefaultElement(): HTMLElement

Returns

HTMLElement

Inherited from

DataGrid.createDefaultElement

Defined in

src/ui/widgets/widget.ts:56

---

getWidgetName()

static getWidgetName(type): string

Parameters

type

Function

Returns

string

Inherited from

DataGrid.getWidgetName

Defined in

src/ui/widgets/widget.ts:95

---

propertyItemToQuickFilter()

static propertyItemToQuickFilter(item): any

Parameters

item

PropertyItem

Returns

any

Inherited from

DataGrid.propertyItemToQuickFilter

Defined in

src/ui/datagrid/datagrid.tsx:235