XYChart Config Schema

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

This object contains configuration specific to XYCharts

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*

XYChartConfig Type

object (XYChart Config)

all of

• Base Diagram Config

XYChartConfig Properties

Property	Type	Required	Nullable	Defined by
width	number	Required	cannot be null	Mermaid Config
height	number	Required	cannot be null	Mermaid Config
titleFontSize	number	Required	cannot be null	Mermaid Config
titlePadding	number	Required	cannot be null	Mermaid Config
showDataLabel	boolean	Optional	cannot be null	Mermaid Config
showDataLabelOutsideBar	boolean	Optional	cannot be null	Mermaid Config
showTitle	boolean	Required	cannot be null	Mermaid Config
showLegend	boolean	Optional	cannot be null	Mermaid Config
legendFontSize	number	Optional	cannot be null	Mermaid Config
legendPadding	number	Optional	cannot be null	Mermaid Config
xAxis	object	Required	cannot be null	Mermaid Config
yAxis	object	Required	cannot be null	Mermaid Config
chartOrientation	Not specified	Required	cannot be null	Mermaid Config
plotReservedSpacePercent	number	Required	cannot be null	Mermaid Config

width

width of the chart

width

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

width Type

number

width Constraints

minimum: the value of this number must greater than or equal to: 1

width Default Value

The default value is:

700

height

height of the chart

height

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

height Type

number

height Constraints

minimum: the value of this number must greater than or equal to: 1

height Default Value

The default value is:

500

titleFontSize

Font size of the chart 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:

20

titlePadding

Top and bottom space from the chart 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:

10

showDataLabel

Should show the value corresponding to the bar within the bar

showDataLabel

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showDataLabel Type

boolean

showDataLabel Default Value

The default value is:

false

showDataLabelOutsideBar

If showing data label then show it outside the bar

showDataLabelOutsideBar

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showDataLabelOutsideBar Type

boolean

showDataLabelOutsideBar Default Value

The default value is:

false

showTitle

Should show the chart title

showTitle

• is required

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showTitle Type

boolean

showTitle Default Value

The default value is:

true

showLegend

Should show a legend for named plots

showLegend

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showLegend Type

boolean

showLegend Default Value

The default value is:

true

legendFontSize

Font size of the legend text

legendFontSize

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

legendFontSize Type

number

legendFontSize Constraints

minimum: the value of this number must greater than or equal to: 1

legendFontSize Default Value

The default value is:

14

legendPadding

Padding around the legend

legendPadding

• is optional

• Type: number

• cannot be null

• defined in: Mermaid Config

legendPadding Type

number

legendPadding Constraints

minimum: the value of this number must greater than or equal to: 0

legendPadding Default Value

The default value is:

10

xAxis

This object contains configuration for XYChart axis config

xAxis

• is required

• Type: object (XYChart axis config)

• cannot be null

• defined in: Mermaid Config

xAxis Type

object (XYChart axis config)

xAxis Default Value

The default value is:

{
  "$ref": "#/$defs/XYChartAxisConfig",
  "title": "XYChart axis config",
  "description": "This object contains configuration for XYChart axis config",
  "type": "object",
  "unevaluatedProperties": true,
  "required": [
    "showLabel",
    "labelFontSize",
    "labelPadding",
    "showTitle",
    "titleFontSize",
    "titlePadding",
    "showTick",
    "tickLength",
    "tickWidth",
    "showAxisLine",
    "axisLineWidth",
    "labelRotation"
  ],
  "properties": {
    "showLabel": {
      "description": "Should show the axis labels (tick text)",
      "type": "boolean",
      "default": true
    },
    "labelFontSize": {
      "description": "font size of the axis labels (tick text)",
      "type": "number",
      "default": 14,
      "minimum": 1
    },
    "labelPadding": {
      "description": "top and bottom space from axis label (tick text)",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTitle": {
      "description": "Should show the axis title",
      "type": "boolean",
      "default": true
    },
    "titleFontSize": {
      "description": "font size of the axis title",
      "type": "number",
      "default": 16,
      "minimum": 1
    },
    "titlePadding": {
      "description": "top and bottom space from axis title",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTick": {
      "description": "Should show the axis tick lines",
      "type": "boolean",
      "default": true
    },
    "tickLength": {
      "description": "length of the axis tick lines",
      "type": "number",
      "default": 5,
      "minimum": 1
    },
    "tickWidth": {
      "description": "width of the axis tick lines",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "showAxisLine": {
      "description": "Show line across the axis",
      "type": "boolean",
      "default": true
    },
    "axisLineWidth": {
      "description": "Width of the axis line",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "labelRotation": {
      "description": "Label rotation in degrees",
      "type": "number",
      "default": 0,
      "minimum": -90,
      "maximum": 90
    }
  }
}

yAxis

This object contains configuration for XYChart axis config

yAxis

• is required

• Type: object (XYChart axis config)

• cannot be null

• defined in: Mermaid Config

yAxis Type

object (XYChart axis config)

yAxis Default Value

The default value is:

{
  "$ref": "#/$defs/XYChartAxisConfig",
  "title": "XYChart axis config",
  "description": "This object contains configuration for XYChart axis config",
  "type": "object",
  "unevaluatedProperties": true,
  "required": [
    "showLabel",
    "labelFontSize",
    "labelPadding",
    "showTitle",
    "titleFontSize",
    "titlePadding",
    "showTick",
    "tickLength",
    "tickWidth",
    "showAxisLine",
    "axisLineWidth",
    "labelRotation"
  ],
  "properties": {
    "showLabel": {
      "description": "Should show the axis labels (tick text)",
      "type": "boolean",
      "default": true
    },
    "labelFontSize": {
      "description": "font size of the axis labels (tick text)",
      "type": "number",
      "default": 14,
      "minimum": 1
    },
    "labelPadding": {
      "description": "top and bottom space from axis label (tick text)",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTitle": {
      "description": "Should show the axis title",
      "type": "boolean",
      "default": true
    },
    "titleFontSize": {
      "description": "font size of the axis title",
      "type": "number",
      "default": 16,
      "minimum": 1
    },
    "titlePadding": {
      "description": "top and bottom space from axis title",
      "type": "number",
      "default": 5,
      "minimum": 0
    },
    "showTick": {
      "description": "Should show the axis tick lines",
      "type": "boolean",
      "default": true
    },
    "tickLength": {
      "description": "length of the axis tick lines",
      "type": "number",
      "default": 5,
      "minimum": 1
    },
    "tickWidth": {
      "description": "width of the axis tick lines",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "showAxisLine": {
      "description": "Show line across the axis",
      "type": "boolean",
      "default": true
    },
    "axisLineWidth": {
      "description": "Width of the axis line",
      "type": "number",
      "default": 2,
      "minimum": 1
    },
    "labelRotation": {
      "description": "Label rotation in degrees",
      "type": "number",
      "default": 0,
      "minimum": -90,
      "maximum": 90
    }
  }
}

chartOrientation

How to plot will be drawn horizontal or vertical

chartOrientation

• is required

• Type: unknown

• cannot be null

• defined in: Mermaid Config

• tsType: "vertical" | "horizontal"

chartOrientation Type

unknown

chartOrientation Default Value

The default value is:

"vertical"

plotReservedSpacePercent

Minimum percent of space plots of the chart will take

plotReservedSpacePercent

• is required

• Type: number

• cannot be null

• defined in: Mermaid Config

plotReservedSpacePercent Type

number

plotReservedSpacePercent Constraints

minimum: the value of this number must greater than or equal to: 30

plotReservedSpacePercent Default Value

The default value is:

50