Requirement Diagram Config Schema
https://mermaid.js.org/schemas/config.schema.json#/$defs/RequirementDiagramConfigThe object containing configurations specific for req 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* |
RequirementDiagramConfig Type
object (Requirement Diagram Config)
all of
RequirementDiagramConfig Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| theme | string | Optional | cannot be null | Mermaid Config |
| look | string | Optional | cannot be null | Mermaid Config |
| rect_fill | string | Optional | cannot be null | Mermaid Config |
| text_color | string | Optional | cannot be null | Mermaid Config |
| rect_border_size | string | Optional | cannot be null | Mermaid Config |
| rect_border_color | string | Optional | cannot be null | Mermaid Config |
| rect_min_width | number | Optional | cannot be null | Mermaid Config |
| rect_min_height | number | Optional | cannot be null | Mermaid Config |
| fontSize | number | Optional | cannot be null | Mermaid Config |
| rect_padding | number | Optional | cannot be null | Mermaid Config |
| line_height | number | Optional | cannot be null | Mermaid Config |
theme
Theme, the CSS style sheet. You may also use themeCSS to override this value.
theme
is optional
Type:
stringcannot be null
defined in: Mermaid Config
theme Type
string
theme Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"default" | |
"base" | |
"dark" | |
"forest" | |
"neutral" | |
"neo" | |
"neo-dark" | |
"redux" | |
"redux-dark" | |
"redux-color" | |
"redux-dark-color" | |
"null" | Can be set to disable any pre-defined mermaid theme |
theme Default Value
The default value is:
"redux-color"look
Defines which main look to use for the diagram.
look
is optional
Type:
stringcannot be null
defined in: Mermaid Config
look Type
string
look Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"classic" | |
"handDrawn" | |
"neo" |
look Default Value
The default value is:
"neo"rect_fill
rect_fill
is optional
Type:
stringcannot be null
defined in: Mermaid Config
rect_fill Type
string
rect_fill Default Value
The default value is:
"#f9f9f9"text_color
text_color
is optional
Type:
stringcannot be null
defined in: Mermaid Config
text_color Type
string
text_color Default Value
The default value is:
"#333"rect_border_size
rect_border_size
is optional
Type:
stringcannot be null
defined in: Mermaid Config
rect_border_size Type
string
rect_border_size Default Value
The default value is:
"0.5px"rect_border_color
rect_border_color
is optional
Type:
stringcannot be null
defined in: Mermaid Config
rect_border_color Type
string
rect_border_color Default Value
The default value is:
"#bbb"rect_min_width
rect_min_width
is optional
Type:
numbercannot be null
defined in: Mermaid Config
rect_min_width Type
number
rect_min_width Default Value
The default value is:
200rect_min_height
rect_min_height
is optional
Type:
numbercannot be null
defined in: Mermaid Config
rect_min_height Type
number
rect_min_height Default Value
The default value is:
200fontSize
fontSize
is optional
Type:
numbercannot be null
defined in: Mermaid Config
fontSize Type
number
fontSize Default Value
The default value is:
14rect_padding
rect_padding
is optional
Type:
numbercannot be null
defined in: Mermaid Config
rect_padding Type
number
rect_padding Default Value
The default value is:
10line_height
line_height
is optional
Type:
numbercannot be null
defined in: Mermaid Config
line_height Type
number
line_height Default Value
The default value is:
20