Leaderboard reference

Rank among categories

Overview

📖 Learn More about the Leaderboard here.

📖 Find examples on the Leaderboard here.

Parameters

Required

You must fill these parameters to produce a Leaderboard

parameters label type description (placeholder | tooltip)
dataset   string |
label   string (Column of dataset expected) Column containing bar label |
legend     |
meta     |
value   string (Column of dataset expected) Column containing bar value |
metaSerie     |

Optional

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

parameters label type description (placeholder | tooltip)
hideEmptyVariation Hide empty variations boolean |
childrenOrder Drill children order   | Use it to order children
recycleColors Recycle groups colors boolean | Reuse groups color when chart data changes (filters or requesters)
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1
packNames Display pack names boolean |
additionalValues Additional values array | Display additional values next to the main oneWill not be displayed on mobile
average Average   | Add a vertical average bar
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.
packs   string (Column of dataset expected) Column containing grouping of bars |
packsOrder Packs order   | use it to order packs
drill Drill object | Your dataset must contain both parents and children values. To do so, use our hierachical rollup VQB step
drill/parent Parents string (Column of dataset expected) Column containing parent labels |
domain Scale array | Use it to define the bars scale.Choose 2 boundsIf you’re displaying %, try a 0 to 100
labelPosition Position of the bar labels string |
variation   string (Column of dataset expected) Column containing variation values |
groupsOrder Groups order   | Use it to order groups
defaultSelected Bar selected by default   |
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
groups   string (Column of dataset expected) Column containing grouping of bars |
sort   string |
rank Display rank for sorted bars boolean |
variationLegend Variation legend string Enter the legend for your variation |
sparklines Sparklines object | Add a line to represent the trend of the value for each labelMake sure you have define an historical datasetfrom the dataset editor menu.Learn more right here
sparklines/dateFormat Date display format string Describe how to display the date | OptionalUse d3 time format (like ‘%Y’ to display just years)
sparklines/showMissingValues Show missing values boolean | Display missing values as blank/white linesBy default missing values are filtered outto display a continuous line
sparklines/commonScatter Common scale boolean | Use the same scale for all sparklines (y axis)
sparklines/prefix   string Type in text | OptionalAdd a prefix to value display
sparklines/forceLexicalOrder Automatic date ordering boolean | Set to false to disable lexical reordering of ordinal dates
sparklines/date   string (Column of dataset expected) Column containing the time dimension |
sparklines/value   string (Column of dataset expected) Column containing the line value |
sparklines/legend   string Type in a legend | Optional
averageText Average legend string Enter text |

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 |
children   object |
children/order     |
children/parent   string |
children/root   string |
children/id   string |
style   string |
reverse     |
source   string |
sentiment   object |
highlighted     |
lazyLoad   boolean |
sparklines/units   object |
sparklines/data   object |
sparklines/data/units   object |
sparklines/data/geofeatures   object |
sparklines/data/geofeatures/query   [‘object’, ‘array’] |
sparklines/data/geofeatures/join   object |
sparklines/data/geofeatures/join/how   string |
sparklines/data/geofeatures/join/on   object |
sparklines/data/geofeatures/join/on/features   string |
sparklines/data/geofeatures/join/on/data   string |
sparklines/data/dimensions   array |
sparklines/data/highlighted     |
sparklines/data/postprocess   array |
sparklines/data/precision     |
sparklines/data/date     |
sparklines/data/hierarchy   object |
sparklines/data/hierarchy/parent   array |
sparklines/data/hierarchy/root   array |
sparklines/data/hierarchy/id   array |
sparklines/data/query     |
sparklines/data/order     |
sparklines/data/pipeline   array |
sparklines/data/history   object |
sparklines/data/history/joins   array |
sparklines/data/history/data   object |
sparklines/data/history/data/query     |
sparklines/data/history/data/postprocess   array |
sparklines/data/history/data/precision     |
sparklines/data/history/data/date     |
sparklines/datesOrder     |
sparklines/joins   array |
sparklines/orderDates   boolean |
sparklines/unit   string |
labelsOrder Labels order   | Use it to order labels