DashboardControl Methods

Methods

Name Description
CanClearMasterFilter(String)

Returns whether or not the specified master filter can be cleared in the current state.

CanPerformDrillDown(String)

Returns whether or not drill down is possible in the current state of the specified dashboard item.

CanPerformDrillUp(String)

Returns whether or not drill up is possible in the current state of the specified dashboard item.

CanSetMasterFilter(String)

Returns whether or not the master filter item allows selecting one or more elements.

CanSetMultiValueMasterFilter(String)

Returns whether or not the master filter item allows selecting multiple elements.

ClearMasterFilter(String)

Clears the specified master filter item.

ExportDashboardItemToExcel(String, Stream)

Exports the dashboard item to the specified stream in Excel format.

ExportDashboardItemToExcel(String, Stream, DashboardExcelExportOptions)

Exports the dashboard item to the specified stream in Excel format using specified export options.

ExportDashboardItemToExcel(String, String)

Exports the dashboard item to the specified file in Excel format.

ExportDashboardItemToExcel(String, String, DashboardExcelExportOptions)

Exports the dashboard item to the specified file in Excel format using specified export options.

ExportDashboardItemToImage(String, Stream)

Exports the dashboard item to the specified stream in Image format.

ExportDashboardItemToImage(String, Stream, DashboardImageExportOptions)

Exports the dashboard item to the specified stream in Image format using the specified image options.

ExportDashboardItemToImage(String, String)

Exports the dashboard item to the specified file in Image format.

ExportDashboardItemToImage(String, String, DashboardImageExportOptions)

Exports the dashboard item to the image file using the specified image options.

ExportDashboardItemToPdf(String, Stream)

Exports the dashboard item to the specified stream in PDF format.

ExportDashboardItemToPdf(String, Stream, DashboardPdfExportOptions)

Exports the dashboard item to the specified stream in PDF format using the specified PDF-specific options.

ExportDashboardItemToPdf(String, String)

Exports the dashboard item to the specified file in PDF format.

ExportDashboardItemToPdf(String, String, DashboardPdfExportOptions)

Exports the dashboard item to the specified file in PDF format using the specified PDF-specific options.

ExportToExcel(Stream)

Exports dashboard data to the specified stream in Excel format.

ExportToExcel(Stream, DashboardExcelExportOptions)

Exports dashboard data to the specified stream in Excel format.

ExportToExcel(String)

Exports dashboard data to the specified file in Excel format.

ExportToExcel(String, DashboardExcelExportOptions)

Exports dashboard data to the specified file in Excel format.

ExportToImage(Stream)

Exports a dashboard to the specified stream in Image format.

ExportToImage(Stream, DashboardImageExportOptions)

Exports a dashboard to the specified stream in Image format using the specified image-specific options.

ExportToImage(String)

Exports a dashboard to the specified file in Image format.

ExportToImage(String, DashboardImageExportOptions)

Exports a dashboard to the specified image file using the specified image-specific options.

ExportToPdf(Stream)

Exports a dashboard to the specified stream in PDF format.

ExportToPdf(Stream, DashboardPdfExportOptions)

Exports a dashboard to the specified stream in PDF format using the specified PDF-specific options.

ExportToPdf(String)

Exports a dashboard to the specified file in PDF format.

ExportToPdf(String, DashboardPdfExportOptions)

Exports a dashboard to the specified file in PDF format using the specified PDF-specific options.

GetAvailableDrillDownValues(String)

Returns axis point tuples identifying elements that can be used to perform drill-down in the specified dashboard item.

GetAvailableFilterValues(String)

Returns axis point tuples identifying elements that can be selected in the current state of the master filter item.

GetAvailablePredefinedRanges(String)

Returns names of the predefined ranges available for the specified Range Filter.

GetCurrentDrillDownValues(String)

Returns an axis point tuple identifying the current drill-down state.

GetCurrentFilterValues(String)

Returns axis point tuples identifying currently selected elements in the master filter item.

GetCurrentPredefinedRange(String)

Returns the name of the currently selected predefined range.

GetCurrentRange(String)

Returns the selected range for the specified Range Filter dashboard item.

GetCurrentSelection(String)

Returns records identifying currently selected elements in the master filter item.

GetDashboardLayout()

Saves dashboard layout to a string.

GetEntireRange(String)

Returns the visible range for the specified Range Filter dashboard item.

GetItemData(String)

Returns the client data for the specified dashboard item.

GetPrintableComponent(String)

Gets a printable component corresponding to the specified dashboard item.

GetUnderlyingData(String)

Returns underlying data for the specified dashboard item.

GetUnderlyingData(String, IList<AxisPoint>)

Returns underlying data for the specified dashboard item by the specified axis points.

GetUnderlyingData(String, IList<AxisPoint>, IList<String>)

Returns underlying data for the specified dashboard item by the specified axis points.

GetUnderlyingData(String, IList<String>)

Returns underlying data for the specified dashboard item by the specified data members.

GetUnderlyingData(String, IList<UnderlyingDataTargetValue>)

Returns underlying data for the specified dashboard item by the specified dimension values.

GetUnderlyingData(String, IList<UnderlyingDataTargetValue>, IList<String>)

Returns underlying data for the specified dashboard item by the specified dimension values.

InvalidateData()

Schedules the asynchronous data update for the entire dashboard. The data update is performed when the UpdateLayout() method is called.

InvalidateData(String)

Schedules the asynchronous data update for the specified dashboard item. The data update is performed when the UpdateLayout() method is called.

LoadDashboard(Stream)

Loads a dashboard from a stream.

LoadDashboard(String)

Loads a dashboard from an XML file.

LoadDashboardLayout(Stream)

Loads a dashboard layout from a stream.

LoadDashboardLayout(String)

Loads a dashboard layout from an XML file.

PerformDrillDown(String, AxisPointTuple)

Performs a drill-down for the required element.

PerformDrillDown(String, DashboardDataRow)

Performs a drill-down for the required element.

PerformDrillDown(String, Object)

Performs a drill-down for the required element by its value.

PerformDrillUp(String)

Performs a drill-up in the specified dashboard item.

ReloadData()

Reloads data from the data source for the entire dashboard.

ReloadData(String)

Reloads data from the data source for the specified dashboard item.

SaveDashboardLayout(Stream)

Saves a dashboard layout to a stream.

SaveDashboardLayout(String)

Saves a dashboard layout to an XML file.

SetDashboardLayout(String)

Applies dashboard layout contained in a string.

SetMasterFilter(String, AxisPointTuple)

Selects required elements in the specified master filter item.

SetMasterFilter(String, IEnumerable<AxisPointTuple>)

Selects the required elements in the specified master filter item.

SetMasterFilter(String, IEnumerable<DashboardDataRow>)

Selects required elements in the specified master filter item.

SetMasterFilter(String, Object)

Selects required elements by their values in the specified master filter item.

SetRange(String, RangeFilterSelection)

Selects the required range in the specified Range Filter dashboard item.

SetRange(String, String)

Selects the specified range in the specified Range Filter dashboard item.

UpdateData()

Performs the scheduled data update asynchronously.