Timeline reference¶
To display events related to time in exhaustive way
Parameters¶
Required¶
You must fill these parameters to produce a Timeline
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| dataset | string | Dataset | | |
| startDate | Start date | string (Column of dataset expected) | Column containing the date of each event | |
| meta | | | ||
| text | string (Column of dataset expected) | Column containing a description of each event | | |
| headline | string (Column of dataset expected) | Column containing a short title for each event | | |
| endDate | End date | string (Column of dataset expected) | Column containing the end date of each event | |
Optional¶
You can let these parameters unset if you do not need them
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| mobileSize | Mobile Size | number | Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| mediaType | Media type | string (Column of dataset expected) | Column containing the type of media | The column should contain external or asset as values |
| content | Content | string (Column of dataset expected) | Column containing another content to be display under the text | |
| style | Custom CSS class | string | amazing-class | Set a custom CSS class to target this specific chart with CSS |
| tutorial | Tutorial | object | | |
| tutorial/content | Message | string | Enter your message | This will be displayed to your users |
| tutorial/alwaysShow | Always show this tutorial | boolean | | By default the tutorial is shown once only |
| tutorial/id | string | Enter an ID | Change the ID to display the tutorial again. All tutorials with the same ID will be displayed only once. | |
| caption | Image’s legend | string (Column of dataset expected) | Column containing a text to be displayed under the image/media | |
| size | Size | number | Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| mediaSource | Media | string (Column of dataset expected) | Column containing the address/name of the media | The URL for an external image or the name of the asset |
Others¶
This parameters are either common to all charts, or hidden from studio. You can use them in code mode, but it’s not recommended !
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| source | string | | | |
| comment | string | | |