Versuschart reference¶
Display 2 dimensions, can be used as an age pyramid
Parameters¶
Required¶
You must fill these parameters to produce a Versuschart
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| label | object | | | |
| label/right | string | Type the name of one of the labels | Name of the right side variable | |
| label/column | string (Column of dataset expected) | Column containing the variables to compare | | |
| label/left | string | Type the name of one of the labels | Name of the left variable | |
| value | string (Column of dataset expected) | Column containing the value | | |
| category | string (Column of dataset expected) | Column containing the dimensions/metric to be compared | Dimensions/metric to be compared | |
| dataset | string | | |
Optional¶
You can let these parameters unset if you do not need them
| parameters | label | type | description (placeholder | tooltip) |
|---|---|---|---|
| domain | Scale | array | | Use it to define the bars scale.Choose 2 boundsIf you’re displaying %, try a 0 to 100 |
| commonScale | Use same scale for all categories | boolean | | |
| size | Size | number | Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| style | Custom CSS class | string | amazing-class | Set a customm CSS class to target this specific chart with CSS |
| 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. | |
| zeroBaseline | Versus baseline | integer | Type in an integer | By default, set to 0 |
| mobileSize | Mobile Size | number | Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1 |
| categoriesOrder | Categories order | | Use it to order categories |
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) |
|---|---|---|---|
| comment | string | | | |
| source | string | | |