Difference between revisions of "CreateFrequenceDiagram"
| Line 1: | Line 1: | ||
| − | {{HelpFiles}} | + | {{HelpFiles}} |
| − | |||
| − | |||
| − | |||
| − | + | = createFrequenceDiagram = | |
| − | + | __NOTOC__ | |
| − | + | Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added. | |
| − | === | + | === Syntax === |
| − | ''axisName | + | createFrequenceDiagram(''axisName'') |
| − | === | + | === Arguments === |
| − | '' | + | ''axisName:'' Is a string expression. This string specifies the name of the axis which must for the frequency diagram. |
| − | === | + | === Return type === |
| − | ''number a = createFrequenceDiagram("Q5_SQ_3");'' | + | ''number'': Id of the added diagram. Diagram id starts from 1 and will increase by one for each time one of the functions createFrequenceDiagram or createCrossDiagram are called. The ids will keep on increasing for the duration of the script |
| + | |||
| + | === Examples === | ||
| + | |||
| + | ''number a = createFrequenceDiagram("Q5_SQ_3");'' | ||
| + | |||
| + | ''print(a);'' //Result: 1 | ||
| + | |||
| + | ''number b = createFrequenceDiagram("Q5_SQ_5");'' | ||
| + | |||
| + | ''print(b);'' //Result: 2 | ||
| + | |||
| + | {{note}}You have to change axis name in example to axis name of DCS that you're working on. | ||
| + | |||
| + | [[Category:Diagram/report_generating_CGScript_functions]] | ||
Revision as of 08:38, 28 December 2011
createFrequenceDiagram
Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.
Syntax
createFrequenceDiagram(axisName)
Arguments
axisName: Is a string expression. This string specifies the name of the axis which must for the frequency diagram.
Return type
number: Id of the added diagram. Diagram id starts from 1 and will increase by one for each time one of the functions createFrequenceDiagram or createCrossDiagram are called. The ids will keep on increasing for the duration of the script
Examples
number a = createFrequenceDiagram("Q5_SQ_3");
print(a); //Result: 1
number b = createFrequenceDiagram("Q5_SQ_5");
print(b); //Result: 2
Note: You have to change axis name in example to axis name of DCS that you're working on.
