Functions

In the previous section, we introduced expressions. Actually, functions are also a type of expression. The original UReport2 provides a large number of built-in functions. Through these built-in functions, various report calculation functions can be achieved. The syntax format of a function is as follows:

FunctionName([Expression,Expression...])

Below we will introduce the built-in functions of UReport2 one by one.

Common Functions

count Function (Count Quantity)

The count function counts the number of objects after evaluating the given expression(s).

sum Function (Summation)

The sum function accumulates the values after evaluating the given expression(s). The sum function requires that the values after evaluation of each expression must be numbers; otherwise, an error will occur.

avg Function (Average)

The avg function calculates the average of the values after evaluating the given expression(s). The avg function requires that the values after evaluation of each expression must be numbers; otherwise, an error will occur.

max Function (Maximum)

The max function finds the maximum value among the values after evaluating the given expression(s). The max function requires that the values after evaluation of each expression must be numbers; otherwise, an error will occur.

min Function (Minimum)

The min function finds the minimum value among the values after evaluating the given expression(s). The min function requires that the values after evaluation of each expression must be numbers; otherwise, an error will occur.

row Function (Get Row Number)

Gets the row number of the current cell. This function is simple and has no parameters.

column Function (Get Column Number)

Gets the column number of the current cell. This function is simple and has no parameters.

order Function (Sort)

The order function requires two parameters. The first is the object expression to be sorted, and the second is a boolean value to set the sorting order: true for ascending, false for descending.

list Function (List Data)

Gets all data defined in the expression(s) and returns them in collection form.

formatnumber Function (Format Number)

Formats the given parameter. It requires at least one parameter. The first parameter is the number object to be formatted. Ensure this parameter value can be converted to a number; otherwise, an error will occur. The second parameter is optional and defines the pattern used for number formatting. If not defined, the default # pattern is used.

get Function (Get Data at Specified Position)

The get function was added in version 2.1.2. Its purpose is to retrieve an object at a specified position in a dataset or a specific property value of an object. The get function can have three parameters: the first is the target collection object (required), the second is the data position, and the third is the object property. The first parameter is mandatory, and the latter two are optional.

Page-related Functions

Page-related functions refer to functions that are calculated during pagination. For example, calculating how many records are on the current page, the sum of a certain cell's value on the current page, the average, maximum, etc.

pcount Function

Counts the number of values corresponding to the expression on the current page. Its usage is essentially the same as the count function, except that pcount only counts the number of expression content corresponding to the current page.

psum Function

Sums all values corresponding to the expression on the current page. Corresponds to the sum function, but psum only targets the current page.

pmax Function

Compares the values corresponding to the expression on the current page and finds the maximum value. Corresponds to the max function, but pmax only targets the current page.

pmin Function

Compares the values corresponding to the expression on the current page and finds the minimum value. Corresponds to the min function, but pmin only targets the current page.

page Function

Outputs the page number of the current page. This function has no parameters.

Mathematical Functions

abs Function (Absolute Value)

Calculates the absolute value of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

ceil Function (Minimum Value - Ceiling)

Rounds a number up to the smallest integer greater than or equal to it. If the parameter value is a decimal, it discards the fractional part. The parameter value after evaluation must be a number; otherwise, an error will occur.

floor Function (Maximum Value - Floor)

Rounds a number down to the largest integer less than or equal to it. If the parameter value is a decimal, it rounds down the fractional part. The parameter value after evaluation must be a number; otherwise, an error will occur.

chn Function (Number to Chinese)

Converts a number to Chinese characters. The parameter value after evaluation must be a number; otherwise, an error will occur.

rmb Function (Number to Chinese Currency)

Converts a number to Chinese uppercase currency amount. The parameter value after evaluation must be a number; otherwise, an error will occur.

cos Function (Cosine)

Calculates the cosine of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

sin Function (Sine)

Calculates the sine of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

tan Function (Tangent)

Calculates the tangent of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

exp Function (Exponential)

Returns the value of e raised to the power of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

log10 Function (Base-10 Logarithm)

Calculates the base-10 logarithm of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

log Function (Natural Logarithm)

Calculates the natural logarithm of the parameter. The parameter value after evaluation must be a number; otherwise, an error will occur.

median Function (Median)

Calculates the median of a set of data. The parameter values after evaluation must be numbers; otherwise, an error will occur.

mode Function (Mode)

Calculates the mode of a set of data. The parameter values after evaluation must be numbers; otherwise, an error will occur.

vara Function (Variance)

Calculates the variance of a set of data. The parameter values after evaluation must be numbers; otherwise, an error will occur.

stdevp Function (Standard Deviation)

Calculates the standard deviation of a set of data. The parameter values after evaluation must be numbers; otherwise, an error will occur.

pow Function (Power)

Returns the value of the first parameter raised to the power of the second parameter. The pow function requires two parameters: the first is the number or expression to be calculated, and the second is the specific exponent.

random Function (Random Number)

Generates a random number. It can have one numeric parameter or expression. If there is a parameter, it uses this parameter as the seed for generating the random number. If not, it generates a random number between 0 and 1.

round Function (Round)

Rounds a decimal number. It requires two parameters. The first parameter is the decimal or expression to be rounded. The second is an optional parameter specifying the number of decimal places to keep. If not provided, no decimal places are kept.

sqrt Function (Square Root)

Calculates the square root of a number or the value after evaluating an expression. The parameter value after evaluation must be a number; otherwise, an error will occur.

Date Functions

date Function (Date)

Outputs the date. The date function can have one parameter, which is the date format. If not provided, it uses the yyyy-MM-dd HH:mm:ss format to output the date.

day Function (Day)

Outputs the day of the month. This function has no parameters.

month Function (Month)

Outputs the current month. This function has no parameters.

week Function (Weekday)

Outputs the current day of the week. This function has no parameters.

year Function (Year)

Outputs the current year. This function has no parameters.

String Functions

indexOf Function (Position)

Used to return the position of a string within a target string. This function requires at least two parameters. The first is the target string, and the second is the string to find. If there is a third parameter, it is the starting position for the search, which must be a number greater than or equal to 0.

length Function (Length)

Calculates the length of the target string. This function must have one parameter.

lower Function (To Lowercase)

Converts all English letters in the parameter to lowercase. This function must have one parameter.

upper Function (To Uppercase)

Converts all English letters in the parameter to uppercase. This function must have one parameter.

replace Function (Replace String)

This function requires three parameters. The first is the target string, the second is the string to be replaced, and the third is the replacement string.

substring Function (Substring)

This function can have three parameters. The first is the target string, the second is the starting position for extraction, and the third is the ending position for extraction.

trim Function (Trim Spaces)

Removes leading and trailing spaces from the target string. This function must have one parameter.