@mogura/moguchart-plugin-excel 1.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-present Murakami Hiroyuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.ja.md

@@ -0,0 +1,126 @@
+# @mogura/moguchart-plugin-excel
+
+[English](./README.md)
+
+ガントチャートライブラリ `@mogura/moguchart-core` 用の Excel (.xlsx) エクスポートプラグインです。
+ExcelJS を使用し、カレンダー日付列にタスク期間が色塗りされた「Excel製ガントチャート（工程表・タイムライン）」を高画質・スタイリング付きで出力します。
+
+## 特徴
+
+- 📊 **Excelタイムライン（工程表）出力**: 左側にタスク属性（WBS、タスク名、担当者、期間、進捗率等）、右側にカレンダー列を配置し、タスクの開始日〜終了日に対応するセルを美しく着色（サマリータスク、土日・祝日の背景色分け、進捗率パーセント表示対応）。
+- 🌐 **多言語対応 & カスタムロケール**: 日本語（`ja`）、英語（`en`）、中国語簡体字（`zh`）を標準サポート。独自の言語定義（`registerExcelLocale`）も追加可能。
+- 🌳 **WBS階層構造の保持**: 親行・子行の階層関係（WBSコード `1`, `1.1`, `1.2` 等）を維持し、インデントや太字を反映。
+- 🎨 **カラーカスタマイズ**: テーマカラーやタスクごとのカスタムバー色（`progressColor`）がExcel上にも反映。
+- ⏱ **多彩なタイムラインスケール**: 時間（hour）・日（day）・週（week）・月（month）スケール、および半日や30分などの列分割に対応。
+- ⚡ **クライアント完結**: ブラウザ上で直接 `.xlsx` ファイルを生成・自動ダウンロード可能。
+
+## インストール
+
+```bash
+pnpm add @mogura/moguchart-plugin-excel
+# または
+npm install @mogura/moguchart-plugin-excel
+```
+
+## 使い方
+
+### 1. プラグインとして登録して使う（推奨）
+
+チャートインスタンスにプラグインを登録すると、`chart.exportExcel()` メソッドが有効化されます。
+
+```typescript
+import '@mogura/moguchart-core'
+import { excelPlugin } from '@mogura/moguchart-plugin-excel'
+
+const chart = document.querySelector('gantt-chart')
+
+// プラグインの登録
+chart.use(excelPlugin({
+  defaultFilename: 'プロジェクト工程表.xlsx',
+  defaultSheetName: '工程表',
+  themeColor: '#3B82F6'
+}))
+
+// Excelエクスポート（タイムライン付き工程表）
+await chart.exportExcel()
+
+// 英語でエクスポート
+await chart.exportExcel({
+  locale: 'en',
+  filename: 'project-schedule.xlsx'
+})
+```
+
+### 2. スタンドアロン関数として呼ぶ（必要な時だけ遅延インポート）
+
+エクスポートボタンがクリックされた時だけ動的インポート（Dynamic Import）することで、初期バンドルサイズを最小限に抑えられます。
+
+```typescript
+async function handleExportExcel(chartElement) {
+  const { exportExcel } = await import('@mogura/moguchart-plugin-excel')
+  await exportExcel(chartElement, {
+    filename: '工程表.xlsx',
+    locale: 'ja',
+    download: true
+  })
+}
+```
+
+### 3. カスタム言語・ロケールの追加
+
+独自の言語定義を追加したい場合、`registerExcelLocale` を使用して新しいロケールを登録できます。
+
+```typescript
+import { registerExcelLocale, exportExcel } from '@mogura/moguchart-plugin-excel'
+
+registerExcelLocale('fr', {
+  code: 'fr',
+  sheetName: 'Planning',
+  defaultFilename: 'planning-gantt.xlsx',
+  columns: {
+    wbs: 'WBS',
+    name: 'Nom de tâche',
+    assignee: 'Responsable',
+    startDate: 'Date de début',
+    endDate: 'Date de fin',
+    duration: 'Durée',
+    progress: 'Progression',
+  },
+  dateFormat: 'DD/MM/YYYY',
+  timeFormat: 'HH:mm',
+  monthYearFormat: (year, month) => `${month}/${year}`,
+  weekFormat: (year, week) => `Sem ${week}, ${year}`,
+  dayHeaderFormat: (date) => `${date.getDate()}`,
+  hourHeaderFormat: (hour) => `${hour}h`,
+  dayNames: ['Dim', 'Lun', 'Mar', 'Mer', 'Jeu', 'Ven', 'Sam'],
+  durationUnit: ' j',
+  summaryLabel: ' (Récapitulatif)',
+  percentLabel: '%',
+})
+
+await chart.exportExcel({ locale: 'fr' })
+```
+
+## オプション (`ExportExcelOptions`)
+
+| オプション | 型 | デフォルト値 | 説明 |
+| :--- | :--- | :--- | :--- |
+| `locale` | `'ja' \| 'en' \| 'zh' \| string \| ExcelLocaleDefinition` | 自動判定 / `'ja'` | 言語・ロケール指定（日本語、英語、中国語、または登録済み独自言語定義） |
+| `filename` | `string` | `'gantt-chart.xlsx'` | 出力ファイル名 |
+| `sheetName` | `string` | `'工程表'` | 出力シート名 |
+| `timelineScale` | `'hour' \| 'day' \| 'week' \| 'month'` | 自動判定 (`'day'`) | タイムライン列の刻み単位（時間・日・週・月） |
+| `columnsPerUnit` | `number` | `1` | 1日または1時間あたりの列数・分割数（例: 2で半日単位や30分刻み） |
+| `snapDurationMinutes` | `number` | 自動判定 / `1440` or `60` | スナップ単位（分）。日単位（1440, 720, 360, 180等）や時間単位（60, 30, 15等）から分割列数を自動計算 |
+| `timelineColumnWidth` | `number` | 自動算出 | タイムライン列の幅（文字数単位。指定なし時は画面のpx幅または既定値から自動計算） |
+| `dateFormat` | `string` | `'YYYY/MM/DD'` | 日付の表示形式 |
+| `includeWeekends` | `boolean` | `true` | タイムラインに土日を含めるか（日単位出力時: 土曜は淡いブルー、日曜・祝祭日は淡い赤/ピンク背景） |
+| `highlightToday` | `boolean` | `true` | 今日の日付列をハイライト表示するか |
+| `themeColor` | `string` | `'#3B82F6'` | ヘッダー行やアクセントのテーマカラー（HEX） |
+| `isHoliday` | `(date: Date) => boolean` | 自動判定 | 祝祭日判定関数（指定なし時は `chart.option.calendar.isHoliday` を自動参照） |
+| `holidayColor` | `string` | `'#FEE2E2'` | 祝祭日および日曜日の背景色（日単位出力時のみ適用、淡い赤/ピンク） |
+| `columns` | `ExcelExportColumn[]` | 標準カラム | 出力するテーブル列のカスタム定義配列 |
+| `download` | `boolean` | `true` | ブラウザで自動ダウンロードをトリガーするか |
+
+## ライセンス
+
+MIT

