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.
| Name |
Type |
Writable |
Description |
| AllowOutputCSV |
boolean |
no |
a boolean value that when true enables the Dashboard to be exported as a CSV file |
| AllowOutuputHtml |
boolean |
no |
a boolean value that when true enables the Dashboard to be exported as an HTML file (runs in the Web Application user interface) |
| AllowOutputRTF |
boolean |
no |
a boolean value that when true enables the Dashboard to be exported as an RTF file |
| AllowOutputPDF |
boolean |
no |
a boolean value that when true enables the Dashboard to be exported as a PDF file |
| AllowOutputExcel |
boolean |
no |
a boolean value that when true enables the Dashboard to be exported as an Excel workbook |
| Id |
string |
yes |
the unique ID of the Dashboard |
| ExportType |
ExportType |
yes |
an ExportType value which sets the desired export types for the Dashboard |
| Description |
string |
yes |
the the Description text for the Dashboard |
| ReportTreeShortcut |
TreeShortcut |
yes |
TreeShortcut value which sets the default action to take when the Dashboard is accessed from the Web Application user interface |
| Name |
string |
no |
fully qualified name (includes folder names) for the Dashboard |
| CanvasFormat |
The following properties set the canvas formatting such as background colors and tile borders
Example:
CanvasFormat.CanvasBackgroundColor = "#ff4c00";
CanvasFormat.CanvasFit = Dashboard.LayoutFit.All;
| Name |
Type |
Writable |
Description |
| .CanvasBackgroundColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the canvas background color |
| .CanvasBackgroundOpacity |
integer |
yes |
an integer value ranging from 0-100 representing the percent opacity of the canvas background. 0 means completely transparent, 100 means fully opague |
| .CanvasFit |
DashboardLayoutFit |
yes |
DashboardLayoutFit value that sets the canvas fit option |
| .CanvasHeight |
integer |
yes |
an integer value specifying the height of the canvas in pixels. Used when CanvasFormat.CanvasFit is DashboardLayoutFit.None |
| .CanvasWidth |
integer |
yes |
an integer value specifying the width of the canvas in pixels. Used when CanvasFormat.CanvasFit is DashboardLayoutFit.Width or DashboardLayoutFit.None. |
| .DefaultTileBackgroundColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile background color |
| .DefaultTileBackgroundOpacity |
integer |
yes |
an integer value ranging from 0–100 representing the default percent opacity of the tile background. 0 means completely transparent, 100 means fully opague |
| .DefaultTileBorders |
The following properties set the default tile border style.
Example:
CanvasFormat.DefaultTileBorder.ShowBorders = true;
CanvasFormat.BorderRadius = 0;
| Name |
Type |
Writable |
Description |
| .ShowBorders |
boolean |
yes |
a boolean value that when true shows the borders, when false hides them. Default value is true. |
| .BorderRadius |
integer |
yes |
an integer value that sets the roundness of the border corners. Default value is 3. |
| .UniformBorders |
boolean |
yes |
a boolean value that when true applies the UniformBorderColor and UniformBorderWeight to all four borders simultaneously. Default value is true. |
| .UniformBorderColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile border color when UniformBorders is true. Default value is #ddd. |
| .UniformBorderWeight |
integer |
yes |
an integer value that sets the width in pixels of the tile border when UniformBorders is true. |
| .TopBorderColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile top border color when UniformBorders is false. Default value is #ddd. |
| .TopBorderWeight |
integer |
yes |
an integer value that sets the width in pixels of the top tile border when UniformBorders is false. |
| .RightBorderColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile right border color when UniformBorders is false. Default value is #ddd. |
| .RightBorderWeight |
integer |
yes |
an integer value that sets the width in pixels of the right tile border when UniformBorders is false |
| .BottomBorderColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile bottom border color when UniformBorders is false. Default value is #ddd. |
| .BottomBorderWeight |
integer |
yes |
an integer value that sets the width in pixels of the bottom tile border when UniformBorders is false |
| .BottomBorderWeight |
integer |
yes |
an integer value that sets the width in pixels of the bottom tile border when UniformBorders is false |
| .LeftBorderColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile left border color when UniformBorders is false. Default value is #ddd. |
| .LeftBorderWeight |
integer |
yes |
an integer value that sets the width in pixels of the left tile border when UniformBorders is false |
|
| .DefaultTileHasShadow |
boolean |
yes |
a boolean value that when true enables tiles to have a slight shadow effect by default |
| .DefaultTileTitleBackgroundColor |
string |
yes |
a string containing a hexadecimal HTML color code that sets the default tile header background color |
| .DefaultTileTitleBackgroundOpacity |
integer |
yes |
an integer value ranging from 0-100 representing the default percent opacity of the tile header background. 0 means completely transparent, 100 means fully opague |
| .IsDashboardReflowEnabled |
boolean |
yes |
a 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. |
| .IsGridSnappingEnabled |
boolean |
yes |
a boolean value that when true will make the tiles snap to the grid |
|
| ReportItems |
ReportItem |
yes |
A list of ReportItem objects, each representing a report contained within the Dashboard. |
To find the index of a particular report on a Dashboard:
- Enter the Dashboard Designer.
- Press Ctrl+Shift+I.
- 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)
|
Description
|
Set the value for a promptable filter that exists on this report
|
|
Remarks
|
The number of entries in filterValues depends on the filter operator.
|
void SetParameterValue(string parameterName, string parameterValue)
|
Description
|
Set the value for a promptable parameter that exists on this report
|