Functions

In alphabetical order:
 

_ABS
_ACOS
_AND
_ANG360
_ASIN
_ATAN
_ATAN2
_AUTHORNAME
_CENTERX
_CENTERY
_CIRCLE_CENTERX
_CIRCLE_CENTERY
_CIRCLES3RD_X
_CIRCLES3RD_Y
_COMPANYNAME
_COS
_COSH
_CUT
_DATE
_DEG
_ELLIPSE_ANGLE
_ELLIPSE_ASPECT
_EVALTEXT
_FABS
_FILENAME
_FLOOR
_FULLFILENAME
_GRAVITY
_HYP
_IF
_LG10
_LN
_LOCALX
_LOCALY
_MAX
_MEASURE
_MIN
_MOD
_NOT
_OR
_PAGEHEIGHT
_PAGENAME
_PAGENUMBER
_PAGESCOUNT
_PAGEWIDTH
_PI
_POW
_RAD
_RAND
_ROUND
_SCALE
_SETF
_SIGN
_SIN
_SINH
_SQRT
_TAN
_TANH
_TEXTHEIGHT
_TEXTLEFT
_TEXTLENGTH
_TEXTRIGHT
_TEXTWIDTH
_TIME
_TITLE
_VALTOTEXT
_VALTOTEXTMES
_WORLDX
_WORLDY
_XOR

By sections:

Mathematical:
_ABS
_CENTERX
_CENTERY
_CIRCLE_CENTERX
_CIRCLE_CENTERY
_CIRCLES3RD_X
_CIRCLES3RD_Y
_CUT
_ELLIPSE_ANGLE
_ELLIPSE_ASPECT
_FABS
_GRAVITY
_HYP
_LG10
_LN
_LOCALX
_LOCALY
_MAX
_MIN
_MOD
_POW
_RAND
_SIGN
_SQRT
_WORLDX
_WORLDY

Trigonometric:
_ACOS
_ASIN
_ATAN
_ATAN2
_COS
_COSH
_PI
_SIN
_SINH
_TAN
_TANH

Logical:
_AND
_IF
_NOT
_OR
_XOR

Functions for transformation and approximation:
_ANG360
_DEG
_RAD
_ROUND
_FLOOR

Text:
_AUTHORNAME
_COMPANYNAME
_EVALTEXT
_FILENAME
_FULLFILENAME
_MEASURE
_SCALE
_TEXTHEIGHT
_TEXTLEFT
_TEXTLENGTH
_TEXTRIGHT
_TEXTWIDTH
_TITLE
_VALTOTEXT
_VALTOTEXTMES

Date and time:
_DATE
_TIME

Page properties:
_PAGEHEIGHT
_PAGENAME
_PAGENUMBER
_PAGESCOUNT
_PAGEWIDTH

Other:
_SETF

 

_ABS

_ABS(arg)
Returns the absolute value of the arg number.

_ABS(str)
Returns the str string without changing it.

Examples:
_ABS(-3) = 3
_ABS(0) =  0
_ABS(4) = 4
_ABS("Text") = "Text"
 

_ACOS

_ACOS(arg)
Returns the arc cosine of the arg (its value is within the -pi/2 to pi/2 range).
The argument value must be within the -1 to 1 ranger. Otherwise the error code generates.
 

_AND

_AND(arg1;arg2)
Returns the bitwise AND;

_AND(str1;str2)
Returns 1 - if the strings are not empty, and 0 - if at least one of them is empty.

_AND(str;arg)
_AND(arg;str)
Returns arg.

Examples:
_AND( 1; 0) = 0
_AND( 3; 2) = 2
_AND("Hello!"; "") = 0
_AND("Text1"; "Text2") = 1
_AND("Text"; 2) = 2
 

_ANG360

_ANG360(arg)
Returns the arg angle, reduced to the 0 to 2*pi interval.

Examples:
_ANG360( 481 deg ) = 121 deg
_ANG360( -4.5 rad) = 1.7832 rad
 

_ASIN

_ASIN(arg)
Returns the arc sine of arg (its value is within the -pi/2 to pi/2 range).
The argument value must be within a -1 to 1 range. Otherwise an error code is generated.
 

_ATAN

_ATAN(arg)
Returns the arctangent of arg (the returned value is within the -pi/2 to pi/2 range).

_ATAN2

_ATAN2(arg1;arg2)
Returns the arctangent of (arg1/arg2). Unlike the _ATAN function, _ATAN2 correctly processes expressions where the arg2 value equals 0. Anyway, the returned value is within the -pi/2 to pi/2 range.

Examples:
_ATAN( 1; 0 ) = 90 deg
_ATAN( 2; 2 ) = 45 deg
 

_AUTHORNAME

 _AUTHORNAME()
Returns the document author's name which you specify in the Document Properties dialog (File/Document Properties).

