Add Widget Dialog Box for Chart Widgets
When you add a new widget by using this dialog box, you perform two steps. In the first step, you select the type of the widget that you want to add to the dashboard; the system brings up the version of the Add Widget dialog box that is specific to the widget type. In the second step, you specify the properties that are specific to the selected widget type. When you modify an existing widget, you perform only the second step. (In this case, the system immediately brings up the appropriate version of the dialog box.)
Add Widget Dialog Box: Step 1
Element | Description |
---|---|
Widget Type | The type of widget to be added to the dashboard, which can be one of the following:
|
The dialog box has the following buttons. | |
Cancel | Cancels the changes and closes the dialog box. |
Next | Goes to the next step of the Add Widget dialog box for the selected widget type. |
Add Widget Dialog Box: Step 2
After you select the Chart widget type in the Add Widget dialog box, or when you click Edit () on the widget toolbar, the Widget Properties dialog box opens. In this dialog box, you need to specify the properties that are specific to chart widgets. You should select the inquiry form to provide source data for the widget, a shared filter to be applied to the data (optional), and the type of the chart; you then configure the chart widget. For more information about chart widgets, see Specific Widgets: Chart Widgets.
Element | Description |
---|---|
Inquiry Screen | Required. The name of the inquiry form that provides data for the widget. |
Inquiry Parameters | A button that you click to open the Inquiry Parameters dialog box so you can specify the parameters for the inquiry selected in the Inquiry Screen box. (For the description of this dialog box, see Other Dialog Boxes.) |
Shared Filter to Apply | The shared filter that is applied to the data in the widget. You can apply a shared filter or leave the box blank to display all the data from the inquiry. |
Filter Settings | A button that you click to open the Filter Settings dialog box. (For the description of this dialog box, see Other Dialog Boxes.) You use this dialog box to configure a filter for data displayed on the widget. |
Configure | A button that you click to open the Chart Settings dialog box. (For the description of this dialog box, see Other Dialog Boxes.) You need to open this dialog box when you want to specify properties that are specific to the chart type. |
Caption | The name of the widget on the dashboard. |
The dialog box has the following buttons. | |
Cancel | Cancels your changes and closes the dialog box. |
Previous |
Returns to the previous step of the dialog box without saving your changes. The button appears only when you are adding a widget. |
Finish | Saves your changes and closes the dialog box. |
Other Dialog Boxes
This section describes dialog boxes that you can open from the Widget Properties dialog box.
Element | Description |
---|---|
Parameter | The name of the parameter of the inquiry selected in the Inquiry Screen box. |
Value | The value of the inquiry parameter. |
Use Default Value | A check box that indicates (if selected) that a default value should be used for the inquiry parameter. You can specify the default value on the Generic Inquiry (SM208000) form. |
The dialog box has the following buttons. | |
Cancel | Cancels your changes and closes the dialog box. |
OK | Saves your changes and closes the dialog box. |
Element | Description |
---|---|
Active | A check box that indicates (if selected) that the row is an active filter. |
Brackets | The opening bracket or brackets for composing a logical expression with multiple filtering conditions. |
Data Field | The field whose value the filter should be applied to. |
Condition | One of the following logical conditions, which will be applied to the
value of the field specified as the Data Field
and the values in the Value 1 and
Value 2 fields if applicable:
Note: If you try to filter the inquiry results by using a string
that contains an underscore, the result will also contain the values
with the same string with any symbol instead of the underscore. For
example, if you try to filter the inquiry by a customer name that
contains the Customer_Name string, the system will return all
the customers whose name contains any of the following strings:
Customer_Name, Customer-Name, and Customer
Name. The reason that all of these strings will be returned
is that the underscore is used as a wildcard
character. |
Use Parameter | A check box that indicates (if selected) that a dashboard parameter is used in the filtering condition. When this check box is selected, only active dashboard parameters are displayed in the Value 1 and Value 2 columns. |
Value 1 | The value you enter for the logical condition used to filter the
data, if the selected condition requires a value. The value you enter
must conform with the data type of the selected property. You can enter
or select a fixed value, one of the predefined parameters, or one of the
dashboard parameters. The predefined parameters are listed in Managing Advanced Filters. |
Value 2 | The second value for the logical condition, if the selected logical
condition requires a second value. (For example, the Is Between
logical condition requires a second value.) The value you enter must
conform with the data type of the selected property. You can enter or
select a fixed value, one of the predefined parameters, or one of the
dashboard parameters. The predefined parameters are listed in Managing Advanced Filters. |
Brackets | A group of closing brackets to group logical conditions. |
Operator | The logical operator to be used between groups of logical conditions. |
Element | Description |
---|---|
Chart Type | Required. The type of chart widget you want to add. The following options are
available:
For more information, see Specific Widgets: Chart Widgets. |
Legend Position | The location of the legend on the widget. The box is displayed for only
doughnut and funnel chart types. The following options are available:
|
The Categories section of the dialog box includes the following elements. | |
Legend | Required. The column from the source form whose values are used for categories.
The values of the selected column are displayed on the chart as follows, depending
on the chart type:
|
Sort By | The value by which the legend data is sorted and the sort order. The left box
defines the sequence to be sorted as follows:
The right box defines the sort order. The way the values are sorted depends on the chart type as well as this selection. The following options are available:
The default values in these boxes depend on the type of the field that you selected in the Legend box, as described below: |
Field to Sort By |
A box, which is used to select the field other than the field selected in the Legend box to define the sorting. By default, this box is not available in the dialog box and appears when Field or Field Value is selected in the left Sort By box. |
Maximum Number of Values Shown |
The maximum number of values to be individually shown on the chart. The system always selects the values starting from the largest ones. If you want the system to individually display all values, set the value of this box to 0. The default value of this box is 10. |
Show Sum of Other Entries |
A check box that indicates (if selected) that the values that are not among the largest values (whose number is specified in the Maximum Number of Values Shown box) are summed and shown on the chart as a single element, with the element type depending on the chart type. For example, for a doughnut chart, the element is a separate sector, and for a line chart, it is a separate point. By default, this check box is cleared. |
Date Rounding | The part of the date field that is displayed on
the chart widget. You can use on the chart either the full date or a particular part of
it (for example, a month or a year). This property is available only for fields of the date type. Select one of the following values:
|
Format | The format of the field value that is
selected in the Legend box. This box is displayed only for fields
of numeric and date types. You can select one of the predefined formats from the list.
By default, the box is empty, which means that the field is not formatted. |
The Series section of the dialog box includes the elements listed below. This section is available for the following chart types: Line, Column, Stacked Column, Bar, and Stacked Bar. |
|
Legend |
The source column for the chart content. The values of the selected column are displayed on the chart as follows, depending on the chart type.
|
Sort By | The value by which the legend data is sorted and the sort order. The left box
defines the sequence to be sorted as follows:
The way the values are sorted depends on the chart type as well as this selection. The following options are available:
The default values in these boxes depend on the type of the field that you selected in the Legend box, as described below: |
Field to Sort By |
A box, which is used to select the field other than the field selected in the Legend box to define the sorting. By default, this box is not available in the dialog box and appears when Field or Field Value is selected in the left Sort By box. |
Maximum Number of Values Shown |
The maximum number of values to be individually shown on the chart. The system always selects the values starting from the largest ones. If you want the system to individually display all values, set the value of this box to 0. The default value of this box is 10. |
Show Sum of Other Entries |
A check box that indicates (if selected) that the values that are not among the largest values (whose number is specified in the Maximum Number of Values Shown box) are summed and shown on the chart as a single element, with the element type depending on the chart type. For example, for a doughnut chart, the element is a separate sector, and for a line chart, it is a separate point. By default, this check box is cleared. |
Date Rounding | The part of the date field that is displayed on
the chart widget. You can use on the chart either the full date or a particular part of
it (for example, a month or a year). This property is available only for fields of the date type. Select one of the following values:
|
Format | The format of the field value that is
selected in the Legend box. This box is displayed only for fields
of numeric and date types. You can select one of the predefined formats from the list.
By default, the box is empty, which means that the field is not formatted. |
Color | The custom colors of chart elements for the values defined in the Series section. The colors should be specified by using expressions. You can open the Expression Editor dialog box by clicking the magnifier icon. For details, see Specific Widgets: Chart Widgets. |
The Values section of the dialog box includes the following elements. | |
Value | A column from the source form. The values of the selected column are displayed
on the chart as follows, depending on the chart type:
|
Aggregation Function |
The aggregate function used to perform a calculation on the column of data selected in the Value box and return a single value, such as the total of the values or the number of selected rows in the column. The following aggregate functions are available:
|
Format |
The format of the field value that is selected in the Value box. You can specify any of the standard formats defined for the format function in .Net. By default, the box is empty, which means that the field is not formatted. |
The dialog box has the following buttons. | |
OK | Saves your changes to the widget properties, and closes the dialog box. |