Creates initial column set for this grid. This column set is then passed to postProcessColumns to adjust widths etc, and then used as the initial columns for the slickgrid.

Returns

Column<TItem>[]

Inherited from

DataGrid.createColumns

createEntityDialog()

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

Defined in: src/ui/datagrid/entitygrid.ts:337

Parameters

itemType

string

callback?

(dlg) => void

Returns

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

createFilterBar()

protected createFilterBar(): void

Defined in: src/ui/datagrid/entitygrid.ts:191

Returns

void

Overrides

DataGrid.createFilterBar

createIncludeDeletedButton()

protected createIncludeDeletedButton(): void

Defined in: src/ui/datagrid/datagrid.tsx:250

Returns

void

Inherited from

DataGrid.createIncludeDeletedButton

createPager()

protected createPager(): void

Defined in: src/ui/datagrid/datagrid.tsx:668

Returns

void

Inherited from

DataGrid.createPager

createQuickFilters()

protected createQuickFilters(filters?): void

Defined in: src/ui/datagrid/datagrid.tsx:198

Parameters

filters?

QuickFilter<Widget<any>, any>[]

Returns

void

Inherited from

DataGrid.createQuickFilters

createQuickSearchInput()

protected createQuickSearchInput(): void

Defined in: src/ui/datagrid/datagrid.tsx:259

Returns

void

Inherited from

DataGrid.createQuickSearchInput

createSleekColumns()

protected createSleekColumns(): Column<TItem>[]

Defined in: src/ui/datagrid/datagrid.tsx:398

Creates the SleekGrid columns. This method calls createColumns (via getColumns for compatibility) and then post processes them.

Returns

Column<TItem>[]

The SleekGrid columns.

Inherited from

DataGrid.createSleekColumns

createSlickContainer()

protected createSlickContainer(): Fluent

Defined in: src/ui/datagrid/datagrid.tsx:622

Returns

Fluent

Inherited from

DataGrid.createSlickContainer

createSlickGrid()

protected createSlickGrid(): ISleekGrid<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:404

Override initSleekGrid to add plugins to the sleekgrid

Returns

ISleekGrid<TItem>

Inherited from

DataGrid.createSlickGrid

createToolbar()

protected createToolbar(buttons): void

Defined in: src/ui/datagrid/datagrid.tsx:694

Parameters

buttons

ToolButton[]

Returns

void

Inherited from

DataGrid.createToolbar

createToolbarExtensions()

protected createToolbarExtensions(): void

Defined in: src/ui/datagrid/entitygrid.ts:84

Returns

void

Overrides

DataGrid.createToolbarExtensions

createView()

protected createView(): IRemoteView<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:626

Returns

IRemoteView<TItem>

Inherited from

DataGrid.createView

dateRangeQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1032

Parameters

field

string

title?

string

Returns

QuickFilter<DateEditor<DateEditorOptions>, DateTimeEditorOptions>

Inherited from

DataGrid.dateRangeQuickFilter

dateTimeRangeQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:1040

Parameters

field

string

title?

string

Returns

QuickFilter<DateTimeEditor<DateTimeEditorOptions>, DateTimeEditorOptions>

Inherited from

DataGrid.dateTimeRangeQuickFilter

deferRender()

protected deferRender(): boolean

Defined in: src/ui/widgets/widget.ts:67

Returns

boolean

Inherited from

DataGrid.deferRender

destroy()

destroy(): void

Defined in: src/ui/datagrid/entitygrid.ts:27

Returns

void

Overrides

DataGrid.destroy

determineText()

protected determineText(getKey): string

Defined in: src/ui/datagrid/datagrid.tsx:1012

Parameters

getKey

(prefix) => string

Returns

string

Inherited from

DataGrid.determineText

editItem()

protected editItem(entityOrId): void

Defined in: src/ui/datagrid/entitygrid.ts:218

Parameters

entityOrId

any

Returns

void

Overrides

