Packet Diagram Config Schema
https://mermaid.js.org/schemas/config.schema.json#/$defs/PacketDiagramConfigThe object containing configurations specific for packet 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* |
PacketDiagramConfig Type
object (Packet Diagram Config)
all of
PacketDiagramConfig Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| rowHeight | number | Optional | cannot be null | Mermaid Config |
| bitWidth | number | Optional | cannot be null | Mermaid Config |
| bitsPerRow | number | Optional | cannot be null | Mermaid Config |
| showBits | boolean | Optional | cannot be null | Mermaid Config |
| paddingX | number | Optional | cannot be null | Mermaid Config |
| paddingY | number | Optional | cannot be null | Mermaid Config |
rowHeight
The height of each row in the packet diagram.
rowHeight
is optional
Type:
numbercannot be null
defined in: Mermaid Config
rowHeight Type
number
rowHeight Constraints
minimum: the value of this number must greater than or equal to: 1
rowHeight Default Value
The default value is:
32bitWidth
The width of each bit in the packet diagram.
bitWidth
is optional
Type:
numbercannot be null
defined in: Mermaid Config
bitWidth Type
number
bitWidth Constraints
minimum: the value of this number must greater than or equal to: 1
bitWidth Default Value
The default value is:
32bitsPerRow
The number of bits to display per row.
bitsPerRow
is optional
Type:
numbercannot be null
defined in: Mermaid Config
bitsPerRow Type
number
bitsPerRow Constraints
minimum: the value of this number must greater than or equal to: 1
bitsPerRow Default Value
The default value is:
32showBits
Toggle to display or hide bit numbers.
showBits
is optional
Type:
booleancannot be null
defined in: Mermaid Config
showBits Type
boolean
showBits Default Value
The default value is:
truepaddingX
The horizontal padding between the blocks in a row.
paddingX
is optional
Type:
numbercannot be null
defined in: Mermaid Config
paddingX Type
number
paddingX Constraints
minimum: the value of this number must greater than or equal to: 0
paddingX Default Value
The default value is:
5paddingY
The vertical padding between the rows.
paddingY
is optional
Type:
numbercannot be null
defined in: Mermaid Config
paddingY Type
number
paddingY Constraints
minimum: the value of this number must greater than or equal to: 0
paddingY Default Value
The default value is:
5