Browse Source

UI: Refactoring

pull/11739/head
Artem Dzhereleiko 2 years ago
parent
commit
dd6b8c0c56
  1. 17
      ui-ngx/src/assets/help/en_US/scada/tag_click_action_fn.md
  2. 5
      ui-ngx/src/assets/help/en_US/scada/tag_state_render_fn.md

17
ui-ngx/src/assets/help/en_US/scada/tag_click_action_fn.md

@ -12,9 +12,8 @@ A JavaScript function invoked when user clicks on SVG element with specific tag.
<ul>
<li><b>ctx:</b> <code>ScadaSymbolContext</code> - <a href="${siteBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/scada-symbols-dev-guide/#scadasymbolcontext" target="_blank">Context</a> of the SCADA symbol.
</li>
<li><b>element:</b> <code>Element</code> - SVG element.<br>
See <a href="https://svgjs.dev/docs/3.2/manipulating/" target="_blank">Manipulating</a> section to manipulate the element.<br>
See <a href="https://svgjs.dev/docs/3.2/animating/" target="_blank">Animating</a> section to animate the element.
<li><b>element:</b> <code>Element</code> - <a href="https://svgjs.dev/docs/3.2/getting-started/" target="_blank">SVG.js</a> element.<br>
See the examples below to learn how to <a href="https://svgjs.dev/docs/3.2/manipulating/" target="_blank">manipulate</a> and <a href="${siteBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/scada-symbols-dev-guide/#scadasymbolanimation" target="_blank">animate</a> elements.<br>
</li>
<li><b>event:</b> <code>Event</code> - DOM event.
</li>
@ -26,15 +25,23 @@ A JavaScript function invoked when user clicks on SVG element with specific tag.
* Set new value action
*callAction: (event: Event, behaviorId: string, value?: any, observer?: Partial\<Observer\<void\>\>): void*
*setValue: (valueId: string, value: any): void*
Avoid manually setting behavior values, as shown in the example, see <a href="${siteBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/scada-symbols-dev-guide/#best-practices" target="_blank">best practice</a> for Device Interaction
```javascript
var active = ctx.values.active;
var action = active ? 'inactive' : 'active';
var action = active ? 'turnOn' : 'turnOff';
ctx.api.callAction(event, action, undefined, {
ctx.api.callAction(event, action, active, {
next: () => {
// To simplify debugging in preview mode
ctx.api.setValue('activate', !active);
},
error: () => {
// To simplify debugging in preview mode
ctx.api.setValue('activate', active);
}
});

5
ui-ngx/src/assets/help/en_US/scada/tag_state_render_fn.md

@ -12,9 +12,8 @@ A JavaScript function used to render SCADA symbol element with specific tag.
<ul>
<li><b>ctx:</b> <code>ScadaSymbolContext</code> - <a href="${siteBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/scada-symbols-dev-guide/#scadasymbolcontext" target="_blank">Context</a> of the SCADA symbol.
</li>
<li><b>element:</b> <code>Element</code> - SVG element.<br>
See <a href="https://svgjs.dev/docs/3.2/manipulating/" target="_blank">Manipulating</a> section to manipulate the element.<br>
See <a href="https://svgjs.dev/docs/3.2/animating/" target="_blank">Animating</a> section to animate the element.
<li><b>element:</b> <code>Element</code> - <a href="https://svgjs.dev/docs/3.2/getting-started/" target="_blank">SVG.js</a> element.<br>
See the examples below to learn how to <a href="https://svgjs.dev/docs/3.2/manipulating/" target="_blank">manipulate</a> and <a href="${siteBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/scada-symbols-dev-guide/#scadasymbolanimation" target="_blank">animate</a> elements.<br>
</li>
</ul>

Loading…
Cancel
Save