SetCurrentTagXAxisTag
- Last UpdatedNov 17, 2021
- 1 minute read
This method configures the currently selected tag in a scatter plot to use another tag from the tag list as its X axis tag. The X axis tag is identified by its server and name.
Syntax
[Result=] aaHistClientTrend.SetCurrentTagXAxisTag(message serverName, message tagName);
Parameters
serverName
The name of the server that the tagName tag is stored on.
tagName
The name of the tag that you want to use as the X axis tag for the current tag. The tag must already be contained in the tag list.
Return Value
The return value is a discrete. Returns True if successful; otherwise returns False. Possible causes of failures include:
-
No tag is currently selected.
-
No tag matches the specified parameters.
-
The current tag is not an analog or discrete tag.
-
The designated X axis tag is the current tag itself.
-
The designated X axis tag is not an analog or discrete tag.
Remarks
If the specified tag is shown in the chart multiple times, the method uses the first instance that was added.