C4 Diagram Config Schema

txt

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

The object containing configurations specific for c4 diagrams

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*

C4DiagramConfig Type

object (C4 Diagram Config)

all of

Base Diagram Config

C4DiagramConfig Properties

Property	Type	Required	Nullable	Defined by
diagramMarginX	`integer`	Required	cannot be null	Mermaid Config
diagramMarginY	`integer`	Required	cannot be null	Mermaid Config
c4ShapeMargin	`integer`	Required	cannot be null	Mermaid Config
c4ShapePadding	`integer`	Required	cannot be null	Mermaid Config
width	`integer`	Required	cannot be null	Mermaid Config
height	`integer`	Required	cannot be null	Mermaid Config
boxMargin	`integer`	Required	cannot be null	Mermaid Config
c4ShapeInRow	`integer`	Required	cannot be null	Mermaid Config
nextLinePaddingX	`number`	Optional	cannot be null	Mermaid Config
c4BoundaryInRow	`integer`	Required	cannot be null	Mermaid Config
personFontSize	Multiple	Optional	cannot be null	Mermaid Config
personFontFamily	`string`	Optional	cannot be null	Mermaid Config
personFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_personFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_personFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_personFontWeight	Multiple	Optional	cannot be null	Mermaid Config
systemFontSize	Multiple	Optional	cannot be null	Mermaid Config
systemFontFamily	`string`	Optional	cannot be null	Mermaid Config
systemFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_systemFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_systemFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_systemFontWeight	Multiple	Optional	cannot be null	Mermaid Config
system_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
system_dbFontFamily	`string`	Optional	cannot be null	Mermaid Config
system_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_system_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_system_dbFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_system_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
system_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
system_queueFontFamily	`string`	Optional	cannot be null	Mermaid Config
system_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_system_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_system_queueFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_system_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
boundaryFontSize	Multiple	Optional	cannot be null	Mermaid Config
boundaryFontFamily	`string`	Optional	cannot be null	Mermaid Config
boundaryFontWeight	Multiple	Optional	cannot be null	Mermaid Config
messageFontSize	Multiple	Optional	cannot be null	Mermaid Config
messageFontFamily	`string`	Optional	cannot be null	Mermaid Config
messageFontWeight	Multiple	Optional	cannot be null	Mermaid Config
containerFontSize	Multiple	Optional	cannot be null	Mermaid Config
containerFontFamily	`string`	Optional	cannot be null	Mermaid Config
containerFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_containerFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_containerFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_containerFontWeight	Multiple	Optional	cannot be null	Mermaid Config
container_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
container_dbFontFamily	`string`	Optional	cannot be null	Mermaid Config
container_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_container_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_container_dbFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_container_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
container_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
container_queueFontFamily	`string`	Optional	cannot be null	Mermaid Config
container_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_container_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_container_queueFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_container_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
componentFontSize	Multiple	Optional	cannot be null	Mermaid Config
componentFontFamily	`string`	Optional	cannot be null	Mermaid Config
componentFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_componentFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_componentFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_componentFontWeight	Multiple	Optional	cannot be null	Mermaid Config
component_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
component_dbFontFamily	`string`	Optional	cannot be null	Mermaid Config
component_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_component_dbFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_component_dbFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_component_dbFontWeight	Multiple	Optional	cannot be null	Mermaid Config
component_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
component_queueFontFamily	`string`	Optional	cannot be null	Mermaid Config
component_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
external_component_queueFontSize	Multiple	Optional	cannot be null	Mermaid Config
external_component_queueFontFamily	`string`	Optional	cannot be null	Mermaid Config
external_component_queueFontWeight	Multiple	Optional	cannot be null	Mermaid Config
wrap	`boolean`	Optional	cannot be null	Mermaid Config
wrapPadding	`number`	Optional	cannot be null	Mermaid Config
person_bg_color	`string`	Optional	cannot be null	Mermaid Config
person_border_color	`string`	Optional	cannot be null	Mermaid Config
external_person_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_person_border_color	`string`	Optional	cannot be null	Mermaid Config
system_bg_color	`string`	Optional	cannot be null	Mermaid Config
system_border_color	`string`	Optional	cannot be null	Mermaid Config
system_db_bg_color	`string`	Optional	cannot be null	Mermaid Config
system_db_border_color	`string`	Optional	cannot be null	Mermaid Config
system_queue_bg_color	`string`	Optional	cannot be null	Mermaid Config
system_queue_border_color	`string`	Optional	cannot be null	Mermaid Config
external_system_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_system_border_color	`string`	Optional	cannot be null	Mermaid Config
external_system_db_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_system_db_border_color	`string`	Optional	cannot be null	Mermaid Config
external_system_queue_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_system_queue_border_color	`string`	Optional	cannot be null	Mermaid Config
container_bg_color	`string`	Optional	cannot be null	Mermaid Config
container_border_color	`string`	Optional	cannot be null	Mermaid Config
container_db_bg_color	`string`	Optional	cannot be null	Mermaid Config
container_db_border_color	`string`	Optional	cannot be null	Mermaid Config
container_queue_bg_color	`string`	Optional	cannot be null	Mermaid Config
container_queue_border_color	`string`	Optional	cannot be null	Mermaid Config
external_container_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_container_border_color	`string`	Optional	cannot be null	Mermaid Config
external_container_db_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_container_db_border_color	`string`	Optional	cannot be null	Mermaid Config
external_container_queue_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_container_queue_border_color	`string`	Optional	cannot be null	Mermaid Config
component_bg_color	`string`	Optional	cannot be null	Mermaid Config
component_border_color	`string`	Optional	cannot be null	Mermaid Config
component_db_bg_color	`string`	Optional	cannot be null	Mermaid Config
component_db_border_color	`string`	Optional	cannot be null	Mermaid Config
component_queue_bg_color	`string`	Optional	cannot be null	Mermaid Config
component_queue_border_color	`string`	Optional	cannot be null	Mermaid Config
external_component_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_component_border_color	`string`	Optional	cannot be null	Mermaid Config
external_component_db_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_component_db_border_color	`string`	Optional	cannot be null	Mermaid Config
external_component_queue_bg_color	`string`	Optional	cannot be null	Mermaid Config
external_component_queue_border_color	`string`	Optional	cannot be null	Mermaid Config
personFont	Not specified	Optional	cannot be null	Mermaid Config
external_personFont	Not specified	Optional	cannot be null	Mermaid Config
systemFont	Not specified	Optional	cannot be null	Mermaid Config
external_systemFont	Not specified	Optional	cannot be null	Mermaid Config
system_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_system_dbFont	Not specified	Optional	cannot be null	Mermaid Config
system_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_system_queueFont	Not specified	Optional	cannot be null	Mermaid Config
containerFont	Not specified	Optional	cannot be null	Mermaid Config
external_containerFont	Not specified	Optional	cannot be null	Mermaid Config
container_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_container_dbFont	Not specified	Optional	cannot be null	Mermaid Config
container_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_container_queueFont	Not specified	Optional	cannot be null	Mermaid Config
componentFont	Not specified	Optional	cannot be null	Mermaid Config
external_componentFont	Not specified	Optional	cannot be null	Mermaid Config
component_dbFont	Not specified	Optional	cannot be null	Mermaid Config
external_component_dbFont	Not specified	Optional	cannot be null	Mermaid Config
component_queueFont	Not specified	Optional	cannot be null	Mermaid Config
external_component_queueFont	Not specified	Optional	cannot be null	Mermaid Config
boundaryFont	Not specified	Optional	cannot be null	Mermaid Config
messageFont	Not specified	Optional	cannot be null	Mermaid Config

