Class 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.

Inheritance
System.Object
RevealView
Namespace: Reveal.Sdk
Assembly: Reveal.UI.Sdk.dll
Syntax
public class RevealView : Control

Constructors

RevealView()

Used to create a new instance of RevealView class.

Declaration
public RevealView()

Fields

CanAddCalculatedFieldsProperty

Declaration
public static readonly DependencyProperty CanAddCalculatedFieldsProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanAddDashboardFilterProperty

Declaration
public static readonly DependencyProperty CanAddDashboardFilterProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanAddDataSourcesProperty

Declaration
public static readonly DependencyProperty CanAddDataSourcesProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanAddDateFilterProperty

Declaration
public static readonly DependencyProperty CanAddDateFilterProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanAddPostCalculatedFieldsProperty

Declaration
public static readonly DependencyProperty CanAddPostCalculatedFieldsProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanAddVisualizationProperty

Declaration
public static readonly DependencyProperty CanAddVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanChangeVisualizationBackgroundColorProperty

Declaration
public static readonly DependencyProperty CanChangeVisualizationBackgroundColorProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanCopyVisualizationProperty

Declaration
public static readonly DependencyProperty CanCopyVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanDuplicateVisualizationProperty

Declaration
public static readonly DependencyProperty CanDuplicateVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanEditProperty

Declaration
public static readonly DependencyProperty CanEditProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanMaximizeVisualizationProperty

Declaration
public static readonly DependencyProperty CanMaximizeVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

CanSaveAsProperty

Declaration
public static readonly DependencyProperty CanSaveAsProperty
Field Value
Type Description
System.Windows.DependencyProperty

ChartTypesProperty

Declaration
public static readonly DependencyProperty ChartTypesProperty
Field Value
Type Description
System.Windows.DependencyProperty

CrosshairsEnabledProperty

Declaration
public static readonly DependencyProperty CrosshairsEnabledProperty
Field Value
Type Description
System.Windows.DependencyProperty

DashboardProperty

Declaration
public static readonly DependencyProperty DashboardProperty
Field Value
Type Description
System.Windows.DependencyProperty

HoverTooltipsEnabledProperty

Declaration
public static readonly DependencyProperty HoverTooltipsEnabledProperty
Field Value
Type Description
System.Windows.DependencyProperty

InteractiveFilteringEnabledProperty

Declaration
public static readonly DependencyProperty InteractiveFilteringEnabledProperty
Field Value
Type Description
System.Windows.DependencyProperty

IsPreviewDataInVisualizationEditorEnabledProperty

Declaration
public static readonly DependencyProperty IsPreviewDataInVisualizationEditorEnabledProperty
Field Value
Type Description
System.Windows.DependencyProperty

MaximizedVisualizationProperty

Declaration
public static readonly DependencyProperty MaximizedVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowBreadcrumbDashboardTitleProperty

Declaration
public static readonly DependencyProperty ShowBreadcrumbDashboardTitleProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowBreadcrumbProperty

Declaration
public static readonly DependencyProperty ShowBreadcrumbProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowChangeDataSourceProperty

Declaration
public static readonly DependencyProperty ShowChangeDataSourceProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowChangeVisualizationProperty

Declaration
public static readonly DependencyProperty ShowChangeVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowDataBlendingProperty

Declaration
public static readonly DependencyProperty ShowDataBlendingProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowDataSourceSelectionDialogSearchProperty

Declaration
public static readonly DependencyProperty ShowDataSourceSelectionDialogSearchProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowDescriptionProperty

Declaration
public static readonly DependencyProperty ShowDescriptionProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowEditDataSourceProperty

Declaration
public static readonly DependencyProperty ShowEditDataSourceProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowExportImageProperty

Declaration
public static readonly DependencyProperty ShowExportImageProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowExportToExcelProperty

Declaration
public static readonly DependencyProperty ShowExportToExcelProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowExportToPDFProperty

Declaration
public static readonly DependencyProperty ShowExportToPDFProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowExportToPowerPointProperty

Declaration
public static readonly DependencyProperty ShowExportToPowerPointProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowFiltersProperty

