@serenity-is/corelib / RemoteView

Class: RemoteView<TEntity>

Type parameters

Name
TEntity

Table of contents

Constructors

• constructor

Properties

• errormsg
• fastSort
• idField
• method
• onAjaxCall
• onDataChanged
• onDataLoaded
• onDataLoading
• onGroupCollapsed
• onGroupExpanded
• onPagingInfoChanged
• onProcessData
• onRowCountChanged
• onRowsChanged
• onRowsOrCountChanged
• onSubmit
• params
• rowsPerPage
• seekToPage
• sortBy
• url

Methods

• addData
• addItem
• beginUpdate
• collapseAllGroups
• collapseGroup
• deleteItem
• endUpdate
• expandAllGroups
• expandGroup
• getFilter
• getFilteredItems
• getGrandTotals
• getGroupItemMetadataProvider
• getGrouping
• getGroups
• getIdPropertyName
• getIdxById
• getItem
• getItemById
• getItemByIdx
• getItemMetadata
• getItems
• getLength
• getLocalSort
• getPagingInfo
• getRowById
• getRowByItem
• getRows
• insertItem
• mapIdsToRows
• mapItemsToRows
• mapRowsToIds
• populate
• populateLock
• populateUnlock
• reSort
• refresh
• setFilter
• setFilterArgs
• setGroupItemMetadataProvider
• setGrouping
• setItems
• setLocalSort
• setPagingOptions
• setRefreshHints
• setSummaryOptions
• sort
• sortedAddItem
• sortedUpdateItem
• syncGridCellCssStyles
• syncGridSelection
• updateItem

Constructors

constructor

• new RemoteView<TEntity>(options)

Type parameters

Name
TEntity

Parameters

Name	Type
options	RemoteViewOptions

Defined in

src/slick/remoteview.ts:119

Properties

errormsg

• errormsg: string

Defined in

src/slick/remoteview.ts:105

---

fastSort

• fastSort: any

Defined in

src/slick/remoteview.ts:66

---

idField

• idField: string

Defined in

src/slick/remoteview.ts:114

---

method

• method: string

Defined in

src/slick/remoteview.ts:113

---

onAjaxCall

• onAjaxCall: RemoteViewAjaxCallback<TEntity>

Defined in

src/slick/remoteview.ts:54

---

onDataChanged

• onDataChanged: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:44

---

onDataLoaded

• onDataLoaded: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:46

---

onDataLoading

• onDataLoading: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:45

---

onGroupCollapsed

• onGroupCollapsed: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:53

---

onGroupExpanded

• onGroupExpanded: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:52

---

onPagingInfoChanged

• onPagingInfoChanged: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:47

---

onProcessData

• onProcessData: RemoteViewProcessCallback<TEntity>

Defined in

src/slick/remoteview.ts:55

---

onRowCountChanged

• onRowCountChanged: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:48

---

onRowsChanged

• onRowsChanged: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:49

---

onRowsOrCountChanged

• onRowsOrCountChanged: EventEmitter<any, IEventData>

Defined in

src/slick/remoteview.ts:50

---

onSubmit

• onSubmit: CancellableViewCallback<TEntity>

Defined in

src/slick/remoteview.ts:43

---

params

• params: any

Defined in

src/slick/remoteview.ts:106

---

rowsPerPage

• rowsPerPage: number

Defined in

src/slick/remoteview.ts:104

---

seekToPage

• Optional seekToPage: number

Defined in

src/slick/remoteview.ts:115

---

sortBy

• sortBy: string[]

Defined in

src/slick/remoteview.ts:111

---

url

• url: string

Defined in

src/slick/remoteview.ts:112

Methods

addData

▸ addData(data): void

Parameters

Name	Type
data	ListResponse<TEntity>

Returns

void

Defined in

src/slick/remoteview.ts:56

---

addItem

▸ addItem(item): void

Parameters

Name	Type
item	TEntity

Returns

void

Defined in

src/slick/remoteview.ts:88

---

beginUpdate

▸ beginUpdate(): void

Returns

void

Defined in

