MAIDR JavaScript API
    Preparing search index...

    Interface SequenceMessage

    One message of a sequence diagram, in the order time runs down the page.

    { from: 'Alice', to: 'Bob', text: 'Hello Bob', kind: 'sync', fragments: ['loop Every minute'] }
    interface SequenceMessage {
        from: string | number;
        to: string | number;
        text?: string;
        kind?: SequenceMessageKind;
        fragments?: string[];
        number?: number;
    }
    Index

    Properties

    from to text? kind? fragments? number?

    Properties

    from: string | number

    The participant it leaves.

    to: string | number

    The participant it arrives at -- the same as from for a message to oneself, or for a note over one participant. A note spanning several participants names the last of them here.

    Optionaltext

    text?: string

    What the arrow is labelled with.

    kind?: SequenceMessageKind

    What the arrow is. Defaults to sync.

    fragments?: string[]

    The combined fragments it sits in, outermost first, each as the diagram labels it: loop Every minute, alt is sick. Omitted or [] outside every fragment.

    number?: number

    The number the diagram prints beside it, when it numbers its messages.

    Settings

    Member Visibility

    On This Page

    Properties