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

複数シート

xlmakeでは複数のシートを持つExcelファイルを簡単に作成できます。

基本的な使い方​

sheet()を連続して呼び出すことで、複数のシートを作成できます。

import { xlmake } from "xlmake";

const output = await xlmake()
  .sheet("売上")
  .table({
    preset: "basic",
    columns: [
      { key: "name", label: "商品名" },
      { key: "sales", label: "売上" },
    ],
    data: salesData,
  })
  .sheet("在庫")  // 2つ目のシート
  .table({
    preset: "basic",
    columns: [
      { key: "name", label: "商品名" },
      { key: "stock", label: "在庫数" },
    ],
    data: stockData,
  })
  .getNode();

await output.saveToFile("report.xlsx");

シート名​

明示的に指定​

xlmake()
  .sheet("売上データ")
  .sheet("在庫データ")
  .sheet("顧客マスタ")

自動生成​

シート名を省略すると、Sheet1, Sheet2... と自動生成されます。

xlmake()
  .sheet()  // Sheet1
  .sheet()  // Sheet2
  .sheet()  // Sheet3

各シートに異なるコンテンツ​

各シートには独立したテーブル、テキスト、画像を追加できます。

const output = await xlmake()
  .sheet("サマリー")
  .text({ value: "月次レポート", style: { bold: true, fontSize: 16 } })
  .space(2)
  .table({
    preset: "basic",
    columns: summaryColumns,
    data: summaryData,
  })
  .sheet("詳細データ")
  .table({
    preset: "striped",
    columns: detailColumns,
    data: detailData,
  })
  .sheet("グラフデータ")
  .table({
    preset: "minimal",
    columns: chartColumns,
    data: chartData,
  })
  .getNode();

ワークブックのマージ​

別々に作成したワークブックを後からマージできます。

基本的な使い方​

const bookA = xlmake().sheet("A").table({ columns: [...], data: [...] });
const bookB = xlmake().sheet("B").table({ columns: [...], data: [...] });
const merged = xlmake().merge([bookA, bookB]);

ユースケース​

モジュール化​

各シートを関数で分離して、コードを整理できます:

// 各シートを関数で分離
function createSalesSheet() {
  return xlmake()
    .sheet("売上")
    .table({ columns: [...], data: salesData });
}

function createStockSheet() {
  return xlmake()
    .sheet("在庫")
    .table({ columns: [...], data: stockData });
}

// マージして出力
const report = xlmake().merge([
  createSalesSheet(),
  createStockSheet(),
]);

await report.getNode().saveToFile("report.xlsx");

条件付きシート追加​

条件に応じてシートを動的に追加できます:

const baseBook = xlmake().sheet("基本データ").table({ ... });
const sheets = [baseBook];

if (includeDetails) {
  sheets.push(xlmake().sheet("詳細").table({ ... }));
}

if (includeSummary) {
  sheets.push(xlmake().sheet("集計").table({ ... }));
}

const report = xlmake().merge(sheets);

注意点​

  • シート名の重複: 同じシート名がある場合はエラーになります
  • 空のワークブック: シートが1つもないワークブックは無視されます

シート名の制約​

Excelの仕様により、シート名には以下の制約があります:

  • 最大31文字
  • 使用できない文字: : \ / ? * [ ]

これらの制約に違反した場合、xlmakeはエラーをスローします。

完全な例​

import { xlmake } from "xlmake";

const salesData = [
  { name: "りんご", sales: 50000 },
  { name: "みかん", sales: 40000 },
];

const stockData = [
  { name: "りんご", stock: 100 },
  { name: "みかん", stock: 200 },
];

const output = await xlmake()
  .sheet("売上")
  .text({ value: "売上データ", style: { bold: true, fontSize: 14 } })
  .space(1)
  .table({
    preset: "basic",
    columns: [
      { key: "name", label: "商品名" },
      { key: "sales", label: "売上" },
    ],
    data: salesData,
  })
  .sheet("在庫")
  .text({ value: "在庫データ", style: { bold: true, fontSize: 14 } })
  .space(1)
  .table({
    preset: "basic",
    columns: [
      { key: "name", label: "商品名" },
      { key: "stock", label: "在庫数" },
    ],
    data: stockData,
  })
  .getNode();

await output.saveToFile("multi-sheet.xlsx");

関連​