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
Worker
Settings
constructor
$type
$t
next
Hash
Code
base
Uri
batch
Completed
enable
Jsonp
entity
Set
execution
Context
filter
Expressions
fixed
Full
Count
group
Descriptions
is
Aggregation
Supported
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
equals
get
Hash
Code
memberwise
Clone
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
RestVirtualDataSourceDataProviderWorkerSettings
Class RestVirtualDataSourceDataProviderWorkerSettings
Hierarchy
Hierarchy
AsyncVirtualDataSourceDataProviderWorkerSettings
RestVirtualDataSourceDataProviderWorkerSettings
Constructors
constructor
Properties
$type
$t
next
Hash
Code
Accessors
base
Uri
batch
Completed
enable
Jsonp
entity
Set
execution
Context
filter
Expressions
fixed
Full
Count
group
Descriptions
is
Aggregation
Supported
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
Methods
equals
get
Hash
Code
memberwise
Clone
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
Worker
Settings
(
)
:
RestVirtualDataSourceDataProviderWorkerSettings
Returns
RestVirtualDataSourceDataProviderWorkerSettings
Properties
$type
$type
:
Type
Static
$t
$t
:
Type
Static
next
Hash
Code
next
Hash
Code
:
number
Accessors
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
(
a
)
:
void
Parameters
a:
(
(
success
,
requiresRefresh
,
messages
)
=>
void
)
(
success
,
requiresRefresh
,
messages
)
:
void
Parameters
success:
boolean
requiresRefresh:
boolean
messages:
string
[]
Returns
void
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
(
a
)
:
void
Parameters
a:
IDataSourceExecutionContext
Returns
void
filter
Expressions
get
filterExpressions
(
)
:
FilterExpressionCollection
Returns
FilterExpressionCollection
set
filterExpressions
(
value
)
:
void
Parameters
value:
FilterExpressionCollection
Returns
void
fixed
Full
Count
get
fixedFullCount
(
)
:
number
Returns
number
set
fixedFullCount
(
value
)
:
void
Parameters
value:
number
Returns
void
group
Descriptions
get
groupDescriptions
(
)
:
SortDescriptionCollection
Returns
SortDescriptionCollection
set
groupDescriptions
(
value
)
:
void
Parameters
value:
SortDescriptionCollection
Returns
void
is
Aggregation
Supported
get
isAggregationSupported
(
)
:
boolean
Returns
boolean
set
isAggregationSupported
(
isSupported
)
:
void
Parameters
isSupported:
boolean
Returns
void
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
(
a
)
:
void
Parameters
a:
(
(
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
(
a
)
:
void
Parameters
a:
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
)
=>
any
)
Returns
(
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
=>
any
)
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
:
any
Parameters
args:
any
[]
fetchCountOnly:
boolean
groupByString:
string
groupBy:
SortDescriptionCollection
summaryString:
string
summary:
SummaryDescriptionCollection
Returns
any
set
provideAggregationParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
=>
any
)
(
args
,
fetchCountOnly
,
groupByString
,
groupBy
,
summaryString
,
summary
)
:
any
Parameters
args:
any
[]
fetchCountOnly:
boolean
groupByString:
string
groupBy:
SortDescriptionCollection
summaryString:
string
summary:
SummaryDescriptionCollection
Returns
any
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
)
=>
any
)
Returns
(
(
args
,
filterString
,
filterExpressions
)
=>
any
)
(
args
,
filterString
,
filterExpressions
)
:
any
Parameters
args:
any
[]
filterString:
string
filterExpressions:
FilterExpressionCollection
Returns
any
set
provideFilterParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
filterString
,
filterExpressions
)
=>
any
)
(
args
,
filterString
,
filterExpressions
)
:
any
Parameters
args:
any
[]
filterString:
string
filterExpressions:
FilterExpressionCollection
Returns
any
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
)
=>
any
)
Returns
(
(
args
,
orderByString
,
orderBy
)
=>
any
)
(
args
,
orderByString
,
orderBy
)
:
any
Parameters
args:
any
[]
orderByString:
string
orderBy:
SortDescriptionCollection
Returns
any
set
provideOrderByParameter
(
value
)
:
void
Parameters
value:
(
(
args
,
orderByString
,
orderBy
)
=>
any
)
(
args
,
orderByString
,
orderBy
)
:
any
Parameters
args:
any
[]
orderByString:
string
orderBy:
SortDescriptionCollection
Returns
any
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
set
sortDescriptions
(
value
)
:
void
Parameters
value:
SortDescriptionCollection
Returns
void
summary
Descriptions
get
summaryDescriptions
(
)
:
SummaryDescriptionCollection
Returns
SummaryDescriptionCollection
set
summaryDescriptions
(
value
)
:
void
Parameters
value:
SummaryDescriptionCollection
Returns
void
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
(
a
)
:
void
Parameters
a:
number
Returns
void
Methods
equals
equals
(
other
)
:
boolean
Parameters
other:
any
Returns
boolean
get
Hash
Code
get
Hash
Code
(
)
:
number
Returns
number
memberwise
Clone
memberwise
Clone
(
)
:
Base
Returns
Base
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