The Number Field allows you to give a display format to numbers being these strings, ints or floats. For example with the format 1,.2 you may transform a "2,3324120424..." number in the database to a more user friendly display like "2,33".
NumberField
...
The join specification is a substring that will be used for numeric concatenation if multiple numbers are displayed at the same time, that way a join value of "|" will be used to join the list [123, 456, 789] as "123|456|789".
Note |
---|
while using format strings adding a number after a comma instead of a dot will cause a rendering error and the number field won't be displayed. Example of this behavior would be "1,2" instead of "1,.2". |
Schema Details
Property | Type | Description | Required | Default | Enum |
---|
type | string | The type of field. | No | number | number |
label | string/null | Label to show for this field. | No | null |
|
css_style | object/null | Style to apply in the HTML of the UI. | No | null |
|
css_class | string/null | CSS class to apply in the HTML component. | No | null |
|
translate | string/null | Translation key for the field. | No | null |
|
translate_label | string/null | Translation key for the label. | No | null |
|
analytics | object/null | Analytics configuration. | No | null |
|
if_not_exist | string/null | Show only if the specified field doesn't exist. | No | null |
|
if_exist | string/null | Show only if the specified field does exist. | No | null |
|
only_on_highlight | boolean | Show only when the value is highlighted. | No | false |
|
display | any | Value from the field. | No | null |
|
field | string | Path to field from which to retrieve the value (in JMESPath format). | Yes |
|
|
field_highlight | string/null | Path to highlight field from which to retrieve the value, in case it is not the same as the field parameter (in JMESPath format). | No | null |
|
default | any | Default value to use in case no value was found for the field. | No | null |
|
transform | array/string/null | List of transformations to apply to the displayed values. | No | null |
|
suffix | string/null | Suffix to append to the value or values. | No | null |
|
prefix | string/null | Prefix to append to the value or values. | No | null |
|
suffix_label | string/null | Suffix to append to the label of the field. | No | null |
|
prefix_label | string/null | Prefix to append to the label of the field. | No | null |
|
sort | string/boolean | Sort order for values in an array. | No | false | asc, desc |
unique | boolean | If the values are in an array, remove the duplicates. | No | false |
|
show_blank | boolean | If there is no value, or value is null, and show_blank is true, keep the field. | No | false |
|
replacement | string/null | Replacement string for matches in the transformations Transformation.REPLACE_FIRST , Transformation.REPLACE_LAST , and Transformation.REPLACE_ALL . | No | null |
|
pattern | string/null | Pattern used to look for matches in the transformations Transformation.REPLACE_FIRST , Transformation.REPLACE_LAST , and Transformation.REPLACE_ALL . | No | null |
|
format | string | Format of the number value. | No | 1,.2 |
|
join | string | String to join multiple values. | No |
|
|
Example JSON Representation
Code Block |
---|
|
{
"type": "number",
"label": "Quantity",
"css_style": null,
"css_class": null,
"translate": null,
"translate_label": null,
"analytics": null,
"if_not_exist": null,
"if_exist": null,
"only_on_highlight": false,
"display": null,
"field": "quantity",
"field_highlight": null,
"default": null,
"transform": null,
"suffix": null,
"prefix": null,
"suffix_label": null,
"prefix_label": null,
"sort": false,
"unique": false,
"show_blank": false,
"replacement": null,
"pattern": null,
"format": "1,.2",
"join": "| "
}
|
Code Example of Usage
Code Block |
---|
|
number_field_example = NumberField(
field="quantity",
format="1,.2",
join="| "
|
_NumberFieldUI
...
Example Configuration
Code Block |
---|
|
NumberField(label='Popularity', field='metadata.popularity', format='1.2') |