Skip to content

XYChart axis config Schema

txt
https://mermaid.js.org/schemas/config.schema.json#/$defs/XYChartAxisConfig

This object contains configuration for XYChart axis config

AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenAllowednoneconfig.schema.json*

XYChartAxisConfig Type

object (XYChart axis config)

XYChartAxisConfig Properties

PropertyTypeRequiredNullableDefined by
showLabelbooleanRequiredcannot be nullMermaid Config
labelFontSizenumberRequiredcannot be nullMermaid Config
labelPaddingnumberRequiredcannot be nullMermaid Config
showTitlebooleanRequiredcannot be nullMermaid Config
titleFontSizenumberRequiredcannot be nullMermaid Config
titlePaddingnumberRequiredcannot be nullMermaid Config
showTickbooleanRequiredcannot be nullMermaid Config
tickLengthnumberRequiredcannot be nullMermaid Config
tickWidthnumberRequiredcannot be nullMermaid Config
showAxisLinebooleanRequiredcannot be nullMermaid Config
axisLineWidthnumberRequiredcannot be nullMermaid Config

showLabel

Should show the axis labels (tick text)

showLabel

showLabel Type

boolean

showLabel Default Value

The default value is:

json
true

labelFontSize

font size of the axis labels (tick text)

labelFontSize

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:

json
14

labelPadding

top and bottom space from axis label (tick text)

labelPadding

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:

json
5

showTitle

Should show the axis title

showTitle

showTitle Type

boolean

showTitle Default Value

The default value is:

json
true

titleFontSize

font size of the axis title

titleFontSize

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:

json
16

titlePadding

top and bottom space from axis title

titlePadding

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:

json
5

showTick

Should show the axis tick lines

showTick

showTick Type

boolean

showTick Default Value

The default value is:

json
true

tickLength

length of the axis tick lines

tickLength

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:

json
5

tickWidth

width of the axis tick lines

tickWidth

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:

json
2

showAxisLine

Show line across the axis

showAxisLine

showAxisLine Type

boolean

showAxisLine Default Value

The default value is:

json
true

axisLineWidth

Width of the axis line

axisLineWidth

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:

json
2