drawlib.diagrams.flow（フローチャート・スイムレーン）

ISO 5807 / JIS X 0121 準拠のフローチャート記号、条件分岐、直交ルーティング、および部門横断スイムレーン（縦・横レーン）を備えたワークフロー図モジュールです。標準インポート: from drawlib.diagrams.flow import Data, Decision, End, FlowDiagram, Process, Start。

from drawlib.canvas import save, setup
from drawlib.diagrams.flow import Data, Decision, End, FlowDiagram, Process, Start
from drawlib.styles import Colors, Styles

setup(width=120, height=68)

flow = FlowDiagram(
    node_style=Styles.Neutral.patch(text_size=10.5),
    edge_style=Styles.DarkBold,
    edge_text_style=Styles.DarkBold.patch(text_size=10.0),
    width=110,
    height=58,
    lane_orientation="vertical",
)

flow.add_lane(
    "Client",
    width=36,
    style=Styles.Neutral,
    header_style=Styles.PrimaryNeutral,
    text_style=Styles.DarkBold.patch(text_size=11.0),
)
flow.add_lane(
    "Gateway",
    width=38,
    style=Styles.Neutral,
    header_style=Styles.SecondaryNeutral,
    text_style=Styles.DarkBold.patch(text_size=11.0),
)
flow.add_lane(
    "Fulfillment",
    width=36,
    style=Styles.Neutral,
    header_style=Styles.PrimaryNeutral,
    text_style=Styles.DarkBold.patch(text_size=11.0),
)

start = flow.add(
    Start("Start", width=20, height=9, style=Styles.PrimaryFlat.patch(text_color=Colors.White, text_size=10.5)),
    xy=(18.0, 43.0),
)
submit = flow.add(Process("Submit Order", width=26, height=10), xy=(18.0, 27.5))
check = flow.add(
    Decision("Valid?", width=24, height=13, style=Styles.PrimaryNeutral.patch(text_size=10.5)),
    xy=(55.0, 27.5),
)
reject = flow.add(
    Data("Error Notice", width=26, height=9, style=Styles.SecondaryNeutral.patch(text_size=10.5)),
    xy=(55.0, 7.5),
)
ship = flow.add(
    Process("Dispatch", width=24, height=10, style=Styles.PrimaryNeutral.patch(text_size=10.5)),
    xy=(92.0, 35.5),
)
done = flow.add(
    End("Done", width=20, height=9, style=Styles.SecondaryNeutral.patch(text_size=10.5)),
    xy=(92.0, 12.0),
)

start.connect(submit, padding=0.8)
submit.connect(check, padding=0.8)
check.connect(ship, label="Yes", start_side="right", end_side="left", padding=0.8)
check.connect(reject, label="No", start_side="bottom", end_side="top", padding=0.8)
ship.connect(done, padding=0.8)

flow.draw(xy=(5.0, 5.0))
save()

typeArrowType#

FlowEdge 接続線の端点に描画する矢印マーカーを指定する型エイリアスです。

ArrowType = Literal["->", "<-", "<->", "-"] | str

• 座標アンカー: FlowEdge の始点および終点に適用されます。

typeConnectable#

FlowEdge の始点 start または終点 end として指定可能なフローチャート要素を表す Union 型エイリアスです。

Connectable = FlowNode | Junction

• 座標アンカー: FlowNode（およびサブクラス Start、End、Process、Decision、Data）の外周ポートアンカー、または Junction の点座標 (x, y) に解決されます。

classData#

データ入力・出力ペイロード・外部ストレージレコードを表す平行四辺形の入出力ノードです。FlowNode のサブクラスです。

