Skip to main content

Function: SequenceDiagram()

SequenceDiagram(options?: object): SequenceDiagramController

Creates a reactive Sequence Diagram coordinator with lifelines and messages.

Parameters​

ParameterTypeDescription
options?{ gapY?: number; lifelineColor?: string; lifelineLength?: number; lifelineOpacity?: number; paddingBottom?: number; participants?: DOMElement[]; startY?: number; }-
options.gapY?numberVertical spacing between message rows in stage units (default: 8).
options.lifelineColor?stringStroke color of participant lifelines (default: "rgba(148, 163, 184, 0.7)").
options.lifelineLength?numberMinimum length of participant lifelines in stage units (default: 42). Automatically extends to fit messages and activations.
options.lifelineOpacity?numberInitial opacity of participant lifelines (default: 1). Set to 0 if animating lifelines in.
options.paddingBottom?numberPadding in stage units below the lowest message or activation (default: 4).
options.participants?DOMElement[]Initial actor elements to register as diagram participants.
options.startY?numberVertical start position for the first message in stage units (default: 32).

Returns​

SequenceDiagramController