Class

SpotfireColumnRelation

SpotfireColumnRelation(leftTable, leftColumn, rightTable, rightColumn, whenExisting, leftColumnTransformation, rightColumnTransformation)

Describes the relationship between two data tables.

Constructor

new SpotfireColumnRelation(leftTable, leftColumn, rightTable, rightColumn, whenExisting, leftColumnTransformation, rightColumnTransformation)

Parameters:
Name Type Description
leftTable String

The name of the data table for which you wish to define a relation.
leftColumn String

The name of the column from the left data table to be used in the matching of rows.
rightTable String

The name of the data table to relate to the left data table.
rightColumn String

The name of the column from the right data table to be used in the matching of rows.
whenExisting SpotfireWhenExistingBehaviors ▼

How to behave when there is already a relation existing between two data tables. Only relevant for data table relations.
add String

Add behavior.
replace String

Replace behavior.
leftColumnTransformation SpotfireColumnTransformations ▼

Transformation method to use to modify the content of the left column. What methods are available depends on the data type of the column.
none String

No transformation, use the raw value.
date String

Convert the value to date.
time String

Convert the value to time.
dateTime String

Convert the value to date time.
timeSpan String

Convert the value to time span.
days String

Convert the value to days.
hours String

Convert the value to hours.
minutes String

Convert the value to minutes.
seconds String

Convert the value to seconds.
string String

Convert the value to string.
real String

Convert the value to real.
integer String

Convert the value to integer.
longInteger String

Convert the value to longInteger.
singleReal String

Convert the value to singleReal.
currency String

Convert the value to currency.
boolean String

Convert the value to boolean.
upper String

(For string only) Convert the value to upper case.
lower String

(For string only) Convert the value to lower case.
len String

(For string only) Convert the value to the length of the string.
trim String

(For string only) Remove whitespaces on the string.
parseReal String

(For string only) Convert string to real.
nameEncode String

(For string only) Encode the value using name convention (0-9a-ZA-Z and . only).
nameDecode String

(For string only) Decode the value using name convention (to utf16 encoding).
base64Decode String

(For string only) Decode the value of a base64 string.
rightColumnTransformation SpotfireColumnTransformations ▼

Transformation method to use to modify the content of the right column. What methods are available depends on the data type of the column.
none String

No transformation, use the raw value.
date String

Convert the value to date.
time String

Convert the value to time.
dateTime String

Convert the value to date time.
timeSpan String

Convert the value to time span.
days String

Convert the value to days.
hours String

Convert the value to hours.
minutes String

Convert the value to minutes.
seconds String

Convert the value to seconds.
string String

Convert the value to string.
real String

Convert the value to real.
integer String

Convert the value to integer.
longInteger String

Convert the value to longInteger.
singleReal String

Convert the value to singleReal.
currency String

Convert the value to currency.
boolean String

Convert the value to boolean.
upper String

(For string only) Convert the value to upper case.
lower String

(For string only) Convert the value to lower case.
len String

(For string only) Convert the value to the length of the string.
trim String

(For string only) Remove whitespaces on the string.
parseReal String

(For string only) Convert string to real.
nameEncode String

(For string only) Encode the value using name convention (0-9a-ZA-Z and . only).
nameDecode String

(For string only) Decode the value using name convention (to utf16 encoding).
base64Decode String

(For string only) Decode the value of a base64 string.