Skip to content

Timeline Diagram Config Schema

txt
https://mermaid.js.org/schemas/config.schema.json#/$defs/TimelineDiagramConfig
AbstractExtensibleStatusIdentifiableCustom PropertiesAdditional PropertiesAccess RestrictionsDefined In
Can be instantiatedNoUnknown statusNoForbiddenAllowednoneconfig.schema.json*

TimelineDiagramConfig Type

object (Timeline Diagram Config)

all of

TimelineDiagramConfig Properties

PropertyTypeRequiredNullableDefined by
diagramMarginXintegerRequiredcannot be nullMermaid Config
diagramMarginYintegerRequiredcannot be nullMermaid Config
leftMarginintegerRequiredcannot be nullMermaid Config
widthintegerRequiredcannot be nullMermaid Config
heightintegerRequiredcannot be nullMermaid Config
paddingnumberOptionalcannot be nullMermaid Config
boxMarginintegerRequiredcannot be nullMermaid Config
boxTextMarginintegerRequiredcannot be nullMermaid Config
noteMarginintegerRequiredcannot be nullMermaid Config
messageMarginintegerRequiredcannot be nullMermaid Config
messageAlignstringRequiredcannot be nullMermaid Config
bottomMarginAdjintegerRequiredcannot be nullMermaid Config
rightAnglesbooleanOptionalcannot be nullMermaid Config
taskFontSizeMultipleOptionalcannot be nullMermaid Config
taskFontFamilystringOptionalcannot be nullMermaid Config
taskMarginnumberOptionalcannot be nullMermaid Config
activationWidthnumberOptionalcannot be nullMermaid Config
textPlacementstringOptionalcannot be nullMermaid Config
actorColoursarrayOptionalcannot be nullMermaid Config
sectionFillsarrayOptionalcannot be nullMermaid Config
sectionColoursarrayOptionalcannot be nullMermaid Config
disableMulticolorbooleanOptionalcannot be nullMermaid Config

diagramMarginX

c4 图右侧和左侧的边距必须为正值。

diagramMarginX

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
50

diagramMarginY

c4 图上方和下方的边距必须为正值。

diagramMarginY

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
10

leftMargin

角色之间的边距

leftMargin

leftMargin Type

integer

leftMargin Constraints

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

leftMargin Default Value

The default value is:

json
150

width

参与者框的宽度

width

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
150

height

角色框的高度

height

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
50

padding

padding

padding Type

number

boxMargin

循环框周围的边距

boxMargin

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
10

boxTextMargin

循环/alt/opt 框中文本周围的边距

boxTextMargin

boxTextMargin Type

integer

boxTextMargin Constraints

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

boxTextMargin Default Value

The default value is:

json
5

noteMargin

注释周围的边距

noteMargin

noteMargin Type

integer

noteMargin Constraints

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

noteMargin Default Value

The default value is:

json
10

messageMargin

消息之间的空间。

messageMargin

messageMargin Type

integer

messageMargin Constraints

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

messageMargin Default Value

The default value is:

json
35

messageAlign

多行消息对齐

messageAlign

messageAlign Type

string

messageAlign Constraints

enum: the value of this property must be equal to one of the following values:

ValueExplanation
"left"
"center"
"right"

messageAlign Default Value

The default value is:

json
"center"

bottomMarginAdj

向下延长图表的边缘。根据 css 样式,这可能需要调整。

bottomMarginAdj

bottomMarginAdj Type

integer

bottomMarginAdj Constraints

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

bottomMarginAdj Default Value

The default value is:

json
1

rightAngles

弯曲箭头变为直角这将显示从同一节点开始并以直角而不是曲线开始的箭头。

rightAngles

rightAngles Type

boolean

taskFontSize

taskFontSize

  • is optional

  • Type: any of the following: string or number (Details)

  • cannot be null

  • defined in: Mermaid Config

taskFontSize Type

any of the following: string or number (Details)

taskFontSize Default Value

The default value is:

json
14

taskFontFamily

taskFontFamily

taskFontFamily Type

string

taskFontFamily Default Value

The default value is:

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

taskMargin

taskMargin

taskMargin Type

number

taskMargin Default Value

The default value is:

json
50

activationWidth

激活框的宽度

activationWidth

activationWidth Type

number

activationWidth Default Value

The default value is:

json
10

textPlacement

text placement as: tspan | fo | old only text as before

textPlacement

textPlacement Type

string

textPlacement Default Value

The default value is:

json
"fo"

actorColours

actorColours

actorColours Type

string[]

actorColours Default Value

The default value is:

json
["#8FBC8F", "#7CFC00", "#00FFFF", "#20B2AA", "#B0E0E6", "#FFFFE0"]

sectionFills

sectionFills

sectionFills Type

string[]

sectionFills Default Value

The default value is:

json
["#191970", "#8B008B", "#4B0082", "#2F4F4F", "#800000", "#8B4513", "#00008B"]

sectionColours

sectionColours

sectionColours Type

string[]

sectionColours Default Value

The default value is:

json
["#fff"]

disableMulticolor

disableMulticolor

disableMulticolor Type

boolean