XYChart axis config Schema β
https://mermaid.js.org/schemas/config.schema.json#/$defs/XYChartAxisConfig
This object contains configuration for XYChart axis config
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config.schema.json* |
XYChartAxisConfig Type β
object
(XYChart axis config)
XYChartAxisConfig Properties β
Property | Type | Required | Nullable | Defined by |
---|---|---|---|---|
showLabel | boolean | Required | cannot be null | Mermaid Config |
labelFontSize | number | Required | cannot be null | Mermaid Config |
labelPadding | number | Required | cannot be null | Mermaid Config |
showTitle | boolean | Required | cannot be null | Mermaid Config |
titleFontSize | number | Required | cannot be null | Mermaid Config |
titlePadding | number | Required | cannot be null | Mermaid Config |
showTick | boolean | Required | cannot be null | Mermaid Config |
tickLength | number | Required | cannot be null | Mermaid Config |
tickWidth | number | Required | cannot be null | Mermaid Config |
showAxisLine | boolean | Required | cannot be null | Mermaid Config |
axisLineWidth | number | Required | cannot be null | Mermaid Config |
showLabel β
Should show the axis labels (tick text)
showLabel
is required
Type:
boolean
cannot be null
defined in: Mermaid Config
showLabel Type β
boolean
showLabel Default Value β
The default value is:
true
labelFontSize β
font size of the axis labels (tick text)
labelFontSize
is required
Type:
number
cannot be null
defined in: Mermaid Config
labelFontSize Type β
number
labelFontSize Constraints β
minimum: the value of this number must greater than or equal to: 1
labelFontSize Default Value β
The default value is:
14
labelPadding β
top and bottom space from axis label (tick text)
labelPadding
is required
Type:
number
cannot be null
defined in: Mermaid Config
labelPadding Type β
number
labelPadding Constraints β
minimum: the value of this number must greater than or equal to: 0
labelPadding Default Value β
The default value is:
5
showTitle β
Should show the axis title
showTitle
is required
Type:
boolean
cannot be null
defined in: Mermaid Config
showTitle Type β
boolean
showTitle Default Value β
The default value is:
true
titleFontSize β
font size of the axis title
titleFontSize
is required
Type:
number
cannot be null
defined in: Mermaid Config
titleFontSize Type β
number
titleFontSize Constraints β
minimum: the value of this number must greater than or equal to: 1
titleFontSize Default Value β
The default value is:
16
titlePadding β
top and bottom space from axis title
titlePadding
is required
Type:
number
cannot be null
defined in: Mermaid Config
titlePadding Type β
number
titlePadding Constraints β
minimum: the value of this number must greater than or equal to: 0
titlePadding Default Value β
The default value is:
5
showTick β
Should show the axis tick lines
showTick
is required
Type:
boolean
cannot be null
defined in: Mermaid Config
showTick Type β
boolean
showTick Default Value β
The default value is:
true
tickLength β
length of the axis tick lines
tickLength
is required
Type:
number
cannot be null
defined in: Mermaid Config
tickLength Type β
number
tickLength Constraints β
minimum: the value of this number must greater than or equal to: 1
tickLength Default Value β
The default value is:
5
tickWidth β
width of the axis tick lines
tickWidth
is required
Type:
number
cannot be null
defined in: Mermaid Config
tickWidth Type β
number
tickWidth Constraints β
minimum: the value of this number must greater than or equal to: 1
tickWidth Default Value β
The default value is:
2
showAxisLine β
Show line across the axis
showAxisLine
is required
Type:
boolean
cannot be null
defined in: Mermaid Config
showAxisLine Type β
boolean
showAxisLine Default Value β
The default value is:
true
axisLineWidth β
Width of the axis line
axisLineWidth
is required
Type:
number
cannot be null
defined in: Mermaid Config
axisLineWidth Type β
number
axisLineWidth Constraints β
minimum: the value of this number must greater than or equal to: 1
axisLineWidth Default Value β
The default value is:
2