Example:
"Author: "+_AUTHORNAME()= "Author: Bill Jonson"
 

_CENTERX

_CENTERX()
Returns the X coordinate of the centre of the object.
The centre of the object is:
- For the Smart Connector:  the middle of its central segment, if the number of segments is odd, or the crossing point of two middle segments, if the number of the segment is even.
- For other objects:  the centre of the alignment box.

This function may be used, for instance, for positioning the Smart Connector's text.
 

_CENTERY

_CENTERY()
Returns the Y coordinate of the centre of the object.
The centre of the object is:
- For the Smart Connector:  the middle of its central segment, if the number of segments is odd, or the crossing point of two middle segments, if the number of the segment is even.
- For other objects:  the centre of the alignment box.

This function may be used, for instance, for positioning the Smart Connector's text.
 

_CIRCLE_CENTERX

_CIRCLE_CENTERX(X1; Y1; X2; Y2; X3; Y3)
Returns the X coordinate of the centre of the circle, built upon the three points: (X1;Y1), (X2;Y2) and (X3;Y3). 

_CIRCLE_CENTERY

_CIRCLE_CENTERY(X1; Y1; X2; Y2; X3; Y3)
Returns the Y coordinate of the centre of the circle, built upon the three points: (X1;Y1), (X2;Y2) and (X3;Y3).

_CIRCLES3RD_X

_CIRCLES3RD_X( X1; Y1; X2; Y2; H)
Returns the X coordinate of the point, that lies at the H distance from the middle point of the vector (X1;Y1) - (X2;Y2). If H is a positive number, this point is to the left of the vector, if negative - the point is to the right of the vector. This function is used to create an arc of the circle upon two points and the height of the arc.  

_CIRCLES3RD_Y

_CIRCLES3RD_Y( X1; Y1; X2; Y2; H)
Returns the Y coordinate of the point, that lies at the H distance from the middle point of the vector (X1;Y1) - (X2;Y2). If H is a positive number, this point is to the left of the vector, if negative - the point is to the right of the vector. This function is used to create an arc of the circle upon two points and the height of the arc.  

_COMPANYNAME

 _COMPANYNAME()
Returns the company name that you specify in the Document Properties dialog (File/Document Properties).

Example:
"Company: "+_COMPANYNAME()= "Company: Computer Systems Odessa Corp."
 

_COS

_COS(arg)
Returns the cosine of arg (the returned value is within the -1 to 1 range).

_COSH

_COSH(arg)
Returns the hyperbolic cosine of arg.

_CUT

_CUT(arg; iarg)
This function discards a number of significant digits after the point from arg. The iarg parameter indicates how many digits to discard. For negative numbers, it discards the digits before the point.

Example:
_CUT( 123.4567; 3) = 123.456
_CUT(123.4567;-2) = 100
_CUT(123.4567;0) = 123
 

_DATE

_DATE()
Returns the string with the current system date on your computer. The data format may vary with system and country.

Example:
_DATE() = 04.09.1999   (Mac)
_DATE() = 04 Sep 1999  (Win)
 

_DEG

_DEG(arg)
Converts arg from radians to degrees.

Example:
_DEG( 3.14) = 180
_DEG(_PI()*3) = 540
 

_ELLIPSE_ANGLE

_ELLIPSE_ANGLE(koeffX; koeffY; iNumberGeometry; iNumberSegment)
Returns the inclination of the main radius of the ellipse with the central point with (Width*koeffX; Height*koeffY) local coordinates. Other parameters, required for building the ellipse, are taken from the segment with iNumberSegment number of the geometry with the iNumberGeometry number.
This function is the default formula for the D column of the EllipseTo segment in the table. 

_ELLIPSE_ASPECT

_ELLIPSE_ASPECT(koeffX; koeffY; iNumberGeometry; iNumberSegment)
Returns the ratio between the large and the small radii of the ellipse with the central point with (Width*koeffX; Height*koeffY). Other parameters, required for building the ellipse, are taken from the segment with iNumberSegment number of the geometry with the iNumberGeometry number.
This function is the default formula for the C column of the EllipseTo segment in the table.  

_EVALTEXT

_EVALTEXT(str)
Converts the string value of str to a number.

Example:
_EVALTEXT( "123.456 ") = 123.456
_EVALTEXT( "123") = 123 

_FABS

_FABS(arg)
If arg is not zero, returns the absolute value for arg.
If arg equals zero, returns 1.

_FABS(str)
Returns the string value str without changing it.

Example:
_FABS( -3 ) = 3
_FABS( 0 ) = 1
_FABS( 1 ) = 1
_FABS("Text") = "Text"
 

_FILENAME

_FILENAME()
Returns the filename under which the document is stored.

Example:
_FILENAME() = "Chart.CDD"
 

