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 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) == 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 using programming languagethe ''+'' 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: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.
<!--T:2155-->Syntax: IF(<expression to be tested>; <expression if true>; <expression if false>)Examples: '''IF(BETWEEN("Value";0;100);10;250)'''- If 'Important'Value'' is between ''0'' and ''100'' returns ''10'': After manually editing the expression, the regular operators can if not be used until you ''Clear All250'' '''IF("Profit" == 0;0;"Profit" + "Taxes")''' - If ''Profit'' equals ''0'' returns ''0'' , if it does not return the filterssum between ''Profit'' and ''Taxes'' '''IF("Product Code" == 3231;0;"Quantity" * 3;"Quantity")''' - If ''Product Code'' equals ''3231'' returns ''Quantity'' plus 3
==== LOG function ==== <!--T:157-->
<!--T:3158-->__TOC__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.
<!--T:159-->
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 ==== <!--T:161-->
<!--T:6163-->The Syntax: MAX(<expression 1>;<expression 2>)Example: '''"Value" / MAX("Quantity";1)''' - Divides ''Value'' by the largest value operands are values from a [[Columns Data Type|data type]] that are used in expressions as variables.between ''Quantity'' and ''1''
==== Value type operand MIN function ==== <!--T:7164-->Are numeric values of the float type (Real numbers domain). These values allow the use of a integer and a fraction part, separated by the dot (.) character (decimal separator). '''Examples''': 1, 1.05, 2.55;
==== Identifier type operand POWER function ==== <!--T:11167-->Are values that represents a field or variable in the expression. Used to make reference to data source columns, delimited by double quotes ("). '''Examples''': "City.City", "Product.Product";
=== Arithmetic Expressions = RANDOM function ==== <!--T:14171-->
<!--T:15172-->The arithmetic expressions relate two operands (value or another expression) to compose Returns a sum, subtraction, multiplication or divisionrandom number within the range of values passed as arguments.
==== Subtraction (-) ROUND function ==== <!--T:17222-->Subtract two operands. Represented by the subtract or hyphen (-) character. Syntax: ''<operand/expression> - <operand/expression>''. '''Examples''': "Gross Sale" - "Taxes";
==== SQRT function (Square Root) ==== <!--T:174-->
<!--T:21176-->The relational expressions compare two operands Syntax: SQRT(<value or another expression>) two evaluate if a condition is Examples: '''SQRT("Profit")'true'' or - Returns the square root of the value ''Profit'' '''falseSQRT(81)''. Usually used with decision functions, like ' - Returns the square root of ''IF81''.
==== Different (!=) LIKE function ==== <!--T:23178-->Performs the different comparison expression between two operands. Represented by the different operator (!=). Syntax: ''<expression> != <expression>''. '''Examples''': "City.City" != 'New York';
==== Lesser than (<) ==Date Functions == <!--T:26181-->Return ''true'' if the the first expression is lesser than the second expression and ''false'' otherwise. Represented by the lesser operator (<). Syntax: ''<expression> < <expression>''. '''Examples''': "Profit" < '0';
<!--T:183-->
* 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) ==== <!--T:29184-->The logical expressions group two 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 the ''IF'' and with relational expressions.
<!--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.
==== Not DAY_FROM_TODAY function (!Days from today) ==== <!--T:32187-->Performs the denial logical operation for a boolean value. If the operand are ''true'' the ''NOT'' convert it to ''false'' (and the other way around). Represented by the ''NOT'' operator (!). Syntax: ''! <expression>''. '''Examples''': IF(!BETWEEN("Date", '01/01/2013', '31/12/2013');'Not 2013';'2013').
<!--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.
==== FIRST_DAY_OF function (First day of) ==== <!--T:35190-->The basic functions are system default functions and implements useful functionalities.
==== Min LAST_DAY_OF function (Last day of) ==== <!--T:42197-->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");
<!--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.
==== Constants list NEW_DATE function (New date) ==== <!--T:48204-->** '''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);
<!--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).
==== First day NUM_OF_DAYS function (Number of days) ==== <!--T:51-->Return the first day of a grouping. This function have 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)) 207- 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);
==== Num NUM_OF_MONTHS function (Number of months ) ==== <!--T:55211-->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;
<!--T:213-->
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) ==== <!--T:58214-->Special variables can be use with the expressions.
<!--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>