tagGroup（タグ グループ）

eagle.tagGroup APIを通じて、現在のアプリケーション内のタググループに簡単にアクセスできます。

// すべてのタググループを取得
const tagGroups = (await eagle.tagGroup.get());

メソッド

get()

すべてのタググループを取得します。

• 戻り値 Promise<tagGroups: Object[]> - tagGroupsのクエリ結果。

const tagGroups = (await eagle.tagGroup.get());

create(options)

すべてのタググループを取得します。

• 戻り値 Promise<tagGroup: Object> - 新しく作成されたタググループ

await eagle.tagGroup.create({
    name: "new group",
    color: "red",
    tags: ["tag1", "tag2"],
    description: "グループの説明"  // Eagle 4.0 build18+
});

---

インスタンスメソッド

save()

タググループの変更を保存します。

• 戻り値 Promise<tagGroup: Object> - 保存結果。

const tagGroups = (await eagle.tagGroup.get());
const tagGroup = tagGroups[0];

tagGroup.name = "new name";
tagGroup.color = "red"; // red, orange, yellow, green, aqua, blue, purple, pink
tagGroup.tags = ["tag1", "tag2"];
tagGroup.description = "グループの説明";  // Eagle 4.0 build18+

await tagGroup.save();

remove()

タググループを削除します。

• 戻り値 Promise<result: boolean> - 削除が成功したかどうか

const tagGroups = (await eagle.tagGroup.get());
const tagGroup = tagGroups[0];

await tagGroup.remove();

addTags(options)

グループにタグを増分で追加します。完全なタグ配列を渡す必要はありません。

• options Object - オプションパラメータ

  • tags string[] - 追加するタグ名の配列

  • removeFromSource boolean (オプション) - 元のグループからタグを削除するかどうか、デフォルトは false

    • false：タグを追加のみ（タグは複数のグループに存在可能）

    • true：タグを移動（元のグループから削除）

• 戻り値 Promise<tagGroup: Object> - 更新されたタググループ

const tagGroups = (await eagle.tagGroup.get());
const tagGroup = tagGroups[0];

// タグを追加（複数のグループに存在可能）
await tagGroup.addTags({
    tags: ['UI', 'UX', 'Typography']
});

// タグを移動（元のグループから削除）
await tagGroup.addTags({
    tags: ['Branding'],
    removeFromSource: true
});

ヒント：addTags() メソッドは Eagle 4.0 build18 以上のバージョンが必要です。

removeTags(options)

グループから指定したタグを削除します。

• options Object - オプションパラメータ

  • tags string[] - 削除するタグ名の配列

• 戻り値 Promise<tagGroup: Object> - 更新されたタググループ

const tagGroups = (await eagle.tagGroup.get());
const tagGroup = tagGroups[0];

// グループからタグを削除
await tagGroup.removeTags({
    tags: ['Outdated', 'Draft']
});

ヒント：removeTags() メソッドは Eagle 4.0 build18 以上のバージョンが必要です。

注意：このメソッドはグループからタグを削除するだけです。タグ自体の削除やアイテムのタグには影響しません。