package/README.md

@@ -0,0 +1,121 @@
+# @mogura/moguchart-plugin-excel
+
+[日本語](./README.ja.md)
+
+Excel (.xlsx) export plugin for `@mogura/moguchart-core`.
+Using ExcelJS, it generates beautifully styled Excel files with an interactive timeline (cell-shaded Gantt chart / schedule) completely in the browser.
+
+## Features
+
+- 📊 **Excel Timeline (Visual Gantt)**: Task attributes on the left (WBS, Task Name, Assignee, Dates, Progress) and calendar date columns on the right with colored task duration cells (summary tasks, weekend & holiday shading, progress labels).
+- 🌐 **Multi-Language Support & Custom Locales**: Built-in support for Japanese (`ja`), English (`en`), and Simplified Chinese (`zh`). Easily register custom language packs with `registerExcelLocale`.
+- 🌳 **WBS Hierarchy**: Retains parent-child hierarchy with WBS codes (`1`, `1.1`), indentations, and bold styling.
+- 🎨 **Color Customization**: Reflects theme colors and task-specific colors (`progressColor`) in Excel.
+- ⏱ **Multi-Scale Timelines**: Supports hour, day, week, and month scales, including sub-day and sub-hour column divisions.
+- ⚡ **Client-side Generation**: Generates and downloads `.xlsx` files directly in the browser.
+
+## Installation
+
+```bash
+pnpm add @mogura/moguchart-plugin-excel
+# or
+npm install @mogura/moguchart-plugin-excel
+```
+
+## Usage
+
+### 1. Register as a Plugin (Recommended)
+
+```typescript
+import '@mogura/moguchart-core'
+import { excelPlugin } from '@mogura/moguchart-plugin-excel'
+
+const chart = document.querySelector('gantt-chart')
+
+chart.use(excelPlugin({
+  defaultFilename: 'project-schedule.xlsx',
+  defaultSheetName: 'Schedule',
+  themeColor: '#3B82F6'
+}))
+
+// Export with timeline
+await chart.exportExcel()
+
+// Export in English
+await chart.exportExcel({
+  locale: 'en',
+  filename: 'project-schedule.xlsx'
+})
+```
+
+### 2. Standalone Function (Dynamic Import)
+
+```typescript
+async function handleExportExcel(chartElement) {
+  const { exportExcel } = await import('@mogura/moguchart-plugin-excel')
+  await exportExcel(chartElement, {
+    filename: 'schedule.xlsx',
+    locale: 'en',
+    download: true
+  })
+}
+```
+
+### 3. Adding Custom Locales
+
+To register and use additional languages:
+
+```typescript
+import { registerExcelLocale, exportExcel } from '@mogura/moguchart-plugin-excel'
+
+registerExcelLocale('fr', {
+  code: 'fr',
+  sheetName: 'Planning',
+  defaultFilename: 'planning-gantt.xlsx',
+  columns: {
+    wbs: 'WBS',
+    name: 'Nom de tâche',
+    assignee: 'Responsable',
+    startDate: 'Date de début',
+    endDate: 'Date de fin',
+    duration: 'Durée',
+    progress: 'Progression',
+  },
+  dateFormat: 'DD/MM/YYYY',
+  timeFormat: 'HH:mm',
+  monthYearFormat: (year, month) => `${month}/${year}`,
+  weekFormat: (year, week) => `Sem ${week}, ${year}`,
+  dayHeaderFormat: (date) => `${date.getDate()}`,
+  hourHeaderFormat: (hour) => `${hour}h`,
+  dayNames: ['Dim', 'Lun', 'Mar', 'Mer', 'Jeu', 'Ven', 'Sam'],
+  durationUnit: ' d',
+  summaryLabel: ' (Summary)',
+  percentLabel: '%',
+})
+
+await chart.exportExcel({ locale: 'fr' })
+```
+
+## Options (`ExportExcelOptions`)
+
+| Option | Type | Default | Description |
+| :--- | :--- | :--- | :--- |
+| `locale` | `'ja' \| 'en' \| 'zh' \| string \| ExcelLocaleDefinition` | Auto-detect / `'ja'` | Language & locale definition |
+| `filename` | `string` | `'gantt-chart.xlsx'` | Output filename |
+| `sheetName` | `string` | `'工程表'` | Output worksheet name |
+| `timelineScale` | `'hour' \| 'day' \| 'week' \| 'month'` | Auto-detect (`'day'`) | Timeline column unit (hour, day, week, month) |
+| `columnsPerUnit` | `number` | `1` | Number of columns per day or hour (e.g. 2 for half-day / 30-min slots) |
+| `snapDurationMinutes` | `number` | Auto-detect / `1440` or `60` | Snap duration in minutes to auto-calculate columns per day/hour (e.g. 720 -> 2 cols/day) |
+| `timelineColumnWidth` | `number` | Auto-computed | Timeline column width (in chars, auto-derived from screen px or defaults) |
+| `dateFormat` | `string` | `'YYYY/MM/DD'` | Date format |
+| `includeWeekends` | `boolean` | `true` | Include weekends in timeline (day scale only: Saturdays in light blue, Sundays & holidays in light red/pink) |
+| `highlightToday` | `boolean` | `true` | Highlight today's date column |
+| `themeColor` | `string` | `'#3B82F6'` | Theme color for header & bars |
+| `isHoliday` | `(date: Date) => boolean` | Auto-detect | Holiday judgment function (auto-detected from `chart.option.calendar.isHoliday`) |
+| `holidayColor` | `string` | `'#FEE2E2'` | Background color for holiday and Sunday columns (applies to day scale only) |
+| `columns` | `ExcelExportColumn[]` | Standard cols | Custom column definitions |
+| `download` | `boolean` | `true` | Auto-trigger file download |
+
+## License
+
+MIT

