Guide
Guide configuration element is responsible for tuning look and feel of your chart.
Example with guide
{
"type": "scatterplot",
"x": "cycleTime",
"y": "effort",
"color": "team",
"size": "count",
"guide": {
"x": {"label": {"text": "Cycle Time in days", "padding": 35}, "padding": 20},
"y": {"label": "Effort in points", "padding": 20},
"padding": {"b": 70, "l": 70, "t": 10, "r": 10},
"showGridLines": "xy",
"color": {
"brewer": ["color-red", "color-green", "color-blue"]
}
}
}
Configuration
Element | Notes | ||
---|---|---|---|
x | Styling options for X axis. | ||
Element | Notes | ||
padding | Describes padding between a chart body and X axis. | ||
label | Describes label for X axis. | ||
Element | Notes | ||
text | Title for X axis | ||
padding | Padding between title and a rest of X axis. | ||
tickFormat | Ticks are small indicators on an axis that shows axis values. tickFormat allows to format tick labels. It uses d3-based formatter. Check available d3 format specifiers. Other possible values:
| ||
tickPeriod | When operate with period scale, it allows to specify the period size. Possible values:
| ||
nice | Possible values: true, false. Defaults to true. By default engine tries to make axis scale "nice". It tries to start measure-based scale from 0 and adds some margins to complete scale with "nice" numbers. For example, if original scale domain contains values [8, 20, ... 40], then axis will have ticks from 0 to 45. | ||
min | The scale domain can be extended using min and max properties. The min and max can't reduce original scale domain and will be ignored in such a cases. "Nicing" will be applied to extended domain by default. Set nice property to false to avoid such a behavior. | ||
max | |||
y | Styling options for Y axis. Same elements as for X applies. | ||
color | Styling options for color dimension. | ||
Element | Notes | ||
brewer | There are to ways to define how color dimension will be colored.Â
| ||
size | Styling options for size dimension. | ||
Element | Notes | ||
minSize | Specifies minimal size of element. | ||
maxSize | Specifies maximal size of element. | ||
padding | Specifies padding of the whole chart. | ||
Element | Notes | ||
b | Bottom padding. | ||
t | Top padding. | ||
l | Left padding. | ||
r | Right padding. | ||
showGridLines | Instructs whether shows coordinates lines. Possible values: x, y, xy. | ||
showAnchors | Defines when to show anchors. Possible values:
This may not apply to all chart types. | ||
interpolate | Possible values:
This may not apply to all chart types. |