DataGrid.editItem

editItemOfType()

protected editItemOfType(itemType, entityOrId): void

Defined in: src/ui/datagrid/entitygrid.ts:235

Parameters

itemType

string

entityOrId

any

Returns

void

Overrides

DataGrid.editItemOfType

EditLink()

EditLink(props): any

Defined in: src/ui/datagrid/datagrid.tsx:740

Renders an edit link for the item in current row. Returns a DocumentFragment for non-data rows, and an anchor element otherwise.

Parameters

props

children?

any

The link text. If not provided it will be taken from ctx.escape(ctx.value)

context?

FormatterContext

formatter context (contains item, value etc)

cssClass?

string

Extra CSS class to add to the link element besides s-EditLink. Optional.

id?

string

The id of the entity to link to. If not provided it will be taken from ctx.item[idField]

idField?

string

The name of the field in item that contains the entity id. Defaults to idProperty. Used if id is not provided.

itemType?

string

The item type to link to. Defaults to this.getItemType()

tabindex?

number

The tabindex to assign to the link, default is undefined

tabIndex?

number

Deprecated

Use tabindex.

Returns

any

Inherited from

DataGrid.EditLink

enableAdvancedFiltering()

protected enableAdvancedFiltering(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:639

Returns

boolean

Inherited from

DataGrid.enableAdvancedFiltering

ensureQuickFilterBar()

protected ensureQuickFilterBar(): QuickFilterBar

Defined in: src/ui/datagrid/datagrid.tsx:190

Returns

QuickFilterBar

Inherited from

DataGrid.ensureQuickFilterBar

filterStoreChanged()

protected filterStoreChanged(): void

Defined in: src/ui/datagrid/entitygrid.ts:196

Returns

void

Overrides

DataGrid.filterStoreChanged

findById()

protected findById<TElement>(id): TElement

Defined in: src/ui/widgets/widget.ts:106

Type Parameters

TElement

TElement extends HTMLElement = HTMLElement

Parameters

id

string

Returns

TElement

Inherited from

DataGrid.findById

findQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:234

Type Parameters

TWidget

TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

DataGrid.findQuickFilter

get_readOnly()

get_readOnly(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:929

Returns

boolean

Inherited from

DataGrid.get_readOnly

getAddButtonCaption()

protected getAddButtonCaption(): string

Defined in: src/ui/datagrid/entitygrid.ts:146

Returns

string

Overrides

DataGrid.getAddButtonCaption

getButtons()

protected getButtons(): ToolButton[]

Defined in: src/ui/datagrid/entitygrid.ts:150

Returns

ToolButton[]

Overrides

DataGrid.getButtons

getColumns()

protected getColumns(): Column<TItem>[]

Defined in: src/ui/datagrid/datagrid.tsx:822

Returns

Column<TItem>[]

Deprecated

override createColumns

Inherited from

DataGrid.getColumns

getColumnsKey()

protected getColumnsKey(): string

Defined in: src/ui/datagrid/datagrid.tsx:784

Returns

string

Inherited from

DataGrid.getColumnsKey

getColumnWidthDelta()

protected getColumnWidthDelta(): number

Defined in: src/ui/datagrid/datagrid.tsx:336

Returns

number

Inherited from

DataGrid.getColumnWidthDelta

getColumnWidthScale()

protected getColumnWidthScale(): number

Defined in: src/ui/datagrid/datagrid.tsx:340

Returns

number

Inherited from

DataGrid.getColumnWidthScale

getCssClass()

protected getCssClass(): string

Defined in: src/ui/widgets/widget.ts:71

Returns

string

Inherited from

DataGrid.getCssClass

getCurrentSettings()

getCurrentSettings(flags?): PersistedGridSettings

Defined in: src/ui/datagrid/datagrid.tsx:1208

Parameters

getCustomAttribute()

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

Defined in: src/ui/widgets/widget.ts:138

Type Parameters

TAttr

TAttr extends CustomAttribute

Parameters

attrType

(...args) => TAttr

inherit

boolean = true

Returns

TAttr

Inherited from

DataGrid.getCustomAttribute

getDefaultSortBy()

protected getDefaultSortBy(): any[]

Defined in: src/ui/datagrid/datagrid.tsx:631

Returns

any[]

Inherited from

DataGrid.getDefaultSortBy

getDialogOptions()

protected getDialogOptions(): any

Defined in: src/ui/datagrid/entitygrid.ts:358

Returns

any

getDialogOptionsFor()

protected getDialogOptionsFor(itemType): any

Defined in: src/ui/datagrid/entitygrid.ts:362

Parameters

itemType

string

Returns

any

getDialogType()

protected getDialogType(): DialogType | PromiseLike<DialogType>

Defined in: src/ui/datagrid/entitygrid.ts:380

Returns

DialogType | PromiseLike<DialogType>

getDialogTypeFor()

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

Defined in: src/ui/datagrid/entitygrid.ts:369

Parameters

itemType

string

Returns

DialogType | PromiseLike<DialogType>

getDisplayName()

protected getDisplayName(): string

Defined in: src/ui/datagrid/entitygrid.ts:130

Returns

string

getElement()

getElement(): HTMLElement

Defined in: src/ui/datagrid/datagrid.tsx:1238

Returns

HTMLElement

Inherited from

DataGrid.getElement

getEntityType()

protected getEntityType(): string

Defined in: src/ui/datagrid/entitygrid.ts:105

Returns

string

getFilterStore()

getFilterStore(): FilterStore

Defined in: src/ui/datagrid/datagrid.tsx:1256

Returns

FilterStore

Inherited from

DataGrid.getFilterStore

getGrid()

getGrid(): ISleekGrid<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:1242

Returns

ISleekGrid<TItem>

Inherited from

DataGrid.getGrid

getGridCanLoad()

protected getGridCanLoad(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:874

Returns

boolean

Inherited from

DataGrid.getGridCanLoad

getGridField()

getGridField(): Fluent

Defined in: src/ui/widgets/widget.ts:110

Returns

Fluent

Inherited from

DataGrid.getGridField

getIdProperty()

protected getIdProperty(): string

Defined in: src/ui/datagrid/datagrid.tsx:972

Returns

string

Inherited from

DataGrid.getIdProperty

getIncludeColumns()

protected getIncludeColumns(include): void

Defined in: src/ui/datagrid/datagrid.tsx:570

Parameters

include

Returns

void

Inherited from

DataGrid.getIncludeColumns

getInitialTitle()

protected getInitialTitle(): string

Defined in: src/ui/datagrid/entitygrid.ts:89

Returns

string

Overrides

DataGrid.getInitialTitle

getInsertPermission()

protected getInsertPermission(): string

Defined in: src/ui/datagrid/entitygrid.ts:300

Returns

string

getIsActiveProperty()

protected getIsActiveProperty(): string

Defined in: src/ui/datagrid/datagrid.tsx:989

Returns

string

Inherited from

DataGrid.getIsActiveProperty

getIsDeletedProperty()

protected getIsDeletedProperty(): string

Defined in: src/ui/datagrid/datagrid.tsx:983

Returns

string

Inherited from

DataGrid.getIsDeletedProperty

getItemCssClass()

protected getItemCssClass(item, index): string

Defined in: src/ui/datagrid/datagrid.tsx:303

Parameters

item

TItem

index

number

Returns

string

Inherited from

DataGrid.getItemCssClass

getItemMetadata()

protected getItemMetadata(item, index): any

Defined in: src/ui/datagrid/datagrid.tsx:307

Parameters

item

TItem

index

number

Returns

any

Inherited from

DataGrid.getItemMetadata

getItemName()

protected getItemName(): string

Defined in: src/ui/datagrid/entitygrid.ts:139

Returns

string

getItems()

getItems(): TItem[]

Defined in: src/ui/datagrid/datagrid.tsx:453

Returns

TItem[]

Inherited from

DataGrid.getItems

getItemType()

protected getItemType(): string

Defined in: src/ui/datagrid/entitygrid.ts:280

Returns

string

Overrides

DataGrid.getItemType

getLocalTextDbPrefix()

protected getLocalTextDbPrefix(): string

Defined in: src/ui/datagrid/datagrid.tsx:950

Returns

string

Inherited from

DataGrid.getLocalTextDbPrefix

getLocalTextPrefix()

protected getLocalTextPrefix(): string

Defined in: src/ui/datagrid/entitygrid.ts:93

Returns

string

Overrides

DataGrid.getLocalTextPrefix

getPagerOptions()

protected getPagerOptions(): PagerOptions

Defined in: src/ui/datagrid/datagrid.tsx:660

Returns

PagerOptions

Inherited from

DataGrid.getPagerOptions

getPersistedSettings()

protected getPersistedSettings(): PersistedGridSettings | Promise<PersistedGridSettings>

Defined in: src/ui/datagrid/datagrid.tsx:1110

Returns

PersistedGridSettings | Promise<PersistedGridSettings>

Inherited from

DataGrid.getPersistedSettings

getPersistenceKey()

protected getPersistenceKey(): string

Defined in: src/ui/datagrid/datagrid.tsx:1070

Returns

string

Inherited from

DataGrid.getPersistenceKey

getPersistenceStorage()

protected getPersistenceStorage(): SettingStorage

Defined in: src/ui/datagrid/datagrid.tsx:1064

Returns

SettingStorage

Inherited from

DataGrid.getPersistenceStorage

getPropertyItems()

protected getPropertyItems(): PropertyItem[]

Defined in: src/ui/datagrid/datagrid.tsx:788

Returns

PropertyItem[]

Inherited from

DataGrid.getPropertyItems

getPropertyItemsData()

protected getPropertyItemsData(): PropertyItemsData

Defined in: src/ui/datagrid/datagrid.tsx:792

Returns

PropertyItemsData

Inherited from

DataGrid.getPropertyItemsData

getPropertyItemsDataAsync()

protected getPropertyItemsDataAsync(): Promise<PropertyItemsData>

Defined in: src/ui/datagrid/datagrid.tsx:812

Returns

Promise<PropertyItemsData>

Inherited from

DataGrid.getPropertyItemsDataAsync

getQuickFilters()

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

Defined in: src/ui/datagrid/datagrid.tsx:220

Returns

QuickFilter<Widget<any>, any>[]

Inherited from

DataGrid.getQuickFilters

getQuickSearchFields()

protected getQuickSearchFields(): QuickSearchField[]

Defined in: src/ui/datagrid/datagrid.tsx:255

Returns

QuickSearchField[]

Inherited from

DataGrid.getQuickSearchFields

getRowDefinition()

protected getRowDefinition(): IRowDefinition

Defined in: src/ui/datagrid/datagrid.tsx:944

Returns

IRowDefinition

Inherited from

DataGrid.getRowDefinition

getService()

protected getService(): string

Defined in: src/ui/datagrid/entitygrid.ts:259

Returns

string

getServiceMethod()

protected getServiceMethod(): string

Defined in: src/ui/datagrid/entitygrid.ts:266

Returns

string

getServiceUrl()

protected getServiceUrl(): string

Defined in: src/ui/datagrid/entitygrid.ts:270

Returns

string

getSlickOptions()

protected getSlickOptions(): GridOptions

Defined in: src/ui/datagrid/datagrid.tsx:852

Returns

GridOptions

Inherited from

DataGrid.getSlickOptions

getTitle()

getTitle(): string

Defined in: src/ui/datagrid/datagrid.tsx:702

Returns

string

Inherited from

DataGrid.getTitle

getView()

getView(): IRemoteView<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:1252

Returns

IRemoteView<TItem>

Inherited from

DataGrid.getView

getViewOptions()

protected getViewOptions(): RemoteViewOptions

Defined in: src/ui/datagrid/entitygrid.ts:274

Returns

RemoteViewOptions

Overrides

DataGrid.getViewOptions

gridPersistenceFlags()

protected gridPersistenceFlags(): GridPersistenceFlags

Defined in: src/ui/datagrid/datagrid.tsx:1083

Returns

GridPersistenceFlags

Inherited from

DataGrid.gridPersistenceFlags

handleGridClick()

protected handleGridClick(e): void

Defined in: src/ui/datagrid/datagrid.tsx:466

Parameters

e

CellMouseEvent

Returns

void

Inherited from

DataGrid.handleGridClick

handleGridColumnsReordered()

protected handleGridColumnsReordered(): void

Defined in: src/ui/datagrid/datagrid.tsx:470

Returns

void

Inherited from

DataGrid.handleGridColumnsReordered

handleGridColumnsResized()

protected handleGridColumnsResized(): void

Defined in: src/ui/datagrid/datagrid.tsx:474

Returns

void

Inherited from

DataGrid.handleGridColumnsResized

handleGridSort()

protected handleGridSort(e): void

Defined in: src/ui/datagrid/datagrid.tsx:461

Parameters

e

GridSortEvent

Returns

void

Inherited from

DataGrid.handleGridSort

handleRoute()

protected handleRoute(e): void

Defined in: src/ui/datagrid/entitygrid.ts:32

Parameters

e

HandleRouteEvent

Returns

void

handleViewFilter()

protected handleViewFilter(item): boolean

Defined in: src/ui/datagrid/datagrid.tsx:537

Parameters

item

TItem

Returns

boolean

Inherited from

DataGrid.handleViewFilter

handleViewProcessData()

protected handleViewProcessData(response): ListResponse<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:546

Parameters

response

ListResponse<TItem>

Returns

ListResponse<TItem>

Inherited from

DataGrid.handleViewProcessData

handleViewSubmit()

protected handleViewSubmit(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:553

Returns

boolean

Inherited from

DataGrid.handleViewSubmit

hasInsertPermission()

protected hasInsertPermission(): boolean

Defined in: src/ui/datagrid/entitygrid.ts:304

Returns

boolean

init()

init(): this

Defined in: src/ui/widgets/widget.ts:153

Returns

this

Inherited from

DataGrid.init

initDialog()

protected initDialog(dialog): void

Defined in: src/ui/datagrid/entitygrid.ts:314

Parameters

dialog

Widget<any>

Returns

void

initEntityDialog()

protected initEntityDialog(itemType, dialog): void

Defined in: src/ui/datagrid/entitygrid.ts:323

Parameters

itemType

string

dialog

Widget<any>

Returns

void

initializeFilterBar()

protected initializeFilterBar(): void

Defined in: src/ui/datagrid/datagrid.tsx:366

Returns

void

Inherited from

DataGrid.initializeFilterBar

initialPopulate()

protected initialPopulate(): void

Defined in: src/ui/datagrid/datagrid.tsx:344

Returns

void

Inherited from

DataGrid.initialPopulate

initSleekGrid()

protected initSleekGrid(): void

Defined in: src/ui/datagrid/datagrid.tsx:413

Returns

void

Inherited from

DataGrid.initSleekGrid

internalRefresh()

protected internalRefresh(): void

Defined in: src/ui/datagrid/datagrid.tsx:915

Returns

void

Inherited from

DataGrid.internalRefresh

internalRenderContents()

internalRenderContents(): void

Defined in: src/ui/widgets/widget.ts:173

Returns

void

Inherited from

DataGrid.internalRenderContents

invokeSubmitHandlers()

protected invokeSubmitHandlers(): void

Defined in: src/ui/datagrid/datagrid.tsx:1052

Returns

void

Inherited from

DataGrid.invokeSubmitHandlers

itemAt()

itemAt(row): TItem

Defined in: src/ui/datagrid/datagrid.tsx:441

Parameters

row

number

Returns

TItem

Inherited from

DataGrid.itemAt

itemId()

itemId(item): any

Defined in: src/ui/datagrid/datagrid.tsx:445

Parameters

item

TItem

Returns

any

Inherited from

DataGrid.itemId

itemLink()

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

Defined in: src/ui/datagrid/datagrid.tsx:734

Parameters

itemType?

string

idField?

string

text?

Format<TItem>

cssClass?

(ctx) => string

encode?

boolean = true

Returns

Format<TItem>

Inherited from

DataGrid.itemLink

layout()

protected layout(): void

Defined in: src/ui/datagrid/datagrid.tsx:161

Returns

void

Inherited from

DataGrid.layout

legacyTemplateRender()

protected legacyTemplateRender(): boolean

Defined in: src/ui/widgets/widget.ts:190

Returns

boolean

Inherited from

DataGrid.legacyTemplateRender

markupReady()

protected markupReady(): void

Defined in: src/ui/datagrid/datagrid.tsx:618

Returns

void

Inherited from

DataGrid.markupReady

newRefreshButton()

protected newRefreshButton(noText?): ToolButton

Defined in: src/ui/datagrid/entitygrid.ts:201

Parameters

noText?

boolean

Returns

ToolButton

onClick()

protected onClick(e, row, cell): void

Defined in: src/ui/datagrid/datagrid.tsx:507

Parameters

e

Event

row

number

cell

number

Returns

void

Inherited from

DataGrid.onClick

onViewFilter()

protected onViewFilter(item): boolean

Defined in: src/ui/datagrid/datagrid.tsx:566

Parameters

item

TItem

Returns

boolean

Inherited from

DataGrid.onViewFilter

onViewProcessData()

protected onViewProcessData(response): ListResponse<TItem>

Defined in: src/ui/datagrid/datagrid.tsx:562

Parameters

response

ListResponse<TItem>

Returns

ListResponse<TItem>

Inherited from

DataGrid.onViewProcessData

onViewSubmit()

protected onViewSubmit(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:609

Returns

boolean

Inherited from

DataGrid.onViewSubmit

persistenceLock()

persistenceLock(): void

Defined in: src/ui/datagrid/datagrid.tsx:1187

Returns

void

Inherited from

DataGrid.persistenceLock

persistenceUnlock()

persistenceUnlock(): void

Defined in: src/ui/datagrid/datagrid.tsx:1191

Returns

void

Inherited from

DataGrid.persistenceUnlock

persistSettings()

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

Defined in: src/ui/datagrid/datagrid.tsx:1195

Parameters

flags?

GridPersistenceFlags

Returns

void | Promise<void>

Inherited from

DataGrid.persistSettings

populateLock()

protected populateLock(): void

Defined in: src/ui/datagrid/datagrid.tsx:866

Returns

void

Inherited from

DataGrid.populateLock

populateUnlock()

protected populateUnlock(): void

Defined in: src/ui/datagrid/datagrid.tsx:870

Returns

void

Inherited from

DataGrid.populateUnlock

populateWhenVisible()

protected populateWhenVisible(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:646

Returns

boolean

Inherited from

DataGrid.populateWhenVisible

postProcessColumns()

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

Defined in: src/ui/datagrid/datagrid.tsx:315

Parameters

columns

Column<any>[]

Returns

Column<any>[]

Inherited from

DataGrid.postProcessColumns

prepareSubmit()

prepareSubmit(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:886

Prepares submit arguments in this.view.params by calling this.view.onSubmit if available, or this.handleViewSubmit if not. Note that if getGridCanLoad returns false, the prepared arguments might be in a incomplete state.

Returns

boolean

Inherited from

DataGrid.prepareSubmit

propertyItemsReady()

protected propertyItemsReady(itemsData): void

Defined in: src/ui/datagrid/datagrid.tsx:112

Parameters

itemsData

PropertyItemsData

Returns

void

Inherited from

DataGrid.propertyItemsReady

propertyItemsToColumns()

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

Defined in: src/ui/datagrid/datagrid.tsx:841

Parameters

propertyItems

PropertyItem[]

Returns

Column<any>[]

Inherited from

DataGrid.propertyItemsToColumns

quickFilterChange()

protected quickFilterChange(e): void

Defined in: src/ui/datagrid/datagrid.tsx:1058

Parameters

e

Event

Returns

void

Inherited from

DataGrid.quickFilterChange

refresh()

refresh(): void

Defined in: src/ui/datagrid/datagrid.tsx:895

Returns

void

Inherited from

DataGrid.refresh

refreshIfNeeded()

protected refreshIfNeeded(): void

Defined in: src/ui/datagrid/datagrid.tsx:908

Returns

void

Inherited from

DataGrid.refreshIfNeeded

render()

render(): any

Defined in: src/ui/widgets/widget.ts:163

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

renderContents()

protected renderContents(): any

Defined in: src/ui/widgets/widget.ts:184

Returns

any

Inherited from

DataGrid.renderContents

resizeCanvas()

protected resizeCanvas(): void

Defined in: src/ui/datagrid/datagrid.tsx:1000

Returns

void

Inherited from

DataGrid.resizeCanvas

restoreSettings()

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

Defined in: src/ui/datagrid/datagrid.tsx:1129

Parameters

settings?

PersistedGridSettings

flags?

GridPersistenceFlags

Returns

void | Promise<void>

Inherited from

DataGrid.restoreSettings

restoreSettingsFrom()

protected restoreSettingsFrom(settings, flags?): void

Defined in: src/ui/datagrid/datagrid.tsx:1140

Parameters

settings

PersistedGridSettings

flags?

GridPersistenceFlags

Returns

void

Inherited from

DataGrid.restoreSettingsFrom

routeDialog()

protected routeDialog(itemType, dialog): void

Defined in: src/ui/datagrid/entitygrid.ts:284

Parameters

itemType

string

dialog

Widget<any>

Returns

void

rowCount()

rowCount(): number

Defined in: src/ui/datagrid/datagrid.tsx:449

Returns

number

Inherited from

DataGrid.rowCount

set_readOnly()

set_readOnly(value): void

Defined in: src/ui/datagrid/datagrid.tsx:933

Parameters

value

boolean

Returns

void

Inherited from

DataGrid.set_readOnly

setCriteriaParameter()

protected setCriteriaParameter(): void

Defined in: src/ui/datagrid/datagrid.tsx:585

Returns

void

Inherited from

DataGrid.setCriteriaParameter

setEquality()

protected setEquality(field, value): void

Defined in: src/ui/datagrid/datagrid.tsx:595

Parameters

field

string

value

any

Returns

void

Inherited from

DataGrid.setEquality

setFilterBarVisibility()

protected setFilterBarVisibility(): void

Defined in: src/ui/datagrid/entitygrid.ts:181

Returns

void

setIncludeColumnsParameter()

protected setIncludeColumnsParameter(): void

Defined in: src/ui/datagrid/datagrid.tsx:599

Returns

void

Inherited from

DataGrid.setIncludeColumnsParameter

setInitialSortOrder()

protected setInitialSortOrder(): void

Defined in: src/ui/datagrid/datagrid.tsx:416

Returns

void

Inherited from

DataGrid.setInitialSortOrder

setItems()

setItems(value): void

Defined in: src/ui/datagrid/datagrid.tsx:457

Parameters

value

TItem[]

Returns

void

Inherited from

DataGrid.setItems

setTitle()

setTitle(value): void

Defined in: src/ui/datagrid/datagrid.tsx:710

Parameters

value

string

Returns

void

Inherited from

DataGrid.setTitle

subDialogDataChange()

protected subDialogDataChange(): void

Defined in: src/ui/datagrid/datagrid.tsx:1004

Returns

void

Inherited from

DataGrid.subDialogDataChange

syncOrAsyncThen()

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

Defined in: src/ui/widgets/widget.ts:207

Type Parameters

T

T

Parameters

syncMethod

() => T

asyncMethod

() => PromiseLike<T>

then

(v) => void

Returns

void

Inherited from

DataGrid.syncOrAsyncThen

transferDialogReadOnly()

protected transferDialogReadOnly(dialog): void

Defined in: src/ui/datagrid/entitygrid.ts:309

Parameters

dialog

Widget<any>

Returns

void

tryFindQuickFilter()

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

Defined in: src/ui/datagrid/datagrid.tsx:242

Type Parameters

TWidget

TWidget

Parameters

type

(...args) => TWidget

field

string

Returns

TWidget

Inherited from

DataGrid.tryFindQuickFilter

updateInterface()

updateInterface(): void

Defined in: src/ui/datagrid/datagrid.tsx:940

Returns

void

Inherited from

DataGrid.updateInterface

useAsync()

protected useAsync(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:153

Returns

boolean

Inherited from

DataGrid.useAsync

useIdPrefix()

protected useIdPrefix(): IdPrefixType

Defined in: src/ui/widgets/widget.ts:214

Returns

IdPrefixType

Inherited from

DataGrid.useIdPrefix

useLayoutTimer()

protected useLayoutTimer(): boolean

Defined in: src/ui/datagrid/datagrid.tsx:157

Returns

boolean

Inherited from

DataGrid.useLayoutTimer

usePager()

protected usePager(): boolean

Defined in: src/ui/datagrid/entitygrid.ts:80

Returns

boolean

Overrides

DataGrid.usePager

viewDataChanged()

protected viewDataChanged(): void

Defined in: src/ui/datagrid/datagrid.tsx:523

Returns

void

Inherited from

DataGrid.viewDataChanged

wrapFormatterWithEditLink()

protected wrapFormatterWithEditLink(column, item): void

Defined in: src/ui/datagrid/datagrid.tsx:826

Parameters

column

Column

item

PropertyItem

Returns

void

Inherited from

DataGrid.wrapFormatterWithEditLink

create()

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

Defined in: src/ui/widgets/widget.ts:126

Type Parameters

TWidget

TWidget extends Widget<P>

P

P

Parameters

params

CreateWidgetParams<TWidget, P>

Returns

TWidget

Inherited from

DataGrid.create

createDefaultElement()

static createDefaultElement(): HTMLElement

Defined in: src/ui/widgets/widget.ts:52

Returns

HTMLElement

Inherited from

DataGrid.createDefaultElement

getWidgetName()

static getWidgetName(type): string

Defined in: src/ui/widgets/widget.ts:91

Parameters

type

Function

Returns

string

Inherited from

DataGrid.getWidgetName

propertyItemToQuickFilter()

static propertyItemToQuickFilter(item): QuickFilter<any, any>

Defined in: src/ui/datagrid/datagrid.tsx:230

Parameters

item

PropertyItem

Returns

QuickFilter<any, any>

Inherited from

DataGrid.propertyItemToQuickFilter

registerClass()

protected static registerClass<TypeName>(typeName, intfAndAttr?): ClassTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:221

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

ClassTypeInfo<TypeName>

Inherited from

DataGrid.registerClass

registerEditor()

protected static registerEditor<TypeName>(typeName, intfAndAttr?): EditorTypeInfo<TypeName>

Defined in: src/ui/widgets/widget.ts:230

Type Parameters

TypeName

TypeName

Parameters

typeName

StringLiteral<TypeName>

intfAndAttr?

(InterfaceType | AttributeSpecifier)[]

Returns

EditorTypeInfo<TypeName>

Inherited from

DataGrid.registerEditor