Release Notes

All future updates and new features added to Reveal SDK will be included here.


Date SDK version Description
Mar-2022 1.1.3 New data source: Google Search Console!
Added a new helper class to configure a JSON Data Source Item: RevealApi.RVJsonSchemaConfigBuilder.
Added a new event to cancel data loading for a visualization: onVisualizationDataLoading.
[Public Bug Fix] Dashboard linking with renamed fields issue
If you renamed a field and then used it as a filter in a dashboard link, the linked dashboard was not filtering properly.
Jan-2022 1.1.2 .NET [Public Bug Fix] [SDK] LocalizationProvider and DataSourceProvider issue
Setting up a LocalizationProvider was not working in a few cases in which a DataSourceProvider was also set up.
[Public Bug Fix] [SDK] Export to Excel with null values in column names issue
When exporting to excel having a null value in a column name, the app was crashing with InvalidCastException.
[Public Bug Fix] [SDK] Export to PDF/PPT with custom logo issue
Exporting to PDF or PPT formats and including a custom branding logo was not working as expected.
[Public Bug Fix] [SDK] Dashboard filtering issue
When using a large data source with dashboard linking and filtering, the app was not showing filtered data as expected.
[Public Bug Fix] [SDK] Dashboard linking and drilled down data issue
When dashboard linking passes information from a visualization, previously drilled down to values were not being included.
The .NET Server SDK was enhanced with several changes:
- .NET server logging - You can now enable .NET server logging for Reveal SDK. It’s managed with upsetting.json LogLevel like "Reveal.Sdk.": "Trace”.
- Playwright-based Export - Export to image, PDF and PPT are now based on Playwright instead of Puppeteer. For further details, read about how can to adjust your deployment procedures.
For further details, please read about how to adjust your deployment.
Dec-2021 1.1.1 .NET Localization support for web
$.ig.RevealSdkSettings.localizedStringsProvider extension point enables localization of several dashboard elements: Dashboard title, Widget title, Field labels, Dashboard Filter titles.
Formatting support for web
$.ig.RevealSdkSettings.fieldFormattingSettingsProvider extension point allows defining custom formatting for any date time or numeric field.
Added option to hide the dashboard header – including the title and the kebab menu.
ShowHeader (WPF) & showHeader (JS).
Added an option to enable/disable the end user ability to maximize visualizations
CanMaximizeVisualizationProperty (WPF) & canMaximizeVisualizationProperty (JS).
Made easier to check if fonts are loaded before rendering in the browser
Now you can you can skip the WebFontLoader library and use $.ig.RevealSdkSettings.ensureFontsLoadedAsync() to make sure all fonts have been loaded. Instantiate RevealView once the promise returned by this method completes to make sure the fonts needed are loaded.
Added a new option in the editor to enable/disable the end user ability to change the background color for a given visualization in the visualization editor.
CanChangeVisualizationBackgroundColorProperty (WPF) & canChangeVisualizationBackgroundColor (JS).
New way to change the background color for a visualization programmatically.
SetVisualizationBackgroundColor (WPF) & setVisualizationBackgroundColor (JS).
[Public Bug Fixes]
- Fixed export to Excel when there are null date values in the dataset.
- Fixed issue exporting to PDF or PPT with custom branding logo.
Dec-2021 1.1.0 JAVA The Java Server SDK was greatly improved, for further details please refer to Reveal Java SDK Upgrade to v1.1.
[Public Bug Fixes] [SDK]
- Fixed export to Excel when there are null date values in the dataset.
- Fixed issue exporting to PDF or PPT with custom branding logo.
Nov-2021 1.0.9 JAVA [Public Bug Fix] [SDK] RevealView's availableChartTypes had a timing issue
Setting the availableChartTypes property right after initializing the RevealView object was causing issues.
[Public Bug Fix] [SDK] RVDateRange Property not returning the expected type
The from property in the RVDateRange class was not returning a JavaScript Date.
Search fields in the Data Blending screen
The Data Blending UI was improved by adding the ability to search for fields to be joined/added in the result.
Oct-2021 1.1.0 .NET The .NET Server SDK was enhanced with several changes:
- Registering Reveal services is more flexible - You now can inject other services in your implementations of Reveal interfaces. You only register the type of your implementations of your Reveal providers interfaces.
- RevealSDKContext removed - RVUserContext is now first class citizen across reveal providers. You need to register a UserContextProvider, which will be instantiating that class and it would be passed to the methods of other Reveal services like IRVDashboardProvider.
- .NET Core 3.1 or newer is now required - Reveal dropped support for .NET Core running on top of .NET Framework v4.6.2 or higher and .NET core 2.2 as it is out of support.
- Improved setup for default implementations - Greatly improved setup for default implementations - Now it's pretty simple to setup Reveal if you have your dashboards in a "Dashboards" folder and your local data files (csv or excel) are located in your "Data" folder on the project root level. Example:
services
  .AddMvc()
  .AddReveal();

