Stackedbarchart reference¶
Good to visualise a breakdown by category for a whole entity
Parameters¶
Required¶
You must fill these parameters to produce a Stackedbarchart
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| label | Label | string (Column of dataset expected) | Column containing bars label | |
| dataset | string | Dataset | | |
| meta | | | ||
| value | Value | string (Column of dataset expected) | Column containing group value | |
| lines | object | | | |
| lines/smoothLine | Smooth line | boolean | | Interpolate between points to ‘smooth’ the line |
| lines/x | X axis | string (Column of dataset expected) | Column name containing x axis values | Same as bars label |
| lines/y | Y axis | string (Column of dataset expected) | Column name containing y axis values | |
| groups | Groups | string (Column of dataset expected) | Column containing bars breakdown | Will be displayed as colors inside the bar |
| metaSerie | | |
Optional¶
You can let these parameters unset if you do not need them
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| labelsOrder | Labels order | | Use it to order labelsOverwrite the sort bars option | |
| hideTotal | Hide bar total | boolean | | |
| groupsOrder | Groups order | | Use it to order groups | |
| urlLabels | URL link | string (Column of dataset expected) | Column containing url link | Add url link to bars label.Works only on horizontal display |
| packs | Packs | string (Column of dataset expected) | Column containing grouping of bars | For horizontal display only |
| packNames | Display packs names | boolean | | |
| hideEmptyGroups | Hide empty groups | boolean | | |
| variation | Variation | string (Column of dataset expected) | Column containing variation | Add a colored dot on the groups |
| showValues | Display all values | boolean | | Horizontal mode onlyIf your data contain negative valuestotal won’t be displayed on top of the bar |
| tickFormat | Custom date format (for date labels) | string | d3 time format. i.e. ‘%Y’ for years | Customize the date display on the axisUse d3 time format |
| legend | Display legend | boolean | | |
| disableZoomIn | Disable zoom in animation | boolean | | The chart will be zoomable (if activated), but will not transition to a zoomed state.All bars will remain visible. |
| packsOrder | Packs order | | Use it to order packs | |
| lines/showValues | Show all values on line | boolean | | |
| lines/commonScale | Use same scale for bars and lines | boolean | | |
| defaultSelected | Bar selected by default | | first, last or the name of the label | |
| disableZoom | Disable zoom | boolean | | The chart will not be zoomable.All bars will remain visible. |
| displayDirection | Choose display direction | string | | |
| 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. | |
| style | Custom CSS class | string | amazing-class | Set a custom CSS class to target this specific chart with CSS |
| size | Size | number | Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| sort | Sort bars | string | | Sort by value |
| mobileSize | Mobile Size | number | Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| visualSelection | Highlight selected bar | boolean | | Display rectangle around selected bar |
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 | | | |
| sentiment | object | | | |
| persistentGroupColors | Recycle groups colors | boolean | | when chart data changes (filters or requesters) |
| crossfilter | object | | Use it for crossfilter configurationShould be configured on the primary chart | |
| crossfilter/datasets | Select the filtered datasets | array | | Datasets that will be filtered on the ‘on’ column |
| crossfilter/on | on column | string (Column of dataset expected) | Column existing in primary and filtered datasets | |
| displayType | Choose display type | string | | |