diagramMarginX

Margin to the right and left of the c4 diagram, must be a positive value.

diagramMarginX

is required
Type: integer
cannot be null
defined in: Mermaid Config

diagramMarginX Type

integer

diagramMarginX Constraints

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

diagramMarginX Default Value

The default value is:

json

diagramMarginY

Margin to the over and under the c4 diagram, must be a positive value.

diagramMarginY

is required
Type: integer
cannot be null
defined in: Mermaid Config

diagramMarginY Type

integer

diagramMarginY Constraints

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

diagramMarginY Default Value

The default value is:

json

c4ShapeMargin

Margin between shapes

c4ShapeMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

c4ShapeMargin Type

integer

c4ShapeMargin Constraints

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

c4ShapeMargin Default Value

The default value is:

json

c4ShapePadding

Padding between shapes

c4ShapePadding

is required
Type: integer
cannot be null
defined in: Mermaid Config

c4ShapePadding Type

integer

c4ShapePadding Constraints

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

c4ShapePadding Default Value

The default value is:

json

width

Width of person boxes

width

is required
Type: integer
cannot be null
defined in: Mermaid Config

width Type

integer

width Constraints

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

width Default Value

The default value is:

json

height

Height of person boxes

height

is required
Type: integer
cannot be null
defined in: Mermaid Config

