Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Toggle component #4249

Merged
merged 4 commits into from
Feb 7, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ Each component in a dashboard or low-code app has a number of default options. B

- In the *Colors* section, specify a custom background color and/or font color, either by specifying the color in RGB format, by entering the hex value or HTML color name, or by using the color picker box on the right.

Under *Colors* > *Accent color* (available from DataMiner 10.4.0 [CU12]/10.5.3 onwards<!--RN 41859-->), you can specify an accent color. If a component supports an accent color (e.g. the [toggle component](xref:Toggle)), it will inherit the selected color. By default, this is set to *Default*, meaning the accent color will match the theme of the dashboard or low-code app.

Under *Colors* > *Data colors* or *Colors* > *Color palette* (prior to DataMiner 10.3.0 [CU16]/10.4.0 [CU4]/10.4.7<!--RN 39739-->), you can customize additional component colors, e.g. for the lines in a line chart.

From DataMiner 10.3.0 [CU16]/10.4.0 [CU4]/10.4.7 onwards<!--RN 39739-->, under *Colors* > *Data colors*, you can specify conditional colors. If a display label of the data matches the specified text, that data will inherit the conditional color. These conditional colors override the normal data colors.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,11 +49,22 @@ To create component references inside textual settings, use the following syntax
> - Any parts of this syntax that contain spaces should be enclosed in double quotation marks.
> - All parts of this syntax are case-sensitive.

Example: If the linked component provided the element name "Localhost" and the protocol name "Microsoft Platform", the following example would result in the text "*The element Localhost uses the protocol Microsoft Platform*":
Examples:

```txt
The element `{COMPONENT."Page 1"."Dropdown 3"."Selected item".Elements.Name}` uses the protocol `{COMPONENT."Page 1"."Dropdown 3"."Selected item".Elements."Protocol Name"}`.
```
- If the linked component provided the element name "Localhost" and the protocol name "Microsoft Platform", the following example would result in the text "*The element Localhost uses the protocol Microsoft Platform*":

```txt
The element `{COMPONENT."Page 1"."Dropdown 3"."Selected item".Elements.Name}` uses the protocol `{COMPONENT."Page 1"."Dropdown 3"."Selected item".Elements."Protocol Name"}`.
```

- If the linked component represents a toggle switch, where "Toggle 1" is either enabled (`true`) or disabled (`false`), the following example would result in the text "*Toggle state: true*" when Toggle 1 is enabled and "*Toggle state: false*" when Toggle 1 is disabled:

```txt
Toggle state: {COMPONENT."Current view"."Toggle 1".Value.Booleans.Value}.
```

> [!NOTE]
> Dynamically referencing boolean values is supported from DataMiner 10.4.0 [CU12]/10.5.3 onwards<!--RN 41845-->.

#### URLs

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -222,3 +222,5 @@ Within the dashboard URL, the following data objects can be specified:
For example, to add a query row with two columns to the URL, of which the first column, *ID*, contains string values, and the second column, *Value*, contains numbers:

`v:1\u001FIDColumn\u000EID\u000Estring\u001FValueColumn\u000EValue\u000Enumber\u001Evalue1\u000EValue 1\u001F5\u000EFive\u001ERowKey`

- *booleans*: Supported from DataMiner 10.4.0 [CU12]/10.5.3 onwards<!--RN 41845-->. Used to specify whether a boolean value is set to "true" or "false" when the dashboard is loaded.
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ To create a new variable:

- Text

- Boolean (available from DataMiner 10.4.0 [CU12]/10.5.3 onwards<!--RN 41845-->)

- Number

- Table <!--RN 41132-->
Expand Down Expand Up @@ -55,6 +57,8 @@ To create a new variable:

- Default text: Enter custom text.

- Default boolean: Choose *True* to enable the boolean variable by default, *False* to disable it, or *Empty* to leave it unset until a value is specified.

- Default number: Enter a number or use the arrow icons to increase or decrease the value.

- Default table: Configure a static table<!--RN 41132-->.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -278,3 +278,9 @@ Many visualizations are available in the Dashboards app and Low-Code Apps, in th
<a href="/user-guide/Advanced_Modules/Dashboards_and_Low_Code_Apps/Visualizations/Available_visualizations/Basic_controls/Timerange.html" title="Time Range" target="_self"><img src="~/user-guide/images/Time_Range.svg" style="width:100%"></a>
</div>
</div>

<div class="row">
<div class="column">
<a href="/user-guide/Advanced_Modules/Dashboards_and_Low_Code_Apps/Visualizations/Available_visualizations/Basic_controls/Toggle.html" title="Toggle" target="_self"><img src="~/user-guide/images/Toggle.svg" style="width:100%"></a>
</div>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
uid: Toggle
---

# Toggle

This basic control (available from DataMiner 10.4.0 [CU12]/10.5.3 onwards<!--RN 41903-->) allows you to enable or disable specific capabilities.

The toggle component accepts boolean input (e.g. variables of type boolean), but can also be used as data output (*Data* > *Components* > *Toggle #* > *Value* > *Booleans*) to drive GQI queries, Automation scripts, and more. For example, you can use one toggle component to trigger a second toggle component.

![Two toggle switches](~/user-guide/images/Notification_and_Vibration_Controls.gif)<br>*Toggle components in DataMiner 10.5.3*

To configure the toggle component:

1. In the *Component* > *Settings* pane, determine whether the component's default value should be "false" (toggle switch disabled) or "true" (toggle switch enabled). By default, this is set to "false".

1. Optionally, fine-tune the component layout. In the *Component* > *Layout* pane, the following options are available:

- The default options available for all components. See [Customizing the component layout](xref:Customize_Component_Layout).

- *Label*: Text that will be displayed next to the toggle switch.

- *Icon*: Icon that will be displayed next to the toggle switch.

## Component actions

When you have added a toggle component to a low-code app, you can configure the following [component action](xref:LowCodeApps_event_config#executing-a-component-action) in your low-code app to interact with the component:

- *Set value*: Allows you to set the current value of the component to either a static value (true, false, or empty) or data input (variables of type boolean)<!--RN 41911-->.
2 changes: 2 additions & 0 deletions user-guide/Advanced_Modules/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -502,6 +502,8 @@ items:
topicUid: DashboardTextInput
- name: Time range
topicUid: TimeRange
- name: Toggle
topicUid: Toggle
- name: Component data
topicUid: Component_Data
- name: URL data
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions user-guide/images/Toggle.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.