Difference between revisions of "CreateFrequenceDiagram"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 +
{{HelpFiles}}
 
[[Category:Diagram/report generating CGScript functions]]
 
[[Category:Diagram/report generating CGScript functions]]
{{HelpFiles}}
+
__NOTOC__
  
 
=createFrequenceDiagram=
 
=createFrequenceDiagram=
Line 6: Line 7:
 
Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.
 
Creates a frequency diagram from the axis name specified. A unique id is returned when a diagram is added.
  
'''Syntax'''
+
===Syntax===
  
 
createFrequenceDiagram(''axisName'')
 
createFrequenceDiagram(''axisName'')
  
'''Arguments'''
+
===Arguments===
  
 
''axisName:'' Is a string expression. This string specifies the name of the axis which must for the frequency diagram.
 
''axisName:'' Is a string expression. This string specifies the name of the axis which must for the frequency diagram.
  
'''Return type'''
+
===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
 
''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'''
+
===Examples===
  
 
''number a = createFrequenceDiagram("Q5_SQ_3");''
 
''number a = createFrequenceDiagram("Q5_SQ_3");''
 
'''Availability'''
 
 
Version 5.4
 
__NOTOC__
 
<!-- imported from file: 4222.htm-->
 

Revision as of 11:42, 15 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");