package/dist/export.d.ts

@@ -0,0 +1,10 @@
+import type { GanttChartElement } from '@mogura/moguchart-core';
+import type { ExportExcelOptions, ExcelExportColumn, ExcelTimelineScale, ExcelLocale } from './types';
+/**
+ * デフォルトの標準カラム定義（多言語・カスタムロケール対応）
+ */
+export declare function getDefaultColumns(scale?: ExcelTimelineScale, locale?: ExcelLocale): ExcelExportColumn[];
+/**
+ * ガントチャートデータをExcel (.xlsx) 形式でエクスポートするメイン関数
+ */
+export declare function exportGanttToExcel(chart: GanttChartElement, options?: ExportExcelOptions): Promise<Blob>;

package/dist/i18n.d.ts

@@ -0,0 +1,94 @@
+import type { GanttChartElement } from '@mogura/moguchart-core';
+/**
+ * Excelエクスポートのロケール定義インターフェース
+ */
+export interface ExcelLocaleDefinition {
+    /** ロケール識別名 (例: 'ja', 'en', 'zh', 'ko', 'de' 等) */
+    name?: string;
+    /** シート名定義 */
+    sheets?: {
+        /** デフォルトのガントチャートシート名 (例: '工程表', 'Gantt Chart') */
+        gantt?: string;
+    };
+    /** 標準カラムヘッダーおよび数値・日付フォーマット */
+    columns?: {
+        taskNo?: string;
+        wbs?: string;
+        rowName?: string;
+        taskName?: string;
+        start?: {
+            day?: string;
+            month?: string;
+            hour?: string;
+        };
+        end?: {
+            day?: string;
+            month?: string;
+            hour?: string;
+        };
+        duration?: {
+            header?: string;
+            dayNumFmt?: string;
+            hourNumFmt?: string;
+        };
+        progress?: string;
+        dependencies?: string;
+        dateFormat?: {
+            day?: string;
+            month?: string;
+            hour?: string;
+        };
+    };
+    /** タイムライン（カレンダー）ヘッダーの表示設定 */
+    timeline?: {
+        /** 曜日表記配列 (0:日曜, 1:月曜, ..., 6:土曜) */
+        dayNames?: string[];
+        /** 月名表記配列 (0:1月, ..., 11:12月) */
+        monthNames?: string[];
+        /** 年グループヘッダー (scale === 'month') */
+        yearFormat?: (year: number) => string;
+        /** 年月グループヘッダー (scale === 'day' | 'week') */
+        yearMonthFormat?: (year: number, month: number, monthName: string) => string;
+        /** 年月日（＋曜日）グループヘッダー (scale === 'hour' や multi-column day) */
+        yearMonthDayFormat?: (year: number, month: number, day: number, dayName: string, monthName: string) => string;
+        /** 週サブラベル (scale === 'week') */
+        weekSubLabel?: (month: number, day: number, weekNumber: number, monthName: string) => string;
+    };
+}
+/**
+ * 日本語ロケール (デフォルト)
+ */
+export declare const jaLocale: ExcelLocaleDefinition;
+/**
+ * 英語ロケール
+ */
+export declare const enLocale: ExcelLocaleDefinition;
+/**
+ * 中国語（簡体字）ロケール
+ */
+export declare const zhLocale: ExcelLocaleDefinition;
+/**
+ * 独自のExcelロケールを登録する
+ *
+ * @param name ロケール識別名 (例: 'zh', 'ko', 'fr', 'de' 等)
+ * @param definition ロケール定義
+ */
+export declare function registerExcelLocale(name: string, definition: ExcelLocaleDefinition): void;
+/**
+ * 登録されているExcelロケール定義を取得する
+ *
+ * @param name ロケール識別名
+ */
+export declare function getExcelLocale(name: string): ExcelLocaleDefinition | undefined;
+/**
+ * 登録されているすべてのロケール識別名を取得する
+ */
+export declare function getSupportedExcelLocales(): string[];
+/**
+ * 2つのロケール定義をディープマージする
+ */
+export declare function mergeLocaleDefinitions(base: ExcelLocaleDefinition, custom: ExcelLocaleDefinition): ExcelLocaleDefinition;
+/**
+ * 指定されたパラメータから最終的なExcelLocaleDefinitionを解決する
+ */
+export declare function resolveExcelLocale(locale?: string | ExcelLocaleDefinition, chart?: GanttChartElement): ExcelLocaleDefinition;

