dot Operators

Color.blue

Property to get/set the blue RGB channel of a Color attribute. Set by number (0-255) or hex (#00-#ff). Get always returns a number sic.

Color.brightness

Property to get/set the the brightness of a Color attribute. The brightness value is always a number (0-100) representing a percentage brightness.

Color.green

Property to get/set the green RGB channel of a Color attribute. Set by number (0-255) or hex (#00-#ff). Get always returns a number sic.

Color.hue

Property to get/set the hue of a Color attribute. The hue value is always a bumber 0-360 representing a circular offset value in degrees for the hue.

Color.red

Property to get/set the red RGB channel of a Color attribute. Set by number (0-255) or hex (#00-#ff). Get always returns a number sic.

Color.saturation

Property to get/set the saturation of a Color attribute. The saturation value is always a number (0-100) representing a percentage saturation.

Date.day

Gets or sets the 1 or 2 digit day for the Date-type attribute specified. Valid range 1-31.

Date.format("formatString")

Formats the date according to the format string.

Date.hour

Gets or sets the 1 or 2 digit hour for the Date-type attribute specified. Valid range 0-23.

Date.second

Gets or sets the 1 or 2 digit minute for the Date-type attribute specified. Valid range 0-59.

Date.second

Gets or sets the 1 or 2 digit minute for the Date-type attribute specified. Valid range 0-59.

Date.month

Gets or sets the 1 or 2 digit month for the Date-type attribute specified. Valid range 1-12.

Date.weekday

Gets read-only day number for the Date-type attribute specified. Value range is 1-7. Days number from 1 (Monday) to 7 (Sunday). This numbering allows easy testing for weekday (#1-5) vs. weekend (#6-7).

Date.year

Gets or sets the 1 to 4 digit year for the Date-type attribute specified.

Interval.day

Gets the duration of the Interval-type attribute specified in whole or partial days.

Interval.hour

Gets the duration of the Interval-type attribute specified in whole or partial hours.

Interval.minute

Gets the duration of the Interval-type attribute specified in whole or partial minutes.

Interval.second

Gets the duration of the Interval-type attribute specified in whole or partial seconds.

List.at(N)

Returns the Nth value of the List as a string. List can be either Set or List type attributes (or string literal, regex, or expression equivalents thereof).

The operator is zero-based, i.e. an N value of 0 returns the first list item, an N of 1 returns value #2, etc. If the value of N exceeds the number of items in the list an empty string (blank value) is returned.

Negatives are allowed, though they work off a 1-based series with -1 being the last item, -2 being the penultimate item, etc.

List.contains("patttern")

This operator tests whether pattern matches the target string attribute or matches a whole discrete value string within a the target list/set attribute value. The match gives a Boolean result. The match is case-sensitive.

The first match, if any, is returned as a 1-based offset. The 1-base ensures all matches, being >= 1, coerce to Boolean 'true' as is needed in a query context.

List: .count

The .count operator lists the number of items in a List (List or Set types). It is the dot operator equivalent of count(list). It is also a more intuitive alternative of List/Set.size. The .size operator was originally envisaged for use with String type data.

It is not necessary to use parentheses after .count, i.e. .count(), as there are no input parameters other than the chained source.

List: .each(var){}

Allows the expression(s) within the trailing {} section to be run on each item in the List. An-loop 'var' is be declared to give reference to the current list item value within the loop code.

List.empty()

Returns a Boolean depending on whether the string/list is empty. If empty, the return value is true, if the attribute has content then false is returned.

List.format("delimiterString")

Allows a list/set to be output as a single concatenated string. A longer 4-parameter version is allowed for creating HTML lists.

List.icontains("patttern")

This operator tests whether pattern matches the target string attribute or matches a whole discrete value string within a the target list/set attribute value. The match gives a Boolean result. The match is case-insensitive.

The first match, if any, is returned as a 1-based offset. The 1-base ensures all matches, being >= 1, coerce to Boolean 'true' as is needed in a query context.

List: .intersect(list)

This returns a list (a Set) of all values in both Lists. It makes no difference to the resulting data which way the two source lists are ordered.

List.isort($AttributeName)

Re-sorts a list or set in case-insensitive lexical order (including string literal lists).

List.max

returns the largest element of a set. N.B., sets are always a string of semi-colon delimited values, even if the values are numbers. If no context is provided, max() compares elements lexically unless every element is a number.

If chaining to literal lists, it can be helpful to enclose the list in parentheses, e.g. (9;4;1;20;5).max

Wiki: Math

min()

returns the smallest element of a list (List or Set types). N.B., lists are always a string of semi-colon delimited values, even if the values are numbers. If no context is provided, min() compares elements lexically unless every element is a number

If chaining to literal lists, it can be helpful to enclose the list in parentheses, e.g. (9;4;1;20;5).max

Wiki: Math

List.nsort($AttributeName)

Re-sorts a list or set in numerical order (including string literal lists).

List.replace()

Note that for lists/set the replace only targets whole values for replacement

List.reverse()

Reverses the current sort of a list or set.

List.size()

Returns the number of items in the list.

List.sort($AttributeName)

Re-sorts a list or set in case-sensitive lexical order (including string literal lists). If Number or Date type attributes are used as optional attribute sort, the sort order is appropriate to data type; numbers sort numerically, ascending and dates in ascending order with 'never' preceding all dates.

List.substr()

Although .substr() can work on lists & sets, it does so upon the stored semi-colon delimited string and is generally thus of less value. Use is thus deprecated in this context.

List.tr()

Simulates the command line tr function allowing all instances of a single [sic] character to be replaced with another. More useful for changing adding invisible control characters (new line, tab, etc.) than for normal characters where .replace works just as well.

List.unique()

Returns the List unsorted but de-duped. akin to passing into a set-type attribute and back.

Number.format(decimalsN,widthN)

Formats a decimal number to a string with decimalsN decimal paces. To aid right-aligning numbers, optionally, widthN left-pads the number with spaces so that widthN = spaces+number; number idoes not count the decimal point character.

Number.precision()

Sets the number of decimal places to show for a non-integer.

Set.at(N)

Returns the Nth value of the List as a string. List can be either Set or List type attributes (or string literal, regex, or expression equivalents thereof).

The operator is zero-based, i.e. an N value of 0 returns the first list item, an N of 1 returns value #2, etc. If the value of N exceeds the number of items in the list an empty string (blank value) is returned.

Set: .count

The .count operator lists the number of items in a List (List or Set types). It is the dot operator equivalent of count(list). It is also a more intuitive alternative of List/Set.size. The .size operator was originally envisaged for use with String type data.

It is not necessary to use parentheses after .count, i.e. .count(), as there are no input parameters other than the chained source.

Set.contains("patttern")

This operator tests whether pattern matches the target string attribute or matches a whole discrete value string within a the target list/set attribute value. The match gives a Boolean result. The match is case-sensitive.

The first match, if any, is returned as a 1-based offset. The 1-base ensures all matches, being >= 1, coerce to Boolean 'true' as is needed in a query context.

Set: .each(var){}

Allows the expression(s) within the trailing {} section to be run on each item in the Set. An-loop 'var' is be declared to give reference to the current list item value within the loop code.

Set.empty()

Returns a Boolean depending on whether the string/list is empty. If empty, the return value is true, if the attribute has content then false is returned.

Set.icontains("patttern")

This operator tests whether pattern matches the target string attribute or matches a whole discrete value string within a the target list/set attribute value. The match gives a Boolean result. The match is case-insensitive.

The first match, if any, is returned as a 1-based offset. The 1-base ensures all matches, being >= 1, coerce to Boolean 'true' as is needed in a query context.

Set: .intersect(list)

This returns a list (a Set) of all values in both Sets. It makes no difference to the resulting data which way the two source sets are ordered.

List.max

returns the largest element of a set. N.B., sets are always a string of semi-colon delimited values, even if the values are numbers. If no context is provided, max() compares elements lexically unless every element is a number.

If chaining to literal lists, it can be helpful to enclose the list in parentheses, e.g. (9;4;1;20;5).max

Wiki: Math

min()

returns the smallest element of a list (List or Set types). N.B., lists are always a string of semi-colon delimited values, even if the values are numbers. If no context is provided, min() compares elements lexically unless every element is a number

If chaining to literal lists, it can be helpful to enclose the list in parentheses, e.g. (9;4;1;20;5).max

Wiki: Math

List.replace() / Set.replace()

Note that for lists/set the replace only targets whole values for replacement

Set.reverse()

Reverses the current sort of a list or set.

Set.size()

Returns the number of items in the list.

Set.substr()

Although .substr() can work on lists & sets, it does so upon the stored semi-colon delimited string and is generally thus of less value. Use is thus deprecated in this context.

Set.tr()

Simulates the command line tr function allowing all instances of a single [sic] character to be replaced with another. More useful for changing adding invisible control characters (new line, tab, etc.) than for normal characters where .replace works just as well.

String.beginsWith()

A simple boolean test to check that a string starts (case-sensitively) with the supplied string literal. Regex patterns are not supported.

Returns the target string, transforming the initial letter of each word to a capital letter and leaving all other characters unchanged. To achieve title case from a mixed case string chain two commands: String.lowercase.capitalize

Trailing parentheses are optional.

Functionally equivalent to capitalize()

String.contains(pattern)

Tests whether a string literal or string-type attribute matches a string literal or regular expression on a case-sensitive basis.

The first match, if any, is returned as a 1-based offset. The 1-base ensures all matches, being >= coerce to Boolean 'true' as is needed in a query context.

String.countOccuranceOf("string")

Returns the Number of times that the literal 'string' appears in the String. No match returns zero.

String.empty()

Returns a Boolean depending on whether the string/list is empty. If empty, the return value is true, if the attribute has content then false is returned.

This is the same as short-from test !$StringAttribute for an unpopulated string.

String.endsWith()

A simple boolean test to check that a string ends (case-sensitively) with the supplied string literal. Regex patterns are not supported.

String.find()

Returns a number with the location of the first occurrence of a substring within the source string. The operator searches for literal strings, not regular expressions. Matches are case sensitive. The offset is zero-based (position 1 is zero). If the string is not found, String.find() returns -1.

String.icontains(pattern)

Tests whether a string literal or string-type attribute matches a string literal or regular expression on a case-insensitive basis.

The first match, if any, is returned as a 1-based offset. The 1-base ensures all matches, being >= coerce to Boolean 'true' as is needed in a query context.

String.json()

This operator (added in v5.7.0) returns a JSON-encoded UTF-8 version of a string attribute's value. The straight double quote, solidus (forward slash) and backslash characters are all escaped by a preceding backslash character.

Prior to v5.11.2 the apostrophe (straight single quote) was escaped but this was dropped as it interferes with some AJAX functions in browsers (and is not required by the JSON spec).

String.lowercase()

Returns the string is all lowercase characters.

Trailing parentheses are optional.

Functionally equivalent to lowercase()

String.replace(pattern, replacment)

Replace all instances of pattern with replacement in string literal or string-type attribute.

String.size()

Returns the number of characters in the string - read-only.

String: .speak()

String.split()

Splits a string in to a list based on instances of 'patter' in the source string. 'pattern' may be quoted string literal or a regular expression.

String.substr(startN,lengthN)

Read-only. Can get lengthN characters from startN position. startN is zero-based and negative numbers (1-based) work back from the end of the string. If lengthN is omitted everything from startN to end of string is returned.

String.toNumber

Explicit coercion from a string containing numerals to a number. This is occasionally needed as in most cases tinderbox coerces a mix of string/number to a resulting string.

String.tr()

Simulates the command line tr function allowing all instances of a single [sic] character to be replaced with another. More useful for changing adding invisible control characters (new line, tab, etc.) than for normal characters where .replace works just as well.

String.uppercase()

Returns the string is all uppercase characters.

Trailing parentheses are optional.

Functionally equivalent to uppercase()

String: .words()