height Type

integer

height Constraints

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

height Default Value

The default value is:

json

boxMargin

Margin around boxes

boxMargin

is required
Type: integer
cannot be null
defined in: Mermaid Config

boxMargin Type

integer

boxMargin Constraints

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

boxMargin Default Value

The default value is:

json

c4ShapeInRow

How many shapes to place in each row.

c4ShapeInRow

is required
Type: integer
cannot be null
defined in: Mermaid Config

c4ShapeInRow Type

integer

c4ShapeInRow Constraints

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

c4ShapeInRow Default Value

The default value is:

json

nextLinePaddingX

nextLinePaddingX

is optional
Type: number
cannot be null
defined in: Mermaid Config

nextLinePaddingX Type

number

c4BoundaryInRow

How many boundaries to place in each row.

c4BoundaryInRow

is required
Type: integer
cannot be null
defined in: Mermaid Config

c4BoundaryInRow Type

integer

c4BoundaryInRow Constraints

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

c4BoundaryInRow Default Value

The default value is:

json

personFontSize

This sets the font size of Person shape for the diagram

personFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

personFontSize Type

any of the following: string or number (Details)

personFontSize Default Value

The default value is:

json

personFontFamily

This sets the font weight of Person shape for the diagram

personFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

personFontFamily Type

string

personFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

personFontWeight

This sets the font weight of Person shape for the diagram

personFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

personFontWeight Type

any of the following: string or number (Details)

personFontWeight Default Value

The default value is:

json

"normal"

external_personFontSize

This sets the font size of External Person shape for the diagram

external_personFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_personFontSize Type

any of the following: string or number (Details)

external_personFontSize Default Value

The default value is:

json

external_personFontFamily

This sets the font family of External Person shape for the diagram

external_personFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_personFontFamily Type

string

external_personFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_personFontWeight

This sets the font weight of External Person shape for the diagram

external_personFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_personFontWeight Type

any of the following: string or number (Details)

external_personFontWeight Default Value

The default value is:

json

"normal"

systemFontSize

This sets the font size of System shape for the diagram

systemFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

systemFontSize Type

any of the following: string or number (Details)

systemFontSize Default Value

The default value is:

json

systemFontFamily

This sets the font family of System shape for the diagram

systemFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

systemFontFamily Type

string

systemFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

systemFontWeight

This sets the font weight of System shape for the diagram

systemFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

systemFontWeight Type

any of the following: string or number (Details)

systemFontWeight Default Value

The default value is:

json

"normal"

external_systemFontSize

This sets the font size of External System shape for the diagram

external_systemFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_systemFontSize Type

any of the following: string or number (Details)

external_systemFontSize Default Value

The default value is:

json

external_systemFontFamily

This sets the font family of External System shape for the diagram

external_systemFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_systemFontFamily Type

string

external_systemFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_systemFontWeight

This sets the font weight of External System shape for the diagram

external_systemFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_systemFontWeight Type

any of the following: string or number (Details)

external_systemFontWeight Default Value

The default value is:

json

"normal"

system_dbFontSize

This sets the font size of System DB shape for the diagram

system_dbFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

system_dbFontSize Type

any of the following: string or number (Details)

system_dbFontSize Default Value

The default value is:

json

system_dbFontFamily

This sets the font family of System DB shape for the diagram

system_dbFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_dbFontFamily Type

string

system_dbFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

system_dbFontWeight

This sets the font weight of System DB shape for the diagram

system_dbFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

system_dbFontWeight Type

any of the following: string or number (Details)

system_dbFontWeight Default Value

The default value is:

json

"normal"

external_system_dbFontSize

This sets the font size of External System DB shape for the diagram

external_system_dbFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_system_dbFontSize Type

any of the following: string or number (Details)

external_system_dbFontSize Default Value

The default value is:

json

external_system_dbFontFamily

This sets the font family of External System DB shape for the diagram

external_system_dbFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_dbFontFamily Type

string

external_system_dbFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_system_dbFontWeight

This sets the font weight of External System DB shape for the diagram

external_system_dbFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_system_dbFontWeight Type

any of the following: string or number (Details)

external_system_dbFontWeight Default Value

The default value is:

json

"normal"

system_queueFontSize

This sets the font size of System Queue shape for the diagram

system_queueFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