package/dist/index.d.ts

@@ -0,0 +1,24 @@
+import type { GanttChartElement, GanttPlugin } from '@mogura/moguchart-core';
+import { exportGanttToExcel, getDefaultColumns } from './export';
+import type { ExcelPluginConfig, ExportExcelOptions, ExcelExportColumn, ExcelTimelineScale, ExcelLocale, ExcelLocaleDefinition } from './types';
+/**
+ * ガントチャートのExcel (.xlsx) エクスポートプラグイン
+ */
+export declare function excelPlugin(config?: ExcelPluginConfig): GanttPlugin<ExcelPluginConfig>;
+/**
+ * クラス形式の ExcelPlugin
+ */
+export declare class ExcelPlugin implements GanttPlugin<ExcelPluginConfig> {
+    name: string;
+    version: string;
+    config?: ExcelPluginConfig;
+    constructor(config?: ExcelPluginConfig);
+    install(chart: GanttChartElement, options?: ExcelPluginConfig): void | undefined;
+}
+/**
+ * スタンドアロン実行関数
+ */
+export declare function exportExcel(chart: GanttChartElement, options?: ExportExcelOptions): Promise<Blob>;
+export { exportGanttToExcel, getDefaultColumns };
+export { registerExcelLocale, getExcelLocale, getSupportedExcelLocales, resolveExcelLocale, jaLocale, enLocale, zhLocale, } from './i18n';
+export type { ExcelPluginConfig, ExportExcelOptions, ExcelExportColumn, ExcelTimelineScale, ExcelLocale, ExcelLocaleDefinition, };