Score card reference

To display a list of metrics

Overview

📖 Learn More about the Score card here.

📖 Find examples on the Score card here.

Parameters

Required

You must fill these parameters to produce a Score card

parameters label type description (placeholder | tooltip)
dataset   string |
label   string (Column of dataset expected) Column containing the label of the metrics to display |
value   string (Column of dataset expected) Column containing the value of the metrics to display | Did you know your value can be a number or some text ?

Optional

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

parameters label type description (placeholder | tooltip)
packs   string (Column of dataset expected) Column containing grouping of metrics | Will add spacing between your packs of labels
hidePackLabels Hide pack labels boolean | Will hide the pack labels
labelsOrder Labels order   | Use it to order labels
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/date   string (Column of dataset expected) Column containing the time dimension |
sparklines/forceLexicalOrder Automatic date ordering boolean | Set to false to disable lexical reordering of ordinal dates
sparklines/value   string (Column of dataset expected) Column containing the line value |
sparklines/prefix   string Type in text | OptionalAdd a prefix to value display
sparklines/legend   string Type in a legend | Optional
sparklines/commonScatter Common scale boolean | Use the same scale for all sparklines (y axis)
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
packsOrder Packs order   | Use it to order packs
size Size number Enter a proportion of the total screen | Use on multiple charts onlyEnter a number from 0 to 1
variation   string (Column of dataset expected) Column containing variation values |
tutorial Tutorial object |
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.
tutorial/content Message string Enter your message | This will be displayed to your users
mobileSize Mobile Size number Enter a proportion of the total mobile screen | Use on multiple charts onlyEnter a number from 0 to 1
variationLegend Variation legend string Enter the legend for your variation | Will appear like a column header on top of the variation

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