Class IgxGenericVirtualDataSource

The base class for generic data sources.

Hierarchy

IgxBaseGenericDataSource
- IgxGenericVirtualDataSource

Constructors

constructor

new IgxGenericVirtualDataSource(): IgxGenericVirtualDataSource
Overrides IgxBaseGenericDataSource.constructor
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:13
Returns IgxGenericVirtualDataSource

Accessors

executionContext

get executionContext(): IDataSourceExecutionContext
Inherited from IgxBaseGenericDataSource.executionContext
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:26
Gets or sets the execution context that the data source should synchronize asynchronous actions with, or use to defer delayed actions.

Returns IDataSourceExecutionContext
set executionContext(v: IDataSourceExecutionContext): void
Inherited from IgxBaseGenericDataSource.executionContext
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:27
Parameters
- v: IDataSourceExecutionContext
Returns void

filterExpressions

get filterExpressions(): IgxFilterExpressionCollection
Inherited from IgxBaseGenericDataSource.filterExpressions
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:43
Gets the current filter that is applied to the data source.

Returns IgxFilterExpressionCollection

groupDescriptions

get groupDescriptions(): IgxDataSourceGroupDescriptionCollection
Inherited from IgxBaseGenericDataSource.groupDescriptions
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:35
Gets the current grouping that is applied to the data source.

Returns IgxDataSourceGroupDescriptionCollection

pageRequested

get pageRequested(): EventEmitter<{
args: IgxPageRequestedEventArgs;
sender: any;
}>
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:56
Raised when the datasource requests page data.

Returns EventEmitter<{
args: IgxPageRequestedEventArgs;
sender: any;
}>

sortDescriptions

get sortDescriptions(): IgxDataSourceSortDescriptionCollection
Inherited from IgxBaseGenericDataSource.sortDescriptions
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:31
Gets the current sort that is applied to the data source.

Returns IgxDataSourceSortDescriptionCollection

summaryDescriptions

get summaryDescriptions(): IgxDataSourceSummaryDescriptionCollection
Inherited from IgxBaseGenericDataSource.summaryDescriptions
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:39
Gets the current summaries that are applied to the data source.

Returns IgxDataSourceSummaryDescriptionCollection

Methods

addSchemaProperty

addSchemaProperty(propertyName: string, propertyType: string | GenericDataSourceSchemaPropertyType): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:37
Parameters
- propertyName: string
- propertyType: string | GenericDataSourceSchemaPropertyType
Returns void

addSummaryDate

addSummaryDate(propertyName: string, operand: string | DataSourceSummaryOperand, value: Date): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:51
Parameters
- propertyName: string
- operand: string | DataSourceSummaryOperand
- value: Date
Returns void

addSummaryDouble

