Linechart with events reference

Add events to contextualize historical data

Overview

📖 Learn More about the Linechart with events here.

📖 Find examples on the Linechart with events here.

Parameters

Required

You must fill these parameters to produce a Linechart with events

parameters label type description (placeholder | tooltip)
dataset   string |
legend Display legend boolean |
value   string (Column of dataset expected) Column containing line value |
date   string (Column of dataset expected) Column containing the time dimension |

Optional

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

parameters label type description (placeholder | tooltip)
meta Additional info   | Will be displayed in the legend
showValues Show all values on line boolean | Warning: this is not recommended
ticks   object |
ticks/displayAllYTicks Display all y ticks boolean | Will overwrite ‘smart’ ticks display
ticks/displayAllXTicks Display all x ticks boolean | Will overwrite ‘smart’ ticks display
ticks/tickFormat x ticks format string Describe how to display the date in the ticks | Use d3 time format. i.e. ‘%Y’ to display just years
ticks/hideXTickLimits Hide start and end ticks boolean |
xLegend Legend for x axis string Enter text here |
tutorial Tutorial object |
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.
tutorial/content Message string Enter your message | This will be displayed to your users
zeroBaseline Y axis baseline   | Y value on which to position the x axisBy default, the lowest y value will be used
groups groups : multi-linechart string (Column of dataset expected) Column containing the name of the different lines |
yLegend Legend for y axis string Enter text here |
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1
dateFormat Legend display format string Describe how to display the date in the legend | Use d3 time format (like ‘%Y’ to display just years)
groupsOrder Lines order   | For legend display only
metaSerie Lines additional info   | Will be displayed in the legendFor each line
events     | Add contextual information on your lineAs the user navigate, some text can pop-up on specific dates
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
smoothLine Smooth boolean | Interpolate between points to ‘smooth’ the line
selectLastDate Select last date boolean | Always select the last date while changing filters
commonScale Don’t adapt y axis when filtering boolean | To resize the y axis
showMissingValues Display missing values boolean | When a value seems missing,cut the line instead of joining points together

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)
crossfilter   object | Use it for crossfilter configurationShould be configured on the primary chart
crossfilter/on on column string (Column of dataset expected) Column existing in primary and filtered datasets |
crossfilter/datasets Select the filtered datasets array | Datasets that will be filtered on the ‘on’ column
sentimentZones   array |
ticks/xTicks Number of max of x ticks integer Specify number maximum of x ticks to be displayed |
comment   string |
datesOrder     |
style   string |
domain Boundary values for Y axis array e.g. [0, 500] |
groupsStyle   string (Column of dataset expected) |
reflectOrderInLegend Reflect value order in the legend boolean |
source   string |