The Nested Field is for displaying nested data that may be displayed into an Accordion.
Property |
---|
Type | Description | Required | Default |
---|
body
...
Enum | |||||
---|---|---|---|---|---|
type | string | The type of field. | No | nested | nested |
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/array/null | 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 | |
collapsed | boolean | Boolean field to define if you want the nested fields collapsed by default or not. | No | true | |
nested_elements | boolean | Boolean field to nest all the nested fields inside a collapsible element. | No | true | |
body | array/DynamicField | List of ordered and formatted fields on the nested body. | No | null | |
collapsed_ | array/DynamicField | Boolean value to represent if the Dynamic Field is collapsed as default state. | No | true | |
nested_elements_ | array/DynamicField | Boolean value to represent if the Nested Fields are surrounded by an Accordion. | No | true | |
label_field | string | Field within the body that will be used as a Label for the Nested Fields. | No | "" |
Code Block | ||||
---|---|---|---|---|
| ||||
{
"type": "nested",
"label": "Nested Information",
"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": "nested.field.path",
"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,
"collapsed": true,
"nested_elements": true,
"body": [
{
"type": "text",
"field": "nested.field1",
"label": "Field 1"
},
{
"type": "number",
"field": "nested.field2",
"label": "Field 2"
}
],
"collapsed_": true,
"nested_elements_": true,
"label_field": "field1"
}
|
Code Block | ||
---|---|---|
| ||
nested_field_example = NestedField(
field="nested.field.path",
body=[
DynamicField(type="text", field="nested.field1", label="Field 1"),
DynamicField(type="number", field="nested.field2", label="Field 2")
]
)
|
...