Namespace Reveal.Sdk
Classes
CachingConfiguration
DashboardModelFactory
DashboardSaveEventArgs
Argument object passed to SaveDashboard event.
DashboardSelectorRequestedEventArgs
The arguments object passed to DashboardSelectorRequested event with the callback function to invoke with the resulting dashboard.
DataSourceItemMappingResult
DataSourceSelectionEventArgs
The arguments object passed to
DataSourcesRequestedEventArgs
The arguments object passed to DataSourcesRequested event with the callback function to invoke with the resulting list of data sources.
ImageExportedEventArgs
The arguments object passed to ImageExported event with the image.
InMemoryDataUtility
MapVisualizationsConfiguration
MenuOpeningEventArgs
The type of the event arguments of the MenuOpening event.
MountainDarkTheme
Dark version of the Mountain theme
MountainLightTheme
Light version of the Mountain theme
OceanDarkTheme
Dark version of the Ocean theme
OceanLightTheme
Light version of the Ocean theme
RevealDashboardThumbnailView
A view that can be used to render the thumbnail (a preview) for a given dashboard, it can be used in a list that shows multiple dashboards, like a picker. The UpMedia.WPF sample uses this control in the OpenDashboardWindow.xaml file
RevealDataSources
Class used to represent the list of data sources and items returned by DataSourcesRequested.
RevealSdkSettings
RevealSettings
The class used to configure a new RevealView instance, including the dashboard
to render and properties to control the different features of the product (like
RevealTheme
The class contains current theme settings. After applying changes RevealView.UpdateRevealTheme function must be called and changes will be taken for those dashboards rendered after this call.
RevealUtility
Utility class used to load a dashboard object or to get the list of values for a given filter.
RevealView
The main class used to render a dashboard in your application, it also allows the edition of existing dashboards or the creation from scratch.
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.
RVAssets
Class that contains assignable assets contained within the SDK's user interface.
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
RVBaseFormattingService
The base class that must be implemented and returned by IRVFormattingProvider in order to be able to alter the format of a dashboard data.
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
RVConditionalFormatting
The class grouping conditional formatting colors."/>
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.
RVDashboard
The class representing a Dashboard model."/>
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.
RVDashboardExtensions
RVDashboardFilter
Class used to represent a dashboard filter
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).
RVDataSourceSelection
Object indicating what was selected by the end user, it could be a data source (like a database) or a data source item (like a table in a database).
RVDateDashboardFilter
Class representing the optional date filter defined in a dashboard model.
RVDateFormattingSpec
The class representing the formatting options used for Date, Time and DateTime dashboard data.
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
Class representing a possible value for a dashboard filter, retrieved from GetFilterValues(RVDashboard, RVDashboardFilter, CancellationToken).
RVFormattingSpec
The base class representing formatting options used for dashboard data.
RVGoogleAnalyticsDataSource
Google Analytics data source
RVGoogleAnalyticsDataSourceItem
Google Analytics data source item.
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.
RVImage
This class represents an object that is used to show an image within the customized app user interface.
RVImageAsset
This class represents an object that is used to show an image within the customized app user interface.
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 LocalDataFilesRootFolder for information about configuring the root directory for this storage.
RVMarketoDataSource
Marketo data source, configures the URL to get data from.
RVMarketoDataSourceItem
Marketo data source item, see RVMarketoDataSource for more information.
RVMenuItem
This class represents an object that is used to show an icon, title text, and click action of a menu item.
RVMenuItemBase
The base class used for menu items.
RVMenuSeparatorItem
This class represents an object that is used to show a seperator as a menu item.
RVMenuSubmenuItem
This class represents an object that is used to show an icon and title text of a submenu item. A submenu item contains other items, however at this time a fully featured submenu item is not fully supported. Custom created submenu items will result in an exception being thrown.
RVMySqlDataSource
MySQL data source
RVMySqlDataSourceItem
MySQL data source item
RVNativeAnalysisServicesDataSource
Microsoft Analysis Services (MS SSAS) TCP connection data source
RVNumberFormattingSpec
The class representing the formatting options used for numeric dashboard data.
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
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.
RVSharePointDataSource
Sharepoint data source, contains the URL to the Sharepoint site to use.
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
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.
ScatterMapVisualizationsConfiguration
Configuration used by Scatter Map visualization, used to configure the tiles provider (one of Bing, ESRI or MapBox) and corresponding token.
ScriptingConfiguration
SdkInMemoryIterator
TooltipShowingEventArgs
The arguments object passed to TooltipShowing event with the information about the visualization selected and the data a tooltip will be displayed for.
VisualizationClickedEventArgs
The arguments object passed to VisualizationDataPointClicked event with the information about the visualization selected and the location of the click. list of data sources.
VisualizationDataLoadingEventArgs
The type of the event arguments of the VisualizationDataLoading event.
VisualizationEditorClosedEventArgs
The type of the event arguments of the VisualizationEditorClosed event.
VisualizationEditorClosingEventArgs
The type of the event arguments of the VisualizationEditorClosing event.
VisualizationEditorOpenedEventArgs
The type of the event arguments of the VisualizationEditorOpened event.
VisualizationEditorOpeningEventArgs
The type of the event arguments of the VisualizationEditorOpening event.
VisualizationLinkingDashboardEventArgs
The arguments object passed to
VisualizationsConfiguration
Interfaces
IRVAuthenticationProvider
The interface that must be implemented and set to AuthenticationProvider, that returns credentials to be used when getting data from a given data source.
IRVDataProvider
The interface that must be implemented and set to
IRVDataSourceCredential
Base interface representing credentials to connect to a given data source
IRVDataSourceProvider
The interface that must be implemented and set to DataSourceProvider in order to replace data sources when a dashboard is opened. See 'Replacing data sources' in the developer guide for more information.
IRVFormattingProvider
The interface that must be implemented and set to FormattingProvider in order to format the different data in dashboards. See 'Formatting Service' in the developer guide for more information.
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
IRVLocalizationProvider
The interface that must be implemented and set to LocalizationProvider in order to localize the following data in dashboards: dashboard title, dashboard filter titles, visualization titles, visualization field labels and visualization summarization field labels. See 'Localization Service' in the developer guide for more information.
IRVLocalizationService
The interface that must be implemented and returned by IRVLocalizationProvider in order to be able to localize dashboard data and modify the formatting settings for a specific fields.
IRVResourceItem
Interface representing items used to get a file (resource) from one of the resource providers (Sharepoint, Web Resource, etc.)
Enums
DataSourcesRequestedTriggerType
Data sources requested trigger type, indicates the context where the data sources are being requested. Data sources can be requested for a visualization, for a dashboard filter or for data blending.
RVChartType
RVDashboardDataType
The list of dashboard data types.
RVDashboardDateAggregationType
The list of periods of time supported for aggregation.
RVDashboardNegativeFormatType
The list of formatting options for a negative numeric data.
RVDashboardNumberFormattingType
The list of formatting options for a numeric data.
RVDateFilterType
Date filter type, you can use one of the predefined filters or the custom range type.
RVGoogleAnalyticsResourceType
Google Analytics resource type.
RVLocalizationElementType
The list of dashboard elements that are supported for localization
RVMapImageryType
RVMenuLocation
Enumeration which specifies where a popup menu is about to be displayed.
RVReportingServicesRenderMode
Render mode for Reporting Services data source item, see RenderMode property.
RVSchemaColumnType
The list of data types supported by Reveal
RVSharePointAuthenticationMethod
Sharepoint authentication methods
RVSharePointItemType
Sharepoint item type
Delegates
DashboardSelectedCallback
DataSourceSelectedCallback
Callback used to indicate a data source (or data source item) was selected to be used when creating a new widget.
DataSourcesRequestedCallback
Callback used to return the list of data sources to display to the user when creating a new widget.
RevealView.LinkedDashboardProviderCallback
RevealView.MenuOpeningHandler
RevealView.VisualizationSeriesColorAssigningHandler
RVDataSourceItemsFilter
VisualizationLinkingCallback
Callback used to return the contents of the target dashboard of a navigation.