From c6bb337d23460f7b468085412d099ac08d6d09e9 Mon Sep 17 00:00:00 2001
From: Vladyslav_Prykhodko <vprykhodko@thingsboard.io>
Date: Wed, 29 Jan 2025 19:08:11 +0200
Subject: [PATCH] UI: Add help to function 'Get Dashboard State with
 Parameters'

---
 ...value-action-settings-panel.component.html |  2 +-
 ...t-value-action-settings-panel.component.ts |  8 ++++
 ...alue_get_dashboard_state_with_params_fn.md | 40 +++++++++++++++++++
 3 files changed, 49 insertions(+), 1 deletion(-)
 create mode 100644 ui-ngx/src/assets/help/en_US/widget/config/parse_value_get_dashboard_state_with_params_fn.md

diff --git a/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.html b/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.html
index 68a9872799..7783c0af20 100644
--- a/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.html
+++ b/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.html
@@ -145,7 +145,7 @@
                   [globalVariables]="functionScopeVariables"
                   [functionArgs]="['data']"
                   functionTitle="{{ 'widgets.value-action.parse-value-function' | translate }}"
-                  helpId="widget/lib/rpc/parse_value_fn">
+                  [helpId]="getParseValueFunctionHelpId()">
       </tb-js-func>
       <div *ngIf="valueType === ValueType.BOOLEAN" class="tb-form-row align-start no-gap column-xs">
         <div class="fixed-title-width fixed-title-height">{{ 'widgets.value-action.state-when-result-is' | translate:{state: stateLabel} }}</div>
diff --git a/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.ts b/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.ts
index 82bc659e12..4c98c0cac4 100644
--- a/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.ts
+++ b/ui-ngx/src/app/modules/home/components/widget/lib/settings/common/action/get-value-action-settings-panel.component.ts
@@ -167,6 +167,14 @@ export class GetValueActionSettingsPanelComponent extends PageComponent implemen
     this.getValueSettingsApplied.emit(getValueSettings);
   }
 
+  getParseValueFunctionHelpId(): string {
+    const action: GetValueAction = this.getValueSettingsFormGroup.get('action').value;
+    if (action === GetValueAction.GET_DASHBOARD_STATE_WITH_PARAMS) {
+      return 'widget/config/parse_value_get_dashboard_state_with_params_fn';
+    }
+    return 'widget/lib/rpc/parse_value_fn';
+  }
+
   private updateValidators() {
     const action: GetValueAction = this.getValueSettingsFormGroup.get('action').value;
     let dataToValueType: DataToValueType = this.getValueSettingsFormGroup.get('dataToValue').get('type').value;
diff --git a/ui-ngx/src/assets/help/en_US/widget/config/parse_value_get_dashboard_state_with_params_fn.md b/ui-ngx/src/assets/help/en_US/widget/config/parse_value_get_dashboard_state_with_params_fn.md
new file mode 100644
index 0000000000..c272a07f79
--- /dev/null
+++ b/ui-ngx/src/assets/help/en_US/widget/config/parse_value_get_dashboard_state_with_params_fn.md
@@ -0,0 +1,40 @@
+#### Parse value function
+
+<div class="divider"></div>
+<br/>
+
+*function (data): boolean*
+
+A JavaScript function that converts the current dashboard state and parameters into a boolean value.
+
+**Parameters:**
+
+<ul>
+  <li><b>data:</b> <a href="https://github.com/thingsboard/thingsboard/blob/master/ui-ngx/src/app/core/api/widget-api.models.ts#L150" target="_blank">StateObject</a> - the current dashboard state object.
+   </li>
+</ul>
+
+**Returns:**
+
+`true` if the widget should be in an activated state, `false` otherwise.
+
+<div class="divider"></div>
+
+##### Examples
+
+* Check if the current dashboard state ID is "default":
+
+```javascript
+return data.id === 'default' ? true : false;
+{:copy-code}
+```
+
+* Check if the current dashboard state parameters are empty:
+
+```javascript
+return Object.keys(data.params).length ? true : false;
+{:copy-code}
+```
+
+<br>
+<br>