Class RevealSdkSettings
Inheritance
Inherited Members
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public static class RevealSdkSettings
Properties
AuthenticationProvider
Property used to return credentials to use for data sources requiring them, like MS SQL Server and the other database providers.
Declaration
public static IRVAuthenticationProvider AuthenticationProvider { get; set; }
Property Value
Type | Description |
---|---|
IRVAuthenticationProvider | Property used to return credentials to use for data sources requiring them, like MS SQL Server and the other database providers. |
Caching
Use this property to configure cache related settings like caching paths.
Declaration
public static CachingConfiguration Caching { get; }
Property Value
Type | Description |
---|---|
CachingConfiguration |
DataProvider
Property used to return in-memory data when Reveal.Sdk.Data.RVInMemoryDataSourceItem is used.
Declaration
public static IRVDataProvider DataProvider { get; set; }
Property Value
Type | Description |
---|---|
IRVDataProvider | Property used to return in-memory data when Reveal.Sdk.Data.RVInMemoryDataSourceItem is used. |
DataSourceProvider
Property used to replace data sources on dashboards being opened. Useful to change some properties on database data sources (like server host, database name or table name) based on the current user or to use in-memory data sources. See the developer guide for more information.
Declaration
public static IRVDataSourceProvider DataSourceProvider { get; set; }
Property Value
Type | Description |
---|---|
IRVDataSourceProvider | Property used to replace data sources on dashboards being opened |
DataSources
Registry of connectors
Declaration
public static IDataSourceRegistry DataSources { get; }
Property Value
Type | Description |
---|---|
Reveal.Engine.Api.IDataSourceRegistry |
DefaultExportPath
Use this property to change the initial directory used for saving exports
Declaration
public static string DefaultExportPath { get; set; }
Property Value
Type | Description |
---|---|
System.String |
EnableActionsOnHoverTooltip
Declaration
public static bool EnableActionsOnHoverTooltip { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableBetaFeatures
Declaration
public static bool EnableBetaFeatures { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
EnableNewCharts
Declaration
public static bool EnableNewCharts { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
FormattingProvider
Property used to return formatting service that can be used to format dashboard data.
Declaration
public static IRVFormattingProvider FormattingProvider { get; set; }
Property Value
Type | Description |
---|---|
IRVFormattingProvider |
License
License code to unlock Reveal BI Embedded and get rid of the Trial mode
Declaration
public static string License { set; }
Property Value
Type | Description |
---|---|
System.String |
LocalDataFilesRootFolder
The directory that will be used as the root folder for files using the local resource provider.
This provider can be used only for CSV, Excel or JSON data files by using Reveal.Sdk.Data.RVLocalFileDataSourceItem objects in
Declaration
public static string LocalDataFilesRootFolder { get; set; }
Property Value
Type | Description |
---|---|
System.String |
LocalizationProvider
Property used to return localization service that can be used to localize dashboard data.
Declaration
public static IRVLocalizationProvider LocalizationProvider { get; set; }
Property Value
Type | Description |
---|---|
IRVLocalizationProvider |
MaxFilterSize
This property controls the maximum number of values displayed in a dashboard filter
Declaration
public static int? MaxFilterSize { get; set; }
Property Value
Type | Description |
---|---|
System.Nullable<System.Int32> |
Scripting
Use this property to configure Scripting (R and Python) visualizations.
Declaration
public static ScriptingConfiguration Scripting { get; }
Property Value
Type | Description |
---|---|
ScriptingConfiguration |
Theme
Use this property to get/set current theme. System.ArgumentNullException
Declaration
public static RevealTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
RevealTheme |
Visualizations
Here you could specify any visualization specific settings.
Declaration
public static VisualizationsConfiguration Visualizations { get; }
Property Value
Type | Description |
---|---|
VisualizationsConfiguration |