Visionary User's Guide

Visionary User's Guide
Appendix C: Functions and Support Syntax

Home Contents Index Master Index New Book

Built-in Functions

Visionary provides the following built-in functions.


Function	Page
Boolean If()	page C-5
CenterPoint()	page C-5
ChildCount()	page C-6
ChildDepth()	page C-6
FormatNum()	page C-6
HasChildren()	page C-7
HasParent()	page C-7
HasSiblings()	page C-7
IsViewer()	page C-8
Length()	page C-8
Max()	page C-8
Min()	page C-9
MoveCenter()	page C-9
Numeric If()	page C-10
PointCount()	page C-10
Point If()	page C-10
PointList If()	page C-11
PointNumber()	page C-11
RGB()	page C-12
Rotate()	page C-12
ScaleXY()	page C-12
SeriesSum()	page C-13
SiblingCount()	page C-13
SiblingNumber()	page C-14
StockImage()	page C-14
String If()	page C-14
TranslateXY()	page C-15

For casting functions, see Appendix B.

Boolean If()

Returns a Boolean value: one of two values depending on whether the Boolean condition is TRUE or FALSE.

Syntax

If(cond, valueIfTrue, valueIfFalse)


Parameter	Data Type	Description
cond	Boolean	Expression to be tested
valueIfTrue	Boolean	Value returned if cond is `TRUE`
valueIfFalse	Boolean	Value returned if cond is `FALSE`

CenterPoint()

Returns a Point value: the center point for the list of points.

Syntax

CenterPoint(list) 



Parameter

Data Type

Description

list
PointList
List of points

ChildCount()

Valid only for hierarchy layouts.

Returns a Numeric value: the number of child data elements for the current data element.

Syntax

ChildCount(recurse) 



Parameter

Data Type

Description

recurse
Boolean
If TRUE, descendants of the data element's child elements are included.

ChildDepth()

Valid only for hierarchy layouts.

Returns a Numeric value: the depth of the current data element relative to the highest parent data element.

Syntax

ChildDepth()

FormatNum()

Returns a String value: the string representing the formatted value.

Syntax

FormatNum(String format, Numeric value) 



Parameter

Data Type

Description

format
Boolean
Template to be used in formatting the value. See "Formatting Values" on page  B-9 for a description of the template options.

value
Numeric
Value to be formatted

HasChildren()

Valid only for hierarchy layouts.

Returns a Boolean value: TRUE if the current data element has a child data element; FALSE otherwise.

Syntax

HasChildren()

HasParent()

Valid only for hierarchy layouts.

Returns a Boolean value: TRUE if the current data element has a parent data element; FALSE otherwise.

Syntax

HasParent()

HasSiblings()

Valid only for hierarchy layouts.

Returns a Boolean value: TRUE if the current data element has sibling data elements; FALSE otherwise.

Syntax

HasSiblings()

IsViewer()

Returns a Boolean value: TRUE if the current value of the global parameter ViewerClass is of the specified viewer class; FALSE otherwise.

Syntax

IsViewer(viewerName) 



Parameter

Data Type

Description

viewerName
String
Name of the viewer class to be tested

Length()

Returns a Numeric value: the length of the specified string.

Syntax

Length(str) 



Parameter

Data Type

Description

str
String
String to be measured

Max()

Returns a Numeric value: the maximum value in the list of arguments.

Syntax

Max(numeric1[, numeric2 [,]]) 



Parameter

Data Type

Description

numeric1, numeric2...
Numeric
Values to be tested

Min()

Returns a Numeric value: the minimum value in the list of arguments.

Syntax

Min(numeric1[, numeric2 [,]]) 



Parameter

Data Type

Description

numeric1, numeric2...
Numeric
Values to be tested

MoveCenter()

Returns PointList values that are centered around the specified point.

Syntax

MoveCenter(list, center) 



Parameter

Data Type

Description

list
PointList
List of points

center
Point
Location where the points are to be centered

Numeric If()

Returns a Numeric value: one of two values depending on whether the Boolean condition is TRUE or FALSE.

Syntax

If(cond, valueIfTrue, valueIfFalse) 



Parameter

Data Type

Description

