Difference between revisions of "CreateFrequenceDiagram"

From Catglobe Wiki
Jump to: navigation, search
(jrfconvert import)
 
 
(7 intermediate revisions by 4 users not shown)
Line 1: Line 1:
[[Category:HelpBooks]]
+
{{HelpFiles}}

 
  
====createFrequenceDiagram====
+
= createFrequenceDiagram =
  
Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.
+
__NOTOC__
  
'''Syntax'''
+
Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.
  
createFrequenceDiagram(''axisName'')
+
=== Syntax  ===
  
'''Arguments'''
+
createFrequenceDiagram(''axisName'')
  
''axisName:'' Is a string expression. This string specifies the name of the axis which must for the frequency diagram.
+
=== Arguments  ===
  
'''Return type'''
+
''axisName:'' Is a string expression. This string specifies the name of the axis which must for the frequency diagram.
  
''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
+
=== Return type  ===
  
'''Examples'''
+
''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
  
''number a = createFrequenceDiagram("Q5_SQ_3");''
+
=== Examples  ===
  
'''Availability'''
+
''number a = createFrequenceDiagram("Q5_SQ_3");''  
  
Version 5.4
+
''print(a);'' //Result: 1
__NOTOC__
+
 
<!-- imported from file: 4222.htm-->
+
''number b = createFrequenceDiagram("Q5_SQ_5");''
 +
 
 +
''print(b);'' //Result: 2
 +
 
 +
{{note}}You have to change axis names in example to axis names of DCS that you're working on.  
 +
 
 +
[[Category:Diagram/report_generating_CGScript_functions]]

Latest revision as of 08:40, 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 Note: You have to change axis names in example to axis names of DCS that you're working on.