Skip to content

First Gridgram

.gg 言語のガイド付きツアー — 1 セクションにつき 1 つの概念と、それに 対応するレンダリング結果を並べて紹介します。上から下まで読めば、 日常的な図で使う構文はすべて押さえられます。

Gridgram は グリッドベースの図版生成器 です。コマンド先頭型の .gg ファイル、または TypeScript の DiagramDef で図を記述すると、 SVG または PNG にレンダリングします。両方とも同じレンダリング パイプラインを通るため、出力は同一であることが保証されます。

始める前に gg バイナリが PATH に通っていることを確認してください — まだインストールしていなければ クイックスタート を参照。

最小の例

basic-01-hello (SVG, frame 1)

単一アイコンの図です — @pos を省略していることに注目。Gridgram は アイコンを宣言順に row 0 上で自動配置するので、横一列の単純なフロー 図は座標指定が一切不要です。

2 つのショートハンド

ほぼすべての行で登場するので先に押さえておくと読みやすくなります:

  • "…" または '…' — ラベル。 icon / region / note / コネクタに付くクォート文字列は表示ラベルです。どちらのクォートでも 同じ。テキスト内のエスケープが楽なほうを選んでください。
  • :user — ID。 先頭の : はノードに名前を付ける記号で、他の ステートメントから参照できるようにします。ID が必要なのは コネクタuser --> api)や ノートのターゲットnote [user] "…")から 参照されるときだけ。参照されないノードは :id を省略でき、内部で 自動 ID が割り振られます。
gg
icon :user tabler/user   "User"    # :user は ID、"User" はラベル
icon :api  tabler/server "API"
user --> api "login"               # コネクタが :id で参照

組込アイコン(Tabler)

上の例で使っている tabler/user は組込アイコン集から来ています。 Gridgram は Tabler アイコン を同梱 しており、5,500 以上の outline アイコンと多数の filled 亜種が使えます。 参照は tabler/ 名前空間経由:

gg
icon @A1 tabler/world        "Front"   # outline
icon @B1 tabler/filled/star  "Hot"     # filled
icon-tabler (SVG, frame 1)

https://tabler.io/icons で全アイコンを検索・ブラウズできます。 カタログ上の名前(arrow-rightcloud-uploaddatabase など)は すべて tabler/ プレフィックス付きで使えます。

指定した名前に filled 亜種がない場合、リゾルバはそのノードを iconError として扱い、赤いリング で描画します。これにより参照 切れが一目で分かります(Tabler の outline は filled よりずっと 網羅的)。

独自アセット(URL / ファイルパス / dataURL)は doc { icons: … } または gridgram.config.ts で登録します。詳細は アイコン を参照。

自動配置の横フロー

basic-02-multi-node (SVG, frame 1)

最小例と同じ原理:アイコンは自動配置され、row 0 上で col が増加します。 コネクタは <id> <arrow> <id> の形でノード間を繋ぎます。

行の折り返し

doccols を指定しつつ @pos を省略した場合、自動配置された アイコンは列数に達した時点で 次の行に折り返し ます:

auto-wrap (SVG, frame 1)
gg
doc { cols: 4 }

icon tabler/user     "user"
icon tabler/world    "web"
icon tabler/server   "api"
icon tabler/database "db"
icon tabler/bolt     "queue"
icon tabler/cloud    "cdn"
icon tabler/lock     "auth"
icon tabler/file     "audit"

8 個のアイコン × 4 列 → 2 行。明示的な @pos と暗黙の配置は自由に 混在でき、明示配置は auto カウンタを進めません。

グリッドに配置する

1 行に収まらなくなったら、各アイコンに @col,row を書きます。グリッド は Excel 風の (列, 行) 順 — 表計算ソフトの A1 と同じ配置規則 です。cols / rows は書いた @col / @row の最大値から自動推論 されるため、2×2 のレイアウトには doc { } ブロックすら不要:

basic-03-grid-2x2 (SVG, frame 1)
AB
12
gg
icon :front @A1 tabler/world    "Frontend"
icon :api   @B1 tabler/server   "API"
icon :cache @A2 tabler/database "Cache"
icon :db    @B2 tabler/database "DB"

明示的にグリッドを固定したい場合(末尾の空セルを残す、推論値を 曖昧にしたくない等)は doc { cols: N, rows: M } を追加します。 リージョン・テーマ・明示グリッドが揃った例は ドキュメント リファレンスを参照。

ラベルは Unicode(CJK OK)

ラベルはすべて UTF-8 テキストとして扱われるので、日本語・中国語・ 韓国語などの非ラテン文字もラテン文字と同じように描画されます。 フォント設定もエスケープも不要:

label-cjk (SVG, frame 1)

コネクタのラベル、ノートの本文、リージョンのタイトルも同様です。 混在スクリプト("API 伺服器" など)は Gridgram が SVG の <text> に そのまま渡し、ブラウザやラスタライザがグリフを選びます。

次に読む

このページを編集Last updated: