An expression is a textual value that starts with =.
Expressions unlike Code Handlers can be defined on the .json
config file and support teleporting.
BeamToIX supports:
binary operators: +, -, *, /, % (modulus).
Work both with numbers and arrays.
+ operator also concatenates textual values.
equality and comparison operators: ==, !=, <, >, <=, >=.
logical comparison: and, or.
These operators transform the 2 numerical values into 0 (false) or 1 (true).
parenthesis: (, ).
textual values: delimited by single quotes.
the following character strings have a special meaning:
- \' - defines a single quote
- \n - defines new line
numerical values.
numerical arrays: [x,y,z].
variables: numerical, textual, numerical arrays, objects.
variable array one-dimension indices.
BeamToIX has the following built-in variables:
e - mathematical constant 'e'.
pi - mathematical constant 'pi'.
deg2rad - =pi/180.
rad2deg - =180/pi.
fps - frames per second.
frameWidth - frame output width = generated file image width.
frameHeight - frame output height = generated file image height.
isTeleporting - Is True, if it's teleporting.
v0 - Computed Numerical valueStart.
v1 - Computed Numerical value.
vd - Computed Numerical difference value - valueStart.
vt - Computed Numerical value injected to the easing function.
vot - Computed Numerical value injected to the oscillator function.
vpt - Computed Numerical value injected to the path function.
t - t used to interpolate an easing, oscillator or path via expression.
= 'A' + 'Beamer'.
= round(12.4 + ceil(50.5) / 2 * (60 % 4)).
= cos(60*deg2rad) * random().
= iff(fps < 20, 'too few frames', 'lots of frames').
=[2, 3] + [4, 5].
=chart.labelsY.marginAfter.
=foo[x-y+z].
public export type
DevToIXexport type VarType = number | string | boolean | number[] | object;
public export interface
export interface Vars{ }
public property [Vars]
e: number;
public property [Vars]
pi: number;
public property [Vars]
deg2rad: number;
=pi/180
public property [Vars]
rad2deg: number;
=180/pi
public property [Vars]
fps?: uint;
Frames per second.
public property [Vars]
frameWidth?: uint;
Frame output width = generated file image width.
public property [Vars]
frameHeight?: uint;
Frame output height = generated file image height.
public property [Vars]
isTeleporting?: boolean;
Is True, if it's teleporting.
public property [Vars]
elIndex?: uint;
Element index of the active adapter
public property [Vars]
elCount?: uint;
Number of elements inside defined by the active adapter
public property [Vars]
v0?: number;
Computed Numerical valueStart.
public property [Vars]
v1?: number;
Computed Numerical value.
public property [Vars]
vd?: number;
Computed Numerical difference value - valueStart.
public property [Vars]
vt?: number;
Computed Numerical value injected to the easing function.
public property [Vars]
vot?: number;
Computed Numerical value injected to the oscillator function.
public property [Vars]
vpt?: number;
Computed Numerical value injected to the path function.
public property [Vars]
t?: number;
t used to interpolate an easing, oscillator or path via expression.
public property [Vars]
v?: number;
Generic value. Used in Charts.
public property [Vars]
i?: int;
Generic iterator. Used in Factories.
public property [Vars]
n?: int;
Generic number of items/points/elements. Used in Charts.
export public const enum
export const enum ExprType;
public export type
export type ExprResult = string | number | number[];
public export type
export type ExprString = string;
public export function
export function getVars(): Vars;
Returns the global expression variables.
Plugins who want to add init variables, should use this function.
The usage of _vars is discourage to be used outside the scope adding init vars
for plugins.
Use args.vars instead.
public export function
export function isCharacter(ch: string | undefined, pos: uint = 0): boolean;
Utility function to test if ch is a character.
It might include non-latin characters. It depends on CharRanges.
Used by developers and plugin creators.
public export function
export function isDigit(ch: string): boolean;
Utility function to test if it's a digit.
Used by developers and plugin creators.
public export function
export function isCharacterOrNum(ch: string): boolean;
Utility function to test if it's a digit or character.
It might include non-latin characters. It depends on CharRanges.
Used by developers and plugin creators.
public export function
export function isExpr(text: string): boolean;
Tests if text is an expression.
Used by developers and plugin creators.
public const enum
const enum TokenType;
public const enum
const enum TokenClass;
public export function
export function arrayInputHelper(params: ExprFuncParams,
req: ExFuncReq,
paramCount: uint | undefined, arrayLength: uint | undefined,
func: (inpArray: any) => any): void;
Provides services for functions where the input can be N numerical parameters, or an array of numerical values.
Supported cases:
paramCount=1; arrayLength=undefined;
func on each index, and set output to an array.func and set output a number.paramCount=undefined; arrayLength=undefined;
func with an array, the result value type
is the same as the one returned by the func.public export function
export function calcExpr(expr: string, args: BeamToIXArgs): ExprResult;
Calculates an expression.
Expects the input to be an expression.
Used mostly by plugin creators and developers.
public export function
export function ifExprCalc(expr: string,
args: BeamToIXArgs): ExprResult | undefined;
If it's an expression, it computes its value.
Returns undefined if it's not an expression.
Used mostly by plugin creators and developers.
public export function
export function ifExprCalcNum(expr: string, defNumber: number | undefined,
args: BeamToIXArgs): number | undefined;
If it's an expression, it computes its value and returns its numerical value.
Returns defNumber if it's not an expression.
Used mostly by plugin creators and developers.
public export function
export function calcStr(expr: string, args: BeamToIXArgs): string;
Computes the expression and returns the value.
If isStrict, checks if the return value is textual, if not throws error.
public export function
export function ifExprCalcStr(expr: string, defString: string | undefined,
args: BeamToIXArgs): string | undefined;
If it's an expression, it computes its value and returns its numerical value.
Returns defNumber if it's not an expression.
Used mostly by plugin creators and developers.
public export function
export function ExprOrNumToNum(param: ExprString | number,
defValue: number | undefined, args: BeamToIXArgs): number | undefined;
Checks if it's an expression, if it is, it computes and returns
the value as a number. Otherwise, returns the parameter as a number.
Used mostly by plugin creators and developers.
public export function
export function ExprOrStrToStr(param: ExprString | string,
defValue: string | undefined, args: BeamToIXArgs): string | undefined;
Checks if it's an expression, if it is, it computes and returns
the value as a number. Otherwise, returns the parameter as a number.
Used mostly by plugin creators and developers.