Module wavedrom::edges

Edges or Arrows define a set of markers and edge lines that can be put over a diagram to indicate properties.

An edge line is between 2 nodes which are identified by a character. If the character is and uppercase ASCII character then is is not displayed on the diagram otherwise it is also shown on the diagram.

There are several types of edges, a full overview can be seen in the wavedrom-rs book. Here they are represented with the EdgeVariant structure.

In WaveJson an edge is given by a string that defined under the edge property array at the root JSON level. The edge there given in the following order: <start node><edge identifier><end node> [label]. The label is text that is put on the middle of the edge.

Structs

• EdgeDefinition
  The definition for an edge
• InSignalPosition
  A position in the signal schema. Containing both a x (cycle offset) value and a y (signal index) value.
• LineEdge
  A edge from a start node to an end node
• LineEdgeMarkers
  A set of edge markers. Both the edge lines and the text_nodes.
• LineEdgeText
  The text belowing to a node

Enums

• EdgeArrowType
  Structure that defines at which sides of an EdgeVariant there are arrows.
• EdgeVariant
  A variant of an edge
• SharpEdgeVariant
  A variant of a sharp edge
• SplineEdgeVariant
  A variant of a smooth / curved edge