drawlib.diagrams.sequence（シーケンス図）

自動等間隔ライフライン、参加者グループ、アクティベーション（実行区間）バー、付箋ノート、および複合フラグメント（alt、loop、opt、par）を備えた時系列 UML シーケンス図モジュールです。標準インポート: from drawlib.diagrams.sequence import GcpIcon, Participant, ParticipantGroup, PhosphorIcon, SequenceDiagram。

from drawlib.canvas import save, setup
from drawlib.diagrams.sequence import GcpIcon, Participant, ParticipantGroup, PhosphorIcon, SequenceDiagram
from drawlib.styles import Colors, Styles

setup(width=120, height=78)

d = SequenceDiagram(
    node_style=Styles.Primary,
    node_text_style=Styles.DarkBold.patch(text_size=10.5),
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.Dark.patch(text_size=10.0),
    node_card_style=Styles.Neutral,
    autonumber=True,
    col_width=34.0,
    step_y=7.0,
    margin=4.0,
)

client = d.add(Participant("Web App", width=22, height=15, icon=PhosphorIcon.BROWSER, icon_size=6.5))

platform = d.add(
    ParticipantGroup(
        title="Auth Platform",
        padding=4.0,
        style=Styles.PrimaryNeutral.patch(line_style="dashed"),
        text_style=Styles.PrimaryBold.patch(text_size=10.5, halign="left"),
    )
)
api = platform.add(
    Participant(
        "Auth API",
        width=22,
        height=15,
        icon=PhosphorIcon.SHIELD_CHECK,
        icon_size=6.5,
        style=Styles.White,
        text_style=Styles.WhiteBold.patch(text_color=Colors.White, text_size=10.5),
        card_style=Styles.PrimaryFlat,
    )
)
db = platform.add(
    Participant("User DB", width=22, height=15, icon=GcpIcon.CLOUD_SQL, icon_size=6.5, card_style=Styles.SecondaryNeutral)
)

api.activate()
client.request(api, "POST /v1/token")
api.request(db, "SELECT user_hash")
db.reply(api, "Row record")

with d.alt("Valid hash") as blk:
    blk.style = Styles.Neutral.patch(line_style="dashed")
    api.reply(client, "200 OK (JWT)")

api.deactivate()

d.draw(xy=(60.0, 39.0), align="center")
save()

classSequenceDiagram#

シーケンス図全体のレイアウトと垂直タイムラインを管理するトップレベルコンテナです。参加者を水平方向に col_width 間隔で自動配置し、イベントごとに下方向へ step_y ずつ時間を進行させます。

SequenceDiagram(
    *,
    node_style: Style,
    node_text_style: Style,
    edge_style: Style,
    edge_text_style: Style,
    node_card_style: Style | None = None,
    title: str = "",
    autonumber: bool = False,
    width: float | None = None,
    height: float | None = None,
    col_width: float = 20.0,
    step_y: float = 7.0,
    margin: float = 5.0,
    style: Style | None = None,
    title_style: Style | None = None,
) -> None

• 座標アンカー: draw(xy=(0.0, 0.0), align="bottom_left") はシーケンス図の左下隅をキャンバス座標 xy に配置します（align="center" の場合はバウンディングボックス中心を xy に配置）。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classParticipant#

上部ヘッダーカードと垂直破線ライフラインを持つ、シーケンス図のアクター・サービス・API エンドポイント・データベース列です。

Participant(
    text: str = "",
    width: float = 20.0,
    height: float = 16.0,
    icon: IconType = None,
    icon_size: float = 8.0,
    style: Style | None = None,
    text_style: Style | None = None,
    card_style: Style | None = None,
    lifeline_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: デフォルトでは上部ヘッダー行に沿って左から右へ diagram.col_width 間隔で自動配置されます。d.add(p, x=...) または p.set_x(x) で水平 X 座標を明示固定することも可能です。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classParticipantGroup#

シーケンス図上部の連続する Participant ヘッダーカード群を囲むラベル付き境界ボックスです。

ParticipantGroup(
    title: str = "",
    padding: float = 4.0,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: group.add(participant) で追加されたメンバー参加者のヘッダーカード群を囲むように水平・垂直範囲が自動計算されます。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classMessage#

2 つの Participant ライフライン間（または自己呼び出しループ）の相互作用を表すメッセージ矢印オブジェクトです。request()、reply()、connect() から返されます。

Message(
    source: Participant,
    target: Participant,
    label: str = "",
    is_reply: bool = False,
    is_async: bool = False,
    arrow: ArrowType = "->",
    style: Style | None = None,
    text_style: Style | None = None,
    padding: PaddingType = 0.0,
    show: bool = True,
) -> None

• 座標アンカー: 該当ステップのタイムライン Y 座標において、source のライフライン X から target のライフライン X まで水平に描画されます（source is target の場合は右側へ折り返すループ矢印）。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classBlock#

d.loop()、d.alt()、d.else_()、d.opt()、d.par() から Python の with コンテキストマネージャとして利用する UML 2.0 複合フラグメント（loop、alt、else、opt、par）です。

Block(
    block_type: BlockType,
    label: str = "",
    diagram: SequenceDiagram | None = None,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: with ブロック内で記録された全メッセージの水平ライフライン範囲と垂直タイムライン区間を自動的に囲みます。

コンストラクタ引数・変更可能属性#

classNote#

現在のタイムラインステップにおいて、単一の Participant ライフラインの脇、または複数のライフラインを跨いで配置される付箋ノート注釈カードです。

Note(
    text: str,
    on: Participant | None = None,
    over: list[Participant] | None = None,
    pos: NotePosition = "right",
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: 現在の垂直タイムラインステップ位置で、on の "left" / "right"、または over 参加者群の水平スパン中央（"over"）に配置されます。

コンストラクタ引数#

パブリックメソッド・プロパティ#

classCustomIcon#

任意のラスター画像ファイル、Dimage オブジェクト、または PIL.Image.Image インスタンスをラップし、Participant(..., icon=CustomIcon(...)) として利用可能にするアダプタクラスです。

CustomIcon(
    image: str | Path | Dimage | Image | CustomIcon,
) -> None

• 座標アンカー: Participant ヘッダーカードのアイコンスロット中央に icon_size で自動配置されます。

コンストラクタ引数#

パブリックメソッド・プロパティ#

typeicons#

CustomIcon、IconType、および全 34 種類のアイコン列挙型を再公開するサブモジュール名前空間（drawlib.diagrams.sequence.icons、drawlib.diagrams.architecture.icons と共通）です。

from drawlib.diagrams.sequence import icons

api = Participant("Gateway", icon=icons.GcpIcon.CLOUD_ENDPOINTS)

• 座標アンカー: 該当なし（40 個のアイコン型およびヘルパーを再公開する名前空間モジュール）。

enumIcon Enums (34 Suites)#

Participant(..., icon=<Enum>.<MEMBER>) のヘッダーカードに宣言的に指定可能な、全 34 種類の標準アイコン StrEnum クラス群です（drawlib.diagrams.sequence 直下および drawlib.diagrams.sequence.icons の双方から再エクスポートされています）。PhosphorIcon は participant.style / diagram.node_style で着色され、残り 33 スイートは drawlib.icons の PNG アセットを描画します。