For further details, please refer to Reveal .NET SDK Upgrade to v1.1.
IRVDataSourceProvider interface changed (Desktop and .NET Server SDK)
The IRVDataSourceProvider interface now has a single ChangeDataSourceItem and it will be called whenever a dashboard need to use a data source item.
Dashboard links in the visualization editor (JavaScript Client SDK)
The JavaScript SDK now supports the creation of dashboard links in the visualization editor. To try this feature, edit one of the ASP UpMedia sample's visualizations and then go to settings to click the plus sign right from Links.
[Public Bug Fix] [SDK] onDateFilterChanged JavaScript event not being triggered
In the Web Client SDK, the onDateFilterChanged event (RVDashboard property) was not being triggered when changing or removing a filter.
[Public Bug Fix] [SDK] availableChartTypes JavaScript accessor not working as expected
In the Web Client SDK, you were not able to instantiate RevealView and immediately set the available charts for end users to pick from (availableChartTypes).
Search fields in the Data Blending screen
The Data Blending UI was improved by adding the ability to search for fields to be joined/added in the result.
Sep-2021 1.0.2013 [Public Bug Fix] Calculated field export to excel resulting in empty cells
When exporting to excel a calculated field doing division by zero, the result included empty cells.
[Public Bug Fix] Data blending with custom queries and server-side processing issues
When turning on “Process Data On Server” in Web .NET and performing a custom query, data blending was not working as expected.
Sep-2021 1.0.2012 [Public Bug Fix] [SDK] Decimal point hidden when Sparkline chart exceeds 100%
In the Web SDK, the property canSaveAs was not being honored if it was changed after a dashboard is set.
[Public Bug Fix] [SDK] Small window sizes render Text chart unreadable
In both Web and Desktop, the Text Chart font becomes unreadable when the window’s size is small.
[Public Bug Fix] [SDK] Issues getting the list of date formats
When getting a list of date formats for a field editor in the Desktop SDK, you can now use RVBaseFormattingService with aggregated dates.
Aug-2021 1.0.2008 [Public Bug Fix] [SDK] Saving dashboard as a stream has issues
When saving dashboards as a stream, in some specific cases dashboard.Serialize.Async() was returning null.
June-2021 1.0.2005 Scatter Maps now support OpenStreetMap!
You can now configure and use OpenStreet Map image tiles in Desktop (WPF) and Web-client (JS).
New Thumbnail component!
You can now render a thumbnail of a dashboard with RevealDashboardThumbnailView.
Credentials from Web client to server-side data source
A new type of credentials RVHeadersDataSourceCredentials allow you to send authentication headers and cookies to REST and Web Resource data sources. For further details, check the following sample in GitHub.
SDK AspNetCore services injection
You can now register the RevealSdkContext and RevealUserContext implementations as a type only (not passing an instance), allowing these classes to get any other AspNetCore services injected through the constructor. For further details check the following sample in GitHub.
[Public Bug fix] Calculated field filter not working with data process on server
When enabling server-side aggregation of the data, calculated fields used as filters were not filtering data as expected.
[Public Bug fix] Google Analytics issues with dashboard filters
When getting data from Google Analytics data sources, you were unable to create dashboard filters.
June-2021 1.0.7 JAVA Scatter Maps now support OpenStreetMap!
You can now configure and use OpenStreet Map image tiles in the SDK Web-client (JS).
[Public Bug fix] [SDK] Text Box content not visible after component is remounted
When using React with a dashboard and a Text Box visualization, content was not visible after component remount. A page reload was required.
[Public Bug fix] Calculated field filter not working with data process on server
When enabling server-side aggregation of the data, calculated fields used as filters were not filtering data as expected.
[Public Bug fix] Google Analytics issues with dashboard filters
When getting data from Google Analytics data sources, you were unable to create dashboard filters.
June-2021 1.0.6 JAVA [Bug Fix] [SDK] Grizzly server throws an exception
When running Reveal in Grizzly, a NoClassDefFoundError exception was being thrown because of a wrong dependency in javax.servlet.ServletContext class (javax.servlet:javaz.servlet-api assembly).
New sample for JAVA SDK released!
There is a new GitHub sample showing how to use Reveal with Grizzly server.
June-2021 1.0.5 JAVA Credentials from Web client to server-side data source
A new type of credentials RVHeadersDataSourceCredentials allow you to send authentication headers and cookies to REST and Web Resource data sources. For further details, check the following sample in GitHub.
May-2021 1.0.1956 (1.0.4 JAVA) [Public Bug Fix] [SDK] Full list of Data Sources displayed by mistake
When using DataSourcesRequested callback in the Desktop SDK, the whole list of data sources was being displayed instead of the ones explicitly added.
[Public Bug Fix] [SDK] Desktop SDK export to Excel not working as expected
When reloading a dashboard and then exporting a single visualization to Excel, the first visualization of the dashboard was always the one exported.
[Public Bug Fix] [SDK] Dashboard with SQL data source using a dynamic port not loading
When loading a dashboard with an SQL data source defined using a dynamic port (providing an instance in the host field), the data source connection was not working because of issues with the dynamic port configuration.
[Public Bug Fix] Calculated field set as Visualization filter were throwing an error
When configuring a Visualization filter based on a calculated field that depends on another calculated field, an error was being shown ("Invalid column name").
[Public Bug Fix] Drill down scenario with different "sort by" configurations not working as expected
When the fields in a hierarchy were configured with a combination of "sort by: " and a descending sorting, the result was the dashboard not loading.
Credentials from Web client to server-side in cross-domain applications
When the backend is not in the same domain as the frontend and you need authentication cookies, you can request credentials using the following Web SDK setting: $.ig.RevealSdkSettings.requestWithCredentialsFlag = true;
May-2021 1.0.3 JAVA New Snowflake connector!
Reveal Java SDK now supports Snowflake data source connector, also including data blending between tables in the same Snowflake database.
Reveal BI Engine for Java was enhanced
Java platform is now as robust as other platforms, helping to avoid server crashes when a visualization sends a big amount of data back to the client. Several new properties in InitializeParameterBuilder control this: maxInMemoryCells, maxStorageCells, maxStringCellSize, and maxTotalStringSize.
Apr-2021 1.0.0 JAVA New JAVA SDK released!
Reveal now supports JAVA as another Web Server option besides .NET. The JAVA SDK requires JAVA 11+ and is distributed as a set of Maven modules. For further details, please refer to Setup and Configuration.
JAVA SDK Samples released!
You can get the JAVA SDK UpMedia samples available in Github.
Mar-2021 1.0.1866 New Properties for Web and Desktop SDK:
showEditDataSource - can be used to disable the Edit button normally available in the data source overflow menu.
canAddDashboardFilter - this property can hide the "Add Dashboard Filter" option in the Add Filter menu. These options are available in Dashboard Edit Mode.
canAddDateFilter - this property can hide the "Add Date Filter" option in the Add Filter menu. These options are available in Dashboard Edit Mode.
[Public Bug Fix] [SDK] revealView.canSaveAs property not working as expected
In the Web SDK, the property canSaveAs was not being honored if it was changed after a dashboard is set.
[Public Bug Fix] [SDK] HttpContextAccessor.HttpContext property not working as expected
In the Web SDK, HttpContextAccessor.HttpContext was null when saving a dashboard (accessing it from SaveDashboardAsync method).
Mar-2021 1.0.1821 [Public Bug Fix] [SDK] SDK apps sometimes throw an NRE exception
When an SDK application was opened for more than 90 minutes without users interacting with it, performing an action was throwing an exception.
Feb-2021 1.0.1772 [Bug Fix] [SDK] Installation of WPF NuGet package failing with packages.config
The installation of WPF NuGet package was failing when the host project used packages.config.
Feb-2021 1.0.1763 [Public Bug Fix] [SDK] HasPendingChanges property not working as expected
In Desktop SDK, the HasPendingChanges property was not set to false after saving a dashboard with changes.
[Public Bug Fix] [SDK] Custom filtering not working
In Desktop SDK, custom queries were not filtering data as expected.
[Public Bug Fix] [SDK] Hiding SQLServer tables also hides views
When using RVDataSourceItemsFilter to hide all tables and show only views, the Views tab was also hidden.
[Public Bug Fix] [SDK] AzureSQL Data Provider throwing an error
When adding an AzureSQL connection, an error message was displayed.
[Public Bug Fix] [SDK] Date filters not displayed if LocalizationProvider set
When a LocalizationProvider was set, date filters from/to were not displayed in the visualizations editor.
[Public Bug Fix] Word not localized to Japanese
The word "Others" was not localized to "その他" in Japanese.
Jan-2021 1.0.1712 [Public Bug Fix] [SDK] The server component relies on Newtonsoft.Json serializer
The Reveal server component was relying on the default JSON serialization settings of the MVC application. Now the hosting app can configure JSON serialization settings as needed.
[Public Bug Fix] [SDK] SQL Server filtering not working for NVARCHAR columns
Filtering for Microsoft SQL Server was not working for NVARCHAR columns when the filtered value contained multibyte characters.
Dec-2020 1.0.1669 [Public Bug Fix] [SDK] Pivot hierarchies filtering not working with "Processing Data on Server"
If the option "Processing Data on Server" was checked, drill down hierarchies in the Pivot Editor were not filtering data.
[Public Bug Fix] [SDK] Custom filtering not working with "Processing Data on Server
If the option "Processing Data on Server" was checked, custom queries were not returning the correct number of rows.
Dec-2020 1.0.1629 Save/Load Dashboards using JSON
You can now use Reveal SDK to save/load dashboards to/from JSON files.
[Public Bug Fix] Category field label not being shown
In Category Charts, tooltips were not displaying the field label but the original field name of a category instead.
[Public Bug Fix] Dates in drill down breadcrumbs wrongly displayed
When drilling down on a date field, breadcrumbs did not display values properly. Now breadcrumbs give clear information about your drill down level.
[Public Bug Fix] Hover Tooltips and Crosshairs not shown by default
In Dashboard View mode, Hover Tooltips and Crosshairs were not displayed until users enable them. Now they are enabled by default.
Sep-2020 1.0.1422 Amazon Athena connector in BETA
You can now connect to Amazon's serverless, interactive query service Athena.
NEW Pre-built Themes
We added four pre-built app themes. Set one of them and use the customizable settings to additionally personalize the look and feel of the Visualization and Dashboard editor. You can choose from one of the following themes: MountainLightTheme (Desktop) / $.ig.MountainLightTheme (Web); MountainDarkTheme (Desktop) / $.ig.MountainDarkTheme (Web); OceanLightTheme (Desktop) / $.ig.OceanLightTheme (Web); OceanDarkTheme (Desktop) / $.ig.OceanDarkTheme (Web).
Marketo provider is Now Available
You can now connect to the marketing platform Marketo and use your data in Reveal.
Amazon Redshift provider is Now Available
You can now use and gain new insights from your data in the Amazon Redshift cloud data warehouse.
New "Data Process on Server" feature
You can now have server-side aggregation of the data coming from the MS SQL, MySQL and Postgres data sources
Jul-2020 1.0.1374 New API to set axis bounds for charts
You can now programmatically change the axis bounds in runtime for a particular visualization.
Salesforce data source enhancements
Now you can use your Salesforce reports in Reveal.
New QuickBooks data source
Connect to your Quickbooks account and use your entities to perform data analysis in Reveal.
New Hubspot data source
You can now connect to Hubspot.
Sharepoint lists and document libraries support
You can now use the metadata (name, type, etc.) collected for all files in a SharePoint library as a data source in Reveal.
New Choropleth Map Visualization
The Choropleth map visualization allows you to create beautiful thematic maps. You can now present geospatial data in an incredibly digestible manner. Let color guide you and help you quickly discover patterns, trends and anomalies on the map.
May-2020 1.0.1255 New Azure Analysis Services data source
With this new data source, you can create dashboards using your data models in Azure Analysis Services.
New icon for Google Sheets files
The look of the Google Sheets files icon was changed.
May-2020 1.0.1222 New Hover Events API
This new event is called *revealView.TooltipShowing in WPF and .onTooltipShowing in Web and is triggered whenever the end-user hovers over a series in a visualization or clicks on the series.
New TreeMap visualization
You can use this new visualization type to present large hierarchies with a set of nested rectangles. Rectangles’ size will show you part-to-whole relationships amongst a variety of metrics, helping you identify patterns and relations between similar data.
Export to Excel enhancements
You can include more visualization types in your spreadsheets upon export. Scatter, Bubble and Sparkline charts are now available.
Various UI/UX improvements
Various minor changes were added to improve user experience in the Visualization, Dashboard, New Data Source dialog, etc.
Added support for Shared Drives in Google Drive
If you have a GSuite Business account, you can now access your Shared Drives data and use it to build visualizations in Reveal.
April-2020 1.0.1136 New Custom Theming
Now you can create your own theme in Reveal by configuring some or all of the customizable settings in the new RevealTheme (Desktop) / $.ig.RevealTheme (Web) class.
Feb-2020 1.0.981 New Properties in RevealSettings
We added multiple new properties to $.ig.RevealSettings to control different features, including: ShowExportToPDF, ShowExportToPowerpoint, ShowExportToExcel, ShowStatisticalFunctions, ShowDataBlending, ShowMachineLearningModelsIntegration, StartWithNewVisualization, InitialThemeName.
Accent Color is Now Available
You can now find the SetAccentColor method added to $.ig.RevealView.
A Trigger Property Added to DataSourceRequested Event
We added a Trigger (of type DataSourcesRequestedTriggerType) property to the DataSourcesRequested event arguments. The users of this event will now gain more context about the DataSourcesRequested purposes.
Nov-2019 1.0.825 Export to Image Functionality is Now Working
Exporting images server-side (both programmatically and through user interaction) was enabled again. For further details about the fix, please refer to: Enabling server-side screenshot generation
Sep-2019 1.0.80x Localization Service for Reveal Desktop SDK
You can now localize titles and labels of a variety of dashboard elements. The Localization service also enables you to change the formatting settings of numeric and non-aggregated date fields.
Formatting Service for Reveal Desktop SDK
You can now format numeric data, aggregated and non-aggregated date fields to your own preferences. Ignore the default formatting and format your dashboard data the way you like it.
Changes in Setup and Configuration (Server SDK)
Reveal Server SDK now supports .NET Core 2.2+ as well as .NET Framework 4.6.1+ ASP MVC application projects. In addition, you will now use exclusively the NuGet package manager to reference assemblies and install dependency packages.
Sep-2019 1.0.70x Step by Step Guide
With this detailed guide, you will start with prerequisites and go through every step needed to setup and configure Reveal’s SDK.
Change the Widget’s Data Source
You can now enable or disable the possibility to change a widget’s data source to end users. When opening the Visualization Data screen in edit mode, Reveal will either show or hide the change data source button in the UI.
Formatting Service for Reveal Desktop SDK
You can now enable or disable the possibility to change the dashboard’s theme to end users. When entering edit mode for a dashboard, Reveal will either show or hide the button used to display the available themes.