Data Types (API)

Coordinate

A coordinate is a point in 3D space and can be described by either a Point or NamedPoint.

Expression

An expression is a Lua string containing variables and numbers. Eg: (1+5)*10.

GridLocation

A Lua table of two values representing the X and Y coordinates on the schematic.

List

A Lua table containing a list (or array) of items of the given type.

Map

A Lua table mapping a key type to a value type.

ObjectReference

A reference (pointer) to an Object.

PointExpression

A value which can be a string or Point.

TerminalType

A terminal type that describes either a Port or a Terminal.

Unit

A string containing a unit. Eg: m/s^2

Variant

A value which can be a number, string, boolean, Complex or Point.

boolean

A standard Lua boolean. See Lua documentation for more details.

function

A standard Lua function. See Lua documentation for more details.

number

A standard Lua number. See Lua documentation for more details.

string

A standard Lua string. See Lua documentation for more details.

table

A standard Lua table. See Lua documentation for more details.