Packet Diagram Config Schema

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

The 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

• Base Diagram Config

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
bitOrder	string	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: number

• cannot 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:

32

bitWidth

The width of each bit in the packet diagram.

bitWidth

• is optional

• Type: number

• cannot 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:

32

bitsPerRow

The number of bits to display per row.

bitsPerRow

• is optional

• Type: number

• cannot 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:

32

showBits

Toggle to display or hide bit numbers.

showBits

• is optional

• Type: boolean

• cannot be null

• defined in: Mermaid Config

showBits Type

boolean

showBits Default Value

The default value is:

true

bitOrder

The direction each row is numbered in. descending mirrors every row so it reads from that row's highest bit on the left down to its lowest bit on the right, the convention used for hardware registers. Fields are still declared lowest bit first, and keep their width.

bitOrder

• is optional

• Type: string

• cannot be null

• defined in: Mermaid Config

bitOrder Type

string

bitOrder Constraints

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

Value	Explanation
"ascending"	Number each row from its lowest bit on the left up to its highest bit on the right.
"descending"	Number each row from its highest bit on the left down to its lowest bit on the right.

bitOrder Default Value

The default value is:

"ascending"

paddingX

The horizontal padding between the blocks in a row.

paddingX

• is optional

• Type: number

• cannot 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:

5

paddingY

The vertical padding between the rows.

paddingY

• is optional

• Type: number

• cannot 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