system_queueFontSize Type

any of the following: string or number (Details)

system_queueFontSize Default Value

The default value is:

json

system_queueFontFamily

This sets the font family of System Queue shape for the diagram

system_queueFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_queueFontFamily Type

string

system_queueFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

system_queueFontWeight

This sets the font weight of System Queue shape for the diagram

system_queueFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

system_queueFontWeight Type

any of the following: string or number (Details)

system_queueFontWeight Default Value

The default value is:

json

"normal"

external_system_queueFontSize

This sets the font size of External System Queue shape for the diagram

external_system_queueFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_system_queueFontSize Type

any of the following: string or number (Details)

external_system_queueFontSize Default Value

The default value is:

json

external_system_queueFontFamily

This sets the font family of External System Queue shape for the diagram

external_system_queueFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_queueFontFamily Type

string

external_system_queueFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_system_queueFontWeight

This sets the font weight of External System Queue shape for the diagram

external_system_queueFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_system_queueFontWeight Type

any of the following: string or number (Details)

external_system_queueFontWeight Default Value

The default value is:

json

"normal"

boundaryFontSize

This sets the font size of Boundary shape for the diagram

boundaryFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

boundaryFontSize Type

any of the following: string or number (Details)

boundaryFontSize Default Value

The default value is:

json

boundaryFontFamily

This sets the font family of Boundary shape for the diagram

boundaryFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

boundaryFontFamily Type

string

boundaryFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

boundaryFontWeight

This sets the font weight of Boundary shape for the diagram

boundaryFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

boundaryFontWeight Type

any of the following: string or number (Details)

boundaryFontWeight Default Value

The default value is:

json

"normal"

messageFontSize

This sets the font size of Message shape for the diagram

messageFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

messageFontSize Type

any of the following: string or number (Details)

messageFontSize Default Value

The default value is:

json

messageFontFamily

This sets the font family of Message shape for the diagram

messageFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

messageFontFamily Type

string

messageFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

messageFontWeight

This sets the font weight of Message shape for the diagram

messageFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

messageFontWeight Type

any of the following: string or number (Details)

messageFontWeight Default Value

The default value is:

json

"normal"

containerFontSize

This sets the font size of Container shape for the diagram

containerFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

containerFontSize Type

any of the following: string or number (Details)

containerFontSize Default Value

The default value is:

json

containerFontFamily

This sets the font family of Container shape for the diagram

containerFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

containerFontFamily Type

string

containerFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

containerFontWeight

This sets the font weight of Container shape for the diagram

containerFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

containerFontWeight Type

any of the following: string or number (Details)

containerFontWeight Default Value

The default value is:

json

"normal"

external_containerFontSize

This sets the font size of External Container shape for the diagram

external_containerFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_containerFontSize Type

any of the following: string or number (Details)

external_containerFontSize Default Value

The default value is:

json

external_containerFontFamily

This sets the font family of External Container shape for the diagram

external_containerFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_containerFontFamily Type

string

external_containerFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_containerFontWeight

This sets the font weight of External Container shape for the diagram

external_containerFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_containerFontWeight Type

any of the following: string or number (Details)

external_containerFontWeight Default Value

The default value is:

json

"normal"

container_dbFontSize

This sets the font size of Container DB shape for the diagram

container_dbFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

container_dbFontSize Type

any of the following: string or number (Details)

container_dbFontSize Default Value

The default value is:

json

container_dbFontFamily

This sets the font family of Container DB shape for the diagram

container_dbFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_dbFontFamily Type

string

container_dbFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

container_dbFontWeight

This sets the font weight of Container DB shape for the diagram

container_dbFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

container_dbFontWeight Type

any of the following: string or number (Details)

container_dbFontWeight Default Value

The default value is:

json

"normal"

external_container_dbFontSize

This sets the font size of External Container DB shape for the diagram

external_container_dbFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_container_dbFontSize Type

any of the following: string or number (Details)

external_container_dbFontSize Default Value

The default value is:

json

external_container_dbFontFamily

This sets the font family of External Container DB shape for the diagram

external_container_dbFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_dbFontFamily Type

string

external_container_dbFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_container_dbFontWeight

This sets the font weight of External Container DB shape for the diagram

external_container_dbFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_container_dbFontWeight Type

any of the following: string or number (Details)

external_container_dbFontWeight Default Value

The default value is:

json

"normal"

container_queueFontSize

This sets the font size of Container Queue shape for the diagram

