Difference between revisions of "Expressions"

From TaticView
Jump to: navigation, search
(Marked this version for translation)
Line 3: Line 3:
  
 
<translate>
 
<translate>
 +
<!--T:68-->
 
<div class="index-right">__TOC__</div>
 
<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 data source file/spreadsheet.
 
You can create expressions (formulas) directly in the dashboard components. It can thus display calculated values that are not present in the data source file/spreadsheet.
  
  
 +
<!--T:70-->
 
To create the expression (formula) in the components, the component must support the addition of the special column ''Expression (Formula)''.
 
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.
 
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-->
 
In addition, it is also possible to use fixed numbers and texts in the case of comparative expressions.
 
In addition, it is also possible to use fixed numbers and texts in the case of comparative expressions.
  
  
 +
<!--T:73-->
 
Expression Example:
 
Expression Example:
  
 +
<!--T:74-->
 
* If the component has the columns ''Total Price'' and ''Quantity'', you can create an expression to calculate the ''Unit Price''. Would be like this:
 
* If the component has the columns ''Total Price'' and ''Quantity'', you can create an expression to calculate the ''Unit Price''. Would be like this:
 
** ''Total Price'' / ''Quantity''
 
** ''Total Price'' / ''Quantity''
Line 25: Line 32:
  
  
 +
<!--T:75-->
 
We just remember that currently TaticView only supports expressions whose numeric return.
 
We just remember that currently TaticView only supports expressions whose numeric return.
  
  
 +
<!--T:76-->
 
Below are details about how the expressions work:
 
Below are details about how the expressions work:
  
== Basic structure of a Expression (Formula) ==
+
== Basic structure of a Expression (Formula) == <!--T:77-->
  
  
==== Value Operand ====
+
==== 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.
 
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
 
