...

To represent a text in its original form. Use this type if you cannot determine the source definition. Try to avoid this type of numbers or dates because the sorting functionality will not work properly in such cases.

If a string contains formatting, for instance line breaks, they will be ignored. In case you need formatting features, see the column types:

• Text

• HTML

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

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: 'Priority'
  key: 'Priority'
  type: 'pill'
  options:
    allowMarkup: markdown
    defaultColor: "#0022dd"
    highlight:
      - value: "1 - Low"
        color: "#C6DDF0"
      - value: "2 - Medium"
        color: "#C99DA3"
      - value: "3 - High"
        color: "#996888"
  showInTableHeader: true
  showInDetailList: true

Text

type: text

Markup

In case you need formatting features, you can use this type. The formatting features are activate the allowMarkup option.

Markdown

The formatting can be based on Markdown (see: https://en.wikipedia.org/wiki/Markdown for details on how to use it). This markup language is used as well-known for its use in documentation software and content management systems like Wikimedia or Atlassian Confluence. The feature set is limited, but therefore especially useful for: Headings, Numbering, Highlighting, and so on.

Generally it is not recommended using this data type option if the column is shown in the table (showInTableHeader should be false).

- label: 'WorklogCreator'
  key: 'descriptioncreator'
  type: 'textstring'
  showInTableHeader: false
  showInDetailList: true
  options:
    allowMarkup: markdown

HTML

type: html

This type option can be used for advanced formatting and extended functionality inside the UI. Since the Portrait Frontend in itself uses HTML for markup declaration, the risk of interference and therefore a malfunctioning Portrait-App is high. Therefore, it is very important to provide clean and safe data inside this column.

Generally it is not recommended using this data type if the column is shown in the table (showInTableHeader should be false).

- label: 'Article'
  key: 'content'
  type: 'html'
  showInTableHeader: false
  showInDetailList: true
  options:
    allowMarkup: html

Preserve Line Breaks

If your text has longer text including line breaks, and you want to preserve them, you can activate the option newline. In combination with the allowMarkup option, the rendering of content is very flexible.

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

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: 'Priority'
  key: 'Priority'
  type: 'pill'
  options:
    allowMarkup: markdown
    defaultColor: "#0022dd"
    highlight:
      - value: "1 - Low"
        color: "#C6DDF0"
      - value: "2 - Medium"
        color: "#C99DA3"
      - value: "3 - High"
        color: "#996888"
  showInTableHeader: true
  showInDetailList: true

Double

type: decimal,2

Use this definition to show the column values as a Floating Point- Number (e.g.: 12,34). In case of the type decimal, you must provide a number of digits for the fractional parts. For Typically this would be two digits:

...