<translate>
<!--T:1-->Expressions allows to manually You can create and edit [[Filters]] rules by using programming languageexpressions (formulas) directly in the dashboard components. It can thus display calculated values that are not present in the data source file/spreadsheet.
<!--T:2-->
'''Important''': After manually editing the expression, the regular operators can not be used until you ''Clear All'' the filters;
To create the expression (formula) in the components, the component must support the addition of the special column ''Expression (Formula)''.
<!--T:3-->
__TOC__
Below are details about how the expressions work:
=== Basic structure of a Expression Structures (Formula) === <!--T:4-->
==== Value Operands Operand ==== <!--T:5-->
<!--T:6-->The value operands are It's the numerical values from a [[Columns Data Type|data type]] that are used in expressions as variables. You can use both while values and decimal values. For decimal values, the decimal separator should be the point.
* Examples: 1, 1.05, 2.55
==== Value type operand ==== <!--T:7-->
Are numeric values of the float type (Real numbers domain). These values allow the use of an integer and a fraction part, separated by the dot (.) character (decimal separator).
'''Examples''': 1, 1.05, 2.55;
==== Text type operand Operand ==== <!--T:8-->Are literal string data operands. These values allow the use of characters chain fields (strings), being delimited by the simple quote (') character. '''Examples''': 'John Snow', 'California', 'Spaghetti';
==== Date It's the text operands. If you want to use this type of operand ==== <!--T:9-->Are values that express any date. It is possible to determine in a date representing it as a stringexpression, being delimited you must delimit them by the simple quote single quotation mark (') character and separated by the bar (/) character. The default supported format is "dd/MM/yyyy". '''Examples''': '01/01/2011', '29/02/2000';
==== Boolean type operand ==== <!--T* Examples:10-->Are values from the ''true'' or John Snow', 'falseCalifornia', ' kind. Usually used to validate or not a condition. Spaghetti'''Examples''': true e false;
==== Identifier type operand ==== <!--T:11-->
Are values that represent a field or variable in the expression. Used to make reference to data source columns, delimited by double quotes (").
'''Examples''': "City.City", "Product.Product";
==== Parenthesis Date Operand ==== <!--T:12-->Used to group and separate expressions parts. Expressions inside parenthesis are processed first. '''Examples''': ("Profit" / "Total Price" ) + 10
==== System variable type operand ==== <!--T:13-->Are system pre-defined variables. These are values are replaced that express any date. To represent a date in run-time by pre-determined valuesexpressions the behaviour is similar to text operands, delimited by double quotes (") and preceded i.e. the content must be surrounded by star single quotation marks (#'). By now only one variable is available: "#null" that indicates null values or fieldsHowever, the mask ''dd/MM/yyyy'' must be used.
* Examples: '01/01/2019', '14/11/2019', '25/12/2019'
=== Arithmetic Expressions === <!--T:14-->
<!--T:15-->The arithmetic expressions relate two operands (value or another expression) to compose a sum, subtraction, multiplication or division.==== Boolean Operand ====
==== Sum (+) ==== <!--T:16-->Sum two operands. Represented by They're operators of the sum (+) charactertrue or false type. Syntax: ''<operand/Normally user to validate, or not, a condition in a more complex expression> + <operand/expression>''. '''Examples''': "Taxes" + "Commissions";
==== Subtraction (-) ==== <!--T:17-->Subtract two operands. Represented by the subtract or hyphen (-) character. Syntax: ''<operand/expression> - <operand/expression>''. '''* Examples''': "Gross Sale" - "Taxes";true, false
==== Multiplication (*) ==== <!--T:18-->
Multiplicate two operands. Represented by the multiplication or star (*) character.
Syntax: ''<operand/expression> * <operand/expression>''.
'''Examples''': "Amount" * "Unit Price";
==== Division(/) Parentheses ==== <!--T:19-->Divides two operands. Represented by the divide or bar (/) character. Syntax: ''<operand/expression> / <operand/expression>''. '''Examples''': "Total Value" / "Amount".
Used to group and separate parts of on expression. Expressions within parentheses are processed first.
=== Relational Expressions === <!--T* Example:20-->("Profit"/"Total Price") + 10
<!--T:21-->
The relational expressions compare two operands (value or another expression) to evaluate if a condition is ''true'' or ''false''. Usually used with decision functions, like the ''IF''.
==== Equal (System variable Operand ==) ==== <!--T:22-->Performs the equal comparison expression between two operands. Represented by the equal operator (==). Syntax: ''<expression> == <expression>''. '''Examples''': "Unit Price" == "Total Price";
==== Different These are predefined variables in the system. To use the system variables you must precede them by hashtag (!=#) ==== <!--T:23-->Performs the different comparison expression between two operands. Represented and delimit them by the different operator double quotes(!="). Syntax: ''<expression> != <expression>''. '''Examples''': Currently only the "#null"Cityvariable is available and indicates null content.City" != 'New York';
==== Greater than * Example: IF(>) "Product" ==== <!--T:24-->Return ''true'' if the first expression is greater than the second expression and ''false'' otherwise. Represented by the greater operator (>). Syntax: ''<expression> > <expression>''. '''Examples''': "Order Date#null" > '01/01/2011';0;20)
==== Greater or equal than (>=) ==== <!--T:25-->
Return ''true'' if the first expression is greater than or equal to the second expression and ''false'' otherwise. Represented by the greater or equal operator (>=).
Syntax: ''<expression> >= <expression>''.
'''Examples''': IF("Order Date" >= '01/01/2011';"Order Date";0);
===Arithmetic Expressions = Lesser than (<) ==== <!--T:26-->Return ''true'' if the first expression is lesser than the second expression and ''false'' otherwise. Represented by the lesser operator (<). Syntax: ''<expression> < <expression>''. '''Examples''': "Profit" < '0';
==== Lesser or equal than Arithmetic expressions relate two operands (<=) ==== <!--T:27-->Return ''true'' if which can be any the first operands described above, or another expression is lesser than or equal ) to make up the second expression and ''false'' otherwise. Represented by the lesser sum, subtraction, multiplication or equal operator (<=). Syntax: ''<expression> <= <expression>''. '''Examples''': IF("Order Date" <= '01/01/2011';"Order Date";0)division.
=== Logical Expressions = Sum (+) ==== <!--T:28-->
<!--T:29-->The logical expressions group Add two value operands (boolean type or another expression) to compose a logic expression, with the objective to evaluate two boolean operands relation into a ''true'' or ''false'' result. Usually used with decision functions, like Represented by the ''IF+'', and with relational expressionscharecter.
Syntax:
<operating or expression result> '''+''' <operating or expression result>
Example:
"Taxes" + "Commissions"
==== And (&&) ==== <!--T:30-->
Performs the logical operation ''AND'' between two boolean values. The two operands must be ''true'' for the result of the operation to be ''true''. Represented by the ''AND'' operator (&&).
Syntax: ''<expression> && <expression>''.
'''Examples''': IF((Gross Sales > '0') && (Seller == 'John Snow');'Sold';'Not Sold'), IF((City!="#null") && (Date<DAY_FROM_TODAY(0));1;0);
==== Or Subtraction (||-) ==== <!--T:31-->Performs the logical operation ''OR'' between two boolean values. One of the two operands must be ''true'' for the result of the operation to be ''true''. Represented by the ''OR'' operator (||). Syntax: ''<expression> || <expression>''. '''Examples''': IF((Gross Sales > '0') || (Sold == 'true');'Sold';'Not Sold'), IF((City!="#null") || (Date<DAY_FROM_TODAY(0));1;0);
==== Not (!) ==== <!--T:32-->Performs the denial logical operation for a boolean Subtract two value. If the operand is ''true'' the ''NOT'' convert it to ''false'' (and the other way around)operands or another expression result. Represented by the ''NOT'' operator (!). Syntax: ''! <expression>''. '''Examples''': IF(!BETWEEN("Date", '01/01/2013', '31/12/2013');'Not 2013';-'2013')charecter.
Syntax:
<operating or expression result> '''-''' <operating or expression result>
Example:
"Price" - "Taxes"
== Auxiliary Functions == <!--T:33-->
=== Basic Functions = Multiplication (*0 ==== <!--T:34-->
<!--T:35-->The basic functions are system default functions and implements useful functionalitiesMultiplies two value operands or another expression result. Represented by the multiplication charecter ''*''.
==== Abs ==== <!--TSyntax:36-->Returns the absolute value of a base value. Syntax: ''ABS( <operating or expressionresult>)''. Accept one parameter and process a numeric data type. '''Examples*'''<operating or expression result> Example: ABS(Gross Sale-Taxes); "Quantity" * "Unit Price"
==== Avg ==== <!--T:37-->
Returns the average value of an array of values.
Syntax: ''AVG(<expression1>;<expression2>[;<expression3>;...;<expressionN>])''. Accept multiple parameter and process a numeric data type.
Can be used to return the average value of different columns from the same row of a table.
'''Examples''': AVG(Taxes;Commissions;Costs);
==== Between Division (/) ==== <!--T:38-->Check if a value is within the boundaries of the parameters values. Syntax: ''BETWEEN(<expression_to_test>;<expression_bottom_limit>;<expression_top_limit>)''. Need three parameters (of any data type, but the three must be from the same type) and returns a boolean, ''true'' if value is inside the boundaries and ''false'' if not. '''Examples''': BETWEEN("Date";'01/01/2013';'31/12/2013'), BETWEEN("Gross Sales";'0';'1000.00');
==== If then else ==== <!--T:39-->Tests a boolean expression and returns a Divide two value in case it is ''true'' and operands or another in case it is ''false''expression result. Syntax: Represented by the division charecter ''IF(<expression_test>;<expression_for_true>;<expression_for_false>)/''. Need three parameters, a boolean for test and returns any data type, provided that both are from the same type. Useful for logic tests where two different executions expressions are needed. '''Examples''': IF("Branch"=='SOUTH';'South';'Other Branch') IF("Profit"==0;0;Profit+Taxes);
==== Log ==== <!--TSyntax:40-->Returns the log value of a number on a set base. Syntax: ''LOG( <expression_numberoperating or expression result>[;<expression_base>])''. Minimum one parameter and maximum two. If just one parameters is given, the neperian log is returned. If the second parameter is also given, returns the log in the respective base. '''Examples/'''<operating or expression result>Example: LOG(Profit); "Price" / "Quantity"
==== Max ==== <!--T:41-->
Returns the greater value between two numbers.
Syntax: ''MAX(<expression_value1>;<expression_value2>)''. Need two value parameters and returns a value data type.
'''Examples''': "Total Value"/MAX("Quantity";"1");
===Relational Expressions = Min ==== <!--T:42-->Returns the smaller value between two numbers. Syntax: ''MIN(<expression_value1>;<expression_value2>)''. Need two value parameters and returns a value data type. '''Examples''': "Total Value"/MIN("Quantity";"1");
==== Pow ==== <!--T:43-->Returns the power Relational expressions compare two operands (value of /text or other expression) to assess whether a number on a set exponentcondition is true or false. Syntax: Normally used with decision functions, such as ''POW(<expression_number>[;<expression_exponent>])IF''. Minimum one parameter and maximum two. If the exponent value is not given, use two (2) by default. '''Examples''': POW(Value1)+POW(Value1-Value2;3);
==== Random ==== <!--T:44-->
Returns an aleatory number inside the boundaries of the limit values.
Syntax: ''RANDOM(<expression_bottom_limit>;<expression_top_limit>)''. Need two parameters, the bottom and the upper limit of the random
number to be generated.
'''Examples''': RANDOM(0.0;1.0);
==== Sqrt Equality (==) ==== <!--T:45-->Returns the square root of a value. Syntax: ''SQRT(<expression>)''. Need one parameters, the value to be calculated. '''Examples''': SQRT('36').
==== Like ==== <!--T:67-->Returns true if the desired content is found in the list and false It compares if the content is not found. Syntax: ''LIKE(<data_set>;<pattern>)''. Needs two parameters, the first is the set of data that will be queried. The second is operands are the term one wishes to findsame, in returning true if they are the data set. Returns true same or falseif they are different. '''Examples''': LIKE("Product";'%ghe%'). Returns true if in Represented by the equality operator ''Product'' dataset there is some containing ''gue==''. Otherwise, returns false.
Syntax: <operating or expression result> '''==''' <operating or expression result>Example: IF("Product" = Date Functions === <!--T:46-->"#null";0;20)
<!--T:47-->
The date functions are operations that use as parameters and return the result of the [[Date|date data type]].
==== Constants list ==== <!--T:48-->
** '''0''': DATE_FIELD_YEAR (Year part);
** '''1''': DATE_FIELD_MONTH (Month part);
** '''2''': DATE_FIELD_DAY (Day part);
** '''3''': DATE_FIELD_FORTNIGHT (Fortnight part);
** '''5''': DATE_FIELD_WEEK (Week part);
==== Date part ==== <!--T:49-->
Return a part of a date.
Syntax: ''DATE_PART(<expression_date>;<constant>)''. Need two parameters, the first is the reference date and the second the constant
representing the desired part date: 0, 1, 2, 3 or 5 (see above constants list).
'''Examples''': DATE_PART("Order Date";0) - returns the year part of the "Order Date";
==== Day from today ==== <!--T:50-->
Return a backward (negative) or forward (positive) date counting from today.
Syntax: ''DAY_FROM_TODAY(<expression_number_days>)''. Need one parameter, the number of days to add or subtract.
'''Examples''': DAY_FROM_TODAY(-1) - returns the yesterday date;
==== First day of ==== <!--T:51-->
Return the first day of a grouping. This function has two variations:
* '''First way''':
Syntax: ''FIRST_DAY_OF(<constant_grouping>;<expression_date>)''. Need two parameters, the first is the constant grouping in which you
want to obtain the first date: 0, 1, 2, 3 or 5 (see constants list) and the second is the anchor base date.
'''Examples''': FIRST_DAY_OF(0;DAY_FROM_TODAY(0)) - first day of year (0) from today (DAY_FROM_TODAY(0)), FIRST_DAY_OF(1;"Order Date") -
first day of month (1) based on the "Order Data";
* '''Second way''':
Syntax: ''FIRST_DAY_OF(<constant_grouping>;<constant_modify_date>;<modify_date_value>)''. Need three parameters, the first is the
constant grouping in which you want to obtain the first date: 0, 1, 2, 3 or 5 (see constants list), the second is the modifier
of the base date from today: 0, 1, 2, 3 or 5 (see constants list) and the third is the amount to change the modifier.
'''Examples''': FIRST_DAY_OF(1;0;-1) - first day of the current month (1) from last year (0;-1);
==== Last day of ==== <!--T:52-->
Return the last day of a grouping. This function has two variations:
* '''First way''':
Syntax: ''LAST_DAY_OF(<constant_grouping>;<expression_date>)''. Need two parameters, the first is the constant grouping in which you
want to obtain the last date: 0, 1, 2, 3 or 5 (see constants list) and the second is the anchor base date.
'''Examples''': LAST_DAY_OF(0;DAY_FROM_TODAY(0)) - last day of year (0) from today (DAY_FROM_TODAY(0)), LAST_DAY_OF(1;"Order Date") -
last day of month (1) based on the "Order Data";
* '''Second way''':
Syntax: ''LAST_DAY_OF(<constant_grouping>;<constant_modify_date>;<modify_date_value>)''. Need three parameters, the first is the
constant grouping in which you want to obtain the last date: 0, 1, 2, 3 or 5 (see constants list), the second is the modifier
of the base date from today: 0, 1, 2, 3 or 5 (see constants list) and the third is the amount to change the modifier.
'''Examples''': LAST_DAY_OF(1;0;-1) - last day of the current month (1) from last year (0;-1);
==== New date ==== <!--T:53-->
Create an object from a day, month and year.
Syntax: ''NEW_DATE(<expression_day>;<expression_month>;<expression_year>)''. Need three parameters, the first is a valid day number (1 to
31), the second for a month (1 to 12) and the third is a year. The date is created from year to day, therefore, the day must be
valid for the month and the year (considering 29/02, year must be bissextile).
'''Examples''': NEW_DATE(1;4;DATE_PART("Order Date";0)) - create the first day of april from the year determined by the current row
"Order Date" column;
==== Num of days ==== <!--T:54-->
Return the number of days between two dates.
Syntax: ''NUM_OF_DAYS(<expression_date1>;<expression_date2>)''. Need two date data type parameters.
'''Examples''': NUM_OF_DAYS(FIRST_DAY_OF(0;"Order Date");"Order Date") - returns the number of days between the first day of year based on
the "Order Date" column to the current day of the "Order Date" column,
NUM_OF_DAYS(FIRST_DAY_OF(1;"Pay Date"); LAST_DAY_OF(1;"Pay Date")) - returns the number of days of the month of the "Pay Date"
column;
==== Num of months ==== <!--T:55-->
Return the number of months between two dates.
Syntax: ''NUM_OF_MONTHS(<expression_date1>;<expression_date2>)''. Need two date data type parameters.
'''Examples''': NUM_OF_MONTHS(FIRST_DAY_OF(0;"Date");"Date") - Return the number of months between the first day of the year of the "Date"
column and the current month of the "Date" column;
==== Previous date ==== <!--T:56-->
Return the closest exact previous date given a day and month.
Syntax: ''PREVIOUS_DATE(<expression_day>;<expression_month>)''. Need two parameters, the first is the day of month and the second the
month.
'''Examples''': PREVIOUS_DATE(1;4) - return the closest ''01/04'', in other words, until "01/04/current year", returns "01/04/last year",
after that returns "01/04/current year".
==== Special variables ==== <!--T:57-->
<!--T:58-->
Special variables can be used with the expressions.
<!--T:66-->
'''Important:''' The variables below must be enclosed in double quotation marks
<!--T:59-->
"@count" - Total number of lines returned in a table.
<!--T:60-->
"@row" - current line number.
<!--T:61-->
"@sum[Column]" - Sum of indicated column.
<!--T:63-->
"@avg[Column]" - Avg of indicated column like @sum[Column] / @count
<!--T:64-->
"@prev[column]" - Previous row column value
<!--T:65-->
"@accumCol[column]" - Current accumulated column value. Useful to calculate Variable Avg ("@accumCol[column]" / "@row")
</translate>