_FLOOR

_FLOOR(arg)
Returns the maximum integer number which is less or equal to arg.

Examples:
_FLOOR( 123.4567 ) = 123
_FLOOR( -45.345 ) = -46
_FLOOR( 0 ) = 0
 

_FULLFILENAME

 _FULLFILENAME()
Returns the filename under which the document is stored with the full path.
Example:
_FULLFILENAME() = "D:\ConceptDraw\Chart.cdd"   (Win)
_FULLFILENAME() = "MyDisk:Desktop Folder:Chart.cdd"  (Mac)
 

_GRAVITY

_GRAVITY(Angle; limit1; limit2)
If Angle is more than limit1 or less than limit2, returns 0,
If Angle is within the [limit1;limit2] range - returns the pi number.
Normally this function is used for setting the orientation of the Text Box, so that the text be readable in whatever position of the object.

Examples:
_GRAVITY(30deg; 15 deg; 165 deg) = 0
_GRAVITY(195deg; 15 deg; 165 deg) = pi
_GRAVITY(Angle;-90 deg;90 deg)

_HYP

_HYP(X; Y)
Returns the length of the hypotenuse of the right-angled triangle with X and Y legs.

Example:
_HYP( 4; 3 ) = 5

_IF

_IF(arg1;arg2;arg3)
If arg1 is a non-zero number, or a non-empty string, the function returns arg2, otherwise - arg3.

Examples:
  _IF( 2 > 1; 3; 4 ) = 3
  _IF( ""; 3; 4 ) = 4

_LG10

_LG10(arg)
Returns the decimal logarithm of arg.

_LN

_LN(arg)
Returns the natural logarithm of arg.

_LOCALX

_LOCALX(X; Y)
Converts the (X;Y) point from the global coordinates to local coordinates. Returns the X coordinate for the resulting point.

_LOCALY

_LOCALY(X; Y)
Converts the (X;Y) point from the global coordinates to local coordinates. Returns the Y coordinate for the resulting point.

_MAX

_MAX(arg1;arg2)
Returns the bigger of the two numbers: arg1 and arg2.

_MAX(arg;str)
_MAX(str;arg)
Returns the number arg (the string value is ignored).

_MAX(str1;str2)
 Returns the length for the longest of two strings: str1 and str2.

Examples:
_MAX( 4; 6 ) = 6
_MAX( "Text"’ ; " Big text ") = 8
_MAX( "Text" ; 7 ) =7

_MEASURE

_MEASURE()
Returns the string containing the current unit of measure.

Example:
_MEASURE() = "ft"

_MIN

_MIN(arg1;arg2)
Returns the minimal of two numbers: arg1 and arg2.

_MIN(arg;str)
_MIN(str;arg)
Returns the number arg (the string value is ignored).

_MIN(str1;str2)
 Returns the length for the shortest of two strings: str1 and str2.

Examples:
_MIN( 4; 6 ) = 6
_MIN( "Text"’ ; " Big text ") = 8
_MIN( "Text" ; 7 ) =7

_MOD

_MOD(arg1;arg2)
Returns the excess of arg1 divided by arg2

_MOD(str;arg)
_MOD(arg;str)
Returns the number arg it the other argument is the string str.

_MOD(str1;str2)
Returns zero if both arguments are strings.

Examples:
_MOD( 19; 6 ) = 1
_MOD( "Text" ; "Big text") = 0
_MOD( "Text" ; 7 ) =7

_NOT

_NOT(arg)
If arg is zero or an empty string, returns 1.
Otherwise returns 0.

Examples:
_NOT(0)=1
_NOT(123)=0

_OR

_OR(arg1;arg2)
Returns bitwise OR;

_OR(str1;str2)
Returns 1 - if at least one of the strings is non-empty, 0 - if both strings are empty.

_OR(str;arg)
_OR(arg;str)
Returns the number arg.

Examples:
  _OR( 1; 0) = 1
  _OR("Hello!"; "") = 1
  _OR("Text1"; "Text2") = 1
  _OR("Text";2) = 2

_PAGEHEIGHT

_PAGEHEIGHT()
Returns the height of the document page. Note that the page size is set in the File / Document Properties dialog, Page tab.

_PAGENAME

_PAGENAME()
Returns the name of the page to which the object belongs. You can set the name in the Page Properties dialog (Page menu).

_PAGENUMBER

_PAGENUMBER()
Returns the number of the page to which the object belongs.

_PAGESCOUNT

_PAGESCOUNT()
Returns the number of pages in the document.

_PAGEWIDTH

_PAGEWIDTH()
Returns the width of the document page. Note that the page size is set in the File / Document Properties dialog, Page tab.

_PI

_PI()
Returns the pi number.

_POW

_POW(arg1;arg2)
Raises arg1 to a power of arg2.

