North American Sales: 1-800-231-8588
Global Contacts
My Account
Menu
North American Sales: 1-800-321-8588
My Account
Sign In/Register
Design & Development
Design & Develop
Best Value Bundles
Infragistics Ultimate
$1,495
The only complete UX/UI toolkit for building high performance, modern web, mobile and desktop applications.
Infragistics Professional
$1,295
The comprehensive UI components library for web, mobile and desktop developers.
Ignite UI
$1,295
A complete library of UI components for building modern, data-rich and responsive web apps.
Web
App Builder
(New)
Ignite UI
Angular
ASP.NET Core
ASP.NET MVC
Blazor
jQuery
React
Web Components
Ultimate UI for ASP.NET Web Forms
Desktop
Ultimate UI for Windows Forms
Ultimate UI for WPF
Cross Platform
Ultimate UI for Uno
Ultimate UI for UWP
Ultimate UI for WinUI
Ultimate UI for Xamarin
Design to Code
Indigo.Design
App Builder
(New)
Automated Testing Tools
Test automation for Micro Focus UFT: Windows Forms
Test automation for Micro Focus UFT: WPF
Test automation for IBM RFT: Windows Forms
UX
Indigo.Design
A Unified Platform for Visual Design, UX Prototyping, Code Generation, and App Development
App Builder
Cloud-based WYSIWYG Drag & Drop Tool, Endless Theming options and Standards-Based Code Output
Business Intelligence
Reveal
Easily embed beautiful data visualizations into your apps
Slingshot
Empower everyone in your organization to use data to make smarter business decisions
Team Productivity
Slingshot
Connect everyone you work with to data, project management, content and chats for better results.
SharePlus
Secure, instant access to content and data on the go – with or without connectivity.
Learn & Support
Support
Help & Support Documents
Blogs
Forums
Product Ideas
Reference Applications
Customer Stories
Webinars
eBook & Whitepapers
Events
Free Trials
Pricing
Product Pricing / Buy Online
Renew Existing License
Contact Us
Ignite UI for Web Components
menu
Components
Get Started
search
Preparing search index...
The search index is not available
All
Public
Public/Protected
All
Inherited
Externals
Only exported
Modules
Rest
Virtual
Data
Source
Data
Provider
constructor
$type
_auto
Refresh
Queued
_schema
Fetch
Queued
schema
Changed
$t
next
Hash
Code
actual
Count
actual
Schema
base
Uri
batch
Completed
defer
Auto
Refresh
enable
Jsonp
entity
Set
execution
Context
filter
Expressions
fixed
Full
Count
group
Descriptions
is
Aggregation
Supported
is
Filtering
Supported
is
Grouping
Supported
is
Item
Index
Lookup
Supported
is
Key
Index
Lookup
Supported
is
Sorting
Supported
notify
Using
Source
Indexes
page
Loaded
page
Size
Requested
perform
Fetch
properties
Requested
provide
Aggregated
Count
provide
Aggregation
Parameter
provide
Desired
Properties
Parameter
provide
Filter
Parameter
provide
Full
Count
provide
Items
provide
Order
By
Parameter
provide
Paging
Parameter
provide
Uri
schema
Included
Properties
sort
Descriptions
summary
Descriptions
summary
Scope
timeout
Milliseconds
update
Notifier
add
Item
add
Page
Request
close
create
Batch
Request
do
Refresh
Internal
do
Schema
Fetch
Internal
equals
flush
Auto
Refresh
get
Hash
Code
get
Item
Value
index
Of
Item
index
Of
Key
memberwise
Clone
notify
Clear
Items
notify
Insert
Item
notify
Remove
Item
notify
Set
Item
queue
Auto
Refresh
queue
Schema
Fetch
refresh
refresh
Internal
remove
All
Page
Requests
remove
Item
remove
Page
Request
resolve
Schema
Property
Type
schema
Fetch
Internal
set
Item
Value
compare
compare
Simple
equals
Simple
equals
Static
get
Array
Of
Properties
get
Array
Of
Values
get
Hash
Code
Static
reference
Equals
Globals
igniteui-webcomponents-datasources
RestVirtualDataSourceDataProvider
Class RestVirtualDataSourceDataProvider
Hierarchy
Hierarchy
Base
RestVirtualDataSourceDataProvider
Implements
IDataSourceVirtualDataProvider
Constructors
constructor
Properties
$type
_auto
Refresh
Queued
_schema
Fetch
Queued
schema
Changed
$t
next
Hash
Code
Accessors
actual
Count
actual
Schema
base
Uri
batch
Completed
defer
Auto
Refresh
enable
Jsonp
entity
Set
execution
Context
filter
Expressions
fixed
Full
Count
group
Descriptions
is
Aggregation
Supported
is
Filtering
Supported
is
Grouping
Supported
is
Item
Index
Lookup
Supported
is
Key
Index
Lookup
Supported
is
Sorting
Supported
notify
Using
Source
Indexes
page
Loaded
page
Size
Requested
perform
Fetch
properties
Requested
provide
Aggregated
Count
provide
Aggregation
Parameter
provide
Desired
Properties
Parameter
provide
Filter
Parameter
provide
Full
Count
provide
Items
provide
Order
By
Parameter
provide
Paging
Parameter
provide
Uri
schema
Included
Properties
sort
Descriptions
summary
Descriptions
summary
Scope
timeout
Milliseconds
update
Notifier
Methods
add
Item
add
Page
Request
close
create
Batch
Request
do
Refresh
Internal
do
Schema
Fetch
Internal
equals
flush
Auto
Refresh
get
Hash
Code
get
Item
Value
index
Of
Item
index
Of
Key
memberwise
Clone
notify
Clear
Items
notify
Insert
Item
notify
Remove
Item
notify
Set
Item
queue
Auto
Refresh
queue
Schema
Fetch
refresh
refresh
Internal
remove
All
Page
Requests
remove
Item
remove
Page
Request
resolve
Schema
Property
Type
schema
Fetch
Internal
set
Item
Value
compare
compare
Simple
equals
Simple
equals
Static
get
Array
Of
Properties
get
Array
Of
Values
get
Hash
Code
Static
reference
Equals
Constructors
constructor
new
Rest
Virtual
Data
Source
Data
Provider
(
)
:
RestVirtualDataSourceDataProvider
Returns
RestVirtualDataSourceDataProvider
Properties
$type
$type
:
Type
_auto
Refresh
Queued
_auto
Refresh
Queued
:
boolean
_schema
Fetch
Queued
_schema
Fetch
Queued
:
boolean
schema
Changed
schema
Changed
:
(
(
sender
,
args
)
=>
void
)
Type declaration
(
sender
,
args
)
:
void
Parameters
sender:
any
args:
DataSourceDataProviderSchemaChangedEventArgs
Returns
void
Static
$t
$t
:
Type
Static
next
Hash
Code
next
Hash
Code
:
number
Accessors
actual
Count
get
actualCount
(
)
:
number
Returns
number
actual
Schema
get
actualSchema
(
)
:
IDataSourceSchema
Returns
IDataSourceSchema
base
Uri
get
baseUri
(
)
:
string
Returns
string
set
baseUri
(
value
)
:
void
Parameters
value:
string
Returns
void
batch
Completed
get
batchCompleted
(
)
:
(
(
success
,
requiresRefresh
,
messages
)
=>
void
)
Returns
(
(
success
,
requiresRefresh
,
messages
)
=>
void
)
(
success
,
requiresRefresh
,
messages
)
:
void
Parameters
success:
boolean
requiresRefresh:
boolean
messages:
string
[]
Returns
void
set
batchCompleted
(
v
)
:
void
Parameters
v:
(
(
success
,
requiresRefresh
,
messages
)
=>
void
)
(
success
,
requiresRefresh
,
messages
)
:
void
Parameters
success:
boolean
requiresRefresh:
boolean
messages:
string
[]
Returns
void
Returns
void
defer
Auto
Refresh
get
deferAutoRefresh
(
)
:
boolean
Returns
boolean
set
deferAutoRefresh
(
value
)
:
void
Parameters
value:
boolean
Returns
void
enable
Jsonp
get
enableJsonp
(
)
:
boolean
Returns
boolean
set
enableJsonp
(
isEnabled
)
:
void
Parameters
isEnabled:
boolean
Returns
void
entity
Set
get
entitySet
(
)
:
string
Returns
string
set
entitySet
(
value
)
:
void
Parameters
value:
string
Returns
void
execution
Context
get
executionContext
(
)
:
IDataSourceExecutionContext
Returns
IDataSourceExecutionContext
set
executionContext
(
value
)
:
void
Parameters
value:
IDataSourceExecutionContext
Returns
void
filter
Expressions
get
filterExpressions
(
)
:
FilterExpressionCollection
Returns
FilterExpressionCollection
fixed
Full
Count
get
fixedFullCount
(
)
:
number
Returns
number
set
fixedFullCount
(
value
)
:
void
Parameters
value:
number
Returns
void
group
Descriptions
get
groupDescriptions
(
)
:
SortDescriptionCollection
Returns
SortDescriptionCollection
is
Aggregation
Supported
get
isAggregationSupported
(
)
:
boolean
Returns
boolean
set
isAggregationSupported
(
isSupported
)
:
void
Parameters
isSupported:
boolean
Returns
void
is
Filtering
Supported
get
isFilteringSupported
(
)
:
boolean
Returns
boolean
is
Grouping
Supported
get
isGroupingSupported
(
)
:
boolean
Returns
boolean
is
Item
Index
Lookup
Supported
get
isItemIndexLookupSupported
(
)
:
boolean
Returns
boolean
is
Key
Index
Lookup
Supported
get
isKeyIndexLookupSupported
(
)
:
boolean
Returns
boolean
is
Sorting
Supported
get
isSortingSupported
(
)
:
boolean
Returns
boolean
notify
Using
Source
Indexes
get
notifyUsingSourceIndexes
(
)
:
boolean
Returns
boolean
page
Loaded
get
pageLoaded
(
)
:
(
(
page
,
currentFullCount
,
actualPageSize
)
=>
void
)
Returns
(
(
page
,
currentFullCount
,
actualPageSize
)
=>
void
)
(
page
,
currentFullCount
,
actualPageSize
)
:
void
Parameters
page:
IDataSourcePage
currentFullCount:
number
actualPageSize:
number
Returns
void
set
pageLoaded
(
value
)
:
void
Parameters
value:
(
(
page
,
currentFullCount
,
actualPageSize
)
=>
void
)
(
page
,
currentFullCount
,
actualPageSize
)
:
void
Parameters
page:
IDataSourcePage
currentFullCount:
number
actualPageSize:
number
Returns
void
Returns
void
page
Size
Requested
get
pageSizeRequested
(
)
:
number
Returns
number
set
pageSizeRequested
(
value
)
:
void
Parameters
value:
number
Returns
void
perform
Fetch
get
performFetch
(
)
:
(
(
request
,
success
,
failure
)
=>
void
)
Returns
(
(
request
,
success
,
failure
)
=>
void
)
(
request
,
success
,
failure
)
:
void
Parameters
request:
{
data
:
null
;
enableJsonpCallback
:
boolean
;
headers
:
any
;
method
:
"GET"
;
requestUri
:
string
;
}
data
:
null
enable
Jsonp
Callback
:
boolean
headers
:
any
method
:
"GET"
request
Uri
:
string
success:
(
(
data
,
response
)
=>
void
)
(
data
,
response
)
:
void
Parameters
data:
any
response:
any
Returns
void
failure:
(
(
err
)
=>
void
)
(
err
)
:
void
Parameters
err:
any
Returns
void
Returns
void
set
performFetch
(
value
)
:
void
Parameters
value:
(
(
request
,
success
,
failure
)
=>
void
)
(
request
,
success
,
failure
)
:
void
Parameters
request:
{
data
:
null
;
enableJsonpCallback
:
boolean
;
headers
:
any
;
method
:
"GET"
;
requestUri
:
string
;
}
data
:
null
enable
Jsonp
Callback
:
boolean
headers
:
any
method
:
"GET"
request
Uri
:
string
success:
(
(
data
,
response
)
=>
void
)
(
data
,
response
)
:
void
Parameters
data:
any
response:
any
Returns
void
failure:
(
(
err
)
=>
void
)
(
err
)
:
void
Parameters
err:
any
Returns
void
Returns
void
Returns
void
properties
Requested
get
propertiesRequested
(
)
:
string
[]
Returns
string
[]
set
propertiesRequested
(
value
)
:
void
Parameters
value:
string
[]
Returns
void
provide
Aggregated
Count
get
provideAggregatedCount
(
)
:
(
(
item
)
=>
number
)
Returns
(
(
item
)
=>
number
)
(
item
)
:
number
Parameters
item:
any
Returns
number
set
provideAggregatedCount
(
value
)
:
void
Parameters
value:
(
(
item
)
=>
number
)
(
item
)
:
number
Parameters
item:
any
Returns
number
Returns
void
provide
Aggregation
Parameter
get
provideAggregationParameter
(
)
:
(
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
=>
void
)
Returns
(
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
=>
void
)
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
:
void
Parameters
args:
any
[]
fetchCountOnly:
boolean
groupByString:
string
groupBy:
SortDescriptionCollection
summaryString:
string
summary:
SummaryDescriptionCollection
Returns
void
set
provideAggregationParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
=>
void
)
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
:
void
Parameters
args:
any
[]
fetchCountOnly:
boolean
groupByString:
string
groupBy:
SortDescriptionCollection
summaryString:
string
summary:
SummaryDescriptionCollection
Returns
void
Returns
void
provide
Desired
Properties
Parameter
get
provideDesiredPropertiesParameter
(
)
:
(
(
args
,
selectString
,
desiredProperties
)
=>
void
)
Returns
(
(
args
,
selectString
,
desiredProperties
)
=>
void
)
(
args
,
selectString
,
desiredProperties
)
:
void
Parameters
args:
any
[]
selectString:
string
desiredProperties:
string
[]
Returns
void
set
provideDesiredPropertiesParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
selectString
,
desiredProperties
)
=>
void
)
(
args
,
selectString
,
desiredProperties
)
:
void
Parameters
args:
any
[]
selectString:
string
desiredProperties:
string
[]
Returns
void
Returns
void
provide
Filter
Parameter
get
provideFilterParameter
(
)
:
(
(
args
,
filterString
,
filterExpressions
)
=>
void
)
Returns
(
(
args
,
filterString
,
filterExpressions
)
=>
void
)
(
args
,
filterString
,
filterExpressions
)
:
void
Parameters
args:
any
[]
filterString:
string
filterExpressions:
FilterExpressionCollection
Returns
void
set
provideFilterParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
filterString
,
filterExpressions
)
=>
void
)
(
args
,
filterString
,
filterExpressions
)
:
void
Parameters
args:
any
[]
filterString:
string
filterExpressions:
FilterExpressionCollection
Returns
void
Returns
void
provide
Full
Count
get
provideFullCount
(
)
:
(
(
page
)
=>
number
)
Returns
(
(
page
)
=>
number
)
(
page
)
:
number
Parameters
page:
any
Returns
number
set
provideFullCount
(
value
)
:
void
Parameters
value:
(
(
page
)
=>
number
)
(
page
)
:
number
Parameters
page:
any
Returns
number
Returns
void
provide
Items
get
provideItems
(
)
:
(
(
result
)
=>
any
[]
)
Returns
(
(
result
)
=>
any
[]
)
(
result
)
:
any
[]
Parameters
result:
any
Returns
any
[]
set
provideItems
(
value
)
:
void
Parameters
value:
(
(
result
)
=>
any
[]
)
(
result
)
:
any
[]
Parameters
result:
any
Returns
any
[]
Returns
void
provide
Order
By
Parameter
get
provideOrderByParameter
(
)
:
(
(
args
,
orderByString
,
orderBy
)
=>
void
)
Returns
(
(
args
,
orderByString
,
orderBy
)
=>
void
)
(
args
,
orderByString
,
orderBy
)
:
void
Parameters
args:
any
[]
orderByString:
string
orderBy:
SortDescriptionCollection
Returns
void
set
provideOrderByParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
orderByString
,
orderBy
)
=>
void
)
(
args
,
orderByString
,
orderBy
)
:
void
Parameters
args:
any
[]
orderByString:
string
orderBy:
SortDescriptionCollection
Returns
void
Returns
void
provide
Paging
Parameter
get
providePagingParameter
(
)
:
(
(
args
,
skip
,
take
)
=>
void
)
Returns
(
(
args
,
skip
,
take
)
=>
void
)
(
args
,
skip
,
take
)
:
void
Parameters
args:
any
[]
skip:
number
take:
number
Returns
void
set
providePagingParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
skip
,
take
)
=>
void
)
(
args
,
skip
,
take
)
:
void
Parameters
args:
any
[]
skip:
number
take:
number
Returns
void
Returns
void
provide
Uri
get
provideUri
(
)
:
(
(
baseUri
,
entitySet
,
args
)
=>
string
)
Returns
(
(
baseUri
,
entitySet
,
args
)
=>
string
)
(
baseUri
,
entitySet
,
args
)
:
string
Parameters
baseUri:
string
entitySet:
string
args:
{
name
:
string
;
value
:
any
;
}
[]
Returns
string
set
provideUri
(
value
)
:
void
Parameters
value:
(
(
baseUri
,
entitySet
,
args
)
=>
string
)
(
baseUri
,
entitySet
,
args
)
:
string
Parameters
baseUri:
string
entitySet:
string
args:
{
name
:
string
;
value
:
any
;
}
[]
Returns
string
Returns
void
schema
Included
Properties
get
schemaIncludedProperties
(
)
:
string
[]
Returns
string
[]
set
schemaIncludedProperties
(
value
)
:
void
Parameters
value:
string
[]
Returns
void
sort
Descriptions
get
sortDescriptions
(
)
:
SortDescriptionCollection
Returns
SortDescriptionCollection
summary
Descriptions
get
summaryDescriptions
(
)
:
SummaryDescriptionCollection
Returns
SummaryDescriptionCollection
summary
Scope
get
summaryScope
(
)
:
DataSourceSummaryScope
Returns
DataSourceSummaryScope
set
summaryScope
(
value
)
:
void
Parameters
value:
DataSourceSummaryScope
Returns
void
timeout
Milliseconds
get
timeoutMilliseconds
(
)
:
number
Returns
number
set
timeoutMilliseconds
(
value
)
:
void
Parameters
value:
number
Returns
void
update
Notifier
get
updateNotifier
(
)
:
IDataSourceDataProviderUpdateNotifier
Returns
IDataSourceDataProviderUpdateNotifier
set
updateNotifier
(
value
)
:
void
Parameters
value:
IDataSourceDataProviderUpdateNotifier
Returns
void
Methods
add
Item
add
Item
(
item
)
:
void
Parameters
item:
any
Returns
void
add
Page
Request
add
Page
Request
(
pageIndex
,
priority
)
:
void
Parameters
pageIndex:
number
priority:
DataSourcePageRequestPriority
Returns
void
close
close
(
)
:
void
Returns
void
create
Batch
Request
create
Batch
Request
(
changes
)
:
void
Parameters
changes:
TransactionState
[]
Returns
void
do
Refresh
Internal
do
Refresh
Internal
(
)
:
void
Returns
void
do
Schema
Fetch
Internal
do
Schema
Fetch
Internal
(
)
:
void
Returns
void
equals
equals
(
other
)
:
boolean
Parameters
other:
any
Returns
boolean
flush
Auto
Refresh
flush
Auto
Refresh
(
)
:
void
Returns
void
get
Hash
Code
get
Hash
Code
(
)
:
number
Returns
number
get
Item
Value
get
Item
Value
(
item
,
valueName
)
:
any
Parameters
item:
any
valueName:
string
Returns
any
index
Of
Item
index
Of
Item
(
item
)
:
number
Parameters
item:
any
Returns
number
index
Of
Key
index
Of
Key
(
key
)
:
number
Parameters
key:
any
[]
Returns
number
memberwise
Clone
memberwise
Clone
(
)
:
Base
Returns
Base
notify
Clear
Items
notify
Clear
Items
(
)
:
void
Returns
void
notify
Insert
Item
notify
Insert
Item
(
index
,
newItem
)
:
void
Parameters
index:
number
newItem:
any
Returns
void
notify
Remove
Item
notify
Remove
Item
(
index
,
oldItem
)
:
void
Parameters
index:
number
oldItem:
any
Returns
void
notify
Set
Item
notify
Set
Item
(
index
,
oldItem
,
newItem
)
:
void
Parameters
index:
number
oldItem:
any
newItem:
any
Returns
void
queue
Auto
Refresh
queue
Auto
Refresh
(
)
:
void
Returns
void
queue
Schema
Fetch
queue
Schema
Fetch
(
)
:
void
Returns
void
refresh
refresh
(
)
:
void
Returns
void
refresh
Internal
refresh
Internal
(
)
:
void
Returns
void
remove
All
Page
Requests
remove
All
Page
Requests
(
)
:
void
Returns
void
remove
Item
remove
Item
(
item
)
:
void
Parameters
item:
any
Returns
void
remove
Page
Request
remove
Page
Request
(
pageIndex
)
:
void
Parameters
pageIndex:
number
Returns
void
resolve
Schema
Property
Type
resolve
Schema
Property
Type
(
propertyPath
)
:
DataSourceSchemaPropertyType
Parameters
propertyPath:
string
Returns
DataSourceSchemaPropertyType
schema
Fetch
Internal
schema
Fetch
Internal
(
)
:
void
Returns
void
set
Item
Value
set
Item
Value
(
item
,
valueName
,
value
)
:
void
Parameters
item:
any
valueName:
string
value:
any
Returns
void
Static
compare
compare
(
item1
,
item2
)
:
number
Parameters
item1:
any
item2:
any
Returns
number
Static
compare
Simple
compare
Simple
(
item1
,
item2
)
:
number
Parameters
item1:
any
item2:
any
Returns
number
Static
equals
Simple
equals
Simple
(
item1
,
item2
)
:
boolean
Parameters
item1:
any
item2:
any
Returns
boolean
Static
equals
Static
equals
Static
(
a
,
b
)
:
boolean
Parameters
a:
any
b:
any
Returns
boolean
Static
get
Array
Of
Properties
get
Array
Of
Properties
(
obj
)
:
any
[]
Parameters
obj:
any
Returns
any
[]
Static
get
Array
Of
Values
get
Array
Of
Values
(
obj
)
:
any
[]
Parameters
obj:
any
Returns
any
[]
Static
get
Hash
Code
Static
get
Hash
Code
Static
(
obj
)
:
number
Parameters
obj:
any
Returns
number
Static
reference
Equals
reference
Equals
(
a
,
b
)
:
boolean
Parameters
a:
any
b:
any
Returns
boolean