Namespace Reveal.Sdk
Classes
Dashboard
An immutable representation of a Dashboard. Could be instantiated by Stream of a .rdash file or by providing JSON string representation of the model.
DashboardInfo
A class that contains a summary of the dashboard, used by client side components to render a preview of the dashboard. You can get an instance of this object by using GetInfoAsync(String).
DefaultDashboardProvider
The Default dashboards provider to be used if such was not registered explicitly in the AddReveal() call. Same as RVDashboardProvider, only the error messages are updated to note that it was automatically registered.
DIExtensions
ExportConfiguration
InMemoryDataUtility
RevealEmbedSettings
Class used to configure the Reveal SDK embedded in your application.
RevealSetupBuilder
Builder class used to register/build services that might be needed for Reveal.
RVAmazonWebServicesCredentials
RVAnalysisServicesDataSource
Abstract base class for Microsoft Analysis Services (MS SSAS) data sources
RVAnalysisServicesDataSourceItem
Microsoft Analysis Services (MS SSAS) item, specifies the cube to get data from.
RVAthenaDataSource
Amazon Athena data source
RVAthenaDataSourceItem
Amazon Athena data source item.
RVAzureAnalysisServicesDataSource
Microsoft Azure Analysis Services data source
RVAzureSqlDataSource
Azure SQL Server data source
RVAzureSqlDataSourceItem
Azure SQL Server data source item
RVAzureSynapseDataSource
Azure Synapse data source
RVAzureSynapseDataSourceItem
Azure Synapse data source item
RVBaseSharePointDataSourceItem
The base abstract class for data source items from Sharepoint.
RVBearerTokenDataSourceCredential
The class used to represent Bearer (aka 'Token') authentication.
RVBigQueryDataSource
BigQuery data source
RVBigQueryDataSourceItem
BigQuery data source item
RVBoxDataSource
Box data source
RVBoxDataSourceItem
Box data source item, referencing a file in Box (box.net)
RVChartSettings
RVChartType
RVCsvDataSource
The data source object used to represent the CSV data source, there are no additional properties in this class as all relevant information is specified in the RVCsvDataSourceItem object.
RVCsvDataSourceItem
The data source item used to represent a dataset from a CSV file, it includes optional settings like the separator to use when parsing the data.
RVDashboardDataSource
The base class representing a data source used in a dashboard, you can see RVDataSourceItem for more information about the relationship between data source and data source items.
RVDashboardFilter
Class used to represent a dashboard filter
RVDashboardProvider
Default file system based implementation of IRVDashboardProvider loading/saving .rdash files from a specified(through the constructor) directory. If the dashboardId does not ends with .rdash it will be added upon save and load.
RVDataCell
Class representing a cell in the visualization data, includes column name, value and formatted value.
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).
RVDateDashboardFilter
Class representing the optional date filter defined in a dashboard model.
RVDateFilterType
Date filter type, you can use one of the predefined filters or the custom range type.
RVDateRange
Class used to represent a date range for filtering.
RVDropboxDataSource
Dropbox data source
RVDropboxDataSourceItem
Dropbox data source item, referencing a file in Dropbox
RVDynamicsCrmDataSource
Dynamics CRM data source, specifies the URL to the server.
RVDynamicsCrmDataSourceItem
Dynamics CRM data source item
RVExcelDataSource
The data source object used to represent the Excel data source, there are no additional properties in this class as all relevant information is specified in the RVExcelDataSourceItem object.
RVExcelDataSourceItem
The data source item used to represent a dataset from an Excel file, it includes information like the name of the sheet to get data from and the range to use when loading data.
RVExcelRange
Class defining the range that should be used when loading data from an Excel sheet.
RVFieldEditorDefaultSettings
A class used to provide the desired default settings for the field editor.
RVFilterValue
RVGoogleAnalyticsDataSource
Google Analytics data source
RVGoogleAnalyticsDataSourceItem
Google Analytics data source item.
RVGoogleAnalyticsResourceType
Google Analytics resource type.
RVGoogleDriveDataSource
Google Drive data source
RVGoogleDriveDataSourceItem
Google Drive data source item, referencing a file in Google Drive
RVGoogleSearchConsoleDataSource
Google Search Console data source
RVGoogleSearchConsoleDataSourceItem
Google Search Console data source item
RVGoogleSheetDataSource
The data source object used to represent the Google sheet data source, there are no additional properties in this class as all relevant information is specified in the RVGoogleSheetDataSourceItem object.
RVGoogleSheetDataSourceItem
The data source item used to represent a dataset from a Google Sheet file, it includes information like the name of the sheet to get data from and the range to use when loading data.
RVHeadersDataSourceCredentials
The class used to represent authentication using headers (including cookies), supported only by Web Resource and REST API data sources. When sending HTTP requests to get data for the data source, the specified headers will be included.
RVHttpAnalysisServicesDataSource
Microsoft Analysis Services (MS SSAS) HTTP connection data source
RVHubspotDataSource
HubSpot data source
RVHubspotDataSourceItem
HubSpot data source item, referencing a HubSpot entity.
RVInMemoryData
Base class that can be used as a helper class to implement IRVInMemoryData, you need to provide the data as an object implementing IEnumerable of IEnumerable objects (each object representing a cell in the data), and the list of fields in the schema. Each row returned by the 'Data' enumerable must have the same number of elements indicated in the schema, the order must be respected and values must be returned in the same order specified in the schema returned.
RVInMemoryData<T>
In-memory data implementation that returns data from the IEnumerable object passed to the constructor, this is the recommended implementation of IRVInMemoryData to use in most of the use cases, as it's the simpler to use. The schema will be automatically calculated from the T data type.
RVInMemoryDataSource
The data source object used to represent the in-memory data source, there are no additional properties in this class as all relevant information is specified in the RVInMemoryDataSourceItem object.
RVInMemoryDataSourceItem
Data source item to get in-memory data
RVJsonDataSource
The data source object used to represent the JSON data source, there are no additional properties in this class as all relevant information is specified in the RVJsonDataSourceItem object.
RVJsonDataSourceItem
The data source item used to represent a dataset from a JSON file, it includes the optional parsing configuration.
RVLocalFileDataSource
The data source object used to represent the local files data source, there are no additional properties in this class as all relevant information is specified in the RVLocalFileDataSourceItem object.
RVLocalFileDataSourceItem
The local file data source item, used to load files from local storage. See
RVMarketoDataSource
Marketo data source, configures the URL to get data from.
RVMarketoDataSourceItem
Marketo data source item, see RVMarketoDataSource for more information.
RVMySqlDataSource
MySQL data source
RVMySqlDataSourceItem
MySQL data source item
RVNativeAnalysisServicesDataSource
Microsoft Analysis Services (MS SSAS) TCP connection data source
RVODataDataSource
OData data source, configures the URL to get data from.
RVODataDataSourceItem
OData data source item, see RVODataDataSource for more information.
RVOneDriveDataSource
OneDrive data source
RVOneDriveDataSourceItem
OneDrive data source item, referencing a file in OneDrive.
RVOracleDataSource
Abstract base class for Oracle data sources
RVOracleDataSourceItem
Oracle data source item
RVOracleServiceDataSource
Oracle data source, it adds the Service name property to the base properties in RVOracleDataSource.
RVOracleSIDDataSource
Oracle data source, it adds the SID property to the base properties in RVOracleDataSource.
RVPostgresDataSource
PostgreSQL data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVPostgresDataSourceItem
PostgreSQL data source item
RVQuickBooksDataSource
QuickBooks data source
RVQuickBooksDataSourceItem
QuickBooks data source item
RVRedshiftDataSource
Amazon Redshift data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVRedshiftDataSourceItem
Amazon Redshift data source item
RVReportingServicesDataSource
Microsoft Reporting Services (MS SSRS) data source
RVReportingServicesDataSourceItem
Microsoft Reporting Services (MS SSRS) data source item
RVReportingServicesRenderMode
Render mode for Reporting Services data source item, see RenderMode property.
RVResourceBasedDataSourceItem
The base abstract class representing a data source item getting data from a file (a resource). This is the base class for CSV, Excel and JSON data source items. It contains the reference to the resource item providing the file, for example a CSV file from a Web Resource URL will be represented as a RVCsvDataSourceItem referencing a RVWebResourceDataSourceItem.
RVRESTDataSource
REST API data source, configures the URL to get data from, HTTP method to use and optionally headers and body to send in the request.
RVRESTDataSourceItem
REST API data source item
RVS3DataSource
Amazon S3 data source
RVS3DataSourceItem
Amazon S3 data source item.
RVSchemaColumn
The class representing a column in the in-memory result, specifies name, label and data type of the column.
RVSchemaColumnAttribute
Attribute that can be used to alter the field name and/or data type of any of the properties in a class declaration. Supported when implementing In-Memory data.
RVSchemaColumnType
The list of data types supported by Reveal
RVSharePointAuthenticationMethod
Sharepoint authentication methods
RVSharePointDataSource
Sharepoint data source, contains the URL to the Sharepoint site to use.
RVSharePointItemType
Sharepoint item type
RVSharePointListDataSourceItem
Data source item to get data from a Sharepoint list
RVSharePointListItemDataSourceItem
Data source item to get data from a single item in a Sharepoint list.
RVSharePointPeopleDataSourceItem
Data source item to get data from people in Sharepoint
RVSharePointSiteDataSourceItem
Data source item to show information from a site (or sub site)
RVSnowflakeDataSource
Snoflake data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVSnowflakeDataSourceItem
Snowflake data source item
RVSqlBasedDataSource
The base data source class used to represent a connection to one of the supported database systems.
RVSqlBasedDataSourceItem
The base item class used to represent a dataset from one of the supported database systems.
RVSqlPDSDataSource
RVSqlPDSDataSourceItem
RVSqlServerDataSource
Microsoft SQL Server data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVSqlServerDataSourceItem
Microsoft SQL Server data source item
RVSyBaseDataSource
Sybase data source, it adds the database name property to the base properties in RVSqlBasedDataSource.
RVSyBaseDataSourceItem
Sybase data source item
RVUserContext
Default implementation of the IRVUserContext interface.
RVUsernamePasswordDataSourceCredential
The class used to represent domain/user/password credentials, required to connect to all data bases (MS SQL, MySQL, etc) and some other data sources (REST API for example).
RVVisualization
The class representing a visualization (widget) in the dashboard model.
RVWebResourceDataSource
Web resource data source, used to download files from HTTP URL's using GET method. See RVRESTDataSource to use other HTTP methods or to customize parameters, headers and body to sent.
RVWebResourceDataSourceItem
Web resource data source item, see RVWebResourceDataSource for more information.
SdkInMemoryIterator
Interfaces
IRVAuthenticationProvider
The interface that must be implemented and registered when adding Reveal in Startup ConfigureServices. It returns credentials to be used when getting data from a given data source.
IRVDashboardProvider
An interface that handles loading and saving dashboards.
IRVDataProvider
The interface that must be implemented and returned in
IRVDataSourceCredential
Base interface representing credentials to connect to a given data source
IRVDataSourceProvider
The interface that must be implemented and returned in
IRVInMemoryData
The interface representing in-memory data to be returned by IRVInMemoryDataProvider, please note data is returned as an IEnumerable, so there's no need to have all data loaded in memory. You would probably use the default implementation for this interface: RVInMemoryData<T>
IRVInMemoryDataProvider
IRVObjectEncoder
Allows the encoding of information in DataSource or DataSourceItems, before returning those objects to the client. DataSource and DataSourceItems information is typically sent from the server to the client when editing a dashboard. Decoding should be done using an IRVDataSourceProvider implementation. Only supported for Database providers.
IRVObjectFilter
Allows filtering of 'objects' (DataSource and DataSourceItems) to be returned to the client. This makes it possible, for example, to avoid some tables or views to be seen when creating a Database data source. Only supported for Database providers.
IRVResourceItem
Interface representing items used to get a file (resource) from one of the resource providers (Sharepoint, Web Resource, etc.)
IRVUserContext
An interface used to identify the user, related to a particular call to the methods of Reveal.Sdk.IRVDashboardProvider, IRVAuthenticationProvider, IRVDataProvider and other providers. You can store some user specific data in the Properties like user's permission that you want to use in some of the providers listed above. You can use RVUserContext as a default implementation.
IRVUserContextProvider
An interface that handle user resolution.