formatter
formatter color
This block defines the threshold values at which the colors used in the dials and graphs in the widgets are to change, and the associated colors that are to be used for each range of values. Multiple color formatters can be used to define different color schemes; each formatter must have a unique name.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
defaultValue |
This property specifies the color that is to be used as default for the formatter. This color will be applied if the value does not match one that is defined in the thresholds property. |
|
||||
label |
Label for the formatter |
|||||
thresholds |
This property defines the threshold values, and the colors that are to be used in the specified ranges. Input alpha-numeric hex codes (e.g. #388e3c) or Decimal code (e.g. rgba(225,69,0, 0.5) for the color, followed by the range the color is to highlight, e.g. #388e3c >=8. |
|
|
|
formatter date
Formats an 7ISO_8601 date to a human-readable form. If emptyValue is undefined and the input date string is invalid (not ISO_8601, including empty), it will present Invalid date. Multiple date formatters can be defined; each date formatter must have a unique name. To customize the 'empty' output, input a string for the emptyValue property.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
datePart |
This property specifies the date part of the input value. Use the "custom" value plus the "inputFormat" property for the custom date part. |
custom |
year | quarter | month | week | day | dayofweek | weekday | hour | calendarmonth | calendarquarter | calendarweek | calendardate | custom |
|||
emptyValue |
This allows you to define a common value or string to be returned in the event a formatter receives an empty value ("", null, undefined, 0 in the case of a number formatter). |
|||||
fiscalFormatString |
This property enables custom formatting for the date string. See [formatting page](https://momentjs.com/docs/#/parsing/string-format/) for details. |
|||||
formatString |
This property enables custom formatting for the date string. See [formatting page](https://momentjs.com/docs/#/parsing/string-format/) for details. |
|
||||
inputFormat |
This property specifies the format of the input data, e.g. DD MMM YYYY. |
|
||||
label |
Label for the formatter |
|||||
locale |
This defines which locale (language or region format) is to be used. (Note that currently only 'en' is supported) |
en |
|
|||
relative |
This property causes the date to be displayed in relative format, e.g. "3 months ago", "a week ago", etc. (true | false). If shortForm is set to true, the date will be presented as e.g. "3mths ago" and "1w ago" respectively. |
false |
true | false |
|
||
shortForm |
This causes the date to be displayed using short form, e.g. "17 Jan '17" instead of "17 January 2017". If relative is also used, then short form will display as "15hrs ago" instead of "15 hours ago". (true | false). |
true |
true | false |
|
formatter number
This defines how numeric values are to be presented. The number formatter will not fail on text strings. If the value is an empty string, the number formatter will fall back to the value specified in emptyValue (if one is specified) or a formatted zero integer. If the value is a non-empty string, the formatter will display the string as-is. (This behavior is possible when expressions with IIF are used in table query and return strings). Multiple number formatters can be used to define different numerical layouts; each formatter must have a unique name.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
decimalSeparator |
Defines the character to be used as the decimal separator. Input e.g. a "." (point). |
. |
|
|
||
emptyValue |
This allows you to define a common value or string to be returned in the event a formatter receives an empty value ("", null, undefined, 0 in the case of a number formatter). |
|||||
indicator |
Always show plus indicator if number is not 0 |
true | false |
||||
integerSeparator |
Defines the character to be used as the thousands separator. Input e.g. a space. |
|
|
|||
keepTrailingZeros |
Specifies whether trailing zeros are to be maintained (e.g. 1.10 is not cut to 1.1). (true | false). |
false |
true | false |
|
|
|
label |
Label for the formatter |
|||||
numberDecimals |
This defines the precision of the value - the number of digits after the decimal point. Input a number. |
2 |
|
|
||
ordinal |
This will format and display the number as Ordinal number. |
false |
true | false |
|||
postfix |
If a symbol or string is required after the value, specify it here. |
|
|
|||
prefix |
If a symbol or string is required before the value, specify it here. E.g. "$". |
|
|
|||
shortForm |
When set to true, K, M or G will be used for large numbers. (true | false). Default is false. |
false |
true | false |
|
|
formatter objectProperty
Formatter to pick property as value from object
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
emptyValue |
This allows you to define a common value or string to be returned in the event a formatter receives an empty value ("", null, undefined, 0 in the case of a number formatter). |
|||||
label |
Label for the formatter |
|||||
property |
Property |
|
formatter period
Formats date part variables and places them in one string.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
datePart |
This property specifies the date part of the input value. |
year | quarter | month | week | day | weekday | hour | calendarQuarter | calendarMonth | calendarWeek | calendarDate |
||||
emptyValue |
This allows you to define a common value or string to be returned in the event a formatter receives an empty value ("", null, undefined, 0 in the case of a number formatter). |
- |
||||
fiscalFormatString |
Allows to format the output for date part variables using a fiscal calendar. |
|||||
formatString |
Allows to format the output for date part variables. |
|||||
label |
Label for the formatter |
formatter text
The text formatter defines how texts are to be displayed. Multiple text formatters can be used to define different text layouts; each formatter must have a unique name. If a text is an empty string and you want to output something specific, use the emptyValue property.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
emptyValue |
This allows you to define a common value or string to be returned in the event a formatter receives an empty value ("", null, undefined, 0 in the case of a number formatter). |
|||||
label |
Label for the formatter |
|||||
length |
You can set the formatter to truncate the text string after it reaches the defined number of characters. Input a number. |
25 |
||||
useDots |
This property adds the ellipses character |
true |
true | false |
formatter value
This is a default value formatter. It makes no transformation to the value, apart from returning the string specified in emptyValue when the value is null or undefined.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
emptyValue |
This allows you to define a common value or string to be returned in the event a formatter receives an empty value ("", null, undefined, 0 in the case of a number formatter). |
|||||
label |
Label for the formatter |
formatter valueMapping [Beta]
This block defines the threshold values at which the emojis/text used in the tiles and cells in the widgets are to change.
| Name | Description | Default value | Available options | |||
|---|---|---|---|---|---|---|
defaultValue |
This property specifies the text/icon/emoji that is to be used as default for the formatter. This text will be applied if the value does not match one that is defined in the thresholds property. |
|||||
label |
Label for the formatter |
|||||
thresholds |
This property defines the threshold values, and the text/emojis that are to be used in the specified ranges e.g, 'text/icon/emoji' > 8 , 'text/icon/emoji' < 8 , 'neutral' = 8. or in the presence of valueMapping threshold entity, it will be mapping the value returned by valueMapping threshold to the text/emoji. |
|