container_queueFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

container_queueFontSize Type

any of the following: string or number (Details)

container_queueFontSize Default Value

The default value is:

json

container_queueFontFamily

This sets the font family of Container Queue shape for the diagram

container_queueFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_queueFontFamily Type

string

container_queueFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

container_queueFontWeight

This sets the font weight of Container Queue shape for the diagram

container_queueFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

container_queueFontWeight Type

any of the following: string or number (Details)

container_queueFontWeight Default Value

The default value is:

json

"normal"

external_container_queueFontSize

This sets the font size of External Container Queue shape for the diagram

external_container_queueFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_container_queueFontSize Type

any of the following: string or number (Details)

external_container_queueFontSize Default Value

The default value is:

json

external_container_queueFontFamily

This sets the font family of External Container Queue shape for the diagram

external_container_queueFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_queueFontFamily Type

string

external_container_queueFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_container_queueFontWeight

This sets the font weight of External Container Queue shape for the diagram

external_container_queueFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_container_queueFontWeight Type

any of the following: string or number (Details)

external_container_queueFontWeight Default Value

The default value is:

json

"normal"

componentFontSize

This sets the font size of Component shape for the diagram

componentFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

componentFontSize Type

any of the following: string or number (Details)

componentFontSize Default Value

The default value is:

json

componentFontFamily

This sets the font family of Component shape for the diagram

componentFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

componentFontFamily Type

string

componentFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

componentFontWeight

This sets the font weight of Component shape for the diagram

componentFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

componentFontWeight Type

any of the following: string or number (Details)

componentFontWeight Default Value

The default value is:

json

"normal"

external_componentFontSize

This sets the font size of External Component shape for the diagram

external_componentFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_componentFontSize Type

any of the following: string or number (Details)

external_componentFontSize Default Value

The default value is:

json

external_componentFontFamily

This sets the font family of External Component shape for the diagram

external_componentFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_componentFontFamily Type

string

external_componentFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_componentFontWeight

This sets the font weight of External Component shape for the diagram

external_componentFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_componentFontWeight Type

any of the following: string or number (Details)

external_componentFontWeight Default Value

The default value is:

json

"normal"

component_dbFontSize

This sets the font size of Component DB shape for the diagram

component_dbFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

component_dbFontSize Type

any of the following: string or number (Details)

component_dbFontSize Default Value

The default value is:

json

component_dbFontFamily

This sets the font family of Component DB shape for the diagram

component_dbFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_dbFontFamily Type

string

component_dbFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

component_dbFontWeight

This sets the font weight of Component DB shape for the diagram

component_dbFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

component_dbFontWeight Type

any of the following: string or number (Details)

component_dbFontWeight Default Value

The default value is:

json

"normal"

external_component_dbFontSize

This sets the font size of External Component DB shape for the diagram

external_component_dbFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_component_dbFontSize Type

any of the following: string or number (Details)

external_component_dbFontSize Default Value

The default value is:

json

external_component_dbFontFamily

This sets the font family of External Component DB shape for the diagram

external_component_dbFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_dbFontFamily Type

string

external_component_dbFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_component_dbFontWeight

This sets the font weight of External Component DB shape for the diagram

external_component_dbFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_component_dbFontWeight Type

any of the following: string or number (Details)

external_component_dbFontWeight Default Value

The default value is:

json

"normal"

component_queueFontSize

This sets the font size of Component Queue shape for the diagram

component_queueFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

component_queueFontSize Type

any of the following: string or number (Details)

component_queueFontSize Default Value

The default value is:

json

component_queueFontFamily

This sets the font family of Component Queue shape for the diagram

component_queueFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_queueFontFamily Type

string

component_queueFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

component_queueFontWeight

This sets the font weight of Component Queue shape for the diagram

component_queueFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

component_queueFontWeight Type

any of the following: string or number (Details)

component_queueFontWeight Default Value

The default value is:

json

"normal"

external_component_queueFontSize

This sets the font size of External Component Queue shape for the diagram

external_component_queueFontSize

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_component_queueFontSize Type

any of the following: string or number (Details)

external_component_queueFontSize Default Value

The default value is:

json

external_component_queueFontFamily

This sets the font family of External Component Queue shape for the diagram

external_component_queueFontFamily

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_queueFontFamily Type

string

external_component_queueFontFamily Default Value

The default value is:

json

"\"Open Sans\", sans-serif"

external_component_queueFontWeight