src/slick/remoteview.ts:57

---

collapseAllGroups

▸ collapseAllGroups(level): void

Parameters

Name	Type
level	number

Returns

void

Defined in

src/slick/remoteview.ts:92

---

collapseGroup

▸ collapseGroup(keys): void

Parameters

Name	Type
keys	any[]

Returns

void

Defined in

src/slick/remoteview.ts:95

---

deleteItem

▸ deleteItem(id): void

Parameters

Name	Type
id	any

Returns

void

Defined in

src/slick/remoteview.ts:59

---

endUpdate

▸ endUpdate(): void

Returns

void

Defined in

src/slick/remoteview.ts:58

---

expandAllGroups

▸ expandAllGroups(level): void

Parameters

Name	Type
level	number

Returns

void

Defined in

src/slick/remoteview.ts:93

---

expandGroup

▸ expandGroup(keys): void

Parameters

Name	Type
keys	any[]

Returns

void

Defined in

src/slick/remoteview.ts:94

---

getFilter

▸ getFilter(): RemoteViewFilter<TEntity>

Returns

RemoteViewFilter<TEntity>

Defined in

src/slick/remoteview.ts:62

---

getFilteredItems

▸ getFilteredItems(): any

Returns

any

Defined in

src/slick/remoteview.ts:63

---

getGrandTotals

▸ getGrandTotals(): any

Returns

any

Defined in

src/slick/remoteview.ts:70

---

getGroupItemMetadataProvider

▸ getGroupItemMetadataProvider(): GroupItemMetadataProvider

Returns

GroupItemMetadataProvider

Defined in

src/slick/remoteview.ts:64

---

getGrouping

▸ getGrouping(): GroupInfo<TEntity>[]

Returns

GroupInfo<TEntity>[]

Defined in

src/slick/remoteview.ts:71

---

getGroups

▸ getGroups(): any[]

Returns

any[]

Defined in

src/slick/remoteview.ts:72

---

getIdPropertyName

▸ getIdPropertyName(): string

Returns

string

Defined in

src/slick/remoteview.ts:68

---

getIdxById

▸ getIdxById(id): any

Parameters

Name	Type
id	any

Returns

any

Defined in

src/slick/remoteview.ts:89

---

getItem

▸ getItem(row): any

Parameters

Name	Type
row	number

Returns

any

Defined in

src/slick/remoteview.ts:102

---

getItemById

▸ getItemById(id): TEntity

Parameters

Name	Type
id	any

Returns

TEntity

Defined in

src/slick/remoteview.ts:69

---

getItemByIdx

▸ getItemByIdx(index): any

Parameters

Name	Type
index	number

Returns

any

Defined in

src/slick/remoteview.ts:90

---

getItemMetadata

▸ getItemMetadata(i): any

Parameters

Name	Type
i	number

Returns

any

Defined in

src/slick/remoteview.ts:86

---

getItems

▸ getItems(): TEntity[]

Returns

TEntity[]

Defined in

src/slick/remoteview.ts:60

---

getLength

▸ getLength(): number

Returns

number

Defined in

src/slick/remoteview.ts:103

---

getLocalSort

▸ getLocalSort(): boolean

Returns

boolean

Defined in

src/slick/remoteview.ts:107

---

getPagingInfo

▸ getPagingInfo(): PagingInfo

Returns

PagingInfo

Defined in

src/slick/remoteview.ts:51

---

getRowById

▸ getRowById(id): number

Parameters

Name	Type
id	any

Returns

number

Defined in

src/slick/remoteview.ts:73

---

getRowByItem

▸ getRowByItem(item): number

Parameters

Name	Type
item	any

Returns

number

Defined in

src/slick/remoteview.ts:74

---

getRows

▸ getRows(): any[]

Returns

any[]

Defined in

src/slick/remoteview.ts:75

---

insertItem

▸ insertItem(insertBefore, item): void

Parameters

Name	Type
insertBefore	number
item	any

Returns

void

Defined in

src/slick/remoteview.ts:81

---

mapIdsToRows

▸ mapIdsToRows(idAray): number[]

