Bulletchart reference¶
To display a value against a goal
Parameters¶
Required¶
You must fill these parameters to produce a Bulletchart
parameters | label | type | description (placeholder | tooltip) |
---|---|---|---|
meta | | | ||
label | Label | string (Column of dataset expected) | Column containing bars label | |
dataset | string | Dataset | | |
target | string (Column of dataset expected) | Column containing the target value | Will be represented as a vertical bar | |
value | Value | string (Column of dataset expected) | Column containing bar value | |
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 |
sparklines | Sparklines | object | | Add a line to represent the trend of the value for each label.Learn more right here |
sparklines/date | string (Column of dataset expected) | Column containing the time dimension | | |
sparklines/dateFormat | Date display format | string | Describe how to display the date | OptionalUse d3 time format (like ‘%Y’ to display just years) |
sparklines/commonScatter | Common scale | boolean | | Use the same scale for all sparklines (y axis) |
sparklines/legend | string | Type in a legend | Optional | |
sparklines/forceLexicalOrder | Automatic date ordering | boolean | | Set to false to disable lexical reordering of ordinal dates |
sparklines/showMissingValues | Show missing values | boolean | | Display missing values as blank/white linesBy default missing values are filtered outto display a continuous line |
defaultSelected | Bar legend expanded by default | | | |
notAlignTargets | Remove targets alignment | boolean | | |
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. | |
size | Size | number | Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1 |
comparison | string (Column of dataset expected) | Column containing comparison value | Will be displayed as an overlay around the bars | |
style | Custom CSS class | string | amazing-class | Set a custom CSS class to target this specific chart with CSS |
rank | Display ranks for sorted bars | boolean | | |
packs | Packs | string (Column of dataset expected) | Column containing grouping of bars | |
colorTargets | Add colors on target tick | boolean | | Use it to visualy see our target reach |
labelsOrder | Labels order | | Use it to order labels | |
packsOrder | Packs order | | Use it to order packs | |
legend | Display legend | boolean | | |
packsName | Display packs names | boolean | | |
commonScale | Use same scale for all bars | 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) |
---|---|---|---|
sparklines/unit | string | | | |
sparklines/datesOrder | | | ||
sparklines/orderDates | boolean | | | |
source | string | | | |
comment | string | | |