This sets the font weight of External Component Queue shape for the diagram

external_component_queueFontWeight

is optional
Type: any of the following: string or number (Details)
cannot be null
defined in: Mermaid Config

external_component_queueFontWeight Type

any of the following: string or number (Details)

external_component_queueFontWeight Default Value

The default value is:

json

"normal"

wrap

This sets the auto-wrap state for the diagram

wrap

is optional
Type: boolean
cannot be null
defined in: Mermaid Config

wrap Type

boolean

wrap Default Value

The default value is:

json

true

wrapPadding

This sets the auto-wrap padding for the diagram (sides only)

wrapPadding

is optional
Type: number
cannot be null
defined in: Mermaid Config

wrapPadding Type

number

wrapPadding Default Value

The default value is:

json

person_bg_color

person_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

person_bg_color Type

string

person_bg_color Default Value

The default value is:

json

"#08427B"

person_border_color

person_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

person_border_color Type

string

person_border_color Default Value

The default value is:

json

"#073B6F"

external_person_bg_color

external_person_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_person_bg_color Type

string

external_person_bg_color Default Value

The default value is:

json

"#686868"

external_person_border_color

external_person_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_person_border_color Type

string

external_person_border_color Default Value

The default value is:

json

"#8A8A8A"

system_bg_color

system_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_bg_color Type

string

system_bg_color Default Value

The default value is:

json

"#1168BD"

system_border_color

system_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_border_color Type

string

system_border_color Default Value

The default value is:

json

"#3C7FC0"

system_db_bg_color

system_db_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_db_bg_color Type

string

system_db_bg_color Default Value

The default value is:

json

"#1168BD"

system_db_border_color

system_db_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_db_border_color Type

string

system_db_border_color Default Value

The default value is:

json

"#3C7FC0"

system_queue_bg_color

system_queue_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_queue_bg_color Type

string

system_queue_bg_color Default Value

The default value is:

json

"#1168BD"

system_queue_border_color

system_queue_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

system_queue_border_color Type

string

system_queue_border_color Default Value

The default value is:

json

"#3C7FC0"

external_system_bg_color

external_system_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_bg_color Type

string

external_system_bg_color Default Value

The default value is:

json

"#999999"

external_system_border_color

external_system_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_border_color Type

string

external_system_border_color Default Value

The default value is:

json

"#8A8A8A"

external_system_db_bg_color

external_system_db_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_db_bg_color Type

string

external_system_db_bg_color Default Value

The default value is:

json

"#999999"

external_system_db_border_color

external_system_db_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_db_border_color Type

string

external_system_db_border_color Default Value

The default value is:

json

"#8A8A8A"

external_system_queue_bg_color

external_system_queue_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_queue_bg_color Type

string

external_system_queue_bg_color Default Value

The default value is:

json

"#999999"

external_system_queue_border_color

external_system_queue_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_system_queue_border_color Type

string

external_system_queue_border_color Default Value

The default value is:

json

"#8A8A8A"

container_bg_color

container_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_bg_color Type

string

container_bg_color Default Value

The default value is:

json

"#438DD5"

container_border_color

container_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_border_color Type

string

container_border_color Default Value

The default value is:

json

"#3C7FC0"

container_db_bg_color

container_db_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_db_bg_color Type

string

container_db_bg_color Default Value

The default value is:

json

"#438DD5"

container_db_border_color

container_db_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_db_border_color Type

string

container_db_border_color Default Value

The default value is:

json

"#3C7FC0"

container_queue_bg_color

container_queue_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_queue_bg_color Type

string

container_queue_bg_color Default Value

The default value is:

json

"#438DD5"

container_queue_border_color

container_queue_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

container_queue_border_color Type

string

container_queue_border_color Default Value

The default value is:

json

"#3C7FC0"

external_container_bg_color

external_container_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_bg_color Type

string

external_container_bg_color Default Value

The default value is:

json

"#B3B3B3"

external_container_border_color

external_container_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_border_color Type

string

external_container_border_color Default Value

The default value is:

json

"#A6A6A6"

external_container_db_bg_color

external_container_db_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_db_bg_color Type

string

external_container_db_bg_color Default Value

The default value is:

json

"#B3B3B3"

external_container_db_border_color

external_container_db_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_db_border_color Type

string

external_container_db_border_color Default Value

The default value is:

json

"#A6A6A6"

external_container_queue_bg_color

external_container_queue_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_queue_bg_color Type