Parameters

Name	Type
idAray	any[]

Returns

number[]

Defined in

src/slick/remoteview.ts:78

---

mapItemsToRows

▸ mapItemsToRows(itemArray): any[]

Parameters

Name	Type
itemArray	any[]

Returns

any[]

Defined in

src/slick/remoteview.ts:76

---

mapRowsToIds

▸ mapRowsToIds(rowArray): any[]

Parameters

Name	Type
rowArray	number[]

Returns

any[]

Defined in

src/slick/remoteview.ts:77

---

populate

▸ populate(): void

Returns

void

Defined in

src/slick/remoteview.ts:99

---

populateLock

▸ populateLock(): void

Returns

void

Defined in

src/slick/remoteview.ts:100

---

populateUnlock

▸ populateUnlock(): void

Returns

void

Defined in

src/slick/remoteview.ts:101

---

reSort

▸ reSort(): void

Returns

void

Defined in

src/slick/remoteview.ts:110

---

refresh

▸ refresh(): void

Returns

void

Defined in

src/slick/remoteview.ts:98

---

setFilter

▸ setFilter(filter): void

Parameters

Name	Type
filter	RemoteViewFilter<TEntity>

Returns

void

Defined in

src/slick/remoteview.ts:61

---

setFilterArgs

▸ setFilterArgs(args): void

Parameters

Name	Type
args	any

Returns

void

Defined in

src/slick/remoteview.ts:79

---

setGroupItemMetadataProvider

▸ setGroupItemMetadataProvider(value): void

Parameters

Name	Type
value	GroupItemMetadataProvider

Returns

void

Defined in

src/slick/remoteview.ts:65

---

setGrouping

▸ setGrouping(groupInfo): void

Parameters

Name	Type
groupInfo	GroupInfo<TEntity>[]

Returns

void

Defined in

src/slick/remoteview.ts:91

---

setItems

▸ setItems(items, newIdProperty?): void

Parameters

Name	Type
items	any[]
newIdProperty?	string | boolean

Returns

void

Defined in

src/slick/remoteview.ts:67

---

setLocalSort

▸ setLocalSort(value): void

Parameters

Name	Type
value	boolean

Returns

void

Defined in

src/slick/remoteview.ts:108

---

setPagingOptions

▸ setPagingOptions(options): void

Parameters

Name	Type
options	PagingOptions

Returns

void

Defined in

src/slick/remoteview.ts:97

---

setRefreshHints

▸ setRefreshHints(hints): void

Parameters

Name	Type
hints	any[]

Returns

void

Defined in

src/slick/remoteview.ts:80

---

setSummaryOptions

▸ setSummaryOptions(options): void

Parameters

Name	Type
options	SummaryOptions

Returns

void

Defined in

src/slick/remoteview.ts:96

---

sort

▸ sort(comparer?, ascending?): void

Parameters

Name	Type
comparer?	(a: any, b: any) => number
ascending?	boolean

Returns

void

Defined in

src/slick/remoteview.ts:109

---

sortedAddItem

▸ sortedAddItem(item): void

Parameters

Name	Type
item	any

Returns

void

Defined in

src/slick/remoteview.ts:82

---

sortedUpdateItem

▸ sortedUpdateItem(id, item): void

Parameters

Name	Type
id	any
item	any

Returns

void

Defined in

src/slick/remoteview.ts:83

---

syncGridCellCssStyles

▸ syncGridCellCssStyles(grid, key): void

Parameters

Name	Type
grid	any
key	string

Returns

void

Defined in

src/slick/remoteview.ts:85

---

syncGridSelection

▸ syncGridSelection(grid, preserveHidden?, preserveHiddenOnSelectionChange?): void

Parameters

Name	Type
grid	any
preserveHidden?	boolean
preserveHiddenOnSelectionChange?	boolean

Returns

void

Defined in

src/slick/remoteview.ts:84

---

updateItem

▸ updateItem(id, item): void

Parameters

Name	Type
id	any
item	TEntity

Returns

void

Defined in

src/slick/remoteview.ts:87