Webtags/Parameters: Difference between revisions

43 bytes added ,  08:37, 2 October 2022
m
Line 12: Line 12:
= Introduction =
= Introduction =


Put simply, using a Webtag is described on the [[Webtags#Using_Webtags|Webtag]] page. Only the GET API interface can't use parameters. All the other possibilities use the general Webtag format:
Using a Webtag is described on the [[Webtags#Using_Webtags|Webtag]] page. Only the GET API interface can't use parameters. All the other possibilities use the general Webtag format:


   <#tag_name [optional input selection parameters] [optional output modification parameters]>
   <#tag_name [optional input selection parameters] [optional output modification parameters]>
Line 18: Line 18:
In the following the input and output parameters are described.
In the following the input and output parameters are described.


# An input parameter is used where the same tag name can represent a value for a number of different past time instants. Each of those past time instants is represented by a different value for the input parameter. So a combination of a tag name and input modification parameter lets CumulusMX select the value you want to see. Whether a particular tag name can use input modification parameters will be shown in the Full list of Webtags.
# An input parameter is used where the same tag name can represent a value for a number of different past time instants e.g. temperature for several days or several hours ago. Each of those past time instants is represented by a different value for the input parameter. So a combination of a tag name and input modification parameter lets CumulusMX select the value you want to see. Whether a particular tag name can use input modification parameters will be shown in the Full list of Webtags.
# An output parameter is used when a particular tag name can be fed through a process that alters how the output is shown:
# An output parameter is used when a particular tag name can be fed through a process that alters how the output is shown:
#* Tag names representing integer values cannot have their output format modified
#* Tag names representing integer values cannot have their output format modified