Describes a data field of the restructured data.
- Source:
Classes
Methods
(static) described_field.copyWithoutGroups(describedDataField) → {module:described_field.DescribedDataField}
Creates a new described data field with all properties of the original one except for dynamically added groups.
Parameters:
| Name | Type | Description |
|---|---|---|
describedDataField |
module:described_field.DescribedDataField |
- Source:
Returns:
Type Definitions
DescribedDataField
Describes a field of the restructured data. Dynamically added properties represent custom named groups containing DescribedDataField-Arrays.
Type:
- Object
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
category |
string |
<optional> |
"" | name of the category. Could contain a short domain name like "product" or "vendor". |
type |
string |
<optional> |
"" | type of the data element. Examples: "summary" for e.g. a list overview. "detail" e.g. when a summary is selected. "filter" e.g. for field/value pair results that can be selected as data filters. |
abbreviation |
string |
<optional> |
"" | one optional character, a symbol character or a short abbreviation of the category |
image |
string |
<optional> |
"" | one optional path to an image resource |
index |
string | array of numbers containing the splitted index. Example: "responses[2].hits.hits[4]._source.name" will have an index of [2,4] |
||
groupNames |
Array.<string> | array of names of all dynamically added properties representing groups |
||
displayName |
string | display name of the field |
||
fieldName |
string | field name |
||
value |
Object | content of the field |
||
couldBeAnyCustomGroupName |
Array.<module:described_field.DescribedDataField> |
<optional> |
any number of groups attached to the field each containing multiple fields |
- Source: