Property functions
The list shows property functions that you can use in expressions.
Function | Description |
---|---|
$csearch
|
Selects a number of columns from a data
table using a limiting search expression. The first argument is a data table
and the second argument is a string that contains the search expression
determining which column names should be returned. The function returns a list
of the (unescaped) column names from the data table that match the search
expression.
Examples:
→ Returns a list of all values in the data table called Data Table.
→ Returns a list of all values in the data table called Data Table beginning with "Col", e.g., Column 1, Column 2, etc. |
$esc
|
Replaces "] " in column
names with "]] " and encloses the escaped column names in
"[ " and "] ". The argument is a property value
or a property function that starts with a dollar sign ($).
Examples:
→ Returns the property value as a column name (within
→ Returns a list of all columns in the data table called "Data Table" beginning with "Col", e.g., [Column 1], [Column 2], etc. |
$map
|
Maps a list-valued property to a single
string. The first argument is a template to use for each value in the list and
the second argument is a specification of how the list values should be
connected in the resulting expression.
Examples:
→ Returns a comma separated list of the sum of the columns
included in the list-valued property, e.g.,
→ Returns a nested categorical hierarchy using the columns
included in the list-valued property, e.g.,
|
BaseRowId
|
Returns a unique identifier for each
calculated row in the visualization. This identifier is selected from
identifiers calculated on the data table. This value may change when filtering
or marking is performed.
Example:
|
ColumnProperty
|
The first argument is a column and the
second argument is the column property name, presented as a string. Returns the
value of the named column property from the column. The column property value
cannot be a list and the column property has to exist before creating the
expression.
Example:
|
DataTableProperty
|
Returns the value of the data table
property. The argument to the method is the name of the data table property,
presented as a string.
Example:
|
DocumentProperty
|
Returns the value of the document property.
Document properties can be used throughout the entire document.
The argument to the method is the name of the document property, presented as a string. Example:
|
RowId
|
Returns a unique identifier for each
calculated row in the visualization. This identifier will not change when
filtering or marking is performed.
Example:
|