_POW(str;arg)
_POW(arg;str)
Returns the arg number if the other argument is a string.

_POW(str1;str2)
Returns zero if both arguments are strings.

Examples:
_POW( 2; 3 ) = 8
_POW( "Text" ; " Big text ") = 0
_POW( "Text" ; 7 ) = 7

_RAD

_RAD(arg)
Converts arg from degrees to radians.

Examples:
  _RAD( 90 ) = 1.57

_RAND

_RAND()
Returns a random value within 0 to 32K range.

_ROUND

_ROUND(arg; iarg)
Returns arg approximated to iarg digits after the decimal point.

Examples:
_ROUND( 123.4567; 3) = 123.457
_ROUND(123.4567;-2) = 100
_ROUND(123.67;0) = 124

_SCALE

_SCALE()
Returns a string describing the current scale of the document in the "N : M" format.

Examples:
_SCALE() = "1 : 1"
_SCALE() = "4 in : 1 ft"

_SETF

_SETF(str; arg)
_SETF(str; strarg)
This function changes the values in the table cells. String str specifies the name of the cell, where to put the data. The arg parameter must contain the new value for the cell. The strarg parameter must contain the string with a new formula for the cell.

Examples:
_SETF( ’’Geometry1.X2’’; ’’Geometry2.X3/2 + Geometry3.X2/4’’)
_SETF(’’Width’’ ; 125 cm)

_SIGN

_SIGN(arg)
Returns the sign of arg:
-1, if arg<0,
1, if arg>0
0, if arg=0

Examples:
_SIGN( 123.4567 ) = 1
_SIGN(-123.4567 ) = -1
_SIGN( 0 ) = 0

_SIN

_SIN(arg)
Returns the sine of arg (the returned value is within -1 to 1 range).

_SINH

_SINH(arg)
Returns the hyperbolic sine of arg.

_SQRT

_SQRT(arg)
Returns the square root from arg. The resulting value is undefined for negative numbers.

_TAN

_TAN(arg)
Returns the tangent of arg.

_TANH

_TANH(arg)
Returns the hyperbolic tangent of arg.

_TEXTHEIGHT

_TEXTHEIGHT(str; arg)
This function calculates the height of the text block, when arg is assigned as its width. The str parameter is usually the contents of text field of the object (the TheText field in the table). When calculating the height, this function considers all current text settings for the object (styles, indents and margins, etc.).

Examples:
_TEXTHEIGHT(TheText;Width)
_TEXTHEIGHT(TheText;2 in)

_TEXTLEFT

_TEXTLEFT(str; iarg)
Returns first iarg characters of the str string.

Example:
_TEXTLEFT( "A big text."; 5) = "A big"

_TEXTLENGTH

_TEXTLENGTH(str)
Returns the length of the str string (the number of characters in the string).

Example:
_TEXTLENGTH("A big text.") = 11

_TEXTRIGHT

_TEXTRIGHT(str; iarg)
Returns last iarg characters of the str string.

Example:
_TEXTRIGHT( "A big text"; 4) = "text"

_TEXTWIDTH

_TEXTWIDTH(str)
Returns the width of the str string considering all current text settings of the object (styles, indents and margins, etc.). Normally, this function is used to make the Text Box the same width as the width of the longest string in the object's text.

Example:
_TEXTWIDTH(TheText)

_TIME

_TIME()
Returns current system time in the "Hours:Minutes:Seconds" format.

Example:
_TIME() = "19:27:13"

_TITLE

_TITLE()
Returns the title of the document. The title is specified in the File / Document Properties dialog, General tab.

_VALTOTEXT

_VALTOTEXT(arg)
Converts the arg number into a string and returns the string.

Example:
_VALTOTEXT( 567.89 ) = "567.89"

_VALTOTEXTMES

_VALTOTEXTMES(arg)
Converts the arg number in a string considering the current unit of measure.

Examples:
_VALTOTEXTMES(15) = "1/16"
_VALTOTEXTMES(1.5 in)+" in." = "1 1/2 in."

_WORLDX

_WORLDX(X;Y)
Converts the (X;Y) point from local coordinates to global coordinates. Returns the X coordinate for the resulting point.

_WORLDY

_WORLDY(X;Y)
Converts the (X;Y) point from local coordinates to global coordinates. Returns the Y coordinate for the resulting point.

_XOR

_XOR(arg1;arg2)
Returns the bitwise XOR.

_XOR(str1;str2)
Returns 1 - if only one string is not empty; 0 - if both strings are empty, or both are not empty.

_XOR(str;arg)
_XOR(arg;str)
Returns the arg number.

Examples:
_XOR( 1;1 ) = 0
_XOR("Text1";"Text2") = 0
_XOR("Text"; 2) = 2

 


See also:
Object Parameter Table
Table Sections


CONTENTS