@serenity-is/corelib / RemoteView
Class: RemoteView<TEntity>
Type Parameters
• TEntity
Constructors
new RemoteView()
new RemoteView<
TEntity>(options):RemoteView<TEntity>
Parameters
options
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?
optionalseekToPage:number
Defined in
sortBy
sortBy:
string[]
Defined in
url
url:
string
Defined in
Methods
addData()
addData(
data):void
Parameters
data
ListResponse<TEntity>
Returns
void
Defined in
addItem()
addItem(
item):void
Parameters
item
TEntity
Returns
void
Defined in
beginUpdate()
beginUpdate():
void
Returns
void
Defined in
collapseAllGroups()
collapseAllGroups(
level):void
Parameters
level
number
Returns
void
Defined in
collapseGroup()
collapseGroup(
keys):void
Parameters
keys
any[]
Returns
void
Defined in
deleteItem()
deleteItem(
id):void
Parameters
id
any
Returns
void
Defined in
endUpdate()
endUpdate():
void
Returns
void
Defined in
expandAllGroups()
expandAllGroups(
level):void
Parameters
level
number
Returns
void
Defined in
expandGroup()
expandGroup(
keys):void
Parameters
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
getGrouping()
getGrouping():
GroupInfo<TEntity>[]
Returns
GroupInfo<TEntity>[]
Defined in
getGroupItemMetadataProvider()
getGroupItemMetadataProvider():
GroupItemMetadataProvider
Returns
GroupItemMetadataProvider
Defined in
getGroups()
getGroups():
any[]
Returns
any[]
Defined in
getIdPropertyName()
getIdPropertyName():
string
Returns
string
Defined in
getIdxById()
getIdxById(
id):any
Parameters
id
any
Returns
any
Defined in
getItem()
getItem(
row):any
Parameters
row
number
Returns
any
Defined in
getItemById()
getItemById(
id):TEntity
Parameters
id
any
Returns
TEntity
Defined in
getItemByIdx()
getItemByIdx(
index):any
Parameters
index
number
Returns
any
Defined in
getItemMetadata()
getItemMetadata(
i):any
Parameters
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
id
any
Returns
number
Defined in
getRowByItem()
getRowByItem(
item):number
Parameters
item
any
Returns
number
Defined in
getRows()
getRows():
any[]
Returns
any[]
Defined in
insertItem()
insertItem(
insertBefore,item):void
Parameters
insertBefore
number
item
any
Returns
void
Defined in
mapIdsToRows()
mapIdsToRows(
idAray):number[]
Parameters
idAray
any[]
Returns
number[]
Defined in
mapItemsToRows()
mapItemsToRows(
itemArray):any[]
Parameters
itemArray
any[]
Returns
any[]
Defined in
mapRowsToIds()
mapRowsToIds(
rowArray):any[]
Parameters
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
refresh()
refresh():
void
Returns
void
Defined in
reSort()
reSort():
void
Returns
void
Defined in
setFilter()
setFilter(
filter):void
Parameters
filter
RemoteViewFilter<TEntity>
Returns
void
Defined in
setFilterArgs()
setFilterArgs(
args):void
Parameters
args
any
Returns
void
Defined in
setGrouping()
setGrouping(
groupInfo):void
Parameters
groupInfo
GroupInfo<TEntity>[]
Returns
void
Defined in
setGroupItemMetadataProvider()
setGroupItemMetadataProvider(
value):void
Parameters
value
GroupItemMetadataProvider
Returns
void
Defined in
setItems()
setItems(
items,newIdProperty?):void
Parameters
items
any[]
newIdProperty?
string | boolean
Returns
void
Defined in
setLocalSort()
setLocalSort(
value):void
Parameters
value
boolean
Returns
void
Defined in
setPagingOptions()
setPagingOptions(
options):void
Parameters
options
Returns
void
Defined in
setRefreshHints()
setRefreshHints(
hints):void
Parameters
hints
any[]
Returns
void
Defined in
setSummaryOptions()
setSummaryOptions(
options):void
Parameters
options
Returns
void
Defined in
sort()
sort(
comparer?,ascending?):void
Parameters
comparer?
(a, b) => number
ascending?
boolean
Returns
void
Defined in
sortedAddItem()
sortedAddItem(
item):void
Parameters
item
any
Returns
void
Defined in
sortedUpdateItem()
sortedUpdateItem(
id,item):void
Parameters
id
any
item
any
Returns
void
Defined in
syncGridCellCssStyles()
syncGridCellCssStyles(
grid,key):void
Parameters
grid
any
key
string
Returns
void
Defined in
syncGridSelection()
syncGridSelection(
grid,preserveHidden?,preserveHiddenOnSelectionChange?):void
Parameters
grid
any
preserveHidden?
boolean
preserveHiddenOnSelectionChange?
boolean
Returns
void
Defined in
updateItem()
updateItem(
id,item):void
Parameters
id
any
item
TEntity
Returns
void