Interface: SequenceDiagramController

Public coordinator for a sequence diagram.

Properties

Property	Type
activations	readonly ActivationBarElement[]
elements	readonly DOMElement[]
gapY	number
lifelines	readonly LifelineElement[]
messages	readonly ConnectorElement[]
participants	readonly DOMElement[]
startY	number

Methods

activate()

activate(actor: DOMElement | LifelineElement, options?: ActivationOptions): ActivationBarElement

Parameters

Parameter	Type
actor	DOMElement | LifelineElement
options?	ActivationOptions

Returns

ActivationBarElement

---

addParticipant()

addParticipant(actor: DOMElement, options?: LifelineOptions): LifelineElement

Parameters

Parameter	Type
actor	DOMElement
options?	LifelineOptions

Returns

LifelineElement

---

getLifeline()

getLifeline(actor: DOMElement): LifelineElement

Parameters

Parameter	Type
actor	DOMElement

Returns

LifelineElement

---

message()

message(from: DOMElement | LifelineElement, to: DOMElement | LifelineElement, options?: string | { align?: Align; blur?: number; brightness?: number; className?: string; color?: string; curvature?: number; customPositioned?: boolean; end?: number; endHead?: ConnectorHeadType; endHeadSize?: number; enterDelay?: number; enterDuration?: number; exitDelay?: number; exitDuration?: number; flow?: FlowEffect; fromAnchor?: ElementAnchor | AnchorMode; fromPadding?: number; height?: Size; id?: string; label?: string; labelOffset?: LabelOffset; labelOffsetX?: string | number; labelOffsetY?: string | number; labelPlacement?: LabelPlacement; labelScale?: number; onActivate?: () => void; onDeactivate?: () => void; onMount?: () => void; onUnmount?: () => void; opacity?: number; origin?: ElementAnchor; padding?: number; position?: Position; pulseInterval?: number | PeriodicPulseOptions; radius?: number; rotation?: number; routing?: "straight" | "corner" | "bezier" | "arc"; rowY?: number; scale?: number; size?: Size; start?: number; startHead?: ConnectorHeadType; startHeadSize?: number; strokePattern?: "solid" | "dashed" | "dotted"; strokeWidth?: number; style?: Properties<0 | string & object, string & object>; theme?: Partial<ThemeConfig>; toAnchor?: ElementAnchor | AnchorMode; toPadding?: number; width?: Size; x?: PositionCoord; y?: PositionCoord; }): ConnectorElement

Parameters

Parameter	Type
from	DOMElement | LifelineElement
to	DOMElement | LifelineElement
options?	string | { align?: Align; blur?: number; brightness?: number; className?: string; color?: string; curvature?: number; customPositioned?: boolean; end?: number; endHead?: ConnectorHeadType; endHeadSize?: number; enterDelay?: number; enterDuration?: number; exitDelay?: number; exitDuration?: number; flow?: FlowEffect; fromAnchor?: ElementAnchor | AnchorMode; fromPadding?: number; height?: Size; id?: string; label?: string; labelOffset?: LabelOffset; labelOffsetX?: string | number; labelOffsetY?: string | number; labelPlacement?: LabelPlacement; labelScale?: number; onActivate?: () => void; onDeactivate?: () => void; onMount?: () => void; onUnmount?: () => void; opacity?: number; origin?: ElementAnchor; padding?: number; position?: Position; pulseInterval?: number | PeriodicPulseOptions; radius?: number; rotation?: number; routing?: "straight" | "corner" | "bezier" | "arc"; rowY?: number; scale?: number; size?: Size; start?: number; startHead?: ConnectorHeadType; startHeadSize?: number; strokePattern?: "solid" | "dashed" | "dotted"; strokeWidth?: number; style?: Properties<0 | string & object, string & object>; theme?: Partial<ThemeConfig>; toAnchor?: ElementAnchor | AnchorMode; toPadding?: number; width?: Size; x?: PositionCoord; y?: PositionCoord; }

Returns

ConnectorElement