製品・APIガイド

ジェネレーターでのデザイン

テンプレートから始める

アカウントのテンプレートから新規作成するか、既存のテンプレートをジェネレーターで開きます。アセットからテキスト、見出し、表、画像、グラフを追加できます。キャンバスで要素を選択すると、インスペクターに設定が表示されます。

レイアウトと利用可能な領域

位置、サイズ、配置にはレイアウト、文字設定や内側の余白にはスタイルを使用します。フロー配置はドキュメントの順序に従い、絶対配置は特定の位置に置く必要がある要素に使用します。長さが変わるレポートにはフローを優先し、長いデータで改ページを確認してください。

サイズと内外の余白

幅100%は、用紙全体ではなく、親領域を満たすことを意味します。ページの余白はドキュメントの使用可能領域を狭め、内側の余白は要素内部の領域を狭めます。段組み内の表やグラフも、段の幅に制限されます。

APIでも同じ操作を行う

エディターは、ご自身でも呼び出せる同じエンドポイントでテンプレート定義を書き込みます。現在の定義を読み取り、変更した後、読み取ったバージョンを指定して書き戻してください。これにより、その間にほかの人が公開した変更を誤って上書きすることを防げます。

cURL

# 1 - エディターが使用する定義をダウンロード
curl -s https://api.pdfgine.com/api/v1/templates/invoice \
  -H "X-PDFgine-Key: $PDFGINE_KEY" > invoice.json

# 2 - invoice.json内の"definition"オブジェクトを編集

# 3 - 同じバージョン番号で書き戻す
curl -X POST https://api.pdfgine.com/api/v1/templates \
  -H "X-PDFgine-Key: $PDFGINE_KEY" \
  -H "Content-Type: application/json" \
  -d '{
        "code": "invoice",
        "name": "Invoice",
        "saveMode": "manual",
        "expectedVersion": 1,
        "changeReason": "ロゴを右余白へ移動しました。",
        "definition": { "page": { "size": "A4", "orientation": "portrait" }, "elements": [] }
      }'

この安全性を確保するのがexpectedVersionです。テンプレートのバージョンが進んでいる場合、書き込みは409で拒否され、レスポンスに現在のバージョンが含まれます。再度読み取り、変更を適用し直して、書き込んでください。

保存と出力の確認

変更を保存し、プレビューと必要なPDFまたはWord出力を確認してください。キャンバスに収まるサンプルでも、実データが長い場合はページが増えることがあります。公開前に、見出し、表、グラフのラベル、改ページをまとめて確認してください。

表データビルダー →

よくある問題

エディターで表示されるのは下書きです。公開するまで、すべての本番生成は以前の公開済みバージョンを使用し続けます。
サンプルデータは実際のデータより短いものです。キャンバスに収まるレイアウトでも、実際の顧客名、住所、30行のデータを入れると、2ページ目にはみ出すことがあります。
100%は用紙ではなく、格納領域を指します。要素の幅が決まる前に、外側余白と内側余白が差し引かれます。
絶対配置は、ほかのコンテンツを避けて移動しません。固定座標に置いた要素は、フローのコンテンツが増えてもその位置に残ります。複数ページにまたがる内容にはflowを使用してください。
同じテンプレートを2人が編集すると、マージではなく409になります。書き込みには開始時のバージョンを含め、そのバージョンが進んでいれば拒否されます。