UI: Add SCADA symbol animation API link

This commit is contained in:
Igor Kulikov 2024-09-25 17:36:22 +03:00
parent 5ba220d127
commit 10b8624e8d
2 changed files with 10 additions and 7 deletions

View File

@ -34,7 +34,7 @@ import {
import { TbEditorCompletion, TbEditorCompletions } from '@shared/models/ace/completion.models'; import { TbEditorCompletion, TbEditorCompletions } from '@shared/models/ace/completion.models';
import { CustomTranslatePipe } from '@shared/pipe/custom-translate.pipe'; import { CustomTranslatePipe } from '@shared/pipe/custom-translate.pipe';
import { AceHighlightRule, AceHighlightRules } from '@shared/models/ace/ace.models'; import { AceHighlightRule, AceHighlightRules } from '@shared/models/ace/ace.models';
import { ValueType } from '@shared/models/constants'; import { HelpLinks, ValueType } from '@shared/models/constants';
import ITooltipsterInstance = JQueryTooltipster.ITooltipsterInstance; import ITooltipsterInstance = JQueryTooltipster.ITooltipsterInstance;
import TooltipPositioningSide = JQueryTooltipster.TooltipPositioningSide; import TooltipPositioningSide = JQueryTooltipster.TooltipPositioningSide;
import ITooltipsterHelper = JQueryTooltipster.ITooltipsterHelper; import ITooltipsterHelper = JQueryTooltipster.ITooltipsterHelper;
@ -1131,6 +1131,10 @@ export const clickActionFunctionCompletions = (ctxCompletion: TbEditorCompletion
export const scadaSymbolContextCompletion = (metadata: ScadaSymbolMetadata, tags: string[], export const scadaSymbolContextCompletion = (metadata: ScadaSymbolMetadata, tags: string[],
customTranslate: CustomTranslatePipe): TbEditorCompletion => { customTranslate: CustomTranslatePipe): TbEditorCompletion => {
const scadaSymbolAnimationLink = HelpLinks.linksMap.scadaSymbolDevAnimation;
const scadaSymbolAnimation = `<a href="${scadaSymbolAnimationLink}">ScadaSymbolAnimation</a>`;
const properties: TbEditorCompletion = { const properties: TbEditorCompletion = {
meta: 'object', meta: 'object',
type: 'object', type: 'object',
@ -1191,9 +1195,8 @@ export const scadaSymbolContextCompletion = (metadata: ScadaSymbolMetadata, tags
} }
], ],
return: { return: {
description: 'Instance of ScadaSymbolAnimation which has generally similar methods as ' + description: `Instance of ${scadaSymbolAnimation} class with API to setup and control the animation.`,
'<a href="https://svgjs.dev/docs/3.2/animating/#svg-runner">SVG.Runner</a> to control the animation.', type: scadaSymbolAnimation
type: 'ScadaSymbolAnimation'
} }
}, },
cssAnimation: { cssAnimation: {
@ -1207,9 +1210,8 @@ export const scadaSymbolContextCompletion = (metadata: ScadaSymbolMetadata, tags
} }
], ],
return: { return: {
description: 'Instance of ScadaSymbolAnimation which has generally similar methods as ' + description: `Instance of ${scadaSymbolAnimation} class with API to setup and control the animation.`,
'<a href="https://svgjs.dev/docs/3.2/animating/#svg-runner">SVG.Runner</a> to control the animation.', type: scadaSymbolAnimation
type: 'ScadaSymbolAnimation'
} }
}, },
resetCssAnimation: { resetCssAnimation: {

View File

@ -187,6 +187,7 @@ export const HelpLinks = {
gatewayInstall: `${helpBaseUrl}/docs/iot-gateway/install/docker-installation`, gatewayInstall: `${helpBaseUrl}/docs/iot-gateway/install/docker-installation`,
scada: `${helpBaseUrl}/docs${docPlatformPrefix}/user-guide/scada`, scada: `${helpBaseUrl}/docs${docPlatformPrefix}/user-guide/scada`,
scadaSymbolDev: `${helpBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/symbols-dev-guide`, scadaSymbolDev: `${helpBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/symbols-dev-guide`,
scadaSymbolDevAnimation: `${helpBaseUrl}/docs${docPlatformPrefix}/user-guide/scada/scada-symbols-dev-guide/#scadasymbolanimation`
} }
}; };
/* eslint-enable max-len */ /* eslint-enable max-len */