メインコンテンツまでスキップ

パッケージ概要

ts-graphviz を拡張またはカスタマイズしたいユーザーにとって、内部パッケージを理解することは有益です。以下に、内部パッケージの概要と、それらを高度なシナリオでどのように使用できるかを説明します。

@ts-graphviz/adapter

目的:Graphviz のコマンドを実行し、DOT 言語の文字列をさまざまな出力形式に変換するためのインターフェースを提供します。

使用方法

  • DOT 文字列をストリームやファイルに変換します。
  • グラフを画像や他の形式にレンダリングする必要がある環境で使用します。

@ts-graphviz/ast

目的:DOT 言語を抽象構文木(AST)レベルで操作できるようにします。

使用方法

  • DOT 文字列を AST ノードに解析します。
  • AST をプログラム的に操作・変換します。
  • 既存の DOT コードの高度な解析や変換に便利です。

@ts-graphviz/common

目的:Graphviz のドメイン知識を集約し、型定義、定数、ユーティリティを提供します。型の拡張などのユースケースに対応しています。

使用方法

  • 型や属性を拡張またはカスタマイズします。
  • カスタム属性を扱う際に型安全性を確保します。
  • パッケージ全体で Graphviz のドメイン知識を一貫して使用できるようにします。

@ts-graphviz/core

目的:ユーザーに提供されるモデルと関数のコア実装を含みます。

使用方法

  • オブジェクト指向の API を使用して、グラフ要素を細かく制御します。
  • クラスを拡張してカスタムな動作や属性を追加します。