Version

RevealSettings Class Members

The following tables list the members exposed by RevealSettings.

Public Constructors
 NameDescription
Public ConstructorRevealSettings ConstructorCreates a new instance of the settings class with the dashboard that must be rendered in the view.  
Public Properties
 NameDescription
Public PropertyCanAddVisualizationA flag that indicates if new visualizations can be added when the dashboard is edited.  
Public PropertyCanEditA flag indicating if the user can switch to edit mode or not, defaults to true.  
Public PropertyCanSaveAsA flag indicating if the user can 'save as' the dashboard.  
Public PropertyDashboardThe dashboard to render in the RevealView object where these settings will be applied. To get a dashboard object you can use the RevealUtility.LoadDashboard and RevealUtility.LoadDashboardSync methods available in RevealUtility. A null dashboard means the view should start creating a new dashboard from scratch.  
Public PropertyDateFilterThe initial date filter to use when rendering the dashboard for the first time. Please note the dashboard needs to be defined with a date filter, if not this attribute will be ignored. After the RevealView object is created the date filter might be updated using RevealView.SetDateFilter.  
Public PropertyMaximizedVisualizationThe visualization to use as the initially maximized visualization. You can get a visualization from the RVDashboard object using RVDashboard.Visualizations or RVDashboard.GetVisualizationByTitle  
Public PropertyShowChangeDataSourceA flag that indicates if the Change data source action should be displayed or not.  
Public PropertyShowChangeVisualizationA 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.  
Public PropertyShowDataBlendingA flag indicating if the button to add fields from another data source should be available or not.  
Public PropertyShowExportImageA flag indicating if the export image action is available or not.  
Public PropertyShowExportToExcelA flag indicating if the export to Excel action is available or not.  
Public PropertyShowExportToPDFA flag indicating if the export to PDF action is available or not.  
Public PropertyShowExportToPowerpointA flag indicating if the export to Powerpoint action is available or not.  
Public PropertyShowFiltersA 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 specified in RevealSettings. Once the RevealView object is created and rendered you can use RevealView.SetFilterSelectedValues to change the selection for a given filter, so you can keep the selected values synced with your app.  
Public PropertyShowMachineLearningModelsIntegrationA flag indicating if the button to add fields from a Machine Learning model should be available or not.  
Public PropertyShowMenuA flag that indicates if the menu (containing Refresh, Export, etc.) should be displayed or not.  
Public PropertyShowRefreshA flag that indicates if the Refresh action should be displayed or not.  
Public PropertyShowStatisticalFunctionsA flag indicating if the menu to apply statistical functions (forecasting, etc.) is available or not.  
Public PropertySingleVisualizationModeSingle visualization mode is used to show a single visualization at a time. You can control the initial visualization to maximize using the MaximizedVisualization property of RevealSettings. If no initial visualization is configured to be maximized the first one will be maximized initially. You can use RevealView.MaximizedVisualization to change the maximized one once the dashboard is visible.  
Public PropertyStartInEditModeA flag indicating the view should start in edit mode instead of the default view mode, defaults to false.  
Public PropertyStartWithNewVisualizationA flag indicating the new visualization dialog should be displayed automatically when this view is presented. This setting requires StartInEditMode set to true.  
Public Methods
 NameDescription
Public MethodGetFilterSelectedValuesReturns the list of selected values for the given filter previously set using SetFilterSelectedValues. Please note this method will return only those selections previously set, it does not return selections stored in the dashboard.  
Public MethodSetFilterSelectedValuesSets the initially selected values for the given filter.  
See Also