Exago Logo
Search
Generic filters
Exact matches only

WebReports.Api.Composite.Dashboards

Note

This version of the .NET API documentation is deprecated. A new version can be found at https://www.exagoaccess.com/api-docs/.

DashboardReport Class

The DashboardReport class allows Dashboards to be manipulated from the host application. This class does not need to be instantiated, it should be retrieved using methods defined in ReportObjectFactory. The DashboardReport class is derived from the ReportObject abstract class.

Properties

A DashboardReport object has the following properties. Properties that appear as hyperlinks below require constants or enums which are documented in the Constants and Enumerators article.

NameTypeWritableDescription
AllowOutputCSVbooleannoa boolean value that when true enables the Dashboard to be exported as a CSV file
AllowOutuputHtmlbooleannoa boolean value that when true enables the Dashboard to be exported as an HTML file (runs in the Web Application user interface)
AllowOutputRTFbooleannoa boolean value that when true enables the Dashboard to be exported as an RTF file
AllowOutputPDFbooleannoa boolean value that when true enables the Dashboard to be exported as a PDF file
AllowOutputExcelbooleannoa boolean value that when true enables the Dashboard to be exported as an Excel workbook
Idstringyesthe unique ID of the Dashboard
ExportTypeExportTypeyesan ExportType value which sets the desired export types for the Dashboard
Descriptionstringyesthe the Description text for the Dashboard
ReportTreeShortcutTreeShortcutyesTreeShortcut value which sets the default action to take when the Dashboard is accessed from the Web Application user interface
Namestringnofully qualified name (includes folder names) for the Dashboard
CanvasFormatThe following properties set the canvas formatting such as background colors and tile borders

Example:

CanvasFormat.CanvasBackgroundColor = "#ff4c00";
CanvasFormat.CanvasFit = Dashboard.LayoutFit.All;
NameTypeWritableDescription
.CanvasBackgroundColorstringyesa string containing a hexadecimal HTML color code that sets the canvas background color
.CanvasBackgroundOpacityintegeryesan integer value ranging from 0100 representing the percent opacity of the canvas background. 0 means completely transparent, 100 means fully opague
.CanvasFitDashboardLayoutFityesDashboardLayoutFit value that sets the canvas fit option
.CanvasHeightintegeryesan integer value specifying the height of the canvas in pixels. Used when CanvasFormat.CanvasFit is DashboardLayoutFit.None
.CanvasWidthintegeryesan integer value specifying the width of the canvas in pixels. Used when CanvasFormat.CanvasFit is DashboardLayoutFit.Width or DashboardLayoutFit.None.
.DefaultTileBackgroundColorstringyesa string containing a hexadecimal HTML color code that sets the default tile background color
.DefaultTileBackgroundOpacityintegeryesan integer value ranging from 0100 representing the default percent opacity of the tile background. 0 means completely transparent, 100 means fully opague
.DefaultTileBordersThe following properties set the default tile border style.

Example:

CanvasFormat.DefaultTileBorder.ShowBorders = true;
CanvasFormat.BorderRadius = 0;
NameTypeWritableDescription
.ShowBordersbooleanyesa boolean value that when true shows the borders, when false hides them. Default value is true.
.BorderRadiusintegeryesan integer value that sets the roundness of the border corners. Default value is 3.
.UniformBordersbooleanyesa boolean value that when true applies the UniformBorderColor and UniformBorderWeight to all four borders simultaneously. Default value is true.
.UniformBorderColorstringyesa string containing a hexadecimal HTML color code that sets the default tile border color when UniformBorders is true. Default value is #ddd.
.UniformBorderWeightintegeryesan integer value that sets the width in pixels of the tile border when UniformBorders is true.
.TopBorderColorstringyesa string containing a hexadecimal HTML color code that sets the default tile top border color when UniformBorders is false. Default value is #ddd.
.TopBorderWeightintegeryesan integer value that sets the width in pixels of the top tile border when UniformBorders is false.
.RightBorderColorstringyesa string containing a hexadecimal HTML color code that sets the default tile right border color when UniformBorders is false. Default value is #ddd.
.RightBorderWeightintegeryesan integer value that sets the width in pixels of the right tile border when UniformBorders is false
.BottomBorderColorstringyesa string containing a hexadecimal HTML color code that sets the default tile bottom border color when UniformBorders is false. Default value is #ddd.
.BottomBorderWeightintegeryesan integer value that sets the width in pixels of the bottom tile border when UniformBorders is false
.BottomBorderWeightintegeryesan integer value that sets the width in pixels of the bottom tile border when UniformBorders is false
.LeftBorderColorstringyesa string containing a hexadecimal HTML color code that sets the default tile left border color when UniformBorders is false. Default value is #ddd.
.LeftBorderWeightintegeryesan integer value that sets the width in pixels of the left tile border when UniformBorders is false
.DefaultTileHasShadowbooleanyesa boolean value that when true enables tiles to have a slight shadow effect by default
.DefaultTileTitleBackgroundColorstringyesa string containing a hexadecimal HTML color code that sets the default tile header background color
.DefaultTileTitleBackgroundOpacityintegeryesan integer value ranging from 0100 representing the default percent opacity of the tile header background. 0 means completely transparent, 100 means fully opague
.IsDashboardReflowEnabledbooleanyesa boolean value that when true will make the tiles reposition each time the width of the canvas is changed. Leave unchecked if the tiles should maintain position when the canvas width is changed. Used when CanvasFormat.CanvasFit is DashboardLayoutFit.Width.
.IsGridSnappingEnabledbooleanyesa boolean value that when true will make the tiles snap to the grid
ReportItemsReportItemyesA list of ReportItem objects, each representing a report contained within the Dashboard.

To find the index of a particular report on a Dashboard:

  1. Enter the Dashboard Designer.
  2. Press Ctrl+Shift+I.
  3. Click on the desired report. The index will appear in the reports title bar.

Methods

A DashboardReport object has no methods.

ReportItem Class DEPRECATED

The ReportItem class represents a report that is contained within a composite report such as a Dashboard.

Properties

A ReportItem object has the following properties:

  • Report: The fully qualified name of the report that this ReportItem represents.

Methods

The ReportItem object has the following methods:

void SetFilterValue(string filterName, wrFilterOperator filterOperator, List<string> filterValues)

DescriptionSet the value for a promptable filter that exists on this report
RemarksThe number of entries in filterValues depends on the filter operator.

void SetParameterValue(string parameterName, string parameterValue)

DescriptionSet the value for a promptable parameter that exists on this report
Was this article helpful?
0 out of 5 stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Please submit the reason for your vote so that we can improve the article.
Table of Contents