Difference between revisions of "AxisSet removeAxis"

From Catglobe Wiki
Jump to: navigation, search
 
Line 1: Line 1:
[[Category:Axis set modifying CGScript functions]]
+
{{HelpFiles}}  
{{HelpFiles}}
 
  
====AxisSet_removeAxis====
+
==== AxisSet_removeAxis ====
  
Removes the axis from the axis set. If no axis exists with the specified name then return false. Else the axis is removed from the axis-set and the function returns true.
+
Removes the axis from the axis set. If no axis exists with the specified name then return false. Else the axis is removed from the axis-set and the function returns true.  
  
'''Syntax'''
+
'''Syntax'''  
  
AxisSet_removeAxis(''name'')
+
AxisSet_removeAxis(''name'')  
  
'''Arguments'''
+
'''Arguments'''  
  
''name'': Is a string expression. It is the axis name
+
''name'': Is a string expression. It is the axis name  
  
'''Return type'''
+
'''Return type'''  
  
bool
+
bool  
  
'''Examples'''
+
'''Examples'''  
  
bool b = AxisSet_removeAxis("Age Groups");
+
''bool b = AxisSet_removeAxis("Age Groups"); ''
  
'''Availability'''
+
''if (b) print("Axis was removed");''
  
Version 5.5
+
''else print("Axis does not exist");''
__NOTOC__
+
 
<!-- imported from file: 5236.htm-->
+
''//Result: Axis does not exist''
 +
 
 +
'''Availability'''
 +
 
 +
Version 5.5 __NOTOC__ <!-- imported from file: 5236.htm-->  
 +
 
 +
[[Category:Axis_set_modifying_CGScript_functions]]

Latest revision as of 11:34, 23 December 2011



AxisSet_removeAxis

Removes the axis from the axis set. If no axis exists with the specified name then return false. Else the axis is removed from the axis-set and the function returns true.

Syntax

AxisSet_removeAxis(name)

Arguments

name: Is a string expression. It is the axis name

Return type

bool

Examples

bool b = AxisSet_removeAxis("Age Groups");

if (b) print("Axis was removed");

else print("Axis does not exist");

//Result: Axis does not exist

Availability

Version 5.5