Timeline reference

To display events related to time in exhaustive way

Overview

📖 Learn More about the Timeline here.

📖 Find examples on the Timeline here.

Parameters

Required

You must fill these parameters to produce a Timeline

parameters label type description (placeholder | tooltip)
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 |
dataset   string |
startDate Start date string (Column of dataset expected) Column containing the date of each event |

Optional

You can let these parameters unset if you do not need them

parameters label type description (placeholder | tooltip)
content   string (Column of dataset expected) Column containing another content to be display under the text |
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 of the media (e.g. the URL for an image) |
tutorial Tutorial object | Help your users understand how to use the chart!This will be displayed the first time your user uses the chart
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.
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
meta Additional info   | Will be displayed under the datein the timeline boxes (bottom)
mediaType Media type string (Column of dataset expected) Column containing the type of media for each media source |
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1

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 |
style   string |