Class RVDataSourceItem

The basic class for data source items that can be used by visualizations to get data. When getting data from a database for example, the data source object contains the information required to connect to the database (like server host and database name) and the data source item contains the information required to get the dataset itself (like table name or view name).

Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public abstract class RVDataSourceItem

Constructors

RVDataSourceItem(RVDashboardDataSource)

Declaration
public RVDataSourceItem(RVDashboardDataSource dataSource)
Parameters
Type Name Description
RVDashboardDataSource dataSource

Properties

DataSource

Reference to the data source object this item belongs to.

Declaration
public RVDashboardDataSource DataSource { get; protected set; }
Property Value
Type Description
RVDashboardDataSource

DefaultRefreshRate

Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.

Declaration
public int? DefaultRefreshRate { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

Description

Description of this data source item.

Declaration
public string Description { get; set; }
Property Value
Type Description
System.String

Id

The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.

Declaration
public string Id { get; set; }
Property Value
Type Description
System.String

Subtitle

The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

Declaration
public string Subtitle { get; set; }
Property Value
Type Description
System.String

Title

The title of the item, as displayed to the user, it might be for example the name of the table in a database.

Declaration
public string Title { get; set; }
Property Value
Type Description
System.String