Difference between revisions of "GetTotalAsSum"

From Catglobe Wiki
Jump to: navigation, search
Line 1: Line 1:
 
{{HelpFiles}}
 
{{HelpFiles}}
  
=== getTotalAsSum  ===
+
===== getTotalAsSum  =====
  
&nbsp;&nbsp;&nbsp; Please take a look at the examples to get understand about this function.<br>
+
Returns the current state of the total percentage values (should be sum of pct values OR always is 100%), which can be shown for table diagrams. The values tells us percentage of answers were given to the question. This may be the same as the total percentage values, but given that the question type is MULTI, it may also be that it was more than this, since each respondent then can give more than one answer to one question. Default value is False.
  
==== Syntax ====
+
'''Syntax'''
  
&nbsp;&nbsp; getTotalAsSum();  
+
getTotalAsSum();  
  
==== Arguments ====
+
'''Arguments'''
  
&nbsp;&nbsp; none  
+
none  
  
==== Return type ====
+
'''Return type'''
  
&nbsp;&nbsp; boolean values (true / false)  
+
boolean values (true / false)  
  
==== Examples ====
+
'''Examples'''
  
<source lang="javascript">print(getTotalAsSum());     // false is default
+
''bool b = getTotalAsSum();''
print(setTotalAsSum(true)); // true
+
 
print(getTotalAsSum());     // true</source>
+
''if (b) print("Total percentage values can greater than 100%.");''
 +
 
 +
''else print("Total percentage values are always 100%.");''
 +
 
 +
''//Result: Total percentage values are always 100%.''
 +
 
 +
'''Availability'''
 +
 
 +
Version 5.8.1 __NOTOC__ <!-- imported from file: 8134.htm-->  
  
 
[[Category:TotalAsSum_functions]]
 
[[Category:TotalAsSum_functions]]

Revision as of 10:41, 27 December 2011


getTotalAsSum

Returns the current state of the total percentage values (should be sum of pct values OR always is 100%), which can be shown for table diagrams. The values tells us percentage of answers were given to the question. This may be the same as the total percentage values, but given that the question type is MULTI, it may also be that it was more than this, since each respondent then can give more than one answer to one question. Default value is False.

Syntax

getTotalAsSum();

Arguments

none

Return type

boolean values (true / false)

Examples

bool b = getTotalAsSum();

if (b) print("Total percentage values can greater than 100%.");

else print("Total percentage values are always 100%.");

//Result: Total percentage values are always 100%.

Availability

Version 5.8.1