addSummaryDouble(propertyName: string, operand: string | DataSourceSummaryOperand, value: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:49
Parameters
- propertyName: string
- operand: string | DataSourceSummaryOperand
- value: number
Returns void

addSummaryInt

addSummaryInt(propertyName: string, operand: string | DataSourceSummaryOperand, value: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:48
Parameters
- propertyName: string
- operand: string | DataSourceSummaryOperand
- value: number
Returns void

addSummaryString

addSummaryString(propertyName: string, operand: string | DataSourceSummaryOperand, value: string): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:50
Parameters
- propertyName: string
- operand: string | DataSourceSummaryOperand
- value: string
Returns void

fillColumnBool

fillColumnBool(column: string, values: boolean[]): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:32
Parameters
- column: string
- values: boolean[]
Returns void

fillColumnDate

fillColumnDate(column: string, values: Date[]): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:36
Parameters
- column: string
- values: Date[]
Returns void

fillColumnDouble

fillColumnDouble(column: string, values: number[]): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:34
Parameters
- column: string
- values: number[]
Returns void

fillColumnInt

fillColumnInt(column: string, values: number[]): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:33
Parameters
- column: string
- values: number[]
Returns void

fillColumnString

fillColumnString(column: string, values: string[]): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:35
Parameters
- column: string
- values: string[]
Returns void

fillCount

fillCount(count: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:31
Provides the row count for the datasource. The datasource obtains this from the page request so be must be called after FillPageStart.

Parameters
- count: number
  - The row count.
Returns void

fillGroupEnd

fillGroupEnd(): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:43
Ends the current group.

Returns void

fillGroupStart

fillGroupStart(startIndex: number, endIndex: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:38
Parameters
- startIndex: number
- endIndex: number
Returns void

fillGroupValueDate

fillGroupValueDate(propertyName: string, value: Date): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:47
Parameters
- propertyName: string
- value: Date
Returns void

fillGroupValueDouble

fillGroupValueDouble(propertyName: string, value: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:45
Parameters
- propertyName: string
- value: number
Returns void

fillGroupValueInt

fillGroupValueInt(propertyName: string, value: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:44
Parameters
- propertyName: string
- value: number
Returns void

fillGroupValueString

fillGroupValueString(propertyName: string, value: string): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:46
Parameters
- propertyName: string
- value: string
Returns void

fillPageEnd

fillPageEnd(): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:24
Ends the current page. Must be called after FillPageStart.

Returns void

fillPageStart

fillPageStart(requestId: number): void
- Defined in igniteui-angular-core/lib/igx-generic-virtual-data-source.d.ts:19
Starts filling a page for the specified request. Must later be followed by FillPageEnd to complete the request.

Parameters
- requestId: number
  - The ID of the requested page.
Returns void

findByName

findByName(name: string): any
Inherited from IgxBaseGenericDataSource.findByName
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:44
Parameters
- name: string
Returns any

queueAutoRefresh

queueAutoRefresh(): void
Inherited from IgxBaseGenericDataSource.queueAutoRefresh
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:49
Called to manually queue a refresh of the data source.

Returns void

`Static` _createFromInternal

_createFromInternal(internal: any): IgxBaseGenericDataSource
Inherited from IgxBaseGenericDataSource._createFromInternal
- Defined in igniteui-angular-core/lib/igx-base-generic-data-source.d.ts:19
Parameters
- internal: any
Returns IgxBaseGenericDataSource

Class IgxGenericVirtualDataSource

Hierarchy

Hierarchy

Constructors

Accessors

Methods

Constructors

constructor

Returns IgxGenericVirtualDataSource

Accessors

executionContext

Returns IDataSourceExecutionContext

Parameters

v: IDataSourceExecutionContext

Returns void

filterExpressions

Returns IgxFilterExpressionCollection

groupDescriptions

Returns IgxDataSourceGroupDescriptionCollection

pageRequested

Returns EventEmitter<{ args: IgxPageRequestedEventArgs; sender: any; }>

sortDescriptions

Returns IgxDataSourceSortDescriptionCollection

summaryDescriptions

Returns IgxDataSourceSummaryDescriptionCollection

Methods

addSchemaProperty

Parameters

propertyName: string

propertyType: string | GenericDataSourceSchemaPropertyType

Returns void

addSummaryDate

Parameters

propertyName: string

operand: string | DataSourceSummaryOperand

value: Date

Returns void

addSummaryDouble

Parameters

propertyName: string

operand: string | DataSourceSummaryOperand

value: number

Returns void

addSummaryInt

Parameters

propertyName: string

operand: string | DataSourceSummaryOperand

value: number

Returns void

addSummaryString

Parameters

propertyName: string

operand: string | DataSourceSummaryOperand

value: string

Returns void

fillColumnBool

Parameters

column: string

values: boolean[]

Returns void

fillColumnDate

Parameters

column: string

values: Date[]

Returns void

fillColumnDouble

Parameters

column: string

values: number[]

Returns void

fillColumnInt

Parameters

column: string

values: number[]

Returns void

fillColumnString

Parameters

column: string

values: string[]

Returns void

Returns EventEmitter<{
args: IgxPageRequestedEventArgs;
sender: any;
}>

`Static` _createFromInternal