string

external_container_queue_bg_color Default Value

The default value is:

json

"#B3B3B3"

external_container_queue_border_color

external_container_queue_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_container_queue_border_color Type

string

external_container_queue_border_color Default Value

The default value is:

json

"#A6A6A6"

component_bg_color

component_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_bg_color Type

string

component_bg_color Default Value

The default value is:

json

"#85BBF0"

component_border_color

component_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_border_color Type

string

component_border_color Default Value

The default value is:

json

"#78A8D8"

component_db_bg_color

component_db_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_db_bg_color Type

string

component_db_bg_color Default Value

The default value is:

json

"#85BBF0"

component_db_border_color

component_db_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_db_border_color Type

string

component_db_border_color Default Value

The default value is:

json

"#78A8D8"

component_queue_bg_color

component_queue_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_queue_bg_color Type

string

component_queue_bg_color Default Value

The default value is:

json

"#85BBF0"

component_queue_border_color

component_queue_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

component_queue_border_color Type

string

component_queue_border_color Default Value

The default value is:

json

"#78A8D8"

external_component_bg_color

external_component_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_bg_color Type

string

external_component_bg_color Default Value

The default value is:

json

"#CCCCCC"

external_component_border_color

external_component_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_border_color Type

string

external_component_border_color Default Value

The default value is:

json

"#BFBFBF"

external_component_db_bg_color

external_component_db_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_db_bg_color Type

string

external_component_db_bg_color Default Value

The default value is:

json

"#CCCCCC"

external_component_db_border_color

external_component_db_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_db_border_color Type

string

external_component_db_border_color Default Value

The default value is:

json

"#BFBFBF"

external_component_queue_bg_color

external_component_queue_bg_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_queue_bg_color Type

string

external_component_queue_bg_color Default Value

The default value is:

json

"#CCCCCC"

external_component_queue_border_color

external_component_queue_border_color

is optional
Type: string
cannot be null
defined in: Mermaid Config

external_component_queue_border_color Type

string

external_component_queue_border_color Default Value

The default value is:

json

"#BFBFBF"

personFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

personFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

personFont Type

unknown (Font Calculator)

external_personFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_personFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_personFont Type

unknown (Font Calculator)

systemFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

systemFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

systemFont Type

unknown (Font Calculator)

external_systemFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_systemFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_systemFont Type

unknown (Font Calculator)

system_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

system_dbFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

system_dbFont Type

unknown (Font Calculator)

external_system_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_system_dbFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_system_dbFont Type

unknown (Font Calculator)

system_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

system_queueFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

system_queueFont Type

unknown (Font Calculator)

external_system_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_system_queueFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_system_queueFont Type

unknown (Font Calculator)

containerFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

containerFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

containerFont Type

unknown (Font Calculator)

external_containerFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_containerFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_containerFont Type

unknown (Font Calculator)

container_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

container_dbFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

container_dbFont Type

unknown (Font Calculator)

external_container_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_container_dbFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_container_dbFont Type

unknown (Font Calculator)

container_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

container_queueFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

container_queueFont Type

unknown (Font Calculator)

external_container_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_container_queueFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_container_queueFont Type

unknown (Font Calculator)

componentFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

componentFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

componentFont Type

unknown (Font Calculator)

external_componentFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_componentFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_componentFont Type

unknown (Font Calculator)

component_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

component_dbFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

component_dbFont Type

unknown (Font Calculator)

external_component_dbFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_component_dbFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_component_dbFont Type

unknown (Font Calculator)

component_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

component_queueFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

component_queueFont Type

unknown (Font Calculator)

external_component_queueFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

external_component_queueFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

external_component_queueFont Type

unknown (Font Calculator)

boundaryFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

boundaryFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

boundaryFont Type

unknown (Font Calculator)

messageFont

JavaScript function that returns a FontConfig.

By default, these return the appropriate *FontSize, *FontFamily, *FontWeight values.

For example, the font calculator called boundaryFont might be defined as:

javascript

boundaryFont: function () {
  return {
    fontFamily: this.boundaryFontFamily,
    fontSize: this.boundaryFontSize,
    fontWeight: this.boundaryFontWeight,
  };
}

messageFont

is optional
Type: unknown (Font Calculator)
cannot be null
defined in: Mermaid Config
tsType: () => Partial<FontConfig>

messageFont Type

unknown (Font Calculator)

C4 Diagram Config Schema ​

C4DiagramConfig Type ​

