Navigation :

StyleCode v2 properties

🚧 Work in progress — This documents the redesigned dashboard layout system, which is still under active development and subject to change. It is not compatible with the older v1 dashboard tile system.

Property	Description	Available in
`alignWithLeft`	Align the y=0 with the left axis.	`chart > vaxis > right` `linechart > vaxis > right`
`areaPosition`	Specifies where the area for a series with `seriesType: area` should be drawn.	`chart`
`areaTo`	Specifies the other bound of the area drawn for a series with `seriesType: area`.	`chart`
`as`	Specifies the name of a data vector (table columns, chart series, summary entries).	`barchart > series` `chart > haxis` `chart > haxis` `chart > haxis` `chart > series` `chart > haxis` `chart > series` `frame` `frame > column` `linechart > haxis` `chart` `chart` `chart` `chart` `chart` `chart` `chart` `summary > entry` `table > column` `tabstrip > tab`
`axisMax`	Specifies the highest value on an axis.	`chart` `chart > haxis` `chart > vaxis > left` `chart > vaxis > right` `linechart > haxis` `linechart > vaxis > left` `linechart > vaxis > right`
`axisMin`	Specifies the lowest value on an axis.	`chart` `chart > haxis` `chart > vaxis > left` `chart > vaxis > right` `linechart > haxis` `linechart > vaxis > left` `linechart > vaxis > right`
`axisScale`	The scale used to render data on the axis. The “log” scale only support strictly positive data.
`backgroundColor`	Specifies the background color of a tile.	`barchart` `button` `chart` `frame` `gauge` `image` `label` `linechart` `markdown` `piechart` `scalar` `summary` `table` `tabstrip`
`badgeColor`	Specifies the preset color theme for the tab’s badge, if displayed. If set to “custom”, the badge will use textColor & backgroundColor.
`barchartValuePosition`	Where the value for a given bar is displayed.	`barchart`
`barchartVariant`	Select one of the barchart tile variant.	`barchart`
`barPadding`	On “auto”, Bar series larger than 25px width will have a few extra pixels of padding between them, for visual clarity. Disabled with specified “none” instead	`chart > haxis` `linechart > haxis`
`barRatio`	Ratio of a bar width “auto” is usually resolved to 1, but if there are fanned series, it is resolved to 0.9.	`chart > haxis` `linechart > haxis`
`barTo`	Specifies the other bound of the bar drawn for a series with `seriesType: bar`.	`chart`
`bannerMessage`	Specifies the message in the banner. If set to anything but the empty string, the banner will be displayed.	`dashboard > runbanner`
`bannerButton`	Specifies the label (and presence) of the banner button. If set to anything but the empty string, the banner will be displayed.	`dashboard > runbanner`
`blockColor`	Choose the accent color for a block.	`region > header`
`blockTitle`	Sets the title of the block.	`region > footer` `region > header`
`booleans`	Specifies how booleans values are displayed. Expect “{true}/{false}” pattern, where {true} (resp. {false}) is the text to display when true (r. false).	`frame > entry > value` `frame > column > value` `table > column > value`
`box0`	Bottom whisker of the box plot	`chart`
`box100`	Top whisker of the box plot	`chart`
`box25`	Bottom of the box part of the box plot	`chart`
`box75`	Top of the box part of the box plot	`chart`
`boxLowerColor`	Fill color of the lower half box	`chart`
`boxUpperColor`	Fill color of the upper half box	`chart`
`buttonAspect`	Specifies the aspect of the button element, usally with a preset of colors. For the more complex customization, use “custom” in conjunction with “buttonBackground”, “buttonBorder” and “buttonText”, that are otherwise without effect.	`dashboard` `dashboard > runbanner`
`buttonBackground`	Enabled only for “buttonAspect”: “custom”. Specifies the background color of the button element.	`dashboard` `dashboard > runbanner`
`buttonBorder`	Enabled only for “buttonAspect”: “custom”. Specifies the border color of the button element. “auto” becomes a darker tone of “buttonBackground”.	`dashboard` `dashboard > runbanner`
`buttonText`	Enabled only for “buttonAspect”: “custom”. Specifies the text color of the button element. “auto” adapts to the background’s luminosity.	`dashboard` `dashboard > runbanner`
`buttonVariantColor`	Theme color used for this button	`button`
`buttonVariantMode`	Aspect mode used for this button	`button`
`cellBackground`	Specifies the background color of a cell in a `show table`.	`frame > entry > value` `frame > header` `frame > column > header` `frame > column > value` `table > column > append` `table > column > prepend` `table > column > value`
`cellTooltip`	Sets the markdown tooltip of the cells.	`frame > entry > value` `frame > header` `frame > column > header` `frame > column > value` `table > column > value`
`chartBlockKind`	Discriminates the stylecode scope for that block.	`chart` `chart` `chart` `chart` `chart`
`color`	Specifies the color of a series for the plot color pipeline.	`barchart > series` `barchart > series > value` `chart > series` `chart > series` `chart > series > value` `piechart > series > value` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`columnAppend`	Specifies whether a cell should be appended at the bottom of a column, and the contents of that cell.	`table > column > append`
`columnDisplay`	Controls the display of a column. `never` columns will never be displayed to the user. `frozen` (resp. `pick`) columns start in the frozen state (resp hidden state).	`frame` `frame > column` `table > column`
`columnPrepend`	Specifies whether a cell should be prepended at the top of a column, and the contents of that cell.	`table > column > prepend`
`columnReadOnly`	Specifies whether a column is read-only in an editable table.	`table > column`
`columnTooltip`	Sets the tooltip of the column.	`table > column`
`columnTooltipText`	Sets the tooltip of the column. Warning: this is a temporary feature, and will be replaced by a markdown property columnTooltip.	`table > column`
`columnWidth`	Specifies a multiplicative factor for the width of a column in a table. Applies both to non-editable tables and editable tables in the tile grid.	`frame` `frame > column` `table > column`
`columnWidthEditable`	Specifies a multiplicative factor for the width of a column for of a table. Applies only to editable tables when the tile is zoomed.	`table > column`
`columnWidthFit`	Specifies an example of value that the column should try to fit whole.	`table > column`
`columnWidthFitBold`	Specifies the boldness of the ColumnWidthFit example.	`table > column`
`columnWidthFitItalic`	Specifies the italic emphasis of the ColumnWidthFit example.	`table > column`
`columnWidthFitUnit`	Specifies the unit used to format the ColumnWidthFit example.	`table > column`
`dashButton`	Specifies the label (and presence) of the dashboard’s “Start Run” button.	`dashboard`
`dashButtonKind`	Restrict what can be the topbar button (run starter or slice selector).	`dashboard`
`dateFormat`	Specifies the format used to print out dates.	`chart > haxis` `frame > entry > value` `frame > column > value` `linechart > haxis > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`dashTitle`	Specifies the title of the dashboard.	`dashboard`
`defaultTab`	If Specified and the value is a tab label (“tileTab” on a Tile), starts the dashboard on that specific tab.	`dashboard`
`downloadColumn`	When set to false, the column is displayed in the dashboard, and will be absent from the downloaded files.	`table > column`
`downloadColumnName`	When the user downloads the tile, this property specifies the name of thecolumn. “default” will use the “as” name instead.	`table > column`
`downloadFileName`	When the user downloads the tile, this property specifies the name of thefile (not including the extension).	`barchart` `linechart` `table`
`entryDisplay`	Specifies that the entry is displayed or hidden.	`summary > entry`
`entryTooltip`	Sets the tooltip of the entry.	`summary > entry`
`entryTooltipText`	Sets the tooltip of the entry. Warning: this is a temporary feature, and will be replaced by a markdown property entryTooltip.	`summary > entry`
`entryWidthFactor`	Specifies if the individual entry should take simple or double width to be displayed.	`summary > entry`
`fieldChoiceLabels`	Specifies the labels displayed for each choice on ‘fieldType: dropdown’. This array property is complementary to ‘fieldChoices’ and must be on the same table as ‘fieldChoices’ to work properly.
`fieldChoices`	When the fieldType is “dropdown”, specifies the available choices that can be selected.
`fieldColor`	Specifies the background color of the field.
`fieldType`	Specifies explicitly the type of the field. Some values will only work on specific data types, if not matching, a ‘bad field type’ rectangle is displayed instead.
`formAccess`	Determines whether a form field should be hidden or shown. Hidden form fields are still submitted with their original value.
`formButton`	Specifies the existence and label of the “submit” button on a form tile.
`formButtonAlign`	Horizontally align form buttons. Both “fieldType: button” and “formButton” are affected by the property.
`formMessage`	If non-empty, will be displayed to the left of the “start run” button of the form. Not displayed if there is no “start run” button.
`fractionSeparator`	Specifies the separator between integer and fractional digits in the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`frameBlockKind`	Discriminates the stylecode scope for that block.	`frame` `frame` `frame`
`gaugeAngle`	Angle of the gauge. Valid range is 180°-270°.	`gauge` `gauge > entry`
`gaugeChromeColor`	Hue used to draw secondary elements (the outer guide, the background). Default is grey.	`gauge`
`gaugeLabelPosition`	Position of the label relative to the gauge.	`gauge`
`gaugeMax`	Maximum value for the gauge	`gauge > entry`
`gaugeMin`	Minimum value for the gauge	`gauge > entry`
`gaugeVariant`	By default, the “bar” variant displays a bar from the minimum to the gauge value. On “dot”, a circle is displayed at the reached value.	`gauge`
`gridlineColor`	Specifies the color for the “gridlines” element.	`chart` `chart > haxis` `chart > vaxis` `linechart > haxis` `linechart > vaxis`
`gridlines`	Specifies the mode for the “gridlines” in the background of the chart.	`chart` `chart > haxis` `chart > vaxis` `linechart > haxis` `linechart > vaxis`
`headerBackground`	Specifies the background color of a header in a `show table`.	`table > column > header`
`headerTextColor`	Specifies the color of the header text for the text color pipeline.	`table > column > header`
`href`	When set, indicates that clicking the element should open another page. Only supports ‘http://’ and ‘https://’ links ; those starting with `~/` will be prefixed with `https://go.lokad.com/<ACCOUNT>` automatically.	`button` `frame > entry > value` `frame > column > value` `label` `region > footer` `scalar > entry > value` `summary > entry > value` `table > column > value`
`hrefAspect`	Specifies the aspect of the href element, either as a link, or a button with preset of colors. For the more complex customization, use “custom” in conjunction with “hrefBackground”, “hrefBorder” and “hrefText”, that are otherwise without effect.	`frame > entry > value` `frame > column > value` `label` `scalar > entry > value` `summary > entry > value` `table > column > value`
`hrefBackground`	Enabled only for “hrefAspect”: “custom”. Specifies the background color of the href element.	`frame > entry > value` `frame > column > value` `label` `scalar > entry > value` `summary > entry > value` `table > column > value`
`hrefBorder`	Enabled only for “hrefAspect”: “custom”. Specifies the border color of the href element. “auto” becomes a darker tone of “hrefBackground”.	`frame > entry > value` `frame > column > value` `label` `scalar > entry > value` `summary > entry > value` `table > column > value`
`hrefTarget`	Specifies if clicking on the href element opens a new browser’ tab (“blank”) or not (“auto”).	`button` `frame > entry > value` `frame > column > value` `label` `region > footer` `scalar > entry > value` `summary > entry > value` `table > column > value`
`hrefText`	Enabled only for “hrefAspect”: “custom”. Specifies the text color of the href element. “auto” adapts to the background’s luminosity.	`frame > entry > value` `frame > column > value` `label` `scalar > entry > value` `summary > entry > value` `table > column > value`
`iconColor`	Specifies the color for the “labelIcon”. If unspecified, will use the tileColor value.	`label`
`iconPosition`	Specifies the position of the icon relative to the label.	`label`
`labelBorderColor`	Specifies the color for the label border. If unspecified, will use the textColor value.	`label`
`labelBorder`	Specifies the sides of the label where a border is displayed. Can accept any combination of “bottom”, “left”, “right”, and “top”, separated by commas if there are more than one. Can be set to “none” or “all” for respectively the empty set and the full set of values.	`label`
`labelIcon`	Specifies the icon that should appear in the label title, `none` if no icon should be displayed.	`label`
`legendPosition`	Specifies the chart’s legend position. The legend will only be rendered in tile mode if the tile is tall or wide enough.	`chart > legend` `linechart > legend` `summary`
`lockColumns`	When true, columns can not be manually re-ordered nor hidden.	`table`
`menuDisplay`	Determines if a given menu element should be displayed or not.
`minPrecision`	Specifies the minimum number of fractional digits to be displayed in the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`monthFormat`	Specifies the format used to print out months (using thesame formatting syntax as dates)	`chart > haxis` `frame > entry > value` `frame > column > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`numbers`	Specifies the number rendering mode for the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`paginateStrategy`	Sets the table’s strategy for choosing between paginate and scrolling all content. If `dynamic` the pagination mode is enabled depending on the content size. If `always` the pagination mode is enabled regardless of content.	`table`
`plusSign`	Displays ‘+’ sign before positive numbers. “always” and “nonzero” only differ for zero values.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`precision`	Specifies the maximum number of fractional digits to be displayed in the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`radius`	Specify the radius multiplier of points composing the scatter plot.	`chart > series > value`
`scalarLabelPosition`	Position the label relative to the value.	`scalar`
`selectAllLabel`	Enable and sets the label for the special All selector. Once it is enabled, any slicer with 2 or more choices will allow the user to temporarilly skip the current slicer choice to have access to the next slicer. Once a non-All choice is made in a downstream slicer, the All slicer gets resolve to the corresponding choice.
`seriesDisplay`	Specifies that the series is displayed or hidden.	`chart > series` `chart > series` `chart` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`seriesFan`	For series type that support it, the fan group for that series.	`chart`
`seriesGroup`	Scaling group for a	`barchart > series`
`seriesLegend`	Specifies what is displayed in the legend for that series	`chart > series` `chart > series` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`seriesLegendRank`	Specifies the rank used to order the series in the legend. If two series share the same rank, the one with the highest average vertical position on the chart is displayed first. “auto” has a different behavior depending on “legendPosition”.	`chart > series` `chart > series` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`seriesLegendTooltip`	Sets the tooltip for the series in the legend.	`chart > series` `chart > series` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`seriesMarker`	The kind of marker the series is rendered with	`chart > series` `chart > series > value`
`seriesOpacity`	Specify the opacity of the series between 0 (fully transparent) and 1 (fully opaque). Is rounded to the nearest percent value.	`chart > series` `chart > series` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`seriesPattern`	Specifies the pattern for displaying a line series in a `linechart` or `plot`.	`chart > series` `chart`
`seriesSmooth`	Sets the smoothing method for line & area series.	`chart > series` `chart` `chart`
`seriesStack`	Specifies the category this series stacks with. An empty string disables stacking of this series.	`chart` `chart` `chart`
`seriesType`	Specifies the display type of a series in a `barchart` or `linechart`.	`chart` `chart` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`size`	Controls the size of the affected tile or entry. 0 is the neutral size and depending of the context various positive and negative values are supported	`button` `label` `scalar` `tabstrip`
`sliceField`	Specifies the appearence of the field. Notice that all sliceField are not available for all sliceHierarchy and/or all field types.
`sliceHierarchy`	Specifies what the field shows and what . Any “none” is handled before others kinds. Other than that, the order follow the entry ordering. “filter”, “ask” & “clear” restrict their ranges of values depending on the others previously handled fields. “ask” & “clear” allow the field to be in an unselected mode, whenever the previously handled fields make the current choice invalid. The difference between the two is that “ask” will reselect itself whenever thereis a single choice available, while “clear” will require to select that one value"filter" is reselected automatically.
`sliceUnselected`	Specifies the text to display on unselected. Used only for some sliceField.
`summaryColumns`	Specifies how the tile splits the available space. On “auto”, makes a number of column depending on the tile’s grid width. When provided a number, split the available space in that many columns.	`summary`
`tabsVariant`	“horizontal” and “vertical” are displayed in strip mode, “select” is a more compact with a button selector.	`tabstrip`
`textAlign`	Specifies the horizontal text alignment in the text pipeline.	`frame > entry > value` `frame > header` `frame > column > header` `frame > column > value` `label` `scalar` `summary > entry` `summary > entry > value` `table > column > append` `table > column > header` `table > column > prepend` `table > column > value`
`textBold`	If set to true, will render the text with a bold emphasis.	`frame > entry > value` `frame > header` `frame > column > header` `frame > column > value` `label` `scalar` `scalar > entry > value` `summary > entry` `summary > entry > value` `table > column > append` `table > column > header` `table > column > prepend` `table > column > value`
`textColor`	Specifies the color of text for the text color pipeline.	`barchart > series` `barchart > series > value` `frame > entry > value` `frame > header` `frame > column > header` `frame > column > value` `gauge` `label` `markdown` `scalar` `scalar > entry > value` `summary > entry > value` `table > column > append` `table > column > prepend` `table > column > value`
`textItalic`	If set to true, will render the text with an italic emphasis.	`frame > entry > value` `frame > header` `frame > column > header` `frame > column > value` `label` `scalar` `scalar > entry > value` `summary > entry` `summary > entry > value` `table > column > append` `table > column > header` `table > column > prepend` `table > column > value`
`textRotation`	If specified to “left” or “right”, the text element is rotated 90 degrees towards that direction.	`label`
`textVerticalAlign`	Specifies the vertical text alignment inside the tile.	`label`
`thousandSeparator`	The thousands separator for the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`tileBackground`	The background color or hue for the tile.	`region` `region > header`
`tileColor`	Choose the accent color for a tile.	`barchart` `button` `chart` `frame` `gauge` `image` `label` `linechart` `markdown` `piechart` `scalar` `summary` `table` `tabstrip`
`tileH`	Set the height of the tile.
`tilePlacement`	Specifies which placement mode to use. When unspecified, the default can be “fixed” if an inline positioning is specified.
`tileTab`	If specified (non-empty string) adds a tab with the given name. The tile is then hidden on any other tab. If set to an empty string, the tile is displayed on all tabs.
`tileTitle`	Sets the title of the tile.	`barchart` `button` `chart` `frame` `gauge` `image` `label` `linechart` `markdown` `piechart` `scalar` `summary` `table` `tabstrip`
`tileTooltip`	Sets the markdown tooltip of the tile.	`barchart` `chart` `frame` `gauge` `label` `linechart` `markdown` `piechart` `scalar` `summary` `table`
`tileTooltipText`	Sets the tooltip of the tile. Warning: this is a temporary feature, and will be replaced by a markdown property tileTooltip.	`barchart` `chart` `frame` `gauge` `label` `linechart` `markdown` `piechart` `scalar` `summary` `table`
`tileW`	Set the width of the tile.
`tileX`	Set the horizontal position of the left edge of the tile, relative to the left side of the dashboard.
`tileY`	Set the vertical position of the top edge of the tile, relative to the left side of the dashboard.
`tileZoom`	Allow the tile to be clicked on (if contextually relevant) to have a full window version inside a modal.	`barchart` `chart` `frame` `linechart` `markdown` `piechart` `summary` `table`
`tooltipColor`	Choose the main color for the tooltip icon.	`barchart` `chart` `chart > series` `chart > series` `frame` `frame > entry > value` `frame > column > value` `gauge` `label` `linechart` `markdown` `piechart` `scalar` `chart` `chart` `chart` `chart` `chart` `chart` `chart` `summary` `summary > entry` `table` `table > column` `table > column > value`
`tooltipSecondaryColor`	Choose the secondary color for the tooltip icon.	`barchart` `chart` `chart > series` `chart > series` `frame` `frame > entry > value` `frame > column > value` `gauge` `label` `linechart` `markdown` `piechart` `scalar` `chart` `chart` `chart` `chart` `chart` `chart` `chart` `summary` `summary > entry` `table` `table > column` `table > column > value`
`treemapCut`	Set the algorithm used to cut the treemap into regions.
`unit`	Controls the unit of numbers in the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series` `chart > series > value` `chart > series` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `chart` `chart` `chart` `chart` `chart` `chart` `summary > entry > value` `table > column > value`
`unitPosition`	Controls the position of the unit in the number pipeline.	`barchart > series > value` `chart` `chart > haxis` `chart > value` `chart > series > value` `chart > series > value` `chart > vaxis > left` `chart > vaxis > right` `frame > entry > value` `frame > column > value` `gauge > entry > value` `linechart > vaxis > left` `linechart > vaxis > right` `piechart > series > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
`vaxis`	When a chart’s definition permit dynamic axis allocation, specifies a series’ axis.	`chart > series` `chart > series` `chart` `chart` `chart` `chart` `chart` `chart` `chart`
`weekFormat`	Specifies the format used to print out weeks (using thesame formatting syntax as dates).	`chart > haxis` `frame > entry > value` `frame > column > value` `scalar > entry > value` `summary > entry > value` `table > column > value`
//: # (Auto-generated! Do not edit above this line.)

User Contributed Notes

0 notes + add a note