1,438
edits
Changes
Marked this version for translation
<languages/>
<translate>
<!--T:168--><div class="index-right">__TOC__</div> <!--T:69-->You can create expressions (formulas) directly in the dashboard components. It can thus display calculated values that are not present in the datasource file/spreadsheet. <!--T:70-->To create the expression (formula) in the components, the component must support the addition of the special column ''Expression (Formula)''. <!--T:71-->In TaticView , all columns in the data file can be used in expressions as long as they are also added to the component that will receive the expression. <!--T:72-->Expressions allows In addition, it is also possible to manually use fixed numbers and texts in the case of comparative expressions. <!--T:73-->Expression Example: <!--T:74-->* If the component has the columns ''Total Price'' and ''Quantity'', you can create and edit an expression to calculate the ''Unit Price''. Would be like this:** ''"Total Price"'' / ''"Quantity"''* In addition, you can use fixed values, such as:** ''"Total price"'' / 10 <!--T:75-->We just remember that currently TaticView only supports expressions whose numeric return. <!--T:225-->Expressions support the backslash as [[FiltersEscapeChar|escape character]] rules so that names can contain the delimiting characters. <!--T:76-->Below are details about how the expressions work: == Basic structure of a Expression (Formula) == <!--T:77--> ==== Identifier ==== <!--T:226--> <!--T:227-->It is the name of the field or column involved in the expression, it must be delimited by double quotes. <!--T:228-->* Examples: "Average Price". "Screw 1\" philips", "Seler" ==== Value Operand ==== <!--T:78--> <!--T:79-->It's the numerical values. You can use both while values and decimal values. For decimal values, the decimal separator should be the point. <!--T:80-->* Examples: 1, 1.05, 2.55 <!--T:220-->* Important: Do not use thousand separator in numeric values. ==== Text Operand ==== <!--T:81--> <!--T:82-->It's the text operands. If you want to use this type of operand in a expression, you must delimit them by the single quotation mark ('). <!--T:83-->* Examples: 'John Snow', 'California', 'Spaghetti' ==== Date Operand ==== <!--T:84--> <!--T:85-->These are values that express any date. To represent a date in expressions the behaviour is similar to text operands, i.e. the content must be surrounded by single quotation marks ('). However, the mask ''dd/MM/yyyy'' must be used. <!--T:86-->* Examples: '01/01/2019', '14/11/2019', '25/12/2019' ==== Boolean Operand ==== <!--T:87--> <!--T:88-->They're operators of the true or false type. Normally user to validate, or not, a condition in a more complex expression. <!--T:89-->* Examples: true, false ==== Parentheses ==== <!--T:90--> <!--T:91-->Used to group and separate parts of on expression. Expressions within parentheses are processed first. <!--T:92-->* Example: ("Profit"/"Total Price") + 10 ==== System variable Operand ==== <!--T:93--> <!--T:94-->These are predefined variables in the system. To use the system variables you must precede them by using programming languagehashtag (#) and delimit them by double quotes("). Currently only the "#null" variable is available and indicates null content. <!--T:95-->* Example: IF("Product" == "#null";0;20) == Arithmetic Expressions == <!--T:96--> <!--T:97-->Arithmetic expressions relate two operands (which can be any the operands described above, or another expression) to make up the sum, subtraction, multiplication or division. ==== Sum (+) ==== <!--T:98--> <!--T:99-->Add two value operands or another expression result. Represented by the ''+'' charecter. <!--T:100-->Syntax: <operating or expression result> '''+''' <operating or expression result>Example: '''"Taxes" + "Commissions"''' - Sums the values of the fields ''Taxes'' and ''Commissions'' ==== Subtraction (-) ==== <!--T:101--> <!--T:102-->Subtract two value operands or another expression result. Represented by the ''-'' charecter. <!--T:103-->Syntax: <operating or expression result> '''-''' <operating or expression result>Example: '''"Price" - "Taxes"''' - Subtracts the values from the ''Price'' and ''Taxes'' fields. ==== Multiplication (*) ==== <!--T:104--> <!--T:105-->Multiplies two value operands or another expression result. Represented by the multiplication charecter ''*''. <!--T:106-->Syntax: <operating or expression result> '''*''' <operating or expression result> Example: '''"Quantity" * "Unit Price"''' - Multiplies the value of the ''Quantity'' field by the value of the ''Unit Price'' field. ==== Division (/) ==== <!--T:107--> <!--T:108-->Divide two value operands or another expression result. Represented by the division charecter ''/''. <!--T:109-->Syntax: <operating or expression result> '''/''' <operating or expression result>Example: '''"Price" / "Quantity"''' - Divides the value of the ''Price'' field by the value of the ''Quantity'' field. == Relational Expressions == <!--T:110--> <!--T:111-->Relational expressions compare two operands (value/text or other expression) to assess whether a condition is true or false. Normally used with decision functions, such as ''IF''. ==== Equality (==) ==== <!--T:112--> <!--T:113-->It compares if two operands are the same, returning true if they are the same or false if they are different. Represented by the equality operator ''==''. <!--T:114-->Syntax: <operating or expression result> '''==''' <operating or expression result>Example: '''IF("Product" == "#null";0;20)''' - If the ''Product'' is null, return the value ''0''. Otherwise return the value ''20'' ==== Different (!=) ==== <!--T:115--> <!--T:116-->It compare if two operands are different, returning true if they were different or false if equal. Represented by the differente operator ''!=''. <!--T:117-->Syntax: <operating or expression result> '''!=''' <operating or expression result>Example: '''IF("Product" != 'Lasagna';0;20)''' - If the ''Product'' is different from ''Lasagna'', return the value ''0''. Otherwise return the value ''20'' ==== Greater than (>) ==== <!--T:118--> <!--T:119-->Compares if the first operator (from the left) is greater than the second operator (from the right), returning true if it is greater and false if it is lesser or equal. Represented by the greater operator ''>''. <!--T:120-->Syntax: <operating or expression result> '''>''' <operating or expression result>Example: '''IF("Gross Value" > 1000;1;0)''' - If the ''Gross Value'' is greater than ''1000'', returns the value ''1'', if not the value ''0'' ==== Greater or equal to (>=) ==== <!--T:121--> <!--T:122-->Compares if the first operator (from the left) is greater or equal to the second operator (from the right), returning true if it is greater or equal and false if it is lesser. Represented by the greater or equal operator ''>=''. <!--T:123-->Syntax: <operating or expression result> '''>=''' <operating or expression result>Example: '''IF("Gross Value" >= 2500;100;0)''' - If ''Gross Value'' is greater than or equal to ''2500'' returns ''100'', otherwise returns ''0'' ==== Less than (<) ==== <!--T:124--> <!--T:125-->Compares if teh first operator (from the left) is lesser than the second operator (from the right), returning true if it is lesser and false if it is greater or equal. Represented by the Lesser operator ''<''. <!--T:126-->Syntax: <operating or expression result> '''<''' <operating or expression result>Example: '''IF("Gross Value" < 100;50;200)''' - If ''Gross Value'' is less than ''100'', returns ''50'' if not ''200'' ==== Less or equal to (<=) ==== <!--T:127--> <!--T:128-->Compares if the first operator (from the left) is lesser or equal to the second operator (from the right), returning true if it is lesser or equal and false if it is greater. Represented by the lesser or equal operator ''<=''. <!--T:129-->Syntax: <operating or expression result> '''<=''' <operating or expression result>Example: '''IF("Gross Value" <= 500;100;0)''' - If ''Gross Value'' is less than or equal to ''500'' returns ''100'', if not ''0'' == Logical Expressions == <!--T:130--> <!--T:131-->Logical expressions group together two operands (Boolean or other expression) to make up a logical expression, in order to evaluate the relationship of two Boolean operators to a true or false result. This type of expression is usually used for decision making, such as IF and with relational expressions. ==== And Operator (&&) ==== <!--T:132--> <!--T:133-->Executes the logical operation ''AND'' between two Boolean values. Both values must return true so that the result of the operation is true. Represented by the ''&&'' operator. <!--T:134-->Syntax: <expression> && <expression>Examples: '''IF(("Price" > 0) && ("Seller" == 'John Snow');450;0)''' - If ''Price'' is greater than ''0'' '''AND''' ''Seller'' is equal to ''John Snow'', returns ''450'' if not returns ''0'' '''IF(("City" != "#null") && ("Product" != 'Lasagna');1;0)''' - If ''City'' is non-null '''AND''' ''Product'' is different from ''Lasagna'' returns ''1'' if it does not return ''0'' ==== Or Operator (||) ==== <!--T:135--> <!--T:136-->Performs the logical ''OR'' operation between two Boolean values. A two values must be true so that the result of the operation is true. Represented by the operator ''||''. <!--T:137-->Syntax: <expression> || <expression>Examples: '''IF(("Price" > 1000) || ("Profit" >= 50);75;55)''' - If ''Price'' is greater than ''1000'' '''OR''' ''Profit'' is greater than or equal to ''50'' returns ''75'' if not ''55'' '''IF(("City" != "#null") || ("Product" != 'Lasagna');1;0)''' - If ''City'' is non-null '''OR''' ''Product'' is different from ''Lasagna'' returns ''1'' if it does not return ''0'' ==== Denial Operator (!) ==== <!--T:139--> <!--T:140-->Performs the logical negation operation for a boolean value. If the result of the operation is true the negation operator converts to false and vice versa. Represented by the operator ''!''. <!--T:141-->Syntax: !<expression>Example: '''IF(!BETWEEN("Delivery Date"; '01/01/2015'; '31/12/2015');2016;2015)''' - If the ''Delivery Date'' is '''NOT''' between ''01/01/2015'' and ''12/31/2015'' returns ''2016''. If between this period returns ''2015'' == Auxiliary Functions == <!--T:142--> <!--T:143-->Basic helper functions are standard system functions and implement useful features for composing complex expressions. ==== ABS function ==== <!--T:144--> <!--T:145-->Function that returns the absolute numeric value of a base numeric value. <!--T:146-->Syntax: ABS(<value operator or expression>)Example: '''ABS("Price" / "Quantity")''' - Returns the absolute value of ''Price'' divided by ''Quantity'' ==== AVG function ==== <!--T:147--> <!--T:148-->Returns the average of the values of a sequence of values. It can be used to return the average of different values of the same row of tables. <!--T:149-->Syntax: AVG(<expression 1>; <expression 2>; ...)Example: '''AVG("Taxes"; "Profit"; "Cost")''' - Returns the average between the sum of the ''Taxes'', ''Profit'' and ''Cost'' columns ==== BETWEEN function ==== <!--T:150--> <!--T:151-->Checks whether a value is within the limits of the parameters used. Return true or false. <!--T:152-->Syntax: BETWEEN(<expression to be tested>; <initial limit>; <end limit>)Example: '''BETWEEN("Date Issued"; '01/01/2019'; '31/12/2019')''' - Returns true if ''Date Issued'' is between ''01/01/2019'' and ''12/31/2019''. Otherwise returns false ==== COUNT function ==== <!--T:229--> <!--T:230-->Returns number of occurrences (lines) for column or value. <!--T:231-->By now this functions works only at Datasource expressions <!--T:232-->Syntax: COUNT(<expression>) Example: '''COUNT("Product")''' - Returns number of occurrences (lines) of products ==== COUNT_DISTINCT function ==== <!--T:233--> <!--T:234-->Returns number of unique occurrences (lines) for column or value. <!--T:235-->By now this functions works only at Datasource expressions <!--T:236-->Syntax: COUNT_DISTINCT(<expression>) Example: '''COUNT_DISTINCT("Product")''' - Returns number of unique (different) occurrences (lines) of products ==== IF ELSE function (If .... Otherwise ...) ==== <!--T:153-->
<!--T:2154-->'''Important''': After manually editing Tests a Boolean expression and applies a condition to true or another condition to false. You need three parameters, separated by semicolons (;). The first parameter is the expressionto be tested, the regular operators can not second the value to be used until you ''Clear All'' applied in case of true, and the filters;third to be applied in case of false.
<!--T:155-->
Syntax:
IF(<expression to be tested>; <expression if true>; <expression if false>)
Examples:
'''IF(BETWEEN("Value";0;100);10;250)''' - If ''Value'' is between ''0'' and ''100'' returns ''10'', if not ''250''
'''IF("Profit" == 0;0;"Profit" + "Taxes")''' - If ''Profit'' equals ''0'' returns ''0'', if it does not return the sum between ''Profit'' and ''Taxes''
'''IF("Product Code" == 3231;0;"Quantity" * 3;"Quantity")''' - If ''Product Code'' equals ''3231'' returns ''Quantity'' plus 3
==== LOG function ==== <!--T:3157-->__TOC__
<!--T:158-->
Returns the logarithm of a number on a defined basis. It can be used with only one parameter, in this case the "base 10" logarithm is used . If two parameters are used, the second server to inform the base to be used by the logarithm.
=== Value Operands = MAX function ==== <!--T:5161-->
<!--T:6162-->The Returns the largest value operands are between two values from a [[Columns Data Type|data type]] that are used in expressions as variables.
<!--T:163-->
Syntax:
MAX(<expression 1>;<expression 2>)
Example:
'''"Value" / MAX("Quantity";1)''' - Divides ''Value'' by the largest value between ''Quantity'' and ''1''
==== Text type operand MIN function ==== <!--T:8164-->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';
==== Parenthesis POWER function ==== <!--T:12167-->Used to group and separate expressions parts. Expressions inside parenthesis are processed first. '''Examples''': ("Profit" / "Total Price" ) + 10
<!--T:169-->
Syntax:
POW(<expression>; <exponent>)
Examples:
'''POW("Profit")''' - Returns the power of the ''Profit'' value.
'''POW("Cost"; 3)''' - Returns the power of the ''Cost'' value, raised to ''3''
==== RANDOM function ==== <!--T:15171-->The arithmetic expressions relate two operands (value or another expression) to compose a sum, subtraction, multiplication or division.
==== Multiplication (*) ROUND function ==== <!--T:18222-->Multiplicate two operands. Represented by the multiplication or star (*) character. Syntax: ''<operand/expression> * <operand/expression>''. '''Examples''': "Amount" * "Unit Price";
<!--T:224-->
Syntax:
ROUND(<value>;<precision>)
Example:
'''ROUND("Profit")''' - If Profit 10.38 returns 10.00
'''ROUND(15.65)''' - Returns 16.00
'''ROUND(1.777;1)''' - Returns 1.8
=== Relational Expressions = SQRT function (Square Root) ==== <!--T:20174-->
<!--T:21175-->The relational expressions compare two operands (Returns the square root of a value or another expression) to evaluate if a condition is ''true'' or ''false''. Usually used with decision functions, like the ''IF''.
==== Greater than (>) LIKE function ==== <!--T:24178-->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" > '01/01/2011';
==== Lesser or equal than (<=) ==Date Functions == <!--T:27181-->Return ''true'' if the first expression is lesser than or equal to the second expression and ''false'' otherwise. Represented by the lesser or equal operator (<=). Syntax: ''<expression> <= <expression>''. '''Examples''': IF("Order Date" <= '01/01/2011';"Order Date";0).
<!--T:182-->
Date functions are operations that take a date as a parameter and also return a date. There are some constants to assist in using date functions, they are:
==== DATE_PART function (Date Part) ==== <!--T:184-->
==== DAY_FROM_TODAY function (Days from today) ==== <!--T:187-->
==== Abs FIRST_DAY_OF function (First day of) ==== <!--T:36190-->Returns the absolute value of a base value. Syntax: ''ABS(<expression>)''. Accept one parameter and process a numeric data type. '''Examples''': ABS(Gross Sale-Taxes);
==== Pow LAST_DAY_OF function (Last day of) ==== <!--T:43197-->Returns the power value of a number on a set exponent. Syntax: ''POW(<expression_number>[;<expression_exponent>])''. 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);
<!--T:200-->
Syntax:
LAST_DAY_OF(<date part>; <base date>)
Examples:
'''LAST_DAY_OF(0;DAY_FROM_TODAY(0))''' - Returns the last day of the year from today.
'''LAST_DAY_OF(1;"Date Issued")''' - Last day of month based on ''Date Issued'' column
<!--T:47203-->The Syntax: LAST_DAY_OF(<date part>;<date modifier>;<date functions are operations that use as parameters and return the result modifier value>)Example: '''LAST_DAY_OF(1;0;-1)''' - last day of the [[Date|date data type]].current month of last year
==== NEW_DATE function (New date) ==== <!--T:204-->
==== Last day NUM_OF_DAYS function (Number of days) ==== <!--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)) 207- 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);
==== Previous date NUM_OF_MONTHS function (Number of months) ==== <!--T:56211-->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".
<!--T:212-->
Returns the number of months between two dates. Therefore, two date parameters are required.
<!--T:59215--> "@count" - Total number Given a day and a month, returns the last occurrence of that date. That is, if the current date (today) is less than the date passed by parameter (day / month), the return is the date (passed by parameter) of lines returned in a tablethe previous year. Otherwise the return will be the current year date.
<!--T:60216--> "@row" Syntax: PREVIOUS_DATE(<day>; <month>)Examples: '''PREVIOUS_DATE(15;12)''' - current line numberConsidering that today's date is 14/11/2019, the last time December 15th occurred relative to today's date was 15/12/2018, so this will be the return.
== Special Variables == <!--T:63217--> "@avg[Column]" - Avg of indicated column like @sum[Column] / @count
<!--T:64218--> "@prev[column]" - Previous row column valueThey can be used in conjunction with expressions to create complex calculations. Must be used in double quotation marks (“)
<!--T:219-->
* '''"@count"''' - Total number of rows that were returned for the component.
* '''"@row"''' - Current row number
* '''"@sum[column]"''' - Sum of the indicated column.
** Example: ''"@sum[Price]"'' - returns the sum of all rows in the ''Price'' column.
* '''"@avg[column]"''' - Average column, similar to ''"@sum[column]"'' / ''"@count"''
* '''"@prev[column]"''' - Row value before current row for this column
* '''"@totalRowValue[column]"''' - Value of total row, (if present), from this column.
* '''"@accumCol[column]"''' - Cumulative value from column to current row. Useful for calculating variable mean.
** Example: ''"@accumCol[column]"'' / ''"@row"''
</translate>