* Examples: 1, 1.05, 2.55
  
  
==== Text Operand ====
+
==== 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 (').
 
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'
 
* Examples: 'John Snow', 'California', 'Spaghetti'
  
  
==== Date Operand ====
+
==== 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.
 
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'
 
* Examples: '01/01/2019', '14/11/2019', '25/12/2019'
  
  
==== Boolean Operand ====
+
==== 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.
 
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
 
* Examples: true, false
  
  
==== Parentheses ====
+
==== Parentheses ==== <!--T:90-->
  
 +
<!--T:91-->
 
Used to group and separate parts of on expression. Expressions within parentheses are processed first.
 
Used to group and separate parts of on expression. Expressions within parentheses are processed first.
  
 +
<!--T:92-->
 
* Example: ("Profit"/"Total Price") + 10
 
* Example: ("Profit"/"Total Price") + 10
  
  
==== System variable Operand ====
+
==== System variable Operand ==== <!--T:93-->
  
 +
<!--T:94-->
 
These are predefined variables in the system. To use the system variables you must precede them by hashtag (#) and delimit them by double quotes("). Currently only the "#null" variable is available and indicates null content.
 
These are predefined variables in the system. To use the system variables you must precede them by hashtag (#) 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)
 
* Example: IF("Product" == "#null";0;20)
  
  
== Arithmetic Expressions ==
+
== 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.
 
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 (+) ====
+
==== Sum (+) ==== <!--T:98-->
  
 +
<!--T:99-->
 
Add two value operands or another expression result. Represented by the ''+'' charecter.
 
Add two value operands or another expression result. Represented by the ''+'' charecter.
  
 +
<!--T:100-->
 
Syntax:
 
Syntax:
 
   <operating or expression result> '''+''' <operating or expression result>
 
   <operating or expression result> '''+''' <operating or expression result>
Line 90: Line 114:
  
  
==== Subtraction (-) ====
+
==== Subtraction (-) ==== <!--T:101-->
  
 +
<!--T:102-->
 
Subtract two value operands or another expression result. Represented by the ''-'' charecter.
 
Subtract two value operands or another expression result. Represented by the ''-'' charecter.
  
 +
<!--T:103-->
 
Syntax:
 
Syntax:
 
   <operating or expression result> '''-''' <operating or expression result>
 
   <operating or expression result> '''-''' <operating or expression result>
Line 100: Line 126:
  
  
==== Multiplication (*) ====
+
==== Multiplication (*) ==== <!--T:104-->
  
 +
<!--T:105-->
 
Multiplies two value operands or another expression result. Represented by the multiplication charecter ''*''.
 
Multiplies two value operands or another expression result. Represented by the multiplication charecter ''*''.
  
 +
<!--T:106-->
 
Syntax:
 
Syntax:
 
   <operating or expression result> '''*''' <operating or expression result>  
 
   <operating or expression result> '''*''' <operating or expression result>  
Line 110: Line 138:
  
  
==== Division (/) ====
+
==== Division (/) ==== <!--T:107-->
  
 +
<!--T:108-->
 
Divide two value operands or another expression result. Represented by the division charecter ''/''.
 
Divide two value operands or another expression result. Represented by the division charecter ''/''.
  
 +
<!--T:109-->
 
Syntax:
 
Syntax:
 
   <operating or expression result> '''/''' <operating or expression result>
 
   <operating or expression result> '''/''' <operating or expression result>
Line 120: Line 150:
  
  
== Relational Expressions ==
+
== 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''.
 
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 (==) ====
+
==== 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 ''==''.
 
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:
 
Syntax:
 
   <operating or expression result> '''==''' <operating or expression result>
 
   <operating or expression result> '''==''' <operating or expression result>
Line 135: Line 168:
  
  
==== Different (!=) ====
+
==== 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 ''!=''.
 
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:  
 
Syntax:  
 
   <operating or expression result> '''!=''' <operating or expression result>
 
   <operating or expression result> '''!=''' <operating or expression result>
Line 145: Line 180:
  
  
==== Greater than (>) ====
+
==== 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 ''>''.
 
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:
 
Syntax:
 
     <operating or expression result> '''>''' <operating or expression result>
 
     <operating or expression result> '''>''' <operating or expression result>
Line 155: Line 192:
  
  
==== Greater or equal to (>=) ====
+
==== 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 ''>=''.
 
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:
 
Syntax:
 
   <operating or expression result> '''>=''' <operating or expression result>
 
   <operating or expression result> '''>=''' <operating or expression result>
Line 165: Line 204:
  
  
==== Less than (<) ====
+
==== 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 ''<''.
 
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:
 
Syntax:
 
   <operating or expression result> '''<''' <operating or expression result>
 
   <operating or expression result> '''<''' <operating or expression result>
Line 175: Line 216:
  
  
==== Less or equal to (<=) ====
+
==== 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 ''<=''.
 
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:
 
Syntax:
 
   <operating or expression result> '''<=''' <operating or expression result>
 
   <operating or expression result> '''<=''' <operating or expression result>
Line 185: Line 228:
  
  
== Logical Expressions ==
+
== 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.
 
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 (&&) ====
+
==== 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.
 
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:
 
Syntax:
 
   <expression> && <expression>
 
   <expression> && <expression>
Line 202: Line 248:
  
  
==== Or Operator (||) ====
+
==== 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 ''||''.
 
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:
 
Syntax:
 
   <expression> || <expression>
 
   <expression> || <expression>
Line 211: Line 259:
 
   '''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(("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''
+
   <!--T:138-->
 +
'''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 (!) ====
+
==== 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 ''!''.
 
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:
 
Syntax:
 
   !<expression>
 
   !<expression>
Line 225: Line 276:
  
  
== Auxiliary Functions ==
+
== Auxiliary Functions == <!--T:142-->
  
 +
<!--T:143-->
 
Basic helper functions are standard system functions and implement useful features for composing complex expressions.
 
Basic helper functions are standard system functions and implement useful features for composing complex expressions.
  
  
==== ABS function ====
+
==== ABS function ==== <!--T:144-->
  
 +
<!--T:145-->
 
Function that returns the absolute numeric value of a base numeric value.
 
Function that returns the absolute numeric value of a base numeric value.
  
 +
<!--T:146-->
 
Syntax:
 
Syntax:
 
   ABS(<value operator or expression>)
 
   ABS(<value operator or expression>)
Line 240: Line 294:
  
  
==== AVG function ====
+
==== 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.
 
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:
 
Syntax:
 
   AVG(<expression 1>; <expression 2>; ...)
 
   AVG(<expression 1>; <expression 2>; ...)
Line 250: Line 306:
  
  
==== BETWEEN function ====
+
==== BETWEEN function ==== <!--T:150-->
  
 +
<!--T:151-->
 
Checks whether a value is within the limits of the parameters used. Return true or false.
 
Checks whether a value is within the limits of the parameters used. Return true or false.
  
 +
<!--T:152-->
 
Syntax:
 
Syntax:
 
   BETWEEN(<expression to be tested>; <initial limit>; <end limit>)
 
   BETWEEN(<expression to be tested>; <initial limit>; <end limit>)
Line 260: Line 318:
  
  
==== IF ELSE function (If .... Otherwise ...) ====
+
==== IF ELSE function (If .... Otherwise ...) ==== <!--T:153-->
  
 +
<!--T:154-->
 
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 expression to be tested, the second the value to be applied in case of true, and the third to be applied in case of false.
 
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 expression to be tested, the second the value to be applied in case of true, and the third to be applied in case of false.
  
 +
<!--T:155-->
 
Syntax:
 
Syntax:
 
   IF(<expression to be tested>; <expression if true>; <expression if false>)
 
   IF(<expression to be tested>; <expression if true>; <expression if false>)
Line 269: Line 329:
 
   '''IF(BETWEEN("Value";0;100);10;250)''' - If ''Value'' is between ''0'' and ''100'' returns ''10'', if not ''250''
 
   '''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''
+
   <!--T:156-->
 +
'''IF("Profit" == 0;0;"Profit" + "Taxes")''' - If ''Profit'' equals ''0'' returns ''0'', if it does not return the sum between ''Profit'' and ''Taxes''
  
  
==== LOG function ====
+
==== LOG function ==== <!--T:157-->
  
 +
<!--T:158-->
 
Returns the logarithm of a number on a defined basis. It can be used with only one parameter, in this case the neperian (natural) logarithm is used . If two parameters are used, the second server to inform the base to be used by the logarithm.
 
Returns the logarithm of a number on a defined basis. It can be used with only one parameter, in this case the neperian (natural) logarithm is used . If two parameters are used, the second server to inform the base to be used by the logarithm.
  
 +
<!--T:159-->
 
Syntax:
 
Syntax:
 
   LOG(<expression>;<base>)
 
   LOG(<expression>;<base>)
Line 281: Line 344:
 
   '''LOG("Profit")'''- Returns the logarithm of the field ''Profit''
 
   '''LOG("Profit")'''- Returns the logarithm of the field ''Profit''
  
   '''LOG("Price";2)''' - Returns the logarithm of the ''Price'' field in base ''2''
+
   <!--T:160-->
 +
'''LOG("Price";2)''' - Returns the logarithm of the ''Price'' field in base ''2''
  
  
==== MAX function ====
+
==== MAX function ==== <!--T:161-->
  
 +
<!--T:162-->
 
Returns the largest value between two values.
 
Returns the largest value between two values.
  
 +
<!--T:163-->
 
Syntax:
 
Syntax:
 
   MAX(<expression 1>;<expression 2>)
 
   MAX(<expression 1>;<expression 2>)
Line 294: Line 360:
  
  
==== MIN function ====
+
==== MIN function ==== <!--T:164-->
  
 +
<!--T:165-->
 
Returns the smallest value between two values.
 
Returns the smallest value between two values.
  
 +
<!--T:166-->
 
Syntax:  
 
Syntax:  
 
   MIN(<expression 1>; <expression 2>)
 
   MIN(<expression 1>; <expression 2>)
Line 304: Line 372:
  
  
==== POWER function ====
+
==== POWER function ==== <!--T:167-->
  
 +
<!--T:168-->
 
Returns the power of a value in a defined exponent. It can be used with only one parameter, in this case it considers the default exponent 2. If a second parameter is passed, this will be the exponent.
 
Returns the power of a value in a defined exponent. It can be used with only one parameter, in this case it considers the default exponent 2. If a second parameter is passed, this will be the exponent.
  
 +
<!--T:169-->
 
Syntax:  
 
Syntax:  
 
   POW(<expression>; <exponent>)
 
   POW(<expression>; <exponent>)
Line 313: Line 383:
 
   '''POW("Profit")''' - Returns the power of the ''Profit'' value.
 
   '''POW("Profit")''' - Returns the power of the ''Profit'' value.
  
   '''POW("Cost"; 3)''' - Returns the power of the ''Cost'' value, raised to ''3''
+
   <!--T:170-->
 +
'''POW("Cost"; 3)''' - Returns the power of the ''Cost'' value, raised to ''3''
  
  
==== RANDOM function ====
+
==== RANDOM function ==== <!--T:171-->
  
 +
<!--T:172-->
 
Returns a random number within the range of values ​​passed as arguments.
 
Returns a random number within the range of values ​​passed as arguments.
  
 +
<!--T:173-->
 
Syntax:  
 
Syntax:  
 
   RANDOM(<start limit>; <end limit>)
 
   RANDOM(<start limit>; <end limit>)
Line 326: Line 399:
  
  
==== SQRT function (Square Root) ====
+
==== SQRT function (Square Root) ==== <!--T:174-->
  
 +
<!--T:175-->
 
Returns the square root of a value.
 
Returns the square root of a value.
  
 +
<!--T:176-->
 
Syntax:  
 
Syntax:  
 
   SQRT(<value or expression>)
 
   SQRT(<value or expression>)
Line 335: Line 410:
 
   '''SQRT("Profit")''' - Returns the square root of the value ''Profit''
 
   '''SQRT("Profit")''' - Returns the square root of the value ''Profit''
  
   '''SQRT(81)''' - Returns the square root of ''81''
+
   <!--T:177-->
 +
'''SQRT(81)''' - Returns the square root of ''81''
  
  
==== LIKE function ====
+
==== LIKE function ==== <!--T:178-->
  
 +
<!--T:179-->
 
Returns true if the desired content is found in the list and false otherwise. It needs two parameters, the first is the data to query and the second is the term to be found. Remembering that it is necessary to use the wildcard operator “%” and surround the term by single quotation mark.
 
Returns true if the desired content is found in the list and false otherwise. It needs two parameters, the first is the data to query and the second is the term to be found. Remembering that it is necessary to use the wildcard operator “%” and surround the term by single quotation mark.
  
 +
<!--T:180-->
 
Syntax:  
 
Syntax:  
 
   LIKE(< data>; <term>)
 
   LIKE(< data>; <term>)
Line 348: Line 426:
  
  
== Date Functions ==
+
== Date Functions == <!--T:181-->
  
 +
<!--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 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:
  
 +
<!--T:183-->
 
* 0: ''DATE_FIELD_YEAR'' (Part of the year)
 
* 0: ''DATE_FIELD_YEAR'' (Part of the year)
 
* 1: ''DATE_FIELD_MONTH'' (Month Part)
 
* 1: ''DATE_FIELD_MONTH'' (Month Part)
Line 359: Line 439:
  
  
==== DATE_PART function (Date Part) ====
+
==== DATE_PART function (Date Part) ==== <!--T:184-->
  
 +
<!--T:185-->
 
Returns part of a date. It needs two parameters, the first is the reference date and the second is the constant that represents which part of the date we want to get.
 
Returns part of a date. It needs two parameters, the first is the reference date and the second is the constant that represents which part of the date we want to get.
  
 +
<!--T:186-->
 
Syntax:  
 
Syntax:  
 
   DATE_ PART(<date>; <constant representing which part>)
 
   DATE_ PART(<date>; <constant representing which part>)
Line 369: Line 451:
  
  
==== DAY_FROM_TODAY function (Days from today) ====
+
==== DAY_FROM_TODAY function (Days from today) ==== <!--T:187-->
  
 +
<!--T:188-->
 
Returns a days count backward (negative) or forward (positive) from today. You need a parameter that indicates the number of days to add or subtract.
 
Returns a days count backward (negative) or forward (positive) from today. You need a parameter that indicates the number of days to add or subtract.
  
 +
<!--T:189-->
 
Syntax:  
 
Syntax:  
 
   DAY_FROM_TODAY(<number of days>)
 
   DAY_FROM_TODAY(<number of days>)
Line 379: Line 463:
  
  
==== FIRST_DAY_OF function (First day of) ====
+
==== FIRST_DAY_OF function (First day of) ==== <!--T:190-->
  
 +
<!--T:191-->
 
Returns the first day of a grouping. This function has two variations:
 
Returns the first day of a grouping. This function has two variations:
  
 +
<!--T:192-->
 
* With two parameters, the first is the grouping constant from which we want to get the first date (see list above), and the second is the base date.
 
* With two parameters, the first is the grouping constant from which we want to get the first date (see list above), and the second is the base date.
  
 +
<!--T:193-->
 
Syntax:  
 
Syntax:  
 
   FIRST_DAY_OF(<date part>; <base date>)
 
   FIRST_DAY_OF(<date part>; <base date>)
Line 390: Line 477:
 
   '''FIRST_DAY_OF(0;DAY_FROM_TODAY(0))''' - Returns the first day of the year from today
 
   '''FIRST_DAY_OF(0;DAY_FROM_TODAY(0))''' - Returns the first day of the year from today
  
   '''FIRST_DAY_OF(1;"Issue Date")''' - First Day of Month Based on ''Issue Date'' Column
+
   <!--T:194-->
 +
'''FIRST_DAY_OF(1;"Issue Date")''' - First Day of Month Based on ''Issue Date'' Column
  
 +
<!--T:195-->
 
* With three parameters, the first is the grouping constant from which we want to get the first date (see list above), the second is the date base modifier from today, and the third is the amount to change the modifier.
 
* With three parameters, the first is the grouping constant from which we want to get the first date (see list above), the second is the date base modifier from today, and the third is the amount to change the modifier.
  
 +
<!--T:196-->
 
Syntax:  
 
Syntax:  
 
   FIRST_DAY_OF(<date part>;<date modifier>;<date modifier value>)
 
   FIRST_DAY_OF(<date part>;<date modifier>;<date modifier value>)
Line 400: Line 490:
  
  
==== LAST_DAY_OF function (Last day of) ====
+
==== LAST_DAY_OF function (Last day of) ==== <!--T:197-->
  
 +
<!--T:198-->
 
Returns the last day of a date grouping. This function has two variations.
 
Returns the last day of a date grouping. This function has two variations.
  
 +
<!--T:199-->
 
* With two parameters, the first is the grouping constant from which we want the last date (see list above), and the second is the base date.
 
* With two parameters, the first is the grouping constant from which we want the last date (see list above), and the second is the base date.
  
 +
<!--T:200-->
 
Syntax:
 
Syntax:
 
   LAST_DAY_OF(<date part>; <base date>)
 
   LAST_DAY_OF(<date part>; <base date>)
Line 411: Line 504:
 
   '''LAST_DAY_OF(0;DAY_FROM_TODAY(0))''' - Returns the last day of the year from today.
 
   '''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:201-->
 +
'''LAST_DAY_OF(1;"Date Issued")''' - Last day of month based on ''Date Issued'' column
  
 +
<!--T:202-->
 
* With three parameters, the first is the grouping constant from which we want the last date (see list above), the second is the date base modifier from today, and the third is the amount to change the modifier.
 
* With three parameters, the first is the grouping constant from which we want the last date (see list above), the second is the date base modifier from today, and the third is the amount to change the modifier.
  
 +
<!--T:203-->
 
Syntax:  
 
Syntax:  
 
   LAST_DAY_OF(<date part>;<date modifier>;<date modifier value>)
 
   LAST_DAY_OF(<date part>;<date modifier>;<date modifier value>)
Line 421: Line 517:
  
  
==== NEW_DATE function (New date) ====
+
==== NEW_DATE function (New date) ==== <!--T:204-->
  
 +
<!--T:205-->
 
Creates a new date. It needs three parameters, the first corresponds to the day (between 1 and 31), the second month (between 1 and 12) and the third the year. The date is created from year to day, ie the day must be valid for the month and year (considering 29/02, the year must be leap).
 
Creates a new date. It needs three parameters, the first corresponds to the day (between 1 and 31), the second month (between 1 and 12) and the third the year. The date is created from year to day, ie the day must be valid for the month and year (considering 29/02, the year must be leap).
  
 +
<!--T:206-->
 
Syntax:  
 
Syntax:  
 
   NEW_DATE(<day>;<month>;<year>)
 
   NEW_DATE(<day>;<month>;<year>)
Line 431: Line 529:
  
  
==== NUM_OF_DAYS function (Number of days) ====
+
==== NUM_OF_DAYS function (Number of days) ==== <!--T:207-->
  
 +
<!--T:208-->
 
Returns the number of days between two dates. Therefore you need two dates.
 
Returns the number of days between two dates. Therefore you need two dates.
  
 +
<!--T:209-->
 
Syntax:  
 
Syntax:  
 
   NUM_OF_DAYS(<date 1>; <date 2>)
 
   NUM_OF_DAYS(<date 1>; <date 2>)
Line 440: Line 540:
 
   '''NUM_OF_DAYS(FIRST_DAY_OF(0;"Issued Date");"Issued Date")''' - Returns the number of days from the first day of the year, based on the ''Issued Date'' column, to the current day, based on the same column.
 
   '''NUM_OF_DAYS(FIRST_DAY_OF(0;"Issued Date");"Issued Date")''' - Returns the number of days from the first day of the year, based on the ''Issued Date'' column, to the current day, based on the same column.
  
   '''NUM_OF_DAYS(FIRST_DAY_OF(1;"Issued Date");LAST_DAY_OF(1,"Issued Date"))''' - Returns the number of days of the month, based on the ''Issued Date'' column.
+
   <!--T:210-->
 +
'''NUM_OF_DAYS(FIRST_DAY_OF(1;"Issued Date");LAST_DAY_OF(1,"Issued Date"))''' - Returns the number of days of the month, based on the ''Issued Date'' column.
  
  
==== NUM_OF_MONTHS function (Number of months) ====
+
==== NUM_OF_MONTHS function (Number of months) ==== <!--T:211-->
  
 +
<!--T:212-->
 
Returns the number of months between two dates. Therefore, two date parameters are required.
 
Returns the number of months between two dates. Therefore, two date parameters are required.
  
 +
<!--T:213-->
 
Syntax:  
 
Syntax:  
 
   NUM_OF_MONTHS(<date 1>; <date 2>)
 
   NUM_OF_MONTHS(<date 1>; <date 2>)
Line 453: Line 556:
  
  
==== PREVIOUS_DATE function (Previous date) ====
+
==== PREVIOUS_DATE function (Previous date) ==== <!--T:214-->
  
 +
<!--T:215-->
 
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 the previous year. Otherwise the return will be the current year date.
 
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 the previous year. Otherwise the return will be the current year date.
  
 +
<!--T:216-->
 
Syntax:  
 
Syntax:  
 
   PREVIOUS_DATE(<day>; <month>)
 
   PREVIOUS_DATE(<day>; <month>)
Line 463: Line 568:
  
  
== Special Variables ==
+
== Special Variables == <!--T:217-->
  
 +
<!--T:218-->
 
They can be used in conjunction with expressions to create complex calculations. Must be used in double quotation marks (“)
 
They 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.
 
* '''"@count"''' - Total number of rows that were returned for the component.
 
* '''"@row"''' - Current row number
 
* '''"@row"''' - Current row number

Revision as of 19:07, 22 November 2019

Other languages:
English • ‎português do Brasil


You can create expressions (formulas) directly in the dashboard components. It can thus display calculated values that are not present in the data source file/spreadsheet.


To create the expression (formula) in the components, the component must support the addition of the special column Expression (Formula).


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.


In addition, it is also possible to use fixed numbers and texts in the case of comparative expressions.


Expression Example:

  • If the component has the columns Total Price and Quantity, you can create 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


We just remember that currently TaticView only supports expressions whose numeric return.


Below are details about how the expressions work:

Basic structure of a Expression (Formula)

Value Operand

It's the numerical values. 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


Text Operand

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 (').

  • Examples: 'John Snow', 'California', 'Spaghetti'


Date Operand

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.

  • Examples: '01/01/2019', '14/11/2019', '25/12/2019'


Boolean Operand

They're operators of the true or false type. Normally user to validate, or not, a condition in a more complex expression.

  • Examples: true, false


Parentheses

Used to group and separate parts of on expression. Expressions within parentheses are processed first.

  • Example: ("Profit"/"Total Price") + 10


System variable Operand

These are predefined variables in the system. To use the system variables you must precede them by hashtag (#) and delimit them by double quotes("). Currently only the "#null" variable is available and indicates null content.

  • Example: IF("Product" == "#null";0;20)


Arithmetic Expressions

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 (+)

Add two value operands or another expression result. Represented by the + charecter.

Syntax:

 <operating or expression result> + <operating or expression result>

Example:

 "Taxes" + "Commissions" - Sums the values of the fields Taxes and Commissions


Subtraction (-)

Subtract two value operands or another expression result. Represented by the - charecter.

Syntax:

 <operating or expression result> - <operating or expression result>

Example:

 "Price" - "Taxes" - Subtracts the values ​​from the Price and Taxes fields.


Multiplication (*)

Multiplies two value operands or another expression result. Represented by the multiplication charecter *.

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 (/)

Divide two value operands or another expression result. Represented by the division charecter /.

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

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 (==)

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 ==.

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 (!=)

It compare if two operands are different, returning true if they were different or false if equal. Represented by the differente operator !=.

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 (>)

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 >.

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 (>=)

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 >=.

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 (<)

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 <.

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 (<=)

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 <=.

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

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 (&&)

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.

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 (||)

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 ||.

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 (!)

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 !.

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

Basic helper functions are standard system functions and implement useful features for composing complex expressions.


ABS function

Function that returns the absolute numeric value of a base numeric value.

Syntax:

 ABS(<value operator or expression>)

Example:

 ABS("Price" / "Quantity") - Returns the absolute value of Price divided by Quantity


AVG function

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.

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

Checks whether a value is within the limits of the parameters used. Return true or false.

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


IF ELSE function (If .... Otherwise ...)

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 expression to be tested, the second the value to be applied in case of true, and the third to be applied in case of false.

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


LOG function

Returns the logarithm of a number on a defined basis. It can be used with only one parameter, in this case the neperian (natural) logarithm is used . If two parameters are used, the second server to inform the base to be used by the logarithm.

Syntax:

 LOG(<expression>;<base>)

Examples:

 LOG("Profit")- Returns the logarithm of the field Profit
 LOG("Price";2) - Returns the logarithm of the Price field in base 2


MAX function

Returns the largest value between two values.

Syntax:

  MAX(<expression 1>;<expression 2>)

Example:

 "Value" / MAX("Quantity";1) - Divides Value by the largest value between Quantity and 1


MIN function

Returns the smallest value between two values.

Syntax:

 MIN(<expression 1>; <expression 2>)

Example:

 "Value" / MIN("Cost"; 100) - Divides Value by the smallest value between Cost and 100


POWER function

Returns the power of a value in a defined exponent. It can be used with only one parameter, in this case it considers the default exponent 2. If a second parameter is passed, this will be the exponent.

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

Returns a random number within the range of values ​​passed as arguments.

Syntax:

 RANDOM(<start limit>; <end limit>)

Example:

 RANDOM(10,100) - Returns a random number between 10 and 100


SQRT function (Square Root)

Returns the square root of a value.

Syntax:

 SQRT(<value or expression>)

Examples:

 SQRT("Profit") - Returns the square root of the value Profit
 SQRT(81) - Returns the square root of 81


LIKE function

Returns true if the desired content is found in the list and false otherwise. It needs two parameters, the first is the data to query and the second is the term to be found. Remembering that it is necessary to use the wildcard operator “%” and surround the term by single quotation mark.

Syntax:

 LIKE(< data>; <term>)

Example:

 LKE("Product"; '%anh%') - Returns true if the Product contains the term anh or false otherwise


Date Functions

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:

  • 0: DATE_FIELD_YEAR (Part of the year)
  • 1: DATE_FIELD_MONTH (Month Part)
  • 2: DATE_FIELD_DAY (Daypart)
  • 3: DATE_FIELD_FORTNIGHT (Part of fortnight)
  • 5: DATE_FIELD_WEEK (Part of the Week)


DATE_PART function (Date Part)

Returns part of a date. It needs two parameters, the first is the reference date and the second is the constant that represents which part of the date we want to get.

Syntax:

 DATE_ PART(<date>; <constant representing which part>)

Example:

 DATE_ PART("Issued Date"; 0) - Returns the year portion of the Issued Date


DAY_FROM_TODAY function (Days from today)

Returns a days count backward (negative) or forward (positive) from today. You need a parameter that indicates the number of days to add or subtract.

Syntax:

 DAY_FROM_TODAY(<number of days>)

Example:

 DAY_FROM_TODAY(-1) - Returns yesterday's date


FIRST_DAY_OF function (First day of)

Returns the first day of a grouping. This function has two variations:

  • With two parameters, the first is the grouping constant from which we want to get the first date (see list above), and the second is the base date.

Syntax:

 FIRST_DAY_OF(<date part>; <base date>)

Examples:

 FIRST_DAY_OF(0;DAY_FROM_TODAY(0)) - Returns the first day of the year from today
 FIRST_DAY_OF(1;"Issue Date") - First Day of Month Based on Issue Date Column
  • With three parameters, the first is the grouping constant from which we want to get the first date (see list above), the second is the date base modifier from today, and the third is the amount to change the modifier.

Syntax:

 FIRST_DAY_OF(<date part>;<date modifier>;<date modifier value>)

Example:

 FIRST_DAY_OF(1,0,-1) - first day of current month of last year


LAST_DAY_OF function (Last day of)

Returns the last day of a date grouping. This function has two variations.

  • With two parameters, the first is the grouping constant from which we want the last date (see list above), and the second is the base date.

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
  • With three parameters, the first is the grouping constant from which we want the last date (see list above), the second is the date base modifier from today, and the third is the amount to change the modifier.

Syntax:

 LAST_DAY_OF(<date part>;<date modifier>;<date modifier value>)

Example:

 LAST_DAY_OF(1,0,-1) - last day of current month of last year


NEW_DATE function (New date)

Creates a new date. It needs three parameters, the first corresponds to the day (between 1 and 31), the second month (between 1 and 12) and the third the year. The date is created from year to day, ie the day must be valid for the month and year (considering 29/02, the year must be leap).

Syntax:

 NEW_DATE(<day>;<month>;<year>)

Example:

 NEW_DATE(1;4;DATE_PART("Issued Date";0)) - Creates the first April day of the year determined by the current row in the Issued Date column.


NUM_OF_DAYS function (Number of days)

Returns the number of days between two dates. Therefore you need two dates.

Syntax:

 NUM_OF_DAYS(<date 1>; <date 2>)

Examples:

 NUM_OF_DAYS(FIRST_DAY_OF(0;"Issued Date");"Issued Date") - Returns the number of days from the first day of the year, based on the Issued Date column, to the current day, based on the same column.
 NUM_OF_DAYS(FIRST_DAY_OF(1;"Issued Date");LAST_DAY_OF(1,"Issued Date")) - Returns the number of days of the month, based on the Issued Date column.


NUM_OF_MONTHS function (Number of months)

Returns the number of months between two dates. Therefore, two date parameters are required.

Syntax:

 NUM_OF_MONTHS(<date 1>; <date 2>)

Example:

 NUM_OF_MONTHS(FIRST_DAY_OF(0; "Date"); "Date") - Returns the number of months between the first day of the year and the current month, based on the Date column.


PREVIOUS_DATE function (Previous date)

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 the previous year. Otherwise the return will be the current year date.

Syntax:

 PREVIOUS_DATE(<day>; <month>)

Examples:

 PREVIOUS_DATE(15;12) - Considering 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

They can be used in conjunction with expressions to create complex calculations. Must be used in double quotation marks (“)


  • "@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
  • "@accumCol[column]" - Cumulative value from column to current row. Useful for calculating variable mean.
    • Example: "@accumCol[column]" / "@row"