Linechart reference¶
Analyze trends and evolution overtime of one or more KPI
Parameters¶
Required¶
You must fill these parameters to produce a Linechart
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| metaSerie | | | ||
| x | X axis | string (Column of dataset expected) | Column containing time dimension | |
| value | Y axis | string (Column of dataset expected) | Column containing line value | |
| dataset | string | | | |
| meta | | |
Optional¶
You can let these parameters unset if you do not need them
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| size | Size | number | Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| events | Events | | Add contextual information on your lineAs the user navigate, some text can pop-up on specific dates | |
| showValues | Show all values on line | boolean | | Warning: this is not recommended |
| showMissingValues | Display missing values | boolean | | When a value seems missing, cut the line instead of joining points together |
| smoothLine | Smooth line | boolean | | Interpolate between points to ‘smooth’ the line |
| recycleColors | Recycle line colors | boolean | | Reuse line color when chart data changes (filters or requesters) |
| commonScale | Don’t adapt y axis | boolean | | Resize the y axis when filtering |
| reflectOrderInLegend | Reflect value order in the legend | boolean | | |
| serieLegendOrder | Series order | | For legend display only | |
| defaultSelected | Default value selected | string | | First, last, report or the name of the xValue |
| xOrder | X axis order | | Use this if your x axis is not a time dimension | |
| xLegend | Legend for x axis | string | Enter text | |
| customTimeFormat | X axis date format | string | Type D3 time format. i.e. ‘%Y’ for years | Customize the date display on the axisUse d3 time format |
| serie | Series label | string (Column of dataset expected) | Column containing lines names | |
| zeroBaseline | Y axis baseline | | Y value on which to position the x axisBy default, set to 0 | |
| tutorial | Tutorial | object | | |
| tutorial/alwaysShow | Always show this tutorial | boolean | | By default the tutorial is shown once only |
| tutorial/content | Message | string | Enter your message | This will be displayed to your users |
| 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. | |
| dashedLines | Dashed lines | | Choose the line which will be dashed | |
| fixedSelection | Maintain selection | boolean | | Keep the selection when clicking on a point |
| mobileSize | Mobile Size | number | Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| ticks | Ticks display | object | | |
| ticks/displayAllYTicks | Display all y ticks | boolean | | Will overwrite ‘smart’ ticks display |
| ticks/customXTicks | Add x ticks manually | array | | Choose the x values to diplay as ticks |
| ticks/displayAllXTicks | Display all x ticks | boolean | | Will overwrite ‘smart’ ticks display |
| ticks/showTickLines | Show ticks indicators | boolean | | |
| ticks/hideXTickLimits | Hide start and end ticks | boolean | | |
| yLegend | Legend for y axis | string | Enter text | |
| sentimentZones | Color zones | array | | Add colored zones. You can add multiple zones one by one |
| alwaysDisplayEvents | Always display all events | boolean | | |
| domain | Scale | array | e.g. [0, 500] | Enter two value to define the min and max scale on which you want to display the linechart |
| legend | Display legend | boolean | | |
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 |
| style | string | | |