C4DiagramConfig Properties ​

diagramMarginX ​

diagramMarginX Type ​

diagramMarginX Constraints ​

diagramMarginX Default Value ​

diagramMarginY ​

diagramMarginY Type ​

diagramMarginY Constraints ​

diagramMarginY Default Value ​

c4ShapeMargin ​

c4ShapeMargin Type ​

c4ShapeMargin Constraints ​

c4ShapeMargin Default Value ​

c4ShapePadding ​

c4ShapePadding Type ​

c4ShapePadding Constraints ​

c4ShapePadding Default Value ​

width ​

width Type ​

width Constraints ​

width Default Value ​

height ​

height Type ​

height Constraints ​

height Default Value ​

boxMargin ​

boxMargin Type ​

boxMargin Constraints ​

boxMargin Default Value ​

c4ShapeInRow ​

c4ShapeInRow Type ​

c4ShapeInRow Constraints ​

c4ShapeInRow Default Value ​

nextLinePaddingX ​

nextLinePaddingX Type ​

c4BoundaryInRow ​

c4BoundaryInRow Type ​

c4BoundaryInRow Constraints ​

c4BoundaryInRow Default Value ​

personFontSize ​

personFontSize Type ​

personFontSize Default Value ​

personFontFamily ​

personFontFamily Type ​

personFontFamily Default Value ​

personFontWeight ​

personFontWeight Type ​

personFontWeight Default Value ​

external_personFontSize ​

external_personFontSize Type ​

external_personFontSize Default Value ​

external_personFontFamily ​

external_personFontFamily Type ​

external_personFontFamily Default Value ​

external_personFontWeight ​

external_personFontWeight Type ​

external_personFontWeight Default Value ​

systemFontSize ​

systemFontSize Type ​

systemFontSize Default Value ​

systemFontFamily ​

systemFontFamily Type ​

systemFontFamily Default Value ​

systemFontWeight ​

systemFontWeight Type ​

systemFontWeight Default Value ​

external_systemFontSize ​

external_systemFontSize Type ​

external_systemFontSize Default Value ​

external_systemFontFamily ​

external_systemFontFamily Type ​

external_systemFontFamily Default Value ​

external_systemFontWeight ​

external_systemFontWeight Type ​

external_systemFontWeight Default Value ​

system_dbFontSize ​

system_dbFontSize Type ​

system_dbFontSize Default Value ​

C4 Diagram Config Schema

C4DiagramConfig Type

C4DiagramConfig Properties

diagramMarginX

diagramMarginX Type

diagramMarginX Constraints

diagramMarginX Default Value

diagramMarginY

diagramMarginY Type

diagramMarginY Constraints

diagramMarginY Default Value

c4ShapeMargin

c4ShapeMargin Type

c4ShapeMargin Constraints

c4ShapeMargin Default Value

c4ShapePadding

c4ShapePadding Type

c4ShapePadding Constraints

c4ShapePadding Default Value

width

width Type

width Constraints

width Default Value

height

height Type

height Constraints

height Default Value

boxMargin

boxMargin Type

boxMargin Constraints

boxMargin Default Value

c4ShapeInRow

c4ShapeInRow Type

c4ShapeInRow Constraints

c4ShapeInRow Default Value

nextLinePaddingX

nextLinePaddingX Type

c4BoundaryInRow

c4BoundaryInRow Type

c4BoundaryInRow Constraints

c4BoundaryInRow Default Value

personFontSize

personFontSize Type

personFontSize Default Value

personFontFamily

personFontFamily Type

personFontFamily Default Value

personFontWeight

personFontWeight Type

personFontWeight Default Value

external_personFontSize

external_personFontSize Type

external_personFontSize Default Value

external_personFontFamily

external_personFontFamily Type

external_personFontFamily Default Value

external_personFontWeight

external_personFontWeight Type

external_personFontWeight Default Value

systemFontSize

systemFontSize Type

systemFontSize Default Value

systemFontFamily

systemFontFamily Type

systemFontFamily Default Value

systemFontWeight

systemFontWeight Type

systemFontWeight Default Value

external_systemFontSize

external_systemFontSize Type

external_systemFontSize Default Value

external_systemFontFamily

external_systemFontFamily Type

external_systemFontFamily Default Value

external_systemFontWeight

external_systemFontWeight Type

external_systemFontWeight Default Value

system_dbFontSize

system_dbFontSize Type

system_dbFontSize Default Value