GenericDataProvider

Version: 9.0

You use the GenericDataProvider component to provide data for, for example, a ListControl. You will often use a ListControl in the DetailsPanel part of a JourneyChart control.

The GenericDataProvider component works in the same way as the ChartDataProvider component. It also calls an MVC Controller that must return data as a JSON object.

Properties

Name

Description

Default

ListSorting

This is a read-only property. You bind to this property from the Sorting property of a ListControl control.

PageNumber

The GenericDataProvider component updates this property with the index (number) of the current page when the PageSize property is smaller than the total number of pages.

PageSize

Specify the number of records that the component retrieves from Sitecore.

Data

Data

SPEAK updates this property with the data the service returns. This is a read-only property.

DataURL

Specify the URL of the service the component calls.

Messages

SPEAK updates this property with the messages the service returns, if any. This is a read-only property.

QueryParameters

Specify parameters for the service the component calls. This property is optional.

ServerSorting

Specify how the server sorts data. You specify an array of data sorting directions and data sorting fields. For example, to sort on the field called “visits” and set the sorting direction to “asc”, you enter this: {"field": "visits", "direction":"asc"}.

You specify asc for ascending sort, and desc for descending.

State

HasData

The component sets this read-only property to True when it has data after getting a response from the service.

HasMoreData

The component sets this read-only property to True when the service has more data than what has already been retrieved.

HasNoData

The component sets this read-only property to True when it does not have data after getting a response from the service.

IsBusy

The component sets this read-only property to True when it is waiting for a response from the service.

TotalRecordCount

The component sets this read-only property to the number of total records the query retrieved.

Do you have some feedback for us?

If you have suggestions for improving this article,