Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The timeline view lets you represent data in a chronological order.

...

Timeline views need 2 configuration fields:

dateStartField (string, required)

The field key that should be used to get the start of the timeline activity. For example a section config like this:

Code Block
{
  "dateStartField": "Begin",
  "dateEndField": "End"
}

Would expect each entry to have a Begin and Endfield with the begin/end dates.

Example data for this section config:

Code Block
{
  "lastUpdated": 1658756953,
  "sourceIdentifier": "tasks",
  "data": {
    "Begin": "2022-04-07",
    "Title": "Activate SSL-Certificates",
    "End": null
  },
  "name": "Activate SSL-Certificates",
  "key": "POR-4"
},
{
  "data": {
    "Begin": "2022-03-30",
    "Title": "Assign Roles",
    "End": "2022-04-04"
  },
  "name": "Assign Roles",
  "key": "POR-1"
},
Info

Dates need to be supplied in the ISO 8601 format, YYYY-MM-DD. For example: 2022-04-07

dateEndField (string, optional)

Same as the dateStartField but for the end of the activity. If left blank, the activity will be considered a one-day event and be displayed as such.