@serenity-is/corelib / RemoteView
Class: RemoteView<TEntity>
Type parameters
Name |
---|
TEntity |
Table of contents
Constructors
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
): RemoteView
<TEntity
>
Type parameters
Name |
---|
TEntity |
Parameters
Name | Type |
---|---|
options |
RemoteViewOptions |
Returns
RemoteView
<TEntity
>
Defined in
Properties
errormsg
• errormsg: string
Defined in
fastSort
• fastSort: any
Defined in
idField
• idField: string
Defined in
method
• method: string
Defined in
onAjaxCall
• onAjaxCall: RemoteViewAjaxCallback
<TEntity
>
Defined in
onDataChanged
• onDataChanged: EventEmitter
<any
, IEventData
>
Defined in
onDataLoaded
• onDataLoaded: EventEmitter
<any
, IEventData
>
Defined in
onDataLoading
• onDataLoading: EventEmitter
<any
, IEventData
>
Defined in
onGroupCollapsed
• onGroupCollapsed: EventEmitter
<any
, IEventData
>
Defined in
onGroupExpanded
• onGroupExpanded: EventEmitter
<any
, IEventData
>
Defined in
onPagingInfoChanged
• onPagingInfoChanged: EventEmitter
<any
, IEventData
>
Defined in
onProcessData
• onProcessData: RemoteViewProcessCallback
<TEntity
>
Defined in
onRowCountChanged
• onRowCountChanged: EventEmitter
<any
, IEventData
>
Defined in
onRowsChanged
• onRowsChanged: EventEmitter
<any
, IEventData
>
Defined in
onRowsOrCountChanged
• onRowsOrCountChanged: EventEmitter
<any
, IEventData
>
Defined in
onSubmit
• onSubmit: CancellableViewCallback
<TEntity
>
Defined in
params
• params: any
Defined in
rowsPerPage
• rowsPerPage: number
Defined in
seekToPage
• Optional
seekToPage: number
Defined in
sortBy
• sortBy: string
[]
Defined in
url
• url: string
Defined in
Methods
addData
▸ addData(data
): void
Parameters
Name | Type |
---|---|
data |
ListResponse <TEntity > |
Returns
void
Defined in
addItem
▸ addItem(item
): void
Parameters
Name | Type |
---|---|
item |
TEntity |
Returns
void
Defined in
beginUpdate
▸ beginUpdate(): void
Returns
void
Defined in
collapseAllGroups
▸ collapseAllGroups(level
): void
Parameters
Name | Type |
---|---|
level |
number |
Returns
void
Defined in
collapseGroup
▸ collapseGroup(keys
): void
Parameters
Name | Type |
---|---|
keys |
any [] |
Returns
void
Defined in
deleteItem
▸ deleteItem(id
): void
Parameters
Name | Type |
---|---|
id |
any |
Returns
void
Defined in
endUpdate
▸ endUpdate(): void
Returns
void
Defined in
expandAllGroups
▸ expandAllGroups(level
): void
Parameters
Name | Type |
---|---|
level |
number |
Returns
void
Defined in
expandGroup
▸ expandGroup(keys
): void
Parameters
Name | Type |
---|---|
keys |
any [] |
Returns
void
Defined in
getFilter
▸ getFilter(): RemoteViewFilter
<TEntity
>
Returns
RemoteViewFilter
<TEntity
>
Defined in
getFilteredItems
▸ getFilteredItems(): any
Returns
any
Defined in
getGrandTotals
▸ getGrandTotals(): any
Returns
any
Defined in
getGroupItemMetadataProvider
▸ getGroupItemMetadataProvider(): GroupItemMetadataProvider
Returns
GroupItemMetadataProvider
Defined in
getGrouping
▸ getGrouping(): GroupInfo
<TEntity
>[]
Returns
GroupInfo
<TEntity
>[]
Defined in
getGroups
▸ getGroups(): any
[]
Returns
any
[]
Defined in
getIdPropertyName
▸ getIdPropertyName(): string
Returns
string
Defined in
getIdxById
▸ getIdxById(id
): any
Parameters
Name | Type |
---|---|
id |
any |
Returns
any
Defined in
getItem
▸ getItem(row
): any
Parameters
Name | Type |
---|---|
row |
number |
Returns
any
Defined in
getItemById
▸ getItemById(id
): TEntity
Parameters
Name | Type |
---|---|
id |
any |
Returns
TEntity
Defined in
getItemByIdx
▸ getItemByIdx(index
): any
Parameters
Name | Type |
---|---|
index |
number |
Returns
any
Defined in
getItemMetadata
▸ getItemMetadata(i
): any
Parameters
Name | Type |
---|---|
i |
number |
Returns
any
Defined in
getItems
▸ getItems(): TEntity
[]
Returns
TEntity
[]
Defined in
getLength
▸ getLength(): number
Returns
number
Defined in
getLocalSort
▸ getLocalSort(): boolean
Returns
boolean
Defined in
getPagingInfo
▸ getPagingInfo(): PagingInfo
Returns
Defined in
getRowById
▸ getRowById(id
): number
Parameters
Name | Type |
---|---|
id |
any |
Returns
number
Defined in
getRowByItem
▸ getRowByItem(item
): number
Parameters
Name | Type |
---|---|
item |
any |
Returns
number
Defined in
getRows
▸ getRows(): any
[]
Returns
any
[]
Defined in
insertItem
▸ insertItem(insertBefore
, item
): void
Parameters
Name | Type |
---|---|
insertBefore |
number |
item |
any |
Returns
void
Defined in
mapIdsToRows
▸ mapIdsToRows(idAray
): number
[]
Parameters
Name | Type |
---|---|
idAray |
any [] |
Returns
number
[]
Defined in
mapItemsToRows
▸ mapItemsToRows(itemArray
): any
[]
Parameters
Name | Type |
---|---|
itemArray |
any [] |
Returns
any
[]
Defined in
mapRowsToIds
▸ mapRowsToIds(rowArray
): any
[]
Parameters
Name | Type |
---|---|
rowArray |
number [] |
Returns
any
[]
Defined in
populate
▸ populate(): void
Returns
void
Defined in
populateLock
▸ populateLock(): void
Returns
void
Defined in
populateUnlock
▸ populateUnlock(): void
Returns
void
Defined in
reSort
▸ reSort(): void
Returns
void
Defined in
refresh
▸ refresh(): void
Returns
void
Defined in
setFilter
▸ setFilter(filter
): void
Parameters
Name | Type |
---|---|
filter |
RemoteViewFilter <TEntity > |
Returns
void
Defined in
setFilterArgs
▸ setFilterArgs(args
): void
Parameters
Name | Type |
---|---|
args |
any |
Returns
void
Defined in
setGroupItemMetadataProvider
▸ setGroupItemMetadataProvider(value
): void
Parameters
Name | Type |
---|---|
value |
GroupItemMetadataProvider |
Returns
void
Defined in
setGrouping
▸ setGrouping(groupInfo
): void
Parameters
Name | Type |
---|---|
groupInfo |
GroupInfo <TEntity >[] |
Returns
void
Defined in
setItems
▸ setItems(items
, newIdProperty?
): void
Parameters
Name | Type |
---|---|
items |
any [] |
newIdProperty? |
string | boolean |
Returns
void
Defined in
setLocalSort
▸ setLocalSort(value
): void
Parameters
Name | Type |
---|---|
value |
boolean |
Returns
void
Defined in
setPagingOptions
▸ setPagingOptions(options
): void
Parameters
Name | Type |
---|---|
options |
PagingOptions |
Returns
void
Defined in
setRefreshHints
▸ setRefreshHints(hints
): void
Parameters
Name | Type |
---|---|
hints |
any [] |
Returns
void
Defined in
setSummaryOptions
▸ setSummaryOptions(options
): void
Parameters
Name | Type |
---|---|
options |
SummaryOptions |
Returns
void
Defined in
sort
▸ sort(comparer?
, ascending?
): void
Parameters
Name | Type |
---|---|
comparer? |
(a : any , b : any ) => number |
ascending? |
boolean |
Returns
void
Defined in
sortedAddItem
▸ sortedAddItem(item
): void
Parameters
Name | Type |
---|---|
item |
any |
Returns
void
Defined in
sortedUpdateItem
▸ sortedUpdateItem(id
, item
): void
Parameters
Name | Type |
---|---|
id |
any |
item |
any |
Returns
void
Defined in
syncGridCellCssStyles
▸ syncGridCellCssStyles(grid
, key
): void
Parameters
Name | Type |
---|---|
grid |
any |
key |
string |
Returns
void
Defined in
syncGridSelection
▸ syncGridSelection(grid
, preserveHidden?
, preserveHiddenOnSelectionChange?
): void
Parameters
Name | Type |
---|---|
grid |
any |
preserveHidden? |
boolean |
preserveHiddenOnSelectionChange? |
boolean |
Returns
void
Defined in
updateItem
▸ updateItem(id
, item
): void
Parameters
Name | Type |
---|---|
id |
any |
item |
TEntity |
Returns
void