Difference between revisions of "CreateCrossDiagram"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
{{HelpFiles}}  
+
{{HelpFiles}}
  
 
==== createCrossDiagram ====
 
==== createCrossDiagram ====
  
Creates a cross diagram from the axis names specified as string arrays for rows and columns. A unique id is returned when a diagram is added.  
+
Creates a cross diagram from the axis names specified as string arrays for rows and columns. A unique id is returned when a diagram is added.
  
'''Syntax'''  
+
'''Syntax'''
  
createCrossDiagram(''rowAxisNames, columnAxisNames'')  
+
createCrossDiagram(''rowAxisNames, columnAxisNames'')
  
'''Arguments'''  
+
'''Arguments'''
  
''rowAxisNames:'' An array expression. This array contains the names of the axes which are used for the rows in the cross diagram  
+
''rowAxisNames:'' An array expression. This array contains the names of the axes which are used for the rows in the cross diagram
  
''columnAxisNames:'' An array expression. This array contains the names of the axes which are used for the columns in the cross diagram.  
+
''columnAxisNames:'' An array expression. This array contains the names of the axes which are used for the columns in the cross diagram.
  
One of these array can be empty and the function will then basically work as a 'createFrequenceDiagram' function.  
+
One of these array can be empty and the function will then basically work as a 'createFrequenceDiagram' function.
  
'''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 = createCrossDiagram({"Q5_SQ_3"},{"Q5_SQ_5"});''  
+
{| border="1" cellspacing="1" cellpadding="1" style="width: 800px"
 +
|-
 +
|
 +
''number a = createCrossDiagram({"Q5_SQ_3"},{"Q5_SQ_5"});''
  
''print(a); //Result: 1''  
+
''print(a); //Result: 1''
  
''number b = createCrossDiagram({"Q5_SQ_3"},{});''  
+
''number b = createCrossDiagram({"Q5_SQ_3"},{});''
  
''print(b); //Result: 2''  
+
''print(b); //Result: 2''
 +
 
 +
''number c = createCrossDiagram({},{"Q5_SQ_5"});''
 +
 
 +
''print(c); //Result: 3''
 +
 
 +
|}
  
''number c = createCrossDiagram({},{"Q5_SQ_5"});''
 
  
''print(c); //Result: 3''
 
  
 
{{note}}You have to change row and column axis names in example to axis names of DCS that you're working on.
 
{{note}}You have to change row and column axis names in example to axis names of DCS that you're working on.
  
'''Availability'''  
+
'''Availability'''
 
 
Version 5.4 __NOTOC__ <!-- imported from file: 4223.htm-->
 
  
[[Category:Diagram/report_generating_CGScript_functions]]
+
Version 5.4 __NOTOC__
 +
<!-- imported from file: 4223.htm-->

Revision as of 03:13, 8 December 2015


createCrossDiagram

Creates a cross diagram from the axis names specified as string arrays for rows and columns. A unique id is returned when a diagram is added.

Syntax

createCrossDiagram(rowAxisNames, columnAxisNames)

Arguments

rowAxisNames: An array expression. This array contains the names of the axes which are used for the rows in the cross diagram

columnAxisNames: An array expression. This array contains the names of the axes which are used for the columns in the cross diagram.

One of these array can be empty and the function will then basically work as a 'createFrequenceDiagram' function.

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 = createCrossDiagram({"Q5_SQ_3"},{"Q5_SQ_5"});

print(a); //Result: 1

number b = createCrossDiagram({"Q5_SQ_3"},{});

print(b); //Result: 2

number c = createCrossDiagram({},{"Q5_SQ_5"});

print(c); //Result: 3


Note Note: You have to change row and column axis names in example to axis names of DCS that you're working on.

Availability

Version 5.4