API Reference
Class
PacketLayoutBlock
A deterministic packet-layout visual block made of contiguous labeled bit fields.
Inheritance
- VisualBlock<PacketLayoutBlock>
- PacketLayoutBlock
Usage
Explore 15 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 15
- Extension method MermaidPacketDocument.ToPacketLayoutBlock
- Method MermaidPacketRendering.ToPacketLayoutBlock
- Method PacketLayoutBlock.AddField
- Method PacketLayoutBlock.Create
- Method PacketLayoutBlock.WithBitNumbers
- Method PacketLayoutBlock.WithBitsPerRow
- Method PacketLayoutBlock.WithCard
- Method PacketLayoutBlock.WithHostFrame
- Method PacketLayoutBlock.WithPadding
- Method PacketLayoutBlock.WithPngOutputScale
- Method PacketLayoutBlock.WithSize
- Method PacketLayoutBlock.WithSubtitle
- Method PacketLayoutBlock.WithTheme
- Method PacketLayoutBlock.WithTitle
- Method PacketLayoutBlock.WithTransparentBackground
Constructors
public PacketLayoutBlock() #Methods
public PacketLayoutBlock AddField(Int32 startBit, Int32 endBit, String label) #Returns:
PacketLayoutBlockAdds one contiguous field.
Parameters
- startBit System.Int32
- endBit System.Int32
- label System.String
public PacketLayoutBlock WithBitNumbers(Boolean visible = true) #Returns:
PacketLayoutBlockSets whether bit start and end numbers are rendered above fields.
Parameters
- visible System.Boolean = true
public PacketLayoutBlock WithBitsPerRow(Int32 bitsPerRow) #Returns:
PacketLayoutBlockSets how many bits are rendered per visual row.
Parameters
- bitsPerRow System.Int32
Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
public virtual RgbaImage RenderRgba() #Returns:
RgbaImageInherited from 0, Culture=neutral, PublicKeyToken=null]]
public virtual String RenderSvg(String idScope) #Returns:
StringInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- idScope String
public PacketLayoutBlock WithCard(Boolean enabled = true) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
public PacketLayoutBlock WithHostFrame(Boolean hostOwnsFrame = true) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- hostOwnsFrame Boolean = true
WithPadding 2 overloads
public PacketLayoutBlock WithPadding(Double padding) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- padding Double
public PacketLayoutBlock WithPadding(Double left, Double top, Double right, Double bottom) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- left Double
- top Double
- right Double
- bottom Double
public PacketLayoutBlock WithPngOutputScale(Int32 scale) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- scale Int32
public PacketLayoutBlock WithSize(Int32 width, Int32 height) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- width Int32
- height Int32
public PacketLayoutBlock WithSubtitle(String subtitle) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- subtitle String
public PacketLayoutBlock WithTheme(ChartTheme theme) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- theme ChartTheme
public PacketLayoutBlock WithTitle(String title) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- title String
public PacketLayoutBlock WithTransparentBackground(Boolean enabled = true) #Returns:
PacketLayoutBlockInherited from 0, Culture=neutral, PublicKeyToken=null]]
Parameters
- enabled Boolean = true
Properties
public IReadOnlyList<PacketLayoutField> Fields { get; } #Gets packet fields in bit order.
public Int32 BitsPerRow { get; set; } #Gets or sets how many bits are rendered per visual row.
public Boolean ShowBitNumbers { get; set; } #Gets or sets whether bit start and end numbers are rendered above fields.
public override String AccessibleName { get; } #Gets a concise accessibility label.