カタログJSONの作成方法 | フィラメントラベルメーカー

このJSONファイルの役割

カタログJSONは、メーカー・材質・シリーズ・色の候補をアプリに渡すためのデータです。ラベルメーカーは起動時に filament-colors.json を読み込みます。独自のJSONを作成してインポートすると、そのブラウザのタブ内だけでカタログを差し替えられます（サーバーには保存されません）。

全体の構成

JSONのトップレベルには manufacturers 配列が必要です。

項目	必須	説明
`manufacturers`	必須	メーカー一覧。1件以上必要です。プルダウンの候補はここから作られます。

階層は次のとおりです。

manufacturers[]
  └─ id, name
       └─ materials[]
            └─ id, name
                 └─ series[]
                      └─ id, name, productName（推奨）
                           └─ colors[]
                                └─ code, name, hex

実例（ルート）

ファイルは manufacturers 配列から始まります。

{
  "manufacturers": [
    …
  ]
}

実例（メーカー・材質・シリーズ）

メーカー名はラベルの「メーカー名」欄に、材質名は「材質」欄に、シリーズ名は「シリーズ名」欄に入ります。 id はプルダウン内部の識別子、name は画面に表示される名前です。

{
  "id": "example-maker",
  "name": "Example Maker",
  "materials": [
    {
      "id": "pla",
      "name": "PLA",
      "series": [
        {
          "id": "basic",
          "name": "Basic",
          "productName": "PLA Basic",
          "colors": [
            …
          ]
        }
      ]
    }
  ]
}

id は英数字とハイフンなど、ファイル内で重複しない文字列にしてください。
productName は必須ではありませんが、色を選んだときの案内文に使われます。省略すると案内文が不完全になることがあります。
シリーズを持たない汎用カタログでは、id を none、name を「無し」にする例もあります（見本JSONの Generic を参照）。

実例（色の定義）

各色は code（色コード）、name（色名）、hex（プレビュー用の色）を持ちます。色を選ぶと、色名とHEX値がラベル入力欄へ自動で入ります。

"colors": [
  { "code": "10100", "name": "Jade White", "hex": "#FFFFFF" },
  { "code": "10101", "name": "Black", "hex": "#000000" },
  { "code": "32101", "name": "Clear", "hex": null }
]

hex は #RRGGBB 形式の文字列、または透明・未設定を表す null が使えます。
hex が null の場合、プレビューは白（#FFFFFF）として扱われます。
code はメーカー独自の番号でも、web-red のような任意の文字列でも構いません。

最小構成の例

動作確認用の、できるだけ短い例です。

{
  "manufacturers": [
    {
      "id": "my-brand",
      "name": "My Brand",
      "materials": [
        {
          "id": "pla",
          "name": "PLA",
          "series": [
            {
              "id": "standard",
              "name": "Standard",
              "productName": "PLA Standard",
              "colors": [
                { "code": "white", "name": "White", "hex": "#FFFFFF" },
                { "code": "black", "name": "Black", "hex": "#000000" }
              ]
            }
          ]
        }
      ]
    }
  ]
}

インポート時のチェック内容

ラベルメーカーはインポート時に、おおまかに次の条件を満たすか確認します。

正しいJSON形式であること（コメント // や /* */ は使えません）
manufacturers が配列で、1件以上含まれること
各メーカーに空でない id と name があること
各材質に空でない id と name があり、series 配列を持つこと
各シリーズに空でない id と name があり、colors 配列を持つこと
各色に空でない code と name があり、hex は文字列または null であること
ファイルサイズが2MB以下であること

形式が合わない場合はエラーが表示されます。まずは見本JSON をダウンロードし、必要な部分だけ編集するのが簡単です。

作成時の注意

標準JSONにはコメントを書けません。補足が必要な場合は別のメモに書いてください。
インポートしたカタログはページを再読み込みすると消え、元の filament-colors.json に戻ります。
すでに作成済みのラベルは、カタログ差し替え後もそのまま残ります。
hex は画面プレビュー用の代表色です。実際のフィラメントの色を保証するものではありません。

使い方

この説明または見本JSONを参考に、カタログJSONを作成します。
ラベルメーカーを開き、ページ下部の「JSONファイルをインポート」からファイルを選びます。
読み込みに成功すると、メーカーのプルダウンが新しいカタログに切り替わります。

おすすめの作成方法