public class DashboardCategory extends DashboardItem
DashboardCategory Data class that encapsulates the entities which comprise a dashboard category
Modifier and Type | Field and Description |
---|---|
BBjNumber | ColSpacing Space in pixels between columns of widgets |
BBjNumber | FillErrorAction Determines how the dashboard should react after encountering an error filling a widget. This numeric field variable defaults to DashboardCategory.getON_FILL_ERROR_IGNORE() (0), meaning that if an error occurs when filling the widget with data the program will silently log the error then continue to run normally. This prevents an entire dashboard application from failing when there is a problem with one widget. The behavior can be set using static field variables like DashboardCategory.getON_FILL_ERROR_IGNORE(), DashboardCategory.getON_FILL_ERROR_WARN(), or DashboardCategory.getON_FILL_ERROR_STOP(). The FillErrorAction can be set programmatically on a Widget, Dashboard Category, or Dashboard object. If you set the FillErrorAction on a Dashboard object, all added DashboardCategories and their Widgets will inherit the setting. If you set the FillErrorAction on a DashboardCategory object, all added Widgets will inherit the setting.
Here is an example showing how to set the behavior in code via a dashboard:
Here are two examples showing how to set the FillErrorAction via a global string:
1) Setting the global string entry in code, before creating any dashboards or widgets:
|
BBjNumber | FixedWidgetWidth The fixed width in pixels in of widgets. This value is used in combination with setWidgetSizingModel(DashboardCategory.getWIDGET_SIZING_FIXED_SIZE()), which determines how the widgets are sized and positioned in the DashboardCategory |
BBjNumber | MaxWidgetWidth Maximum width in pixels of widgets |
BBjNumber | MinWidgetWidth Minimum width in pixels of widgets |
static BBjNumber | ON_FILL_ERROR_IGNORE A constant to define how the dashboard handles widget fill errors - This value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file). |
static BBjNumber | ON_FILL_ERROR_STOP A constant to define how the dashboard handles widget fill errors - This value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file). |
static BBjNumber | ON_FILL_ERROR_WARN A constant to define how the dashboard handles widget fill errors - This value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file. |
BBjNumber | RowSpacing Space in pixels between rows of widgets |
static BBjNumber | WIDGET_SIZING_DYNAMIC_SIZE A constant used with WidgetSizingModel to define dynamic widget sizing |
static BBjNumber | WIDGET_SIZING_FIXED_SIZE A constant used with WidgetSizingModel to define fixed widget sizing |
BBjNumber | WidgetSizingModel Determines how the dashboard will size the widgets in a category. The WIDGIT_SIZING constants define the options, which include fixed sizing and dynamic sizing. |
Constructor and Description |
---|
DashboardCategory(BBjString p_name$, BBjString p_title$) DashboardCategory Constructs a DashboardCategory |
Modifier and Type | Method and Description |
---|---|
DashboardWidget | addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns an |
DashboardWidget | addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns an |
DashboardWidget | addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns an |
DashboardWidget | addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns an |
DashboardWidget | addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns an Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns an Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns an Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns an Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addDashboardWidget(Widget p_widget!) Creates an active |
DashboardWidget | addDashboardWidget(Widget p_widget!, BBjNumber p_active) Creates an active or inactive |
void | addDashboardWidget(DashboardWidget p_dashboardWidget!) Adds a dashboard widget to the end of the dashboard category |
DashboardWidget | addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns a |
DashboardWidget | addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) Creates and returns a |
DashboardWidget | addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a |
DashboardWidget | addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a |
DashboardWidget | addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) Creates and returns a |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns an empty |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, ResultSet p_resultSet!) Creates and returns a |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_file$, BBjString p_template$, DataRow p_filter!) Creates and returns a |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$) Creates and returns a |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a |
DashboardWidget | addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!) Creates and returns a |
DashboardWidget | addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns an |
DashboardWidget | addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_text$) Creates and returns an |
DashboardWidget | addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$) Creates and returns an |
DashboardWidget | addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_imageName$) Creates and returns an |
DashboardWidget | addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, URL p_imageURL!) Creates and returns an |
DashboardWidget | addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBJasperReport p_report!) Creates and returns a This method of creating a JasperViewerWidget is less efficient than the version that takes a report file, connection string, and parameter list as your code must create and fill the report before displaying the dashboard. Creating the widget with this method also requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed. |
DashboardWidget | addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!) Creates and returns a This method is more efficient than the version that take a BBJasperReport object as the Dashboard Utility will create and fill the report just before displaying the widget. The other method requires that you create and fill the report before the dashboard is displayed, even if the widget is not on the first tab and will never be displayed. Additionally, creating the widget with this method will refill the report automatically whenever the widget is refreshed. Constructing the widget with the BBJasperReport object requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed. |
DashboardWidget | addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a |
DashboardWidget | addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a |
DashboardWidget | addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a |
DashboardWidget | addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a |
DashboardWidget | addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns a Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher. |
DashboardWidget | addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$) Creates and returns an |
DashboardWidget | addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$) Creates and returns an |
DashboardWidget | addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!) Creates and returns an |
DashboardWidget | addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend) Creates and returns an |
BBjNumber | dashboardWidgetExists(BBjString p_widgetName$) Determines if a dashboard widget exists given its name |
void | destroy() Destroys the dashboard category and destroys all dashboardWidgets contained in the category |
DashboardWidget | getDashboardWidget(BBjString p_widgetName$) Returns a dashboard widget given its name |
BBjNumber | getDashboardWidgetPosition(DashboardWidget p_dashboardWidget!) Returns the position of a dashboard widget |
BBjVector | getDashboardWidgets() Returns the dashboard widgets in a BBjVector |
BBjNumber | getDefaultColSpacing() Returns the default col spacing between widgets |
BBjNumber | getDefaultMaxWidgetWidth() Returns the default maximum widget width |
BBjNumber | getDefaultMinWidgetWidth() Returns the default minimum widget width |
BBjNumber | getDefaultRowSpacing() Returns the default row spacing between widgets |
BBjNumber | getNumDashboardWidgets() Returns the number of dashboard widgets |
void | removeDashboardWidget(BBjString p_widgetName$) Removes a dashboard widget, causing all widgets with a higher position to be shifted down by one |
void | repositionDashboardWidget(DashboardWidget p_dashboardWidget!, BBjNumber p_destPosition) Repositions a dashboard widget by inserting it at the specified destination position, shifting all remaining widgets one position higher |
void | setWidgetBorderColor(BBjColor p_color!) Sets the border color of the widgets |
void | setWidgetBorderSelectedColor(BBjColor p_color!) Sets the border selected color of the widgets |
void | setWidgetTitlebarDecorationBackColor(BBjColor p_color!) Sets the title bar decoration background color of the widgets |
void | setWidgetTitlebarDecorationSelectedBackColor(BBjColor p_color!) Sets the title bar decoration selected background color of the widgets |
void | setWidgetTitlebarNameBackColor(BBjColor p_color!) Sets the title bar name background color of the widgets |
void | setWidgetTitlebarNameFont(Font p_font!) Sets the title bar font of the widgets |
void | setWidgetTitlebarNameFont(BBjString p_fontFile$, BBjNumber p_style, BBjNumber p_fontSize) Sets the title bar font of the widgets
You may specify any font given a fully qualified path, a font name or path that can be found via the current PREFIX setting, or any font located in the |
void | setWidgetTitlebarNameForeColor(BBjColor p_color!) Sets the title bar name foreground color of the widgets |
void | setWidgetTitlebarNameSelectedBackColor(BBjColor p_color!) Sets the title bar name selected background color of the widgets |
void | setWidgetTitlebarSeparatorColor(BBjColor p_color!) Sets the title bar separator background color of the widgets |
void | setWidgetTitlebarSeparatorSelectedColor(BBjColor p_color!) Sets the title bar separator selected background color of the widgets |
DashboardWidget | updateDashboardWidget(BBjString p_widgetName$, Widget p_widget!) Updates a dashboard widget in the dashboard category |
getBackColor, getName, getTitle, getUserData, setBackColor, setName, setTitle, setUserData
public BBjNumber ColSpacing
Space in pixels between columns of widgets
public BBjNumber FillErrorAction
Determines how the dashboard should react after encountering an error filling a widget.
This numeric field variable defaults to DashboardCategory.getON_FILL_ERROR_IGNORE() (0), meaning that if an error occurs when filling the widget with data the program will silently log the error then continue to run normally. This prevents an entire dashboard application from failing when there is a problem with one widget. The behavior can be set using static field variables like DashboardCategory.getON_FILL_ERROR_IGNORE(), DashboardCategory.getON_FILL_ERROR_WARN(), or DashboardCategory.getON_FILL_ERROR_STOP().
The FillErrorAction can be set programmatically on a Widget, Dashboard Category, or Dashboard object. If you set the FillErrorAction on a Dashboard object, all added DashboardCategories and their Widgets will inherit the setting. If you set the FillErrorAction on a DashboardCategory object, all added Widgets will inherit the setting.
Here is an example showing how to set the behavior in code via a dashboard:
category!.setFillErrorAction(DashboardCategory.getON_FILL_ERROR_WARN())
Note that you may also set the "BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION" global string entry
either via code or in a configuration file to control the behavior. If the FillErrorAction is set
via a global string it will override all default and programmatically set values for all widgets.
Here are two examples showing how to set the FillErrorAction via a global string:
1) Setting the global string entry in code, before creating any dashboards or widgets:
temp$ = STBL("BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION", "1")
2) Setting the global string entry in the config file, without changing any code:
SET BASIS_DASHBOARD_UTILITY_FILL_ERROR_ACTION=1
BBj 18.20
public BBjNumber FixedWidgetWidth
The fixed width in pixels in of widgets. This value is used in combination with setWidgetSizingModel(DashboardCategory.getWIDGET_SIZING_FIXED_SIZE()), which determines how the widgets are sized and positioned in the DashboardCategory
public BBjNumber MaxWidgetWidth
Maximum width in pixels of widgets
public BBjNumber MinWidgetWidth
Minimum width in pixels of widgets
public static BBjNumber ON_FILL_ERROR_IGNORE
A constant to define how the dashboard handles widget fill errors - This value indicates it should ignore the error and proceed as normal (note that all errors are logged to the BBjServices debug log file).
BBj 18.20
public static BBjNumber ON_FILL_ERROR_STOP
A constant to define how the dashboard handles widget fill errors - This value indicates it should THROW the error which usually results in the program stopping (note that all errors are logged to the BBjServices debug log file).
BBj 18.20
public static BBjNumber ON_FILL_ERROR_WARN
A constant to define how the dashboard handles widget fill errors - This value indicates it should warn the user then proceed as normal (note that all errors are logged to the BBjServices debug log file.
BBj 18.20
public BBjNumber RowSpacing
Space in pixels between rows of widgets
public static BBjNumber WIDGET_SIZING_DYNAMIC_SIZE
A constant used with WidgetSizingModel to define dynamic widget sizing
public static BBjNumber WIDGET_SIZING_FIXED_SIZE
A constant used with WidgetSizingModel to define fixed widget sizing
public BBjNumber WidgetSizingModel
Determines how the dashboard will size the widgets in a category. The WIDGIT_SIZING constants define the options, which include fixed sizing and dynamic sizing.
public DashboardCategory(BBjString p_name$, BBjString p_title$)
DashboardCategory Constructs a DashboardCategory
p_name$
Name of the categoryp_title$
Title of the categorypublic DashboardWidget addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns an AreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns an AreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns an AreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns an AreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns an XYChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addDashboardWidget(Widget p_widget!)
Creates an active DashboardWidget
based on the provided widget and adds it to the current category
p_widget!
The Widget that will be used to create the dashboard widgetpublic DashboardWidget addDashboardWidget(Widget p_widget!, BBjNumber p_active)
Creates an active or inactive DashboardWidget
based on the provided widget and adds it to the current category
p_widget!
Tbe Widget that will be used to create the dashboard widgetp_active
Indicates if the dashboard widget should be active when added. 0=inactive, 1=activepublic void addDashboardWidget(DashboardWidget p_dashboardWidget!)
Adds a dashboard widget to the end of the dashboard category
p_dashboardWidget!
DashboardWidget to addpublic DashboardWidget addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$)
Creates and returns a GridWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdpublic DashboardWidget addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a GridWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a GridWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a GridWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_rs!
BBjRecordSet which contains data for the dashboard widgetp_columns!
BBjVector which contains the column names for the data for the dashboard widgetpublic DashboardWidget addGridDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!)
Creates and returns a GridWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_colHeaderData!
BBjVector which contains the column header datap_rowData!
BBjVector which contains the row datapublic DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$)
Creates and returns an empty GridWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be created BBj 19.10
public DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, ResultSet p_resultSet!)
Creates and returns a GridExWidget
dashboard widget based on a BASIS Components ResultSet that contains the data for the widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_resultSet!
BASIS Components ResultSet that contains the data for the widget ResultSet
BBj 19.12
public DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_file$, BBjString p_template$, DataRow p_filter!)
Creates and returns a GridExWidget
dashboard widget using the BASIS Components to build a ResultSet based off of a data file, string template, and filter
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_file$
The the name of the MKEYED, XKEYED, or VKEYED file that contains the data for the widgetp_template$
The string template describing the records in the filep_filter!
The DataRow that acts as a filter when retrieving data DataRow
BBj 19.12
public DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a GridExWidget
dashboard widget using a connection string and SQL query
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widget BBj 19.10
public DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a GridExWidget
dashboard widget using a connection string, SQL query, and mode
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 19.10
public DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a GridExWidget
dashboard widget using a BBjRecordSet for the row data and an (optionally null()) BBjVector for the column header data
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_rs!
BBjRecordSet which contains data for the dashboard widgetp_columns!
BBjVector that contains an ordered list of the columns to be used for the grid's data. The entries may be a string corresponding to a field name, or a 0-based index of the column number. If null() is passed in for the p_columns! vector then all columns of the BBjRecordSet will be used. BBj 19.10
public DashboardWidget addGridExDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjVector p_colHeaderData!, BBjVector p_rowData!)
Creates and returns a GridExWidget
dashboard widget using BBjVectors for the column header data and row data
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_colHeaderData!
BBjVector which contains the column header datap_rowData!
BBjVector which contains the row data BBj 19.10
public DashboardWidget addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$)
Creates and returns an HtmlViewWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdpublic DashboardWidget addHtmlViewDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_text$)
Creates and returns an HtmlViewWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_text$
HTML that will be displayed in the html view dashboard widgetpublic DashboardWidget addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$)
Creates and returns an ImageWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdpublic DashboardWidget addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_imageName$)
Creates and returns an ImageWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_imageName$
Location of a image for the dashboard image widgetpublic DashboardWidget addImageDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, URL p_imageURL!)
Creates and returns an ImageWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for previewp_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_imageURL!
URL of a image for the dashboard image widgetpublic DashboardWidget addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBJasperReport p_report!)
Creates and returns a JasperViewerWidget
dashboard widget based the provided BBJasperReport
This method of creating a JasperViewerWidget is less efficient than the version that takes a report file, connection string, and parameter list as your code must create and fill the report before displaying the dashboard. Creating the widget with this method also requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_report!
BBJasperReport to show in the jasper viewer widgetpublic DashboardWidget addJasperViewerDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_reportFile$, BBjString p_connectString$, HashMap p_params!)
Creates and returns a JasperViewerWidget
dashboard widget with parameters so that the Dashboard Utility can create and fill the report before it displays the widget
This method is more efficient than the version that take a BBJasperReport object as the Dashboard Utility will create and fill the report just before displaying the widget. The other method requires that you create and fill the report before the dashboard is displayed, even if the widget is not on the first tab and will never be displayed. Additionally, creating the widget with this method will refill the report automatically whenever the widget is refreshed. Constructing the widget with the BBJasperReport object requires that you register for the refresh callback event and refill the report yourself if you want the report to be updated when the widget is refreshed.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_reportFile$
The path to a jrxml or jasper report filep_connectString$
JDBC connect string used to connect to the databasep_params!
A HashMap containing parameters for the report which may be set to null() if the report doesn't require parameters BBj 18.20
public DashboardWidget addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addLineChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns a LineChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices)
Creates and returns a PieChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_numSlices
Number of slices that will be in the pie chart The p_numSlices parameter is no longer required, so use the method that doesn't require this parameter instead.
public DashboardWidget addPieChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend)
Creates and returns a PieChartWidget
dashboard widget with an empty dataset
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend, BBjNumber p_numSlices)
Creates and returns a RingChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_numSlices
Number of slices that will be in the ring chart The p_numSlices parameter is no longer required, so use the method that doesn't require this parameter instead.
public DashboardWidget addRingChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjNumber p_flat, BBjNumber p_legend)
Creates and returns a RingChartWidget
dashboard widget with an empty dataset
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a StackedAreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a StackedAreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's title and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a StackedAreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addStackedAreaChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns a StackedAreaChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addStackedBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns a StackedBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addStackedPercentageBarChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_flat, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns a StackedPercentageBarChartWidget
dashboard widget
Note: As of BBj 23.00, the Dashboard Utility uses JFreeCharts 1.5.x which removes the pseudo-3D charts. Therefore, the p_flat parameter will be ignored in version 23 and higher.
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_flat
Indicates whether the chart should be flat. 0=3D, 1=Flat (2D), ignored in version 23 and higherp_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic DashboardWidget addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$)
Creates and returns an XYChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetpublic DashboardWidget addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjString p_connectString$, BBjString p_sql$, BBjString p_mode$)
Creates and returns an XYChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_connectString$
JDBC connect string used to connect to the databasep_sql$
SQL query used to provide data for the widgetp_mode$
A string comprised of a list of properties and values separated by commas that will be passed to the database or JDBC connection at connect time. For example: "USER=myusername, PWD=mypass, AUTOCOMMIT=N"
BBj 16.00
public DashboardWidget addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend, BBjRecordSet p_rs!, BBjVector p_columns!)
Creates and returns an XYChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendp_rs!
BBjRecordSet which contains data for the embedded widgetp_columns!
BBjVector which contains the column names for the data for the embedded widgetpublic DashboardWidget addXYChartDashboardWidget(BBjString p_name$, BBjString p_title$, BBjString p_previewText$, BBjString p_previewImage$, BBjString p_chartTitle$, BBjString p_domainTitle$, BBjString p_rangeTitle$, BBjNumber p_orientation, BBjNumber p_legend)
Creates and returns an XYChartWidget
dashboard widget
p_name$
Unique name of the widgetp_title$
Title which will display in the title barp_previewText$
Description of the widget used for the preview text in the Customize screen and as the tooltip text on the widget's titlep_previewImage$
Location of a image used for preview, if empty then a dynamic image will be createdp_chartTitle$
Title to be displayed above the chart (may be empty)p_domainTitle$
Title for the domain axis (may be empty)p_rangeTitle$
Title for the range axis (may be empty)p_orientation
Indicates whether the chart will be in portrait or landscape orientation. Example: orientation=LineChartWidget.getORIENTATION_VERTICAL()p_legend
Indicates whether to show a legend for the chart. 0=Do not show legend, 1=Show legendpublic BBjNumber dashboardWidgetExists(BBjString p_widgetName$)
Determines if a dashboard widget exists given its name
p_widgetName$
Name of the dashboard wiget to test for existancepublic void destroy()
Destroys the dashboard category and destroys all dashboardWidgets contained in the category
public DashboardWidget getDashboardWidget(BBjString p_widgetName$)
Returns a dashboard widget given its name
p_widgetName$
Name of the dashboard wiget to obtainpublic BBjNumber getDashboardWidgetPosition(DashboardWidget p_dashboardWidget!)
Returns the position of a dashboard widget
p_dashboardWidget!
DashboardWidget to get the position forpublic BBjVector getDashboardWidgets()
Returns the dashboard widgets in a BBjVector
public BBjNumber getDefaultColSpacing()
Returns the default col spacing between widgets
public BBjNumber getDefaultMaxWidgetWidth()
Returns the default maximum widget width
public BBjNumber getDefaultMinWidgetWidth()
Returns the default minimum widget width
public BBjNumber getDefaultRowSpacing()
Returns the default row spacing between widgets
public BBjNumber getNumDashboardWidgets()
Returns the number of dashboard widgets
public void removeDashboardWidget(BBjString p_widgetName$)
Removes a dashboard widget, causing all widgets with a higher position to be shifted down by one
p_widgetName$
Name of the dashboard wiget to removepublic void repositionDashboardWidget(DashboardWidget p_dashboardWidget!, BBjNumber p_destPosition)
Repositions a dashboard widget by inserting it at the specified destination position, shifting all remaining widgets one position higher
p_dashboardWidget!
DashboardWidget to respositionp_destPosition
Destination positionpublic void setWidgetBorderColor(BBjColor p_color!)
Sets the border color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetBorderSelectedColor(BBjColor p_color!)
Sets the border selected color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarDecorationBackColor(BBjColor p_color!)
Sets the title bar decoration background color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarDecorationSelectedBackColor(BBjColor p_color!)
Sets the title bar decoration selected background color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarNameBackColor(BBjColor p_color!)
Sets the title bar name background color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarNameFont(Font p_font!)
Sets the title bar font of the widgets
p_font!
A Font to be used for the title bar of the widgetspublic void setWidgetTitlebarNameFont(BBjString p_fontFile$, BBjNumber p_style, BBjNumber p_fontSize)
Sets the title bar font of the widgets
You may specify any font given a fully qualified path, a font name or path that can be found via the current PREFIX setting, or any font located in the
p_fontFile$
A string that contains the path to the font file.public void setWidgetTitlebarNameForeColor(BBjColor p_color!)
Sets the title bar name foreground color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarNameSelectedBackColor(BBjColor p_color!)
Sets the title bar name selected background color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarSeparatorColor(BBjColor p_color!)
Sets the title bar separator background color of the widgets
p_color!
BBjColor that specifies the colorpublic void setWidgetTitlebarSeparatorSelectedColor(BBjColor p_color!)
Sets the title bar separator selected background color of the widgets
p_color!
BBjColor that specifies the colorpublic DashboardWidget updateDashboardWidget(BBjString p_widgetName$, Widget p_widget!)
Updates a dashboard widget in the dashboard category
p_widgetName$
Existing name of the dashboard widget to updatep_widget!
New widget