cond
Boolean
Expression to be tested

valueIfTrue
Numeric
Value returned if cond is TRUE

valueIfFalse
Numeric
Value returned if cond is FALSE

PointCount()

Returns a Numeric value: the number of data elements in the current data source.

Syntax

PointCount()

Point If()

Returns a Point value: one of two values depending on whether the Boolean condition is TRUE or FALSE.

Syntax

If(cond, valueIfTrue, valueIfFalse) 



Parameter

Data Type

Description

cond
Boolean
Expression to be tested

valueIfTrue
Point
Value returned if cond is TRUE

valueIfFalse
Point
Value returned if cond is FALSE

PointList If()

Returns a PointList value: one of two values depending on whether the Boolean condition is TRUE or FALSE.

Syntax

If(cond, valueIfTrue, valueIfFalse) 



Parameter

Data Type

Description

cond
Boolean
Expression to be tested

valueIfTrue
PointList
Value returned if cond is TRUE

valueIfFalse
PointList
Value returned if cond is FALSE

PointNumber()

Returns a Numeric value: zero-based index of the current data element in the list of data elements.

Syntax

PointNumber()

RGB()

Returns a Color value: the combination of red, green, and blue values in the range 0 to 2553-1, inclusive.

Syntax

RGB(red, green, blue) 



Parameter

Data Type

Description

red
Numeric
Red value

green
Numeric
Green value

blue
Numeric
Blue value

Each parameter is clipped to the range 0 to 255, inclusive.

Rotate()

Returns PointList values: a new list of points that reflects the rotation of the specified list of points about (0,0) by the specified rotation angle.

Syntax

Rotate(list, angle) 



Parameter

Data Type

Description

list
PointList
List of points

angle
Numeric
Angle of rotation in degrees

ScaleXY()

Returns PointList values: the specified list of points that have been scaled by the specified scale factor.

Syntax

ScaleXY(list, xscale, yscale) 



Parameter

Data Type

Description

list
PointList
List of points

xscale
Numeric
Amount by which each x value is to be multiplied

yscale
Numeric
Amount by which each y value is to be multiplied

SeriesSum()

Returns a Numeric value: the accumulated result of the evaluation of the specified expression for each data element.

Syntax

SeriesSum(expr) 



Parameter

Data Type

Description

expr
Numeric
Expression to be evaluated at each point

SiblingCount()

Valid only for hierarchy layouts.

Returns a Numeric value: the number of sibling data elements, counting the current data element.

Syntax

SiblingCount()

SiblingNumber()

Valid only for hierarchy layouts.

Returns a Numeric value: the zero-based index of the current data element in its list of siblings.

Syntax

SiblingNumber()

StockImage()

Returns an Image value: the specified image from the set of static images stored with the world.

Syntax

StockImage(imageName) 



Parameter

Data Type

Description

imageName
String
Name of the stock image

String If()

Returns a String value: one of two values depending on whether the Boolean condition is TRUE or FALSE.

Syntax

If(Boolean cond, String valueIfTrue, String valueIfFalse) 



Parameter

Data Type

Description

cond
Boolean
Expression to be tested

valueIfTrue
String
Value returned if cond is TRUE

valueIfFalse
String
Value returned if cond is FALSE

TranslateXY()

Returns PointList values: the specified list of points translated according to the specified offset.

Syntax

TranslateXY(list, xshift, yshift) 



Parameter

Data Type

Description

list
PointList
List of points

xshift
Numeric
Amount each point is to be shifted in the x direction

yshift
Numeric
Amount each point is to be shifted in the y direction

Visionary User's GuideAppendix C: Functions and Support Syntax Home Contents Index Master Index New Book

Built-in Functions

ChildCount()

ChildDepth()

FormatNum()

HasChildren()

HasParent()

HasSiblings()

IsViewer()

Length()

Max()

Min()

MoveCenter()

Numeric If()

PointCount()

Point If()

PointList If()

PointNumber()

RGB()

ScaleXY()

SeriesSum()

SiblingCount()

SiblingNumber()

StockImage()

String If()

TranslateXY()

Visionary User's Guide
Appendix C: Functions and Support Syntax

Home Contents Index Master Index New Book