Skip to main content

Sequence diagram

A simple implementation of standard UML sequence diagram. See examples here

ParticipantSchema

A participant in the sequence diagram

NameTypeDescriptionRequiredDefault
title

string

Name of the participant

Inferred from participant shape if not provided

icon

Component

Shape of the participant

MessageSchema

A message between participants A message between participants.

NameTypeDescriptionRequiredDefault
from

string

Sender participant

to

string

Receiver participant

message

string

Message content

return

boolean

Is this a return message?

false

dashed

boolean

Is this message dashed? Default to true for return messages

InteractionSchema

An interaction frame in the sequence diagram

NameTypeDescriptionRequiredDefault
title

string

Title of the interaction frame, if not provided, no frame is drawn

messages

[ MessageSchema ]

Messages in this interaction

SizeSchema

Size configuration for the sequence diagram

NameTypeDescriptionRequiredDefault
participant

number

Width of the participant box

60

timelinePadding

number

Space between each messages

15

participantsPadding

number

Padding between participant boxes

100

activationWidth

number

Width of the activation bar

12

SequenceDiagramSchema

The schema for end user to define sequence diagram component

NameTypeDescriptionRequired
participants

< string, ParticipantSchema >

Participants in the sequence diagram, if not provided, participants will be inferred from message sources and targets

messages

[ MessageSchema ]

If provided, messages converted as first interaction automatically

interactions

[ InteractionSchema ]

Interactions in the sequence diagram

size

SizeSchema

Size configuration for the diagram