...

- label: 'Creator'
  key: 'creator'
  type: 'string'
  hideIfEmpty: true
  showInTableHeader: true
  showInDetailList: true

...

- label: 'Description'
  key: 'desc'
  type: 'string'
  showInTableHeader: false
  showInDetailList: true
  options:
    newline: preserve

Hide fields if they are empty

You can define, if a field should be hidden in the detail view, if the value is empty.

In this example, the Creator field is hidden, if it is empty:

- label: 'Creator'
  key: 'creator'
  type: 'string'
  hideIfEmpty: true
  showInTableHeader: true
  showInDetailList: true

By default, the field is shown even though, the value is empty.

Pill

type: pill

The pill lets you color highlight specific values (e.g. “To-Do” is blue, “In Progress” is yellow, “Done” is green). The pill can be either used inside the list and inside the detail view.

...

- label: 'Is completed'
  key: 'isCompleted'
  type: 'boolean'
  showInTableHeader: true
  showInDetailList: true

The following values, and their string representations, are considered as false: false, 0, null, '', undefined.

Form

type: form

Allow opening forms directly from a given entry. The form can be opened with given data of the entry when the property forwardProperties forwardFields is configured.

- label: 'New Opportunity'
  type: 'form'
  key: 'createOpportunity'
  icon: 'briefcase'
  showInTableHeader: false
  showInDetailList: true
  options:
    forwardProperties:forwardFields:
      - COMPANY_REFERENCE,
      - COMPANY_NAME,
      - SOURCEID

In this example, the form 'createOpportunity' can be opened via the button 'New Opportunity' inside the detail-view of an entry. The values COMPANY_REFERENCE, COMPANY_REFERENCE or SOURCEID are passed into the form. The button has the icon 'briefcase'.

...

The icon property defines what glyph is shown in the button. The list of possible icons is based on the https://feathericons.com/ library and are open source. The feather icon site lets you search for icons and use the icon name inside the property (e.g. phone).

- label: 'Send Request'
  key: 'requestMailto'
  type: 'action'
  icon: 'phone'
  showInTableHeader: false
  showInDetailList: true

Tables

type: table

This type can be used to show a list of objects as a table. In conjunction with the ELO maps this can represent tables with columns and a given list of lines.

- label: 'Taxes'
  key: 'map_objekte_TAX_AMOUNT'
  type: 'table'
  options:
    allowMarkup: markdown
    tableWidth: auto
    columns:
      - label: Net Amount
        field: TAX_AMOUNT_POS_NET
      - label: VAT in %
        field: TAX_AMOUNT_IN_PERCENT
      - label: VAT in €
        field: TAX_AMOUNT_IN_EUR
  showInTableHeader: false
  showInDetailList: true 

Options:

• tableWidth either ‘fixed’ or 'auto'

Download

type: download

This type will show a download button for the linked document (next to possibly defined actions). This type is only effective if the entry is connected to a document (currently only possible for entries coming from ELO sources). For this type the configuration value key has no effect – it will therefore be ignored.

...

This type will show a horizontal bar chart to use for visualizing progress or similar data. You can pass a configuration object where you can specify which keys from the entries the chart should use, and their color in the chart.

...

- label: 'Progress'
  key: ''
  type: 'stackedBarChart'
  showInTableHeader: false
  showInDetailList: true
  options:
    defaultColor: '#0022dd',
    stackedBarChart:
      - key: 'Remaining'
        color: '#C6DDF0'
      - key: 'Spent'
        color: '#C99DA3'
      - key: 'Excess'
        color: '#996888'

If you have an entry with these data fields:

...

A stacked bar chart type with the above configuration will create a diagram that shows 50% Remaining “Remaining” in color #C6DDF0, 40% Spent “Spent” in color #C99DA3 and 10% Excess “Excess” in color #996888.