Data(
    text: str = "",
    width: float = 24.0,
    height: float = 12.0,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: flow.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。

コンストラクタ引数#

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

classDecision#

4 つの頂点アンカーを持つひし形（ダイヤモンド）として描画される条件分岐ノードです。FlowNode のサブクラスです。

Decision(
    text: str = "",
    width: float = 22.0,
    height: float = 14.0,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: flow.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。"Yes" と "No" の出力分岐が重ならないよう、.connect() で start_side="right" / start_side="bottom" 等を明示指定することを推奨します。

コンストラクタ引数#

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

classEnd#

スタジアム型（カプセル／ピル形状）として描画されるフローチャート終了端子ノードです。FlowNode のサブクラスです。

End(
    text: str = "End",
    width: float = 20.0,
    height: float = 10.0,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: flow.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。

コンストラクタ引数#

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

classFlowDiagram#

フローチャートおよび部門横断スイムレーン図のトップレベルコンテナです。スイムレーン利用時も全ノードは単一の共通グローバル座標空間を共有します。

FlowDiagram(
    *,
    node_style: Style,
    edge_style: Style,
    edge_text_style: Style,
    title: str = "",
    title_style: Style | None = None,
    width: float | None = None,
    height: float | None = None,
    style: Style | None = None,
    lane_orientation: Orientation = "vertical",
) -> None

• 座標アンカー: draw(xy=(0.0, 0.0), align="bottom_left") は図のローカル左下隅 (0.0, 0.0) をキャンバス座標 xy に配置します（align="center" の場合は図全体の中心を xy に配置）。

コンストラクタ引数#

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

classFlowEdge#

FlowDiagram 内の 2 つの Connectable 要素を結ぶ接続エッジです。

FlowEdge(
    start: Connectable,
    end: Connectable,
    label: str = "",
    arrow: ArrowType | None = None,
    routing: RoutingType = "orthogonal",
    start_side: Side = "auto",
    end_side: Side = "auto",
    style: Style | None = None,
    text_style: Style | None = None,
    padding: PaddingType = 0.0,
    show: bool = True,
) -> None

• 座標アンカー: start の start_side ポートと end の end_side ポートを接続します。中間ウェイポイントは図のローカル座標 (x, y) で指定します。

コンストラクタ引数#

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

classFlowNode#

すべてのフローチャート記号（"process"、"decision"、"start"、"end"、"data"）を表す基底ノードクラスです。通常は shape_type と標準サイズが設定済みの具象サブクラス Start、End、Process、Decision、Data を使用します。

FlowNode(
    text: str = "",
    width: float = 24.0,
    height: float = 12.0,
    style: Style | None = None,
    text_style: Style | None = None,
    shape_type: ShapeType = "process",
    show: bool = True,
) -> None

• 座標アンカー: flow.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。

コンストラクタ引数#

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

classJunction#

FlowDiagram 内でエッジの折れ曲がり制御や分岐・合流に用いる面積ゼロの接続ポイントです。

Junction(
    xy: tuple[float, float],
    *,
    show: bool = True,
) -> None

• 座標アンカー: 図ローカル座標系における厳密な点 (x, y)。flow.junction(xy) または edge.add_point(xy) で生成します。

コンストラクタ引数#

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

classLane#

FlowDiagram の背景を区切るスイムレーン列（lane_orientation="vertical"）またはスイムレーン行（lane_orientation="horizontal"）です。通常は flow.add_lane(...) から生成します。

Lane(
    title: str,
    size: float,
    style: Style | None = None,
    text_style: Style | None = None,
    header_size: float = 6.0,
    header_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: 図の (0, 0) グローバル座標系上に順番に自動タイリングされます（縦列レーンは左から右、横行レーンは上から下）。幅 $W_0, W_1, \dots$ の縦列レーンの場合、各列の中心 X 座標は $X_0 = W_0 / 2$、$X_1 = W_0 + W_1 / 2$ となります。

コンストラクタ引数・属性#

typeOrientation#

FlowDiagram におけるスイムレーンの並び軸を指定する Literal 型エイリアスです。

Orientation = Literal["vertical", "horizontal"]

• 座標アンカー: Lane 帯が背景にタイリングされる方向を制御します。

typePaddingType#

FlowEdge の両端に設けるクリアランス余白距離を表す Union 型エイリアスです。

PaddingType = float | tuple[float, float]

• 座標アンカー: start および end ノード境界からエッジ端点までの離隔距離を指定します。

classProcess#

アクション・タスク・業務処理ステップを表す長方形ノードです。FlowNode のサブクラスです。

Process(
    text: str = "",
    width: float = 24.0,
    height: float = 12.0,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: flow.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。

コンストラクタ引数#

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

typeRoutingType#

FlowEdge 接続線の経路計算方式を指定する Literal 型エイリアスです。

RoutingType = Literal["orthogonal", "direct"]

• 座標アンカー: 解決された start と end のポート座標間の補間経路を制御します。

typeShapeType#

FlowNode のフローチャート記号形状を選択する Literal 型エイリアスです。

ShapeType = Literal["process", "decision", "start", "end", "data"]

• 座標アンカー: すべての形状はノードの中心座標 (cx, cy) を基準に描画されます。

typeSide#

FlowNode 図形上の接続ポート辺を指定する Literal 型エイリアスです。

Side = Literal["left", "right", "top", "bottom", "auto"]

• 座標アンカー: 対応する辺の中点（Decision では各頂点）に解決されます。"auto" の場合は対向する最短辺を自動選択します。

classStart#

スタジアム型（カプセル／ピル形状）として描画されるフローチャート開始端子ノードです。FlowNode のサブクラスです。

Start(
    text: str = "Start",
    width: float = 20.0,
    height: float = 10.0,
    style: Style | None = None,
    text_style: Style | None = None,
    show: bool = True,
) -> None

• 座標アンカー: flow.add(node, xy=(cx, cy)) で登録する際の中心座標 (cx, cy)。

コンストラクタ引数#

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