Declaration
public static readonly DependencyProperty ShowFiltersProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowHeaderProperty

Declaration
public static readonly DependencyProperty ShowHeaderProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowMachineLearningModelsIntegrationProperty

Declaration
public static readonly DependencyProperty ShowMachineLearningModelsIntegrationProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowMenuProperty

Declaration
public static readonly DependencyProperty ShowMenuProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowRefreshProperty

Declaration
public static readonly DependencyProperty ShowRefreshProperty
Field Value
Type Description
System.Windows.DependencyProperty

ShowStatisticalFunctionsProperty

Declaration
public static readonly DependencyProperty ShowStatisticalFunctionsProperty
Field Value
Type Description
System.Windows.DependencyProperty

SingleVisualizationModeProperty

Declaration
public static readonly DependencyProperty SingleVisualizationModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

StartInEditModeProperty

Declaration
public static readonly DependencyProperty StartInEditModeProperty
Field Value
Type Description
System.Windows.DependencyProperty

StartWithNewVisualizationProperty

Declaration
public static readonly DependencyProperty StartWithNewVisualizationProperty
Field Value
Type Description
System.Windows.DependencyProperty

Properties

Assets

Declaration
public RVAssets Assets { get; }
Property Value
Type Description
RVAssets

CanAddCalculatedFields

A flag indicating if new (calculated) fields can be added to the list of fields.

Declaration
public bool CanAddCalculatedFields { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if new (calculated) fields can be added to the list of fields, it defaults to true.

CanAddDashboardFilter

A flag that indicates if the end user will be allowed to create dashboard filters.

Declaration
public bool CanAddDashboardFilter { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the end user will be allowed to create datasource based dashboard filters. It defaults to true.

CanAddDataSources

Enables adding new data sources.

Declaration
public bool CanAddDataSources { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if data sources can be added, it defaults to false

CanAddDateFilter

A flag that indicates if the end user will be allowed to create date filter.

Declaration
public bool CanAddDateFilter { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the end user will be allowed to create datasource based dashboard filters. It defaults to true.

CanAddPostCalculatedFields

A flag indicating if the f(x) option in numeric values sections (like "Values") should be displayed or not.

Declaration
public bool CanAddPostCalculatedFields { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the f(x) option in numeric values sections (like "Values") should be displayed or not, it defaults to true.

CanAddVisualization

A flag that indicates if new visualizations can be added when the dashboard is edited.

Declaration
public bool CanAddVisualization { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if new visualizations can be added when the dashboard is edited, it defaults to true.

CanChangeVisualizationBackgroundColor

[Obsolete] A flag indicating if the end-user can change the background color for a given visualization in the visualization editor (under Settings tab), if enabled the list of colors specified via BackgroundColors will be displayed as a suggested palette, but the user can also use an advanced mode to select any color. In the future, this property will be removed and the background color setting will be automatically visible in the visualization editor settings.

Declaration
[Obsolete]
public bool CanChangeVisualizationBackgroundColor { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the end-user can change the background color for a given visualization, it defaults to true.

CanCopyVisualization

A flag that indicates if the "Copy" option is available in the menu for a visualization.

Declaration
public bool CanCopyVisualization { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the "Copy" option is available in the menu for a visualization, it defaults to true.

CanDuplicateVisualization

A flag that indicates if the "Duplicate" option is available in the menu for a visualization.

Declaration
public bool CanDuplicateVisualization { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the "Duplicate" option is available in the menu for a visualization, it defaults to true.

CanEdit

A flag indicating if the user can switch to edit mode or not, defaults to true.

Declaration
public bool CanEdit { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the user can switch to edit mode or not, defaults to true.

CanMaximizeVisualization

A flag that indicates if the maximize visualization would be visible and the user would be able to maximize visualizations. Defaults to true.

Declaration
public bool CanMaximizeVisualization { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if new visualizations can be added when the dashboard is edited, it defaults to true.

CanSaveAs

A flag indicating if the user can 'save as' the dashboard.

Declaration
public bool CanSaveAs { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the user can 'save as' the dashboard, it defaults to true.

CategoryGroupingSeparator

Declaration
public string CategoryGroupingSeparator { get; set; }
Property Value
Type Description
System.String

ChartTypes

Declaration
public List<RVChartTypeItem> ChartTypes { get; set; }
Property Value
Type Description
System.Collections.Generic.List<RVChartTypeItem>

CrosshairsEnabled

Enables crosshairs for chart visualizations.

Declaration
public bool CrosshairsEnabled { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if crosshairs are displayed for charts, it defaults to false

Dashboard

The Dashboard to load in the RevealView

Declaration
public RVDashboard Dashboard { get; set; }
Property Value
Type Description
RVDashboard

DefaultChartType

This property allows the customization of the default visualization when a new visualization is created.

Declaration
public RVChartType DefaultChartType { get; set; }
Property Value
Type Description
RVChartType

DefaultCustomChartType

This property allows setting the defualt custom visualization when they are defined in ChartTypes.

Declaration
public string DefaultCustomChartType { get; set; }
Property Value
Type Description
System.String

DisableKeyboardManagement

By default Reveal will intercept keyboard events in the containing Window to provide keyboard navigation support. Set this flag to true in order disable that behavior.

Declaration
public bool DisableKeyboardManagement { get; set; }
Property Value
Type Description
System.Boolean

HoverTooltipsEnabled

Enables hover tooltips for chart visualizations.

Declaration
public bool HoverTooltipsEnabled { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if tooltips are displayed on hover for chart visualizations, it defaults to true

InteractiveFilteringEnabled

Enables interactive filtering for visualizations.

Declaration
public bool InteractiveFilteringEnabled { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if interactive filtering is enabled, it defaults to false

IsPreviewDataInVisualizationEditorEnabled

A flag indicating if a small set of data should be displayed as tooltip when moving the mouse over a field.

Declaration
public bool IsPreviewDataInVisualizationEditorEnabled { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if data should be included in the tooltip when setting the mouse over a field, defaults to false.

LinkedDashboardProvider

Declaration
public RevealView.LinkedDashboardProviderCallback LinkedDashboardProvider { get; set; }
Property Value
Type Description
RevealView.LinkedDashboardProviderCallback

MaximizedVisualization

The visualization to use as the initially maximized visualization. You can get a visualization from the RVDashboard object using Visualizations or GetByTitle(IEnumerable<RVVisualization>, String)

Declaration
public RVVisualization MaximizedVisualization { get; set; }
Property Value
Type Description
RVVisualization

The visualization to use as the initially maximized visualization.

ShowBreadcrumb

Gets or sets the visibility status of the drill down breadcrumb.

Declaration
public bool ShowBreadcrumb { get; set; }
Property Value
Type Description
System.Boolean

true if the breadcrumb is visible; false otherwise. Default is true.

ShowBreadcrumbDashboardTitle

Gets or sets the visibility status of the dashboard title in the breadcrumb when the visualization is maximized.

Declaration
public bool ShowBreadcrumbDashboardTitle { get; set; }
Property Value
Type Description
System.Boolean

true if the dashboard title in the breadcrumb is visible when maximized; false otherwise. Default is false.

ShowChangeDataSource

A flag that indicates if the Change data source action should be displayed or not.

Declaration
public bool ShowChangeDataSource { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the Change data source action should be displayed or not, it defaults to true.

ShowChangeVisualization

A flag indicating if the button to change visualization should be available or not, this button is used to switch to another visualization type (for example from Bar to Column chart) without entering edit mode.

Declaration
public bool ShowChangeVisualization { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the button to change visualization should be available or not, it defaults to true

ShowDataBlending

A flag indicating if the button to add fields from another data source should be available or not.

Declaration
public bool ShowDataBlending { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the button add fields from another data source (in the visualization editor) should be available or not, it defaults to true

ShowDataSourceSelectionDialogSearch

A flag indicating if the data source selection dialog (displayed when creating a new visualization) includes a search box on top to search for data sources.

Declaration
public bool ShowDataSourceSelectionDialogSearch { get; set; }
Property Value
Type Description
System.Boolean

true if a search box should be displayed in the data source selection dialog, it defaults to false.

ShowDescription

Allows to indicate if the Dashboard's description should be displayed.

Declaration
public bool ShowDescription { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the Dashboard's description should be displayed, it defaults to true

ShowEditDataSource

A flag that indicates if the edit button for a datasource in the visualization editor should be displayed.

Declaration
public bool ShowEditDataSource { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the edit button for a datasource in the visualization editor should be displayed or not, it defaults to false.

ShowExportImage

A flag indicating if the export image action is available or not.

Declaration
public bool ShowExportImage { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the export image action is available or not, it defaults to true.

ShowExportToExcel

A flag indicating if the export to Excel action is available or not.

Declaration
public bool ShowExportToExcel { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the export to Excel action is available or not, it defaults to true.

ShowExportToPDF

A flag indicating if the export to PDF action is available or not.

Declaration
public bool ShowExportToPDF { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the export to PDF action is available or not, it defaults to true.

ShowExportToPowerPoint

A flag indicating if the export to PowerPoint action is available or not.

Declaration
public bool ShowExportToPowerPoint { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the export to PowerPoint action is available or not, it defaults to true.

ShowFilters

A flag that allows the dashboard filters panel to be hidden. This is useful if you want to limit the selected values for the filters to the initial selection. Once the RevealView object is created and rendered you can use SelectedValues to change the selection for a given filter, so you can keep the selected values synced with your application.

Declaration
public bool ShowFilters { get; set; }
Property Value
Type Description
System.Boolean

A flag that allows the dashboard filters panel to be hidden, it defaults to true.

ShowHeader

A flag that indicates if dashboard header will be rendered, it defaults to true. Please note that if you hide the header bar UI controls to save, save as, export wont be vailable for the end user.

Declaration
public bool ShowHeader { get; set; }
Property Value
Type Description
System.Boolean

ShowMachineLearningModelsIntegration

A flag indicating if the button to add fields from a Machine Learning model should be available or not.

Declaration
public bool ShowMachineLearningModelsIntegration { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the button add fields from a Machine Learning model (in the visualization editor) should be available or not, it defaults to false

ShowMenu

A flag that indicates if the menu (containing Refresh, Export, etc.) should be displayed or not.

Declaration
public bool ShowMenu { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the menu (containing Refresh, Export, etc.) should be displayed or not. Default value is true

ShowRefresh

A flag that indicates if the Refresh action should be displayed or not.

Declaration
public bool ShowRefresh { get; set; }
Property Value
Type Description
System.Boolean

A flag that indicates if the Refresh action should be displayed or not, it defaults to true.

ShowStatisticalFunctions

A flag indicating if the menu to apply statistical functions (forecasting, etc.) is available or not.

Declaration
public bool ShowStatisticalFunctions { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating if the menu to apply statistical functions (forecasting, etc.) is available or not, it defaults to true.

SingleVisualizationMode

Single visualization mode is used to show a single visualization at a time. You can control the initial visualization to maximize using the MaximizedVisualization property. If no initial visualization is configured to be maximized the first one will be maximized initially. You can use MaximizedVisualization to change the maximized one once the dashboard is visible.

Declaration
public bool SingleVisualizationMode { get; set; }
Property Value
Type Description
System.Boolean

Flag indicating if single visualization mode should be used, it defaults to false.

StartInEditMode

A flag indicating the view should start in edit mode instead of the default view mode, defaults to false. This flag is taken into account on when the Dashboard property is changed and the dashboard rendered.

Declaration
public bool StartInEditMode { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating the view should start in edit mode instead of the default view mode, defaults to false.This flag is taken into account on when the Dashboard property is changed and the dashboard rendered.

StartWithNewVisualization

A flag indicating the new visualization dialog should be displayed automatically when this view is presented. This setting requires StartInEditMode set to true.

Declaration
public bool StartWithNewVisualization { get; set; }
Property Value
Type Description
System.Boolean

A flag indicating the new visualization dialog should be displayed automatically when this view is presented, defaults to false.

UrlLinkRequested

Declaration
public RevealView.UrlLinkRequestedCallback UrlLinkRequested { get; set; }
Property Value
Type Description
RevealView.UrlLinkRequestedCallback

Methods

EnterEditMode()

Declaration
public void EnterEditMode()

ExitEditMode(Boolean)

Declaration
public void ExitEditMode(bool applyChanges)
Parameters
Type Name Description
System.Boolean applyChanges

GetCurrentTheme()

Returns currently applied theme. This method is marked as obsolete, use Theme property to get/set current theme.

Declaration
[Obsolete("This method is obsolete and will be removed. Use RevealSdkSettings class' Theme property instead.")]
public static RevealTheme GetCurrentTheme()
Returns
Type Description
RevealTheme

MaximizeVisualization(RVVisualization)

Used to maximize a visualization once the Reveal View was initialized and rendered. It might be used to sync the currently displayed visualization with a feature in the containing application, like displaying 'Sales by Country' along a Sales report.

Declaration
public bool MaximizeVisualization(RVVisualization visualization)
Parameters
Type Name Description
RVVisualization visualization

The visualization to be maximized, an object obtained from the dashboard with Visualizations[index] or GetVisualizationByTitle(title)
Returns
Type Description
System.Boolean

true if the given visualization was found in the dashboard and maximized properly, false otherwise.
See Also

MinimizeVisualization()

Used to restore the currently maximized visualization to the original state, so the whole dashboard is visible.

Declaration
public bool MinimizeVisualization()
Returns
Type Description
System.Boolean

True if there was a maximized visualization, which was minimized, false otherwise.

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnRenderSizeChanged(SizeChangedInfo)

Declaration
protected override void OnRenderSizeChanged(SizeChangedInfo sizeInfo)
Parameters
Type Name Description
System.Windows.SizeChangedInfo sizeInfo

RefreshDashboardData()

Method used to programmatically refresh the dashboard data, equivalent to execute the 'Refresh' action in the dashboard menu.

Declaration
public void RefreshDashboardData()

RefreshTheme()

Makes sure the current theme specified in Theme is applied. This involve re-loading of the currently displayed dashboard so any state like pending edits, maximized visualization, filters selection changes will be reset and lost.

Declaration
public void RefreshTheme()

Serialize()

Serializes the current dashboard to a byte array

Declaration
public Task<byte[]> Serialize()
Returns
Type Description
System.Threading.Tasks.Task<System.Byte[]>

a byte array with the contents of the dashboard in rdash format

SerializeAsJson()

Serializes the current dashboard to JSON string

Declaration
public Task<string> SerializeAsJson()
Returns
Type Description
System.Threading.Tasks.Task<System.String>

a JSON string with the contents of the dashboard

SerializeWithName(String)

Serializes the current dashboard in '.rdash' format to a byte array, the title of the dashboard is changed to match the specified name.

Declaration
public Task<byte[]> SerializeWithName(string name)
Parameters
Type Name Description
System.String name

The new name of the dashboard, it changes the title attribute of the dashboard object
Returns
Type Description
System.Threading.Tasks.Task<System.Byte[]>

SerializeWithNameAsJson(String)

Serializes the current dashboard as JSON formatted string, the title of the dashboard is changed to match the specified name.

Declaration
public Task<string> SerializeWithNameAsJson(string name)
Parameters
Type Name Description
System.String name

The new name of the dashboard, it changes the title attribute of the dashboard object
Returns
Type Description
System.Threading.Tasks.Task<System.String>

SetVisualizationBackgroundColor(RVVisualization, Color)

Updates the background color for the given visualization.

Declaration
public void SetVisualizationBackgroundColor(RVVisualization visualization, Color color)
Parameters
Type Name Description
RVVisualization visualization

the visualization to update
System.Windows.Media.Color color

the new background color to use

SetVisualizationChartSettings(RVVisualization, RVChartSettings)

Updates the chart settings for a given visualization, ignored if the visualization type is not chart.

Declaration
public void SetVisualizationChartSettings(RVVisualization visualization, RVChartSettings chartSettings)
Parameters
Type Name Description
RVVisualization visualization

the visualization to update
RVChartSettings chartSettings

the new chart settings to use

ToImage()

Returns an image of the DashboardView. If no dashboard is shown, null is returned.

Declaration
public BitmapSource ToImage()
Returns
Type Description
System.Windows.Media.Imaging.BitmapSource

A System.Windows.Media.Imaging.BitmapSource with the image.

UpdateRevealTheme(RevealTheme)

Overrides built in Reveal Theme settings. This method will not affect views that already display dashboards. This method is marked as obsolete, use Theme property to get/set current theme. System.ArgumentNullException

Declaration
[Obsolete("This method is obsolete and will be removed. Use RevealSdkSettings class' Theme property instead.")]
public static void UpdateRevealTheme(RevealTheme theme)
Parameters
Type Name Description
RevealTheme theme

Events

DashboardChanged

Event triggered when the dashboard property is set to a new instance of an RVDashboard.

Declaration
public event EventHandler<DashboardChangedEventArgs> DashboardChanged
Event Type
Type Description
System.EventHandler<DashboardChangedEventArgs>
Remarks

If the dashboard property is set to null, a new dashboard is created automatically with a title "New Dashboard".

Examples

This sample shows how to use the DashboardChanged event.

private void RevealView_DashboardChanged(object sender, DashboardChangedEventArgs e)
{
    // Access the old and new dashboard
    var oldDashboard = e.OldValue;
    var newDashboard = e.NewValue;

    // Implement your logic here
}

DashboardSelectorRequested

Declaration
public event EventHandler<DashboardSelectorRequestedEventArgs> DashboardSelectorRequested
Event Type
Type Description
System.EventHandler<DashboardSelectorRequestedEventArgs>

DataSourceSelectionDialogShowing

Event called when the list of data sources is about to be displayed, this is the way to show your own UI for the list of data sources instead of the default UI, for that you need to cancel the received event and display your own UI.

Declaration
public event EventHandler<DataSourceSelectionEventArgs> DataSourceSelectionDialogShowing
Event Type
Type Description
System.EventHandler<DataSourceSelectionEventArgs>

DataSourcesRequested

Event used to return the list of data sources to display to the user when creating a new visualization. If this handler is not installed Reveal will only display the list of data sources already used in the dashboard (if any).

Declaration
public event EventHandler<DataSourcesRequestedEventArgs> DataSourcesRequested
Event Type
Type Description
System.EventHandler<DataSourcesRequestedEventArgs>
Examples
             private void RevealView_DataSourcesRequested(object sender, DataSourcesRequestedEventArgs e)
             {
                 var inMemoryDSI = new RVInMemoryDataSourceItem("employees");
                 inMemoryDSI.Title = "Employees";
                 inMemoryDSI.Description = "Employees";

                 var sqlDs = new RVSqlServerDataSource();
                 sqlDs.Title = "Clients";
                 sqlDs.Id = "SqlDataSource1";
                 sqlDs.Host = "db.mycompany.local";
                 sqlDs.Port = 1433;
                 sqlDs.Database = "Invoices";

                 e.Callback(new RevealDataSources(
                      new List<object>() { sqlDs }, 
                      new List<object>() { inMemoryDSI }, 
                      false));
             }

EditModeEntered

Event triggered when the dashboard is edited, the argument contains the edited RVDashboard./>

Declaration
public event EventHandler<EditModeEnteredArgs> EditModeEntered
Event Type
Type Description
System.EventHandler<EditModeEnteredArgs>

EditModeExited

Event triggered when the dashboard stops being edited, the argument contains the edited RVDashboard./>

Declaration
public event EventHandler<EditModeExitedArgs> EditModeExited
Event Type
Type Description
System.EventHandler<EditModeExitedArgs>

FieldsInitializing

Event used to implement FieldsInitializing method

Declaration
public event RevealView.FieldsInitializingHandler FieldsInitializing
Event Type
Type Description
RevealView.FieldsInitializingHandler

ImageExported

Event triggered when the dashboard was exported to an image, the argument contains the image as a System.Windows.Media.Imaging.BitmapSource./>

Declaration
public event EventHandler<ImageExportedEventArgs> ImageExported
Event Type
Type Description
System.EventHandler<ImageExportedEventArgs>

MaximizedVisualizationChanged

Event triggered when there was a change in the maximized visualization, a new visualization is maximized or the maximized visualization was minimized.

Declaration
public event EventHandler MaximizedVisualizationChanged
Event Type
Type Description
System.EventHandler

MenuOpening

Declaration
public event RevealView.MenuOpeningHandler MenuOpening
Event Type
Type Description
RevealView.MenuOpeningHandler

SaveDashboard

Event triggered when a save (or save as) operation is being performed, the handler is responsible for storing the dashboard and notify when the operation is complete using SaveFinished().

Declaration
public event EventHandler<DashboardSaveEventArgs> SaveDashboard
Event Type
Type Description
System.EventHandler<DashboardSaveEventArgs>

TooltipShowing

Event fired when the user hovers over a visualization and a tooltip is about to show up. Cancel the event to disable to rendering of the tooltip.

Declaration
public event EventHandler<TooltipShowingEventArgs> TooltipShowing
Event Type
Type Description
System.EventHandler<TooltipShowingEventArgs>
Examples
            private void RevealView_TooltipShowing(object sender, TooltipShowingEventArgs e)
            {
                var vizTitle = e.Visualization.Title;
                if(vizTitle == "noNeedForTooltipsHere")
                {
                    e.Cancel = true;
                }
            }

VisualizationDataLoading

Event triggered when a visualization is about to request data, the event can be canceled if showing data for the visualization is not allowed. ErrorMessage can be used to set the error message displayed in the visualization.

Declaration
public event EventHandler<VisualizationDataLoadingEventArgs> VisualizationDataLoading
Event Type
Type Description
System.EventHandler<VisualizationDataLoadingEventArgs>

VisualizationDataPointClicked

Event indicating data in a visualization was clicked (might be a cell in a table or a column/bar in a chart).

Declaration
public event EventHandler<VisualizationClickedEventArgs> VisualizationDataPointClicked
Event Type
Type Description
System.EventHandler<VisualizationClickedEventArgs>
Examples
            private void RevealView_VisualizationDataPointClicked(object sender, VisualizationClickedEventArgs e)
            {
                var vizTitle = e.Visualization.Title;
                var column = e.Cell.ColumnName;
                var formattedValue = e.Cell.FormattedValue;
                var value = e.Cell.Value;
                foreach (var c in e.Row)
                {
                    var cValue = c.Value;
                    //TODO: use value from column c.ColumnName
                }
            }

VisualizationEditorClosed

Event triggered when the visualization editor was closed. VisualizationEditorClosingEventArgs if you want to cancel the editor closing action.

Declaration
public event EventHandler<VisualizationEditorClosedEventArgs> VisualizationEditorClosed
Event Type
Type Description
System.EventHandler<VisualizationEditorClosedEventArgs>

VisualizationEditorClosing

Event triggered when the close button in the visualization editor is being pressed, the event can be canceled if closing the visualization is not allowed. ResetVisualization can be used to reset the visualization to the original state, when the editor was displayed.

Declaration
public event EventHandler<VisualizationEditorClosingEventArgs> VisualizationEditorClosing
Event Type
Type Description
System.EventHandler<VisualizationEditorClosingEventArgs>

VisualizationEditorOpened

Event triggered when the visualization editor was opened. VisualizationEditorOpeningEventArgs if you want to cancel the editor opening action.

Declaration
public event EventHandler<VisualizationEditorOpenedEventArgs> VisualizationEditorOpened
Event Type
Type Description
System.EventHandler<VisualizationEditorOpenedEventArgs>

VisualizationEditorOpening

Event triggered when the visualization editor is about to be opened, the event can be canceled if editing the visualization is not allowed.

Declaration
public event EventHandler<VisualizationEditorOpeningEventArgs> VisualizationEditorOpening
Event Type
Type Description
System.EventHandler<VisualizationEditorOpeningEventArgs>

VisualizationSeriesColorAssigning

Declaration
public event RevealView.VisualizationSeriesColorAssigningHandler VisualizationSeriesColorAssigning
Event Type
Type Description
RevealView.VisualizationSeriesColorAssigningHandler