Class RevealEmbedSettings
Class used to configure the Reveal SDK embedded in your application.
Inheritance
System.Object
RevealEmbedSettings
Assembly: Infragistics.Reveal.SDK.WebAPI.dll
Syntax
public class RevealEmbedSettings : Object
Constructors
RevealEmbedSettings()
Declaration
public RevealEmbedSettings()
Properties
AdvancedSettings
Declaration
public IDictionary<string, object> AdvancedSettings { get; }
Property Value
| Type |
Description |
| System.Collections.Generic.IDictionary<System.String, System.Object> |
|
CacheEncryptionPassword
Sets the encryption password for the SQLite cache files (ignored if encryption is disabled)
Declaration
public string CacheEncryptionPassword { get; set; }
Property Value
| Type |
Description |
| System.String |
|
CachePath
Directory where the rest of cache files (like downloaded files) will be stored, it defaults to the temporary directory in the system.
Declaration
public string CachePath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
DataCachePath
Directory where files caching data will be stored, it defaults to CachePath
Declaration
public string DataCachePath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
EnableCacheEncryption
Enables the use of encryption of the SQLite cache (only works for M.D.SQLite)
It defaults to false
Declaration
public bool EnableCacheEncryption { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Export
A group of configuration options for export to image, pdf & powerpoint
Declaration
public ExportConfiguration Export { get; }
Property Value
| Type |
Description |
| Reveal.Sdk.ExportConfiguration |
|
IsLegacyCacheEnabled
Uses the legacy SQLite cache.
It defaults to true
Declaration
public bool IsLegacyCacheEnabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
License
License code to unlock Reveal BI Embedded and get rid of the Trial mode
Declaration
public string License { get; set; }
Property Value
| Type |
Description |
| System.String |
|
LocalFileStoragePath
Root directory used to load data files using the "Local" data source, see .
It defaults to "C:\Reveal\Files"
Declaration
public string LocalFileStoragePath { get; set; }
Property Value
| Type |
Description |
| System.String |
|
MaxDownloadSize
Sets a limit on the size of a single download (e.g. a CSV file). Default us 200Mb.
Declaration
public Nullable<long> MaxDownloadSize { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int64> |
|
MaxFilterSize
This property controls the maximum number of values displayed in a dashboard filter
Declaration
public Nullable<int> MaxFilterSize { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int32> |
|
MaxInMemoryCells
Set this property to the expected maximum size of pivot tables or grids, given as a number of cells.
The engine avoids using too much memory and this setting provides a hint for its memory management.
Default is 10 million cells.
Declaration
public Nullable<long> MaxInMemoryCells { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int64> |
|
MaxStorageCells
Set this property to the expected maximum size of cells to be processed from any data source
(e.g. from a Sql Server table rows, from CSV rows, etc.).
The engine avoids using too much disk space for its cache and this setting provides a hint for its
caching management. Default is 10 million cells.
Declaration
public Nullable<long> MaxStorageCells { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int64> |
|
MaxStringCellSize
Sets a limit on the number of characters any string in a dataset column may have.
Default is 256.
Declaration
public Nullable<int> MaxStringCellSize { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int32> |
|
MaxTotalStringsSize
Set this property to the expected maximum size of pivot tables or grids,
given as the total number of characters in all of its cells.
The engine avoids using too much memory and this setting provides a hint for its memory
management. Default is 64 million.
Declaration
public Nullable<long> MaxTotalStringsSize { get; set; }
Property Value
| Type |
Description |
| System.Nullable<System.Int64> |
|
NewLocalProcessingEnabled
Declaration
public bool NewLocalProcessingEnabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
ServerSideDataSourcesEnabled
Declaration
public bool ServerSideDataSourcesEnabled { get; set; }
Property Value
| Type |
Description |
| System.Boolean |
|
Methods
EnableEncryption(String)
Enables the use of encryption with an user defined password.
Declaration
public void EnableEncryption(string password)
Parameters
| Type |
Name |
Description |
| System.String |
password |
|