You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: dataminer/Functions/Dashboards_and_Low_Code_Apps/Visualizations/Available_visualizations/General/Button.md
+48-48Lines changed: 48 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,81 +4,81 @@ uid: DashboardButton
4
4
5
5
# Button
6
6
7
-
> [!IMPORTANT]
8
-
> In the Dashboards app, this feature is currently still in preview. For more information, see [Soft-launch options](xref:SoftLaunchOptions). However, it is fully available in the [DataMiner Low-Code Apps](xref:Application_framework).
9
-
10
-
In the Dashboards app, this component is available in soft launch, if the soft-launch option *ReportsAndDashboardsButton* is enabled. In the DataMiner Low-Code Apps, it is available by default.
7
+
The button component is a customizable element used to trigger actions in a low-code app.
11
8
12
9
<br>*Button component in DataMiner 10.4.6*
13
10
14
-
To configure the component:
15
-
16
-
## [In the DataMiner Low-Code Apps](#tab/tabid-1)
17
-
18
-
1. In the *Component* > *Settings* pane, click the configuration icon next to *On click* and select the action(s) you want the button to execute. See [Configuring app events](xref:LowCodeApps_event_config).
19
-
20
-
1. Fine-tune the component layout. In the *Component* > *Layout* pane, the following options are available:
21
-
22
-
- The default options available for all components. See [Customizing the component layout](xref:Customize_Component_Layout).
23
-
24
-
-*Label*: Determines which text is displayed on the button.
11
+
> [!TIP]
12
+
> See also: [Using button components and header bars in Low-Code Apps](https://www.youtube.com/watch?v=7Qhitj3fQB4)
25
13
26
-
-*Icon*: Allows you to select an icon to be displayed next to the label.
14
+
## Configuration options
27
15
28
-
##[In the Dashboards app](#tab/tabid-2)
16
+
### Button layout
29
17
30
-
In the Dashboards app, the soft-launch button component can be used to execute the action of a button parameter. As such, it must be configured with button parameter data.
18
+
In the *Layout* pane, you can find the default options available for all components. See [Customizing the component layout](xref:Customize_Component_Layout).
31
19
32
-
> [!NOTE]
33
-
> If the *ReportsAndDashboardsAutomationScript* soft-launch option is enabled as well, this component functions as an Automation script component, and you can link it directly to an Automation script in the *Settings* pane. However, if you add a button parameter to the component, it will still act as a parameter button even with this soft-launch option.
20
+
Additionally, the following layout options are also available:
34
21
35
-
1. Apply parameter data. See [Adding data to a component](xref:Adding_data_to_component).
22
+
| Section | Option | Description |
23
+
|--|--|--|
24
+
| Advanced | Label | Determine which text is displayed on the button. |
25
+
| Advanced | Icon | Select an icon to be displayed next to the label. |
36
26
37
-
You will only be able to select button parameters for the data. Several parameters can be added in the same component.
27
+
### Button settings
38
28
39
-
1. Fine-tune the component layout. In the *Component* > *Layout* pane, the following options are available:
29
+
In the *Settings* pane for this component, you can customize its behavior to suit your requirements:
40
30
41
-
- The default options available for all components. See [Customizing the component layout](xref:Customize_Component_Layout).
31
+
| Section | Option | Description |
32
+
|--|--|--|
33
+
| WebSocket settings | Inherit WebSocket settings from page/panel | Clear the checkbox to use a custom polling interval for this component. When cleared, you can specify a different polling interval (in seconds). |
34
+
| General | On click | Configure the action(s) that will be triggered by clicking the button. See [Configuring app events](xref:LowCodeApps_event_config). |
42
35
43
-
- In case the component displays more than one parameter, in the *Advanced* > *Layout* section, you can adjust the way the different items are displayed:
36
+
## Using the button in dashboards (preview)
44
37
45
-
-*Layout*: Determines whether the different items are displayed next to each other or below each other. However, note that when the items are viewed on a small screen, they will always be displayed below each other.
38
+
The button component is **currently still in preview** in the Dashboards app, and requires the [soft-launch option *ReportsAndDashboardsButton*](xref:Overview_of_Soft_Launch_Options#reportsanddashboardsbutton) to be enabled.
46
39
47
-
-*Maximum rows per page*: Determines how many items can at most be displayed below each other on a single page.
40
+
When used in dashboards, the soft-launch button component can be used to **execute the action of a button parameter**. As such, it must always be configured with button parameter data. Multiple parameters can be added to the same element.
48
41
49
-
-*Maximum columns per page*: Determines how many items can at most be displayed next to each other on a single page.
42
+
> [!NOTE]
43
+
>
44
+
> - If the *ReportsAndDashboardsAutomationScript* soft-launch option is enabled as well, this component functions as an Automation script component, and you can link it directly to an Automation script in the *Settings* pane. However, if you add a button parameter to the component, it will still act as a parameter button even with this soft-launch option.
45
+
> - From DataMiner 10.2.5/10.3.0 onwards, the output of an (interactive) Automation script can be used as data for other components, for example in a GQI query.
50
46
51
-
- The *Button text* option allows you to customize the text that should be displayed on the button. By default, the button displays the same text as in Cube.
47
+
### Dashboard button layout
52
48
53
-
1. Optionally, configure the following settings in the *Component* > *Settings* pane:
49
+
In the *Layout* pane, you can find the default options available for all components. See [Customizing the component layout](xref:Customize_Component_Layout).
54
50
55
-
- To use a custom polling interval for this component, in the *WebSocket settings* section, clear the checkbox and specify a different polling interval (in seconds).
51
+
Additionally, the following layout options are available. Some options only appear when the component displays multiple parameters:
56
52
57
-
- In case the component displays more than one parameter, configure how the parameters should be grouped: by parameter, by element, by table index (if relevant) or by all the above together.
53
+
| Section | Option | Description |
54
+
|--|--|--|
55
+
| Advanced | Layout | Determine whether the different items are displayed next to each other or below each other. However, note that when the items are viewed on a small screen, they will always be displayed below each other. |
56
+
| Advanced | Maximum rows per page | Determine how many items can at most be displayed below each other on a single page. |
57
+
| Advanced | Maximum columns per page | Determine how many items can at most be displayed next to each other on a single page. |
58
+
| Advanced | Button text | Customize the text that should be displayed on the button. By default, the button displays the same text as in Cube. |
59
+
| Advanced | Simple button text size | Select the size of the button text: small, medium, or large. |
58
60
59
-
- In case the button triggers an Automation script, additional settings will also be available related to this script.
61
+
### Dashboard button settings
60
62
61
-
- Depending on the script configuration, it may be possible to configure the parameters and/or dummies used in the script. For each of the parameters and dummies, a checkbox allows you to select whether these are required, i.e. whether the script can be executed only if these are filled in.
63
+
The following optional settings are available for the soft-launch button component:
62
64
63
-
> [!NOTE]
64
-
> The input for an interactive Automation script can be specified by the user or retrieved via linked data. In case both are possible for the same component, user input always takes precedence.
65
-
>
66
-
> In case several data is linked to the component, they are considered in the order they were added. For example, if 2 data sources are used and the data that was first added is applicable, the second data input will be ignored.
65
+
- In case the component displays more than one parameter, configure how the parameters should be grouped: by parameter, by element, by table index (if relevant) or by all the above together.
67
66
68
-
- The standard options for script execution can be configured. See [Script execution options](xref:Script_execution_options).
67
+
- In case the button triggers an Automation script, additional settings will also be available related to this script.
69
68
70
-
- The following additional options are available:
69
+
- Depending on the script configuration, it may be possible to configure the parameters and/or dummies used in the script. For each of the parameters and dummies, a checkbox allows you to select whether these are required, i.e. whether the script can be executed only if these are filled in.
71
70
72
-
-*Ask for confirmation*: Determines whether the user will be asked for confirmation before the script is executed.
71
+
> [!NOTE]
72
+
> The input for an interactive Automation script can be specified by the user or retrieved via linked data. In case both are possible for the same component, user input always takes precedence.
73
+
>
74
+
> In case several data is linked to the component, they are considered in the order they were added. For example, if 2 data sources are used and the data that was first added is applicable, the second data input will be ignored.
73
75
74
-
-*Show success popup*: Determines whether a pop-up message is displayed when the script has been successfully executed. By default enabled.
76
+
- The standard options for script execution can be configured. See [Script execution options](xref:Script_execution_options).
75
77
76
-
-*Custom success message*: Allows you to configure a custom message to be displayed when the script has been successfully executed.
78
+
- The following additional options are available:
77
79
78
-
***
80
+
-*Ask for confirmation*: Determines whether the user will be asked for confirmation before the script is executed.
79
81
80
-
> [!NOTE]
81
-
> From DataMiner 10.2.5/10.3.0 onwards, the output of an (interactive) Automation script can be used as data for other components, for example in a GQI query.
82
+
-*Show success popup*: Determines whether a pop-up message is displayed when the script has been successfully executed. By default enabled.
82
83
83
-
> [!TIP]
84
-
> See also: [Using button components and header bars in Low-Code Apps](https://www.youtube.com/watch?v=7Qhitj3fQB4)
84
+
-*Custom success message*: Allows you to configure a custom message to be displayed when the script has been successfully executed.
0 commit comments