@eightkk/vue-weave 1.0.0 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/CONTRIBUTING.md +11 -18
- package/README.ja.md +40 -37
- package/README.md +39 -36
- package/dist/{core-BH5rTsKp.js → core-LWK21xl4.js} +1815 -1749
- package/dist/core.js +1 -1
- package/dist/index.js +3627 -3144
- package/dist/style.css +1 -1
- package/dist/types/components/GanttChart.vue.d.ts +15 -1
- package/dist/types/core/index.d.ts +1 -0
- package/dist/types/core/sheetEditing.d.ts +36 -0
- package/dist/types/core/types.d.ts +23 -1
- package/docs/api.md +20 -0
- package/docs/integration.md +33 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
No changes yet.
|
|
6
6
|
|
|
7
|
+
## 1.1.0 - 2026-11-21
|
|
8
|
+
|
|
9
|
+
Adds spreadsheet editing to GanttChart. All changes are additive; nothing from 1.0.0 changes or is removed.
|
|
10
|
+
|
|
11
|
+
- Added opt-in spreadsheet editing on GanttChart (`spreadsheet`): rectangular selection, copy, cut and paste as tab-separated text, Delete to clear, fill down with Ctrl/Cmd+D or a pointer and touch fill handle, typing to edit and spreadsheet navigation keys. Each operation is one `sheet-edit` proposal (`TimelineSheetEdit`, actions `paste`, `fill` and `clear`), checked as a whole by the new `validateSheetEdit` prop and reported by `sheet-edit-rejected(reason, change?)`. New optional `GanttLabels` fields `sheetHint`, `sheetReadOnly`, `sheetRagged`, `sheetOutside` and `sheetRejected` localize the texts.
|
|
12
|
+
- Added core helpers `parseSheetText`, `formatSheetText` and `applyTimelineSheetEdit` (with the types `TimelineSheetChanges` and `TimelineSheetAppliers`).
|
|
13
|
+
- Added an auto-scheduled project plan sheet and an approval workflow editor to the bilingual demo homepage.
|
|
14
|
+
|
|
7
15
|
## 1.0.0 - 2026-11-21
|
|
8
16
|
|
|
9
17
|
This is the first stable release. From here on the package follows SemVer as defined in [Compatibility and versioning](docs/api.md#compatibility-and-versioning), and it is published on npm as `@eightkk/vue-weave` (`npm install @eightkk/vue-weave`). The changes below fix data-correctness and compatibility problems found in the pre-release review; the ones that change results or types are listed under "Breaking changes", each with who is affected and what to do.
|
package/CONTRIBUTING.md
CHANGED
|
@@ -89,28 +89,21 @@ Versions follow [Semantic Versioning](https://semver.org/). From 1.0.0, breaking
|
|
|
89
89
|
|
|
90
90
|
## Prepare a release
|
|
91
91
|
|
|
92
|
-
A maintainer
|
|
92
|
+
A maintainer publishes a GitHub Release. The dedicated npm workflow uses npm Trusted Publishing (OIDC) to publish the same verified tarball for stable releases.
|
|
93
|
+
|
|
94
|
+
Set up the [npm trusted publisher](https://docs.npmjs.com/trusted-publishers/) once in the settings for `@eightkk/vue-weave`. Select GitHub Actions and use account `EightKK`, repository `vue-weave`, workflow filename `publish-npm.yml`, and environment `npm-publish`. Allow direct publishing (`npm publish`). The workflow uses a GitHub-hosted runner and needs no npm token. Trusted publishing needs npm 11.5.1 or later; the workflow stops before downloading anything if the runner's npm is older.
|
|
95
|
+
|
|
96
|
+
Also set the repository's **Settings > Pages > Build and deployment > Source** to **GitHub Actions** once, so the Pages workflow can deploy the demo. GitHub Pages requires a public repository on the Free plan.
|
|
93
97
|
|
|
94
98
|
1. Choose the version by the rules in [Versioning](#versioning) and set it with `npm version <version> --no-git-tag-version`, which updates `package.json` and `package-lock.json` together. Move the `Unreleased` entries into a `## <version> - <YYYY-MM-DD>` changelog entry and leave an empty `Unreleased` section. In `README.md` and `README.ja.md`, update the tarball name in the install instructions and the `v<version>` tag in the absolute image and document URLs (npm shows the README without the repository, so those links point at the release tag). Review package metadata and distribution rights for source, examples and assets.
|
|
95
99
|
2. From the final source revision, run `npm ci`, the checks in [Verify a pull request](#verify-a-pull-request), `npm pack --dry-run` and `npm audit`. Review every failure and inspect the actual packed file list. CI covers Node.js 22 and 24 on Linux and Windows, with Chromium interactions on Linux; use the results for the release commit.
|
|
96
100
|
3. Verify that private vulnerability reporting is enabled under the repository's **Settings > Advanced Security**. GitHub offers it only for public repositories, so enable it as soon as the repository is public. Review the source, package contents and Git history for credentials, personal data and confidential examples. Preserve project and third-party notices.
|
|
97
|
-
4. Run `npm run prepare:release` (below)
|
|
98
|
-
5. Create the `v<version>` tag on the checked revision
|
|
99
|
-
6.
|
|
100
|
-
|
|
101
|
-
```sh
|
|
102
|
-
npm publish <path-to-verified-tgz> --access public
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
7. Check that the registry holds the same bytes. The integrity npm reports must equal the local SHA-512 of the tarball:
|
|
106
|
-
|
|
107
|
-
```sh
|
|
108
|
-
npm view @eightkk/vue-weave@<version> dist.integrity
|
|
109
|
-
node -e "console.log('sha512-' + require('node:crypto').createHash('sha512').update(require('node:fs').readFileSync(process.argv[1])).digest('base64'))" <path-to-verified-tgz>
|
|
110
|
-
```
|
|
101
|
+
4. Run `npm run prepare:release` (below) to produce the verified tarball and offline demo under `artifacts/release/<version>/`.
|
|
102
|
+
5. Create and push the `v<version>` tag on the checked revision from `main`. The tagged revision must contain the npm workflow.
|
|
103
|
+
6. Draft the GitHub Release with the changelog entry as its notes. Attach `eightkk-vue-weave-<version>.tgz`, `eightkk-vue-weave-<version>-source-demo.tar.gz`, and `SHA256SUMS` before publishing the Release.
|
|
104
|
+
7. Check the **Publish to npm** run in Actions. It checks the tarball checksum and package version before publication, then waits up to about 90 seconds for the registry to list the version and compares its integrity with the attached tarball. Rerun a failed job after fixing its cause. If npm already holds the same bytes, the rerun succeeds without uploading again. If npm holds different bytes, investigate and release a new version.
|
|
111
105
|
|
|
112
|
-
|
|
113
|
-
8. Create the GitHub Release from the `v<version>` tag. Attach the same tarball bytes that were published, `eightkk-vue-weave-<version>-source-demo.tar.gz` and `SHA256SUMS` from `artifacts/release/<version>/`, and use the changelog entry as the release notes.
|
|
106
|
+
The workflow publishes every stable release with the `latest` dist-tag. After a patch release for an older release line (for example 1.0.4 after 1.1.0), move `latest` back to the newest version with `npm dist-tag add @eightkk/vue-weave@<newest-version> latest`.
|
|
114
107
|
|
|
115
108
|
To prepare matching local package and offline-demo candidates, install Chromium once with `npx playwright install chromium`, then run:
|
|
116
109
|
|
|
@@ -120,4 +113,4 @@ npm run prepare:release
|
|
|
120
113
|
|
|
121
114
|
This command reruns the full check, browser tests, package-consumer tests (including the public API baseline) and dependency audit. It requires registry access (or a populated npm cache), Chromium and a `tar` executable, which is supplied by current Windows and Linux environments. It uses an explicit source-file allowlist, rejects symlinks, and excludes `.git`, `node_modules`, local settings, credentials and test output. It checks that source files stay unchanged during verification, creates an archive with the generated `preview/`, compares every extracted file against the source inventory, and smoke-tests the extracted demo without installing dependencies. Each run writes all of its files (tarball, source archive, `SHA256SUMS` and `release-verification.json`) into a new candidate directory `artifacts/.candidate-*`, then checks that the checksums and the record match the files. Only then does it move that set into `artifacts/release/<version>/` with two directory renames, replacing the previous set for that version as a whole. If any step fails, the candidate is deleted and the previous verified set stays unchanged; a run that is killed can leave a `.candidate-*` directory, which is safe to delete. `VW_RELEASE_FAIL_AT=after-package`, `before-promote` or `during-promote` simulates a failure at that point, and `test/release-candidate.test.mjs` covers these cases. The verification record lists file hashes and outstanding publication checks; it does not certify distribution rights, Git history or hosted settings. No publishing, tags or repository changes are performed. Review the allowlisted source files for confidential content before sharing them. GitHub's generated source ZIP omits ignored `preview/` and requires a demo build.
|
|
122
115
|
|
|
123
|
-
|
|
116
|
+
The Pages workflow builds the public demo from `main` and deploys `preview/` to [GitHub Pages](https://eightkk.github.io/vue-weave/). The local preview server binds to `127.0.0.1`.
|
package/README.ja.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Vue Weave
|
|
2
2
|
|
|
3
|
-
[](https://github.com/EightKK/vue-weave/actions/workflows/ci.yml) [](https://github.com/EightKK/vue-weave/blob/v1.
|
|
3
|
+
[](https://github.com/EightKK/vue-weave/actions/workflows/ci.yml) [](https://github.com/EightKK/vue-weave/blob/v1.1.0/LICENSE)
|
|
4
4
|
|
|
5
|
-
[English](https://github.com/EightKK/vue-weave/blob/v1.
|
|
5
|
+
[English](https://github.com/EightKK/vue-weave/blob/v1.1.0/README.md)
|
|
6
6
|
|
|
7
|
-
[ソースコード](https://github.com/EightKK/vue-weave) · [課題・問い合わせ](https://github.com/EightKK/vue-weave/issues) · [リリース](https://github.com/EightKK/vue-weave/releases)
|
|
7
|
+
[デモを試す](https://eightkk.github.io/vue-weave/) · [ソースコード](https://github.com/EightKK/vue-weave) · [課題・問い合わせ](https://github.com/EightKK/vue-weave/issues) · [リリース](https://github.com/EightKK/vue-weave/releases)
|
|
8
8
|
|
|
9
9
|
Vue 3でネットワークグラフとガントチャートを実装するためのライブラリです。関係の探索、工程フロー、製造のロット系譜、プロジェクト工程、設備・担当者別の予定などを、型付きの2つのコンポーネントで作れます。グラフ・日程計算・設備負荷の計算は、Node.js、Worker、サーバーでも動くヘッドレスのコアで行えます。
|
|
10
10
|
|
|
@@ -26,17 +26,17 @@ Vue `^3.5.0` をpeer dependencyとしています。npm 7以降では、アプ
|
|
|
26
26
|
import '@eightkk/vue-weave/style.css'
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Viteではこのままimportできます。`tsconfig.json` で `noUncheckedSideEffectImports` を有効にしている場合や、CSSを扱えないビルド環境の場合は、[The stylesheet and TypeScript](https://github.com/EightKK/vue-weave/blob/v1.
|
|
29
|
+
Viteではこのままimportできます。`tsconfig.json` で `noUncheckedSideEffectImports` を有効にしている場合や、CSSを扱えないビルド環境の場合は、[The stylesheet and TypeScript](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#the-stylesheet-and-typescript)を参照してください。
|
|
30
30
|
|
|
31
|
-
**コアだけを使う場合(サーバー・Worker)。** `@eightkk/vue-weave/core` は実行時にVueを必要とせず、Node.js 22.18以降、Worker、サーバーで動作します。ただしVueは必須のpeer dependencyで、optionalなpeerとしては設定していないため、`npm install @eightkk/vue-weave` でVueもインストールされます。コアだけを配備する環境でVueを除くには `--omit=peer` を付けてインストールします。詳しくは[Core only: servers and Workers](https://github.com/EightKK/vue-weave/blob/v1.
|
|
31
|
+
**コアだけを使う場合(サーバー・Worker)。** `@eightkk/vue-weave/core` は実行時にVueを必要とせず、Node.js 22.18以降、Worker、サーバーで動作します。ただしVueは必須のpeer dependencyで、optionalなpeerとしては設定していないため、`npm install @eightkk/vue-weave` でVueもインストールされます。コアだけを配備する環境でVueを除くには `--omit=peer` を付けてインストールします。詳しくは[Core only: servers and Workers](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#core-only-servers-and-workers)を参照してください。
|
|
32
32
|
|
|
33
|
-
**オフラインでのインストール。** 各[GitHub Release](https://github.com/EightKK/vue-weave/releases)には、npmに公開したものと同じパッケージのtarballも添付しています。`eightkk-vue-weave-1.
|
|
33
|
+
**オフラインでのインストール。** 各[GitHub Release](https://github.com/EightKK/vue-weave/releases)には、npmに公開したものと同じパッケージのtarballも添付しています。`eightkk-vue-weave-1.1.0.tgz` をダウンロードし、利用するアプリケーションのフォルダーからインストールします。次のパスは実際のファイルのパスに置き換えます。
|
|
34
34
|
|
|
35
35
|
```sh
|
|
36
|
-
npm install ./eightkk-vue-weave-1.
|
|
36
|
+
npm install ./eightkk-vue-weave-1.1.0.tgz
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
チェックアウトから[ローカルパッケージを作成](https://github.com/EightKK/vue-weave/blob/v1.
|
|
39
|
+
チェックアウトから[ローカルパッケージを作成](https://github.com/EightKK/vue-weave/blob/v1.1.0/CONTRIBUTING.md#build-a-local-package)することもできます。
|
|
40
40
|
|
|
41
41
|
## クイックスタート
|
|
42
42
|
|
|
@@ -142,40 +142,40 @@ const activate = (event: ViewTargetEvent) => linked.select(event.target.view, [e
|
|
|
142
142
|
</template>
|
|
143
143
|
```
|
|
144
144
|
|
|
145
|
-
ホバー、負荷行、折り畳まれた項目への移動は [Linking views](https://github.com/EightKK/vue-weave/blob/v1.
|
|
145
|
+
ホバー、負荷行、折り畳まれた項目への移動は [Linking views](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#linking-views) を、`useEditTransaction` は [Saving through a server](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#saving-through-a-server) を参照してください。
|
|
146
146
|
|
|
147
147
|
## ギャラリー
|
|
148
148
|
|
|
149
149
|
画像はすべて、このリポジトリの[デモ](#デモを起動する)の画面です。
|
|
150
150
|
|
|
151
|
-

|
|
152
152
|
|
|
153
|
-

|
|
154
154
|
|
|
155
155
|
<table>
|
|
156
156
|
<tr>
|
|
157
157
|
<td width="50%" valign="top">
|
|
158
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
158
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/process-lanes.png" alt="工程レーンのデモ。機械加工の工程を4つの部門レーン(購買、加工、検査、空の出荷レーン)に配置し、部門間の受け渡しを表す直角の辺がレーン境界をまたぎ、ミニマップにもレーンが表示されている" width="100%"><br>
|
|
159
159
|
<b>スイムレーン。</b>部門や作業区ごとのレーンを指定した順に並べます(<code>layoutSwimlaneGraph</code>、<code>lanes</code>)。
|
|
160
160
|
</td>
|
|
161
161
|
<td width="50%" valign="top">
|
|
162
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
162
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/quantity-flow.png" alt="数量フローのデモ。100個のロットが2つのラインに60対40で分かれ、検査で合流し、Bラインで4個減り、10個が手戻りとして破線の帯でループするサンキー図と、工程ごとの流入量・流出量・差の表" width="100%"><br>
|
|
163
163
|
<b>数量フロー。</b>辺を数量に比例した太さの帯として、図全体で同じ縮尺で描きます(<code>layoutFlowGraph</code>、<code>edgeBands</code>)。
|
|
164
164
|
</td>
|
|
165
165
|
</tr>
|
|
166
166
|
<tr>
|
|
167
167
|
<td width="50%" valign="top">
|
|
168
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
168
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/linked-views.png" alt="ビュー連動のデモ。ガントチャートで「Cut order A」を選択すると、上のネットワークグラフと下のCNCセルの負荷行でも同じタスクが強調され、負荷行では赤い区間が負荷超過を示している" width="100%"><br>
|
|
169
169
|
<b>ビューの連動。</b>一つのビューで選ぶと、グラフ、ガントチャート、負荷行で同じタスクが強調されます(<code>useLinkedSelection</code>)。
|
|
170
170
|
</td>
|
|
171
171
|
<td width="50%" valign="top">
|
|
172
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
172
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/plan-comparison.png" alt="計画シナリオのデモ。保守時間帯の後へ切断作業を送る候補計画を現行計画と比較し、最終完了、期限超過、割り当ての変更、CNCセルの負荷超過を表にまとめ、ガントチャートでは各候補バーの下に現行計画を細い帯で表示している" width="100%"><br>
|
|
173
173
|
<b>計画シナリオ。</b>候補計画を採用する前に現行計画と比較します(<code>comparePlans</code>)。
|
|
174
174
|
</td>
|
|
175
175
|
</tr>
|
|
176
176
|
<tr>
|
|
177
177
|
<td width="50%" valign="top">
|
|
178
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
178
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/diagram-styles-dark.png" alt="ダークテーマで表示したダイアグラム表現のデモ。楕円、ひし形、六角形のノード、主経路の破線のアニメーション辺、白抜き矢印や丸の端の記号、左右に振り分けた平行な辺の組を含む受注処理フロー" width="100%"><br>
|
|
179
179
|
<b>ダイアグラム表現とダークテーマ。</b>ノード形状、辺の端の記号、アニメーションする辺と平行な辺、組み込みのダークテーマ。
|
|
180
180
|
</td>
|
|
181
181
|
<td width="50%" valign="top">
|
|
@@ -186,13 +186,13 @@ const activate = (event: ViewTargetEvent) => linked.select(event.target.view, [e
|
|
|
186
186
|
|
|
187
187
|
## 機能
|
|
188
188
|
|
|
189
|
-
基本機能以外はすべてオプトインです。ここでは概要を示します。props、イベント、スロット、関数の一覧は [docs/api.md](https://github.com/EightKK/vue-weave/blob/v1.
|
|
189
|
+
基本機能以外はすべてオプトインです。ここでは概要を示します。props、イベント、スロット、関数の一覧は [docs/api.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/api.md) に、手順は [docs/integration.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md) と [docs/scheduling.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/scheduling.md) にあります。
|
|
190
190
|
|
|
191
191
|
### NetworkGraph
|
|
192
192
|
|
|
193
|
-
- **レイアウト:** 分岐・合流、閉路、自己ループに対応した標準の階層レイアウト(`LR`・`TB`・`RL`・`BT`。`crossingReduction: 'barycenter'` で交差を削減)。`layout` propでは、木、放射状、円形、格子、同心円、決定的な力学モデルの各配置(`layoutTreeGraph`、`layoutRadialGraph`、`layoutCircularGraph`、`layoutGridGraph`、`layoutConcentricGraph`、`layoutForceGraph`)や、アプリケーションで導入した[ELK.js](https://github.com/EightKK/vue-weave/blob/v1.
|
|
194
|
-
- **工程レーン:** `layoutSwimlaneGraph` は部門や作業区ごとのレーンを指定した順に並べます。`lanes` propで帯を描き、ミニマップと書き出しにも反映されます。ドラッグしたノードが入るレーンは `graphSwimlaneAt` で判定できます。詳しくは[Swimlanes for process flows](https://github.com/EightKK/vue-weave/blob/v1.
|
|
195
|
-
- **数量フロー(サンキー図):** `layoutFlowGraph` は各辺を数量に応じた太さにして図全体で同じ縮尺で描き、ノードごとの流入量・流出量とその差を補正せずに報告します。単位の異なる数量は合算せず、手戻りのループは破線の参照帯にします。`edgeBands` propは「Cut → Inspect: 60 pcs」のような名前付きで帯を描きます。詳しくは[Quantity flows](https://github.com/EightKK/vue-weave/blob/v1.
|
|
193
|
+
- **レイアウト:** 分岐・合流、閉路、自己ループに対応した標準の階層レイアウト(`LR`・`TB`・`RL`・`BT`。`crossingReduction: 'barycenter'` で交差を削減)。`layout` propでは、木、放射状、円形、格子、同心円、決定的な力学モデルの各配置(`layoutTreeGraph`、`layoutRadialGraph`、`layoutCircularGraph`、`layoutGridGraph`、`layoutConcentricGraph`、`layoutForceGraph`)や、アプリケーションで導入した[ELK.js](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#use-elkjs-for-layout)の結果を使えます。
|
|
194
|
+
- **工程レーン:** `layoutSwimlaneGraph` は部門や作業区ごとのレーンを指定した順に並べます。`lanes` propで帯を描き、ミニマップと書き出しにも反映されます。ドラッグしたノードが入るレーンは `graphSwimlaneAt` で判定できます。詳しくは[Swimlanes for process flows](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#swimlanes-for-process-flows)を参照してください。
|
|
195
|
+
- **数量フロー(サンキー図):** `layoutFlowGraph` は各辺を数量に応じた太さにして図全体で同じ縮尺で描き、ノードごとの流入量・流出量とその差を補正せずに報告します。単位の異なる数量は合算せず、手戻りのループは破線の参照帯にします。`edgeBands` propは「Cut → Inspect: 60 pcs」のような名前付きで帯を描きます。詳しくは[Quantity flows](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#quantity-flows-sankey-diagrams)を参照してください。
|
|
196
196
|
- **描画:** 独自のSVGを描く `node`・`edge`・`group`・`minimap-node` スロット、HTMLを表示する `tooltip`・`node-toolbar`・`edge-toolbar` スロット。ひし形・楕円・六角形のノード、直角・直線の辺(`edgeStyle`)、ノードを避ける経路(`avoidNodes`)、経由点、端の記号、アニメーションする辺、平行な辺の振り分け。
|
|
197
197
|
- **変更案としての編集:** ノードの移動、型付きのポートルール(`connectionRules`)で検査する接続と接続先のヒント、ラベルのその場編集、矩形・投げ縄による選択、入れ子で折りたためるグループ、ノードのサイズ変更、グリッドへの吸着と整列ガイド、パレットからのドロップ、クリップボード、キーボードによる削除。
|
|
198
198
|
- **表示範囲の操作:** ミニマップ、大規模グラフ向けの表示範囲外の描画省略と縮小時の簡略表示、ピンチズーム、検索結果の強調(`matchIds`)、`focusNode(id)`、`fit({ ids })`。
|
|
@@ -201,6 +201,7 @@ const activate = (event: ViewTargetEvent) => linked.select(event.target.view, [e
|
|
|
201
201
|
|
|
202
202
|
- **表示:** 複数レーン、進捗率、マイルストーン、ラグのラベル付きのFS/SS/FF/SF依存関係。サマリーの集約バーと、オプトインのサマリー行への依存関係を持つ階層行。差異付きで最大3つの名前付きベースライン。多段見出し、日時マーカー、期間の強調(`markerRanges`)。ステータス日付線とイナズマ線。非稼働時間の網掛け。クリティカルパスの枠線、余裕の線、期限、分割バー。`calculateResourceLoad` の出力をそのまま渡せる設備負荷のヒストグラム(`loadRows`)。
|
|
203
203
|
- **変更案としての編集:** ドラッグとキーボードによる移動・伸縮、移動に連動して動くバーのプレビュー(`cascade`)、依存関係の作成と付け替え、複数選択と一括移動、ドラッグによるバーの作成、進捗率のスライダー、削除、行の階層移動、列幅の変更、スケジュール制約のハンドル、型付きのセル編集(`field-edit`)、アプリの一覧からのドロップ(`bar-drop`)。
|
|
204
|
+
- **スプレッドシート編集(`spreadsheet`):** セル範囲の選択、Excel や Google スプレッドシートとのコピー・切り取り・貼り付け、Delete による消去、Ctrl/⌘+D や右下のハンドルによる下方向のコピー、文字入力による編集。操作ごとに一つの `sheet-edit` 変更案として届き、`validateSheetEdit` で一括で却下でき、`applyTimelineSheetEdit` で反映できます。デモには、表からスケジューラーがバー・矢印・クリティカルパスを計算する工程表と、購買申請の承認フローの編集画面があります。
|
|
204
205
|
- **時間軸:** ズームプリセット、IANAタイムゾーンとロケールに沿ったカレンダー用プリセット(`calendarZoomPresets`、`intlTimeFormatter`)、非稼働時間を圧縮する時間軸(`createWorkingTimeScale`)、Ctrl+ホイールとピンチによるズーム、現在時刻マーカー、`fitToBars()`。
|
|
205
206
|
- **大規模データ:** 行と表示時間範囲の仮想化。表示中の週と行だけを読み込むための `visible-window-change`。
|
|
206
207
|
|
|
@@ -209,13 +210,13 @@ const activate = (event: ViewTargetEvent) => linked.select(event.target.view, [e
|
|
|
209
210
|
- **グラフのアルゴリズムと指標:** `topologicalOrder`、`findGraphCycles`、`shortestGraphPath`、`searchGraphNodes`、`filterGraph`、連結成分、次数・媒介・PageRankの各中心性、Louvain法によるコミュニティ検出(`detectGraphCommunities`)と、その結果をグループに変換する `graphCommunityGroups`。
|
|
210
211
|
- **日程計算:** `buildWorkPeriods` で作るカレンダー(IANAタイムゾーンを含む)上での `scheduleTasks`。最遅開始、手動・非アクティブ・サマリーのタスク、制約、中断区間、循環や実行不能の診断に対応します。`scheduleTasks(input, { explain: true })` は各タスクの開始が決まった理由をトレースし、`toPlanningDiagnostics` は問題を一覧にします。
|
|
211
212
|
- **リソース:** `calculateResourceLoad` と `levelResources`。時間とともに変わる能力(`capacityPeriods`)や、タスクの一部だけを占める割り当て(`workOffset`、`workDuration`)にも対応します。`projectResourceTimeline` はリソース別に計画を表示し、`buildPlacementInput` は未計画タスクを計算から除きます。
|
|
212
|
-
- **計画の更新:** `propagateEdit`、`rescheduleFromStatusDate`、`rescheduleFromActuals`(記録した実績を保ち、残りを予測)、そして編集した内容と結果として動いた内容を分けて示す `comparePlans`。詳しくは[Compare plan scenarios](https://github.com/EightKK/vue-weave/blob/v1.
|
|
213
|
+
- **計画の更新:** `propagateEdit`、`rescheduleFromStatusDate`、`rescheduleFromActuals`(記録した実績を保ち、残りを予測)、そして編集した内容と結果として動いた内容を分けて示す `comparePlans`。詳しくは[Compare plan scenarios](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/scheduling.md#compare-plan-scenarios)を参照してください。
|
|
213
214
|
- **データ交換:** Microsoft Project XML(カレンダー、リソース、割り当てを含む)、iCalendar、CSVの読み込みと書き出し(`fromMsProjectXml`、`toMsProjectXml`、`fromICalendar`、`toICalendar`、`parseCsv`、`toCsv`)。日程をPERT図にする `scheduleToGraph`。
|
|
214
215
|
|
|
215
216
|
### ビューの連動・大規模データ・保存
|
|
216
217
|
|
|
217
|
-
- **ビューの連動:** `useLinkedSelection` はグラフ、ガントチャート、負荷行をエンティティの対応づけで連動させます。`revealNode`、`revealBar`、`revealLinkedTarget` は折り畳まれたグループや行の中も含めて項目へ移動し、`timelineBarsInRange` と `resolveTimeRangeTargets` はある時間範囲に作業していた対象を強調します。詳しくは[Linking views](https://github.com/EightKK/vue-weave/blob/v1.
|
|
218
|
-
- **大規模データ:** `useWindowedData` はアプリの `load` 関数を通じて表示中の範囲だけを取得し、中断、重複排除、再試行に対応します。グラフ展開ヘルパーと `layoutGraphIncrementally` は、表示中のノードを動かさずにグラフを1ホップずつ読み込みます。`useAsyncGraphLayout` はWorkerでレイアウトを計算し、`routingPolicy="preserve"` はエンジンの配線を保持します。詳しくは[Loading only what is visible](https://github.com/EightKK/vue-weave/blob/v1.
|
|
218
|
+
- **ビューの連動:** `useLinkedSelection` はグラフ、ガントチャート、負荷行をエンティティの対応づけで連動させます。`revealNode`、`revealBar`、`revealLinkedTarget` は折り畳まれたグループや行の中も含めて項目へ移動し、`timelineBarsInRange` と `resolveTimeRangeTargets` はある時間範囲に作業していた対象を強調します。詳しくは[Linking views](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#linking-views)を参照してください。
|
|
219
|
+
- **大規模データ:** `useWindowedData` はアプリの `load` 関数を通じて表示中の範囲だけを取得し、中断、重複排除、再試行に対応します。グラフ展開ヘルパーと `layoutGraphIncrementally` は、表示中のノードを動かさずにグラフを1ホップずつ読み込みます。`useAsyncGraphLayout` はWorkerでレイアウトを計算し、`routingPolicy="preserve"` はエンジンの配線を保持します。詳しくは[Loading only what is visible](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#loading-only-what-is-visible)を参照してください。
|
|
219
220
|
- **表示と保存:** 行を検索・並べ替える `useTimelineView`、Undo/Redoの `useEditHistory`、サーバーのアダプターを通じて版競合も扱いながら保存する `useEditTransaction`、版付きで検証されたJSONとして保存・復元する `serializeWeaveSnapshot` と `restoreWeaveSnapshot`。
|
|
220
221
|
|
|
221
222
|
### 書き出し・テーマ・アクセシビリティ
|
|
@@ -232,16 +233,16 @@ const png = await chart.value!.exportPng({ scale: 2 })
|
|
|
232
233
|
|
|
233
234
|
## 対応状況
|
|
234
235
|
|
|
235
|
-
- **バージョン1.0です。** [セマンティックバージョニング](https://semver.org/lang/ja/)に従い、破壊的変更はメジャーリリースだけで行い、[変更履歴](https://github.com/EightKK/vue-weave/blob/v1.
|
|
236
|
+
- **バージョン1.0です。** [セマンティックバージョニング](https://semver.org/lang/ja/)に従い、破壊的変更はメジャーリリースだけで行い、[変更履歴](https://github.com/EightKK/vue-weave/blob/v1.1.0/CHANGELOG.md)の「Breaking changes」に記載します。対象となるもの(エクスポートされた名前と型、props、イベント、スロット、ドキュメントに記載した `--vw-*` 変数、スナップショットの形式)と対象外のもの(エラーメッセージの文言、コンポーネントが出力する `vw-` クラス、DOM構造、サーバーレンダリングのマークアップ)は[Compatibility and versioning](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/api.md#compatibility-and-versioning)に記載しています。
|
|
236
237
|
- **Vue:** 3.x の3.5以降(peer dependency `^3.5.0`)。
|
|
237
238
|
- **モジュールとTypeScript:** ESMのみ。型定義は `Bundler` と `NodeNext` の型解決に対応しています。項目の `data` に型を付けられ(`NetworkNode<MyData>`、`TimelineBar<MyData>`)、その型がキャストなしでスロットのpropsやコールバックに渡ります。
|
|
238
239
|
- **Node.js:** ヘッドレスの `@eightkk/vue-weave/core`、サーバーサイドレンダリング、開発には22.18以降が必要です。
|
|
239
240
|
- **ブラウザー:** 最新の主要ブラウザー(Chrome、Edge、Firefox、Safari)。自動ブラウザーテストはChromiumのみで実行するため、ほかのブラウザーはCIの対象外です。
|
|
240
|
-
- **アクセシビリティ:** キーボード操作とARIA名を備えています。専用のスクリーンリーダーでの検証はまだ行っていません([構成、性能上の扱い、対応範囲](https://github.com/EightKK/vue-weave/blob/v1.
|
|
241
|
+
- **アクセシビリティ:** キーボード操作とARIA名を備えています。専用のスクリーンリーダーでの検証はまだ行っていません([構成、性能上の扱い、対応範囲](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/architecture.md)を参照)。十分に対応していると想定しないでください。
|
|
241
242
|
|
|
242
243
|
## デモを起動する
|
|
243
244
|
|
|
244
|
-
|
|
245
|
+
デモは[GitHub Pages](https://eightkk.github.io/vue-weave/)で公開しています。`main`から再ビルドされるため、最新リリースより新しい内容のことがあります。ローカルで起動するには、Node.js 22.18以降とnpmを用意します。cloneしたソースやGitHubのソースZIPのフォルダーで次を実行します。
|
|
245
246
|
|
|
246
247
|
```sh
|
|
247
248
|
npm ci
|
|
@@ -249,27 +250,29 @@ npm run build:demo
|
|
|
249
250
|
npm start
|
|
250
251
|
```
|
|
251
252
|
|
|
252
|
-
|
|
253
|
+
トップページでは「製造計画」と「ロットの流れ」を試せます。ほかの作例は「サンプル集」から開けます。
|
|
254
|
+
|
|
255
|
+
サンプル集には例ごとのページ([ギャラリー](#ギャラリー)を参照)、書き出しボタン、テーマ切り替え、採用済みの変更を戻す **Undo**/**Redo** があります。**Edit graph** や **Planning overlays** などの切り替えで、上記のオプトイン機能を試せます。**Design gallery** の行では、同じ2つのコンポーネントをスロット、`--vw-*` 変数、`vw-` クラスだけで作り替えています。編集結果はデモ画面内の状態として保持します。デモの未計画一覧、インスペクター、診断一覧、ツールバーは `examples/components/` の参考実装で、パッケージには含まれません。
|
|
253
256
|
|
|
254
257
|
Windowsでは代わりに `Start.cmd` をダブルクリックしても起動できます。`preview/` が現在のソースからビルドされたものであればそのまま表示し、そうでなければ先にビルドします。インストール済みの依存関係が `package-lock.json` と一致しない場合は、ビルドの前に `npm ci` も実行します。`npm start` は `preview/` をそのまま表示します。
|
|
255
258
|
|
|
256
259
|
`preview/` を含むビルド済みデモのアーカイブ(リリースに添付されることがあります)を使う場合は、全体を展開して `npm start` を実行するか、Windowsで `Start.cmd` をダブルクリックします。ビルド済みデモはNode.jsがあれば依存関係のインストールなしで起動できます。ソースを変更した場合は `Start.cmd` がデモをビルドし直します。初回はnpmとインターネット接続が必要です。
|
|
257
260
|
|
|
258
|
-
開発・検証コマンドは[Contributing](https://github.com/EightKK/vue-weave/blob/v1.
|
|
261
|
+
開発・検証コマンドは[Contributing](https://github.com/EightKK/vue-weave/blob/v1.1.0/CONTRIBUTING.md)を参照してください。
|
|
259
262
|
|
|
260
263
|
## ドキュメント
|
|
261
264
|
|
|
262
265
|
API、コメント、詳細ドキュメントは英語です。
|
|
263
266
|
|
|
264
|
-
- [入力型と公開API](https://github.com/EightKK/vue-weave/blob/v1.
|
|
265
|
-
- [Vue・Nuxtへの組み込み、独自描画、時間軸、保存処理](https://github.com/EightKK/vue-weave/blob/v1.
|
|
266
|
-
- [構成、性能上の扱い、対応範囲](https://github.com/EightKK/vue-weave/blob/v1.
|
|
267
|
-
- [日程計算と設備負荷](https://github.com/EightKK/vue-weave/blob/v1.
|
|
268
|
-
- [開発とリリース手順](https://github.com/EightKK/vue-weave/blob/v1.
|
|
269
|
-
- [セキュリティ方針と脆弱性の非公開報告](https://github.com/EightKK/vue-weave/blob/v1.
|
|
270
|
-
- [行動規範](https://github.com/EightKK/vue-weave/blob/v1.
|
|
271
|
-
- [変更履歴](https://github.com/EightKK/vue-weave/blob/v1.
|
|
267
|
+
- [入力型と公開API](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/api.md)
|
|
268
|
+
- [Vue・Nuxtへの組み込み、独自描画、時間軸、保存処理](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md)
|
|
269
|
+
- [構成、性能上の扱い、対応範囲](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/architecture.md)
|
|
270
|
+
- [日程計算と設備負荷](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/scheduling.md)
|
|
271
|
+
- [開発とリリース手順](https://github.com/EightKK/vue-weave/blob/v1.1.0/CONTRIBUTING.md)
|
|
272
|
+
- [セキュリティ方針と脆弱性の非公開報告](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/security.md)
|
|
273
|
+
- [行動規範](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/code-of-conduct.md)
|
|
274
|
+
- [変更履歴](https://github.com/EightKK/vue-weave/blob/v1.1.0/CHANGELOG.md)
|
|
272
275
|
|
|
273
276
|
## ライセンス
|
|
274
277
|
|
|
275
|
-
MITです。[LICENSE](https://github.com/EightKK/vue-weave/blob/v1.
|
|
278
|
+
MITです。[LICENSE](https://github.com/EightKK/vue-weave/blob/v1.1.0/LICENSE) を参照してください。ビルド済みデモの第三者ライセンス表示は [THIRD_PARTY_NOTICES.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/THIRD_PARTY_NOTICES.md) と [Third-party licenses](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/third-party-licenses.md) にあります。
|
package/README.md
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Vue Weave
|
|
2
2
|
|
|
3
|
-
[](https://github.com/EightKK/vue-weave/actions/workflows/ci.yml) [](https://github.com/EightKK/vue-weave/blob/v1.
|
|
3
|
+
[](https://github.com/EightKK/vue-weave/actions/workflows/ci.yml) [](https://github.com/EightKK/vue-weave/blob/v1.1.0/LICENSE)
|
|
4
4
|
|
|
5
|
-
[日本語](https://github.com/EightKK/vue-weave/blob/v1.
|
|
5
|
+
[日本語](https://github.com/EightKK/vue-weave/blob/v1.1.0/README.ja.md)
|
|
6
6
|
|
|
7
|
-
[Source](https://github.com/EightKK/vue-weave) · [Issues](https://github.com/EightKK/vue-weave/issues) · [Releases](https://github.com/EightKK/vue-weave/releases)
|
|
7
|
+
[Interactive demo](https://eightkk.github.io/vue-weave/) · [Source](https://github.com/EightKK/vue-weave) · [Issues](https://github.com/EightKK/vue-weave/issues) · [Releases](https://github.com/EightKK/vue-weave/releases)
|
|
8
8
|
|
|
9
9
|
Interactive network graphs and Gantt charts for Vue 3. Build relationship explorers, process flows, production views, project schedules and resource timelines from two typed components, and do the graph, scheduling and resource-load calculations in a headless core that also runs in Node.js, workers and on servers.
|
|
10
10
|
|
|
@@ -26,17 +26,17 @@ Import the stylesheet once, for example in your application's entry file:
|
|
|
26
26
|
import '@eightkk/vue-weave/style.css'
|
|
27
27
|
```
|
|
28
28
|
|
|
29
|
-
Vite handles this import as it is. If your `tsconfig.json` enables `noUncheckedSideEffectImports`, or your build has no CSS loader, see [The stylesheet and TypeScript](https://github.com/EightKK/vue-weave/blob/v1.
|
|
29
|
+
Vite handles this import as it is. If your `tsconfig.json` enables `noUncheckedSideEffectImports`, or your build has no CSS loader, see [The stylesheet and TypeScript](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#the-stylesheet-and-typescript).
|
|
30
30
|
|
|
31
|
-
**Core only (servers and Workers).** `@eightkk/vue-weave/core` runs without Vue at runtime, in Node.js 22.18+, Workers and on servers. Vue is still a required peer dependency (an optional peer is not configured), so `npm install @eightkk/vue-weave` installs Vue as well. To leave it out of a core-only deployment, install with `--omit=peer`. See [Core only: servers and Workers](https://github.com/EightKK/vue-weave/blob/v1.
|
|
31
|
+
**Core only (servers and Workers).** `@eightkk/vue-weave/core` runs without Vue at runtime, in Node.js 22.18+, Workers and on servers. Vue is still a required peer dependency (an optional peer is not configured), so `npm install @eightkk/vue-weave` installs Vue as well. To leave it out of a core-only deployment, install with `--omit=peer`. See [Core only: servers and Workers](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#core-only-servers-and-workers).
|
|
32
32
|
|
|
33
|
-
**Offline install.** Each [GitHub Release](https://github.com/EightKK/vue-weave/releases) also has the package tarball, the same file that is published to npm. Download `eightkk-vue-weave-1.
|
|
33
|
+
**Offline install.** Each [GitHub Release](https://github.com/EightKK/vue-weave/releases) also has the package tarball, the same file that is published to npm. Download `eightkk-vue-weave-1.1.0.tgz` and install it from your application's directory, replacing the example path with the actual one:
|
|
34
34
|
|
|
35
35
|
```sh
|
|
36
|
-
npm install ./eightkk-vue-weave-1.
|
|
36
|
+
npm install ./eightkk-vue-weave-1.1.0.tgz
|
|
37
37
|
```
|
|
38
38
|
|
|
39
|
-
You can also [build a local package](https://github.com/EightKK/vue-weave/blob/v1.
|
|
39
|
+
You can also [build a local package](https://github.com/EightKK/vue-weave/blob/v1.1.0/CONTRIBUTING.md#build-a-local-package) from a checkout.
|
|
40
40
|
|
|
41
41
|
## Quick start
|
|
42
42
|
|
|
@@ -142,40 +142,40 @@ const activate = (event: ViewTargetEvent) => linked.select(event.target.view, [e
|
|
|
142
142
|
</template>
|
|
143
143
|
```
|
|
144
144
|
|
|
145
|
-
See [Linking views](https://github.com/EightKK/vue-weave/blob/v1.
|
|
145
|
+
See [Linking views](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#linking-views) for hover, load rows and moving to collapsed items, and [Saving through a server](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#saving-through-a-server) for `useEditTransaction`.
|
|
146
146
|
|
|
147
147
|
## Gallery
|
|
148
148
|
|
|
149
149
|
All screenshots are from the [demo app](#run-the-demo) in this repository.
|
|
150
150
|
|
|
151
|
-

|
|
152
152
|
|
|
153
|
-

|
|
154
154
|
|
|
155
155
|
<table>
|
|
156
156
|
<tr>
|
|
157
157
|
<td width="50%" valign="top">
|
|
158
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
158
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/process-lanes.png" alt="Process lanes demo: a machining process in four department lanes (Purchasing, Machining, Inspection and an empty Shipping lane), with orthogonal hand-over edges crossing the lane boundaries and the lanes repeated in the minimap" width="100%"><br>
|
|
159
159
|
<b>Swimlanes.</b> One lane per department or work centre, in your order (<code>layoutSwimlaneGraph</code>, <code>lanes</code>).
|
|
160
160
|
</td>
|
|
161
161
|
<td width="50%" valign="top">
|
|
162
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
162
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/quantity-flow.png" alt="Quantity flow demo: a Sankey diagram of a lot of 100 pieces that splits 60/40 between two lines, merges at inspection, loses 4 pieces on line B and loops 10 pieces through rework as a dashed band, with a table of inflow, outflow and difference per step" width="100%"><br>
|
|
163
163
|
<b>Quantity flows.</b> Edges drawn as bands as wide as their quantity, on one scale (<code>layoutFlowGraph</code>, <code>edgeBands</code>).
|
|
164
164
|
</td>
|
|
165
165
|
</tr>
|
|
166
166
|
<tr>
|
|
167
167
|
<td width="50%" valign="top">
|
|
168
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
168
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/linked-views.png" alt="Linked views demo: Cut order A is selected in the Gantt chart, and the same task is highlighted in the network graph above and in the CNC cell load row below, where a red segment marks an overload" width="100%"><br>
|
|
169
169
|
<b>Linked views.</b> Select in one view and the graph, Gantt chart and load rows highlight the same task (<code>useLinkedSelection</code>).
|
|
170
170
|
</td>
|
|
171
171
|
<td width="50%" valign="top">
|
|
172
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
172
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/plan-comparison.png" alt="Plan scenarios demo: a candidate plan that pushes the cutting work after a maintenance window, compared with the current plan in a table of final completion, deadline misses, changed assignments and CNC cell overload, and a Gantt chart that shows the current plan as a strip below each candidate bar" width="100%"><br>
|
|
173
173
|
<b>Plan scenarios.</b> Compare a candidate plan with the current one before adopting it (<code>comparePlans</code>).
|
|
174
174
|
</td>
|
|
175
175
|
</tr>
|
|
176
176
|
<tr>
|
|
177
177
|
<td width="50%" valign="top">
|
|
178
|
-
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.
|
|
178
|
+
<img src="https://raw.githubusercontent.com/EightKK/vue-weave/v1.1.0/.github/images/diagram-styles-dark.png" alt="Diagram styles demo in the dark theme: an order fulfilment flow with ellipse, diamond and hexagon nodes, dashed animated main-path edges, open-arrow and circle edge markers, and a pair of parallel edges spread apart" width="100%"><br>
|
|
179
179
|
<b>Diagram styles and dark theme.</b> Node shapes, edge markers, animated and parallel edges, and the built-in dark theme.
|
|
180
180
|
</td>
|
|
181
181
|
<td width="50%" valign="top">
|
|
@@ -186,13 +186,13 @@ All screenshots are from the [demo app](#run-the-demo) in this repository.
|
|
|
186
186
|
|
|
187
187
|
## Features
|
|
188
188
|
|
|
189
|
-
Everything beyond the basics is opt-in. This is an overview; the full list of props, events, slots and functions is in [docs/api.md](https://github.com/EightKK/vue-weave/blob/v1.
|
|
189
|
+
Everything beyond the basics is opt-in. This is an overview; the full list of props, events, slots and functions is in [docs/api.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/api.md), with guides in [docs/integration.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md) and [docs/scheduling.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/scheduling.md).
|
|
190
190
|
|
|
191
191
|
### NetworkGraph
|
|
192
192
|
|
|
193
|
-
- **Layouts:** a built-in layered layout (`LR`, `TB`, `RL` or `BT`, with `crossingReduction: 'barycenter'`) that handles branches, merges, cycles and self-loops. Through the `layout` prop: tree, radial, circular, grid, concentric and deterministic force layouts (`layoutTreeGraph`, `layoutRadialGraph`, `layoutCircularGraph`, `layoutGridGraph`, `layoutConcentricGraph`, `layoutForceGraph`), or [ELK.js](https://github.com/EightKK/vue-weave/blob/v1.
|
|
194
|
-
- **Process lanes:** `layoutSwimlaneGraph` gives each department or work centre a lane in your order; the `lanes` prop draws the bands, also in the minimap and exports, and `graphSwimlaneAt` finds the lane a node was dragged to. See [Swimlanes for process flows](https://github.com/EightKK/vue-weave/blob/v1.
|
|
195
|
-
- **Quantity flows (Sankey diagrams):** `layoutFlowGraph` sizes each edge by its quantity on one scale, reports inflow, outflow and their difference per node as given, never adds different units, and draws rework loops as dashed reference bands; the `edgeBands` prop renders them with names such as "Cut → Inspect: 60 pcs". See [Quantity flows](https://github.com/EightKK/vue-weave/blob/v1.
|
|
193
|
+
- **Layouts:** a built-in layered layout (`LR`, `TB`, `RL` or `BT`, with `crossingReduction: 'barycenter'`) that handles branches, merges, cycles and self-loops. Through the `layout` prop: tree, radial, circular, grid, concentric and deterministic force layouts (`layoutTreeGraph`, `layoutRadialGraph`, `layoutCircularGraph`, `layoutGridGraph`, `layoutConcentricGraph`, `layoutForceGraph`), or [ELK.js](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#use-elkjs-for-layout) installed by your application.
|
|
194
|
+
- **Process lanes:** `layoutSwimlaneGraph` gives each department or work centre a lane in your order; the `lanes` prop draws the bands, also in the minimap and exports, and `graphSwimlaneAt` finds the lane a node was dragged to. See [Swimlanes for process flows](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#swimlanes-for-process-flows).
|
|
195
|
+
- **Quantity flows (Sankey diagrams):** `layoutFlowGraph` sizes each edge by its quantity on one scale, reports inflow, outflow and their difference per node as given, never adds different units, and draws rework loops as dashed reference bands; the `edgeBands` prop renders them with names such as "Cut → Inspect: 60 pcs". See [Quantity flows](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#quantity-flows-sankey-diagrams).
|
|
196
196
|
- **Drawing:** `node`, `edge`, `group` and `minimap-node` slots for your own SVG, `tooltip`, `node-toolbar` and `edge-toolbar` slots for HTML; diamond, ellipse and hexagon nodes; orthogonal or straight edges (`edgeStyle`), routes around nodes (`avoidNodes`), waypoints, end markers, animated edges and spread parallel edges.
|
|
197
197
|
- **Editing as proposals:** node moves, connections checked against typed port rules (`connectionRules`) with valid-target hints, inline label editing, box or lasso selection, nested and collapsible groups, node resizing, snap to grid with alignment guides, palette drops, clipboard, and keyboard deletion.
|
|
198
198
|
- **Navigation:** minimap, viewport culling and level of detail for large graphs, pinch zoom, search highlighting (`matchIds`), `focusNode(id)` and `fit({ ids })`.
|
|
@@ -201,6 +201,7 @@ Everything beyond the basics is opt-in. This is an overview; the full list of pr
|
|
|
201
201
|
|
|
202
202
|
- **Display:** multiple lanes, progress, milestones and FS/SS/FF/SF dependencies with lag labels; row groups with summary rollups and optional summary dependencies; up to three named baseline sets with variance; header bands, date markers and highlighted ranges (`markerRanges`); a status-date line and progress line; non-working time shading; critical outlines, float lines, deadlines and split bars; a resource load histogram (`loadRows`) that accepts `calculateResourceLoad` output.
|
|
203
203
|
- **Editing as proposals:** drag and keyboard moves and resizes, auto-scheduling previews of the bars a move would push (`cascade`), dependency creation and reconnection, multiple selection and batch moves, drag to create, progress sliders, deletion, row hierarchy moves, column resizing, scheduling constraint handles, typed cell editors (`field-edit`), and drops from your own lists (`bar-drop`).
|
|
204
|
+
- **Spreadsheet editing (`spreadsheet`):** select cell ranges, copy, cut and paste with Excel or Google Sheets, clear, fill down with Ctrl/Cmd+D or the corner handle, and type to edit; each operation is one `sheet-edit` proposal that `validateSheetEdit` can reject as a whole and `applyTimelineSheetEdit` applies. The demo homepage has a schedule sheet whose bars, arrows and critical path the scheduler derives from the grid, and a purchase approval workflow editor.
|
|
204
205
|
- **Time scales:** zoom presets, ready calendar presets in an IANA time zone and locale (`calendarZoomPresets`, `intlTimeFormatter`), a scale that compresses non-working time (`createWorkingTimeScale`), Ctrl+wheel and pinch zoom, a now marker and `fitToBars()`.
|
|
205
206
|
- **Scale:** row and time-window virtualization, and `visible-window-change` to load only the visible weeks and rows.
|
|
206
207
|
|
|
@@ -209,13 +210,13 @@ Everything beyond the basics is opt-in. This is an overview; the full list of pr
|
|
|
209
210
|
- **Graph algorithms and metrics:** `topologicalOrder`, `findGraphCycles`, `shortestGraphPath`, `searchGraphNodes`, `filterGraph`, connected components, degree, betweenness and PageRank centrality, and Louvain communities (`detectGraphCommunities`) that `graphCommunityGroups` turns into groups.
|
|
210
211
|
- **Scheduling:** `scheduleTasks` on calendars from `buildWorkPeriods`, including IANA time zones, as-late-as-possible, manual, inactive and summary tasks, constraints, pauses and cycle and infeasibility diagnostics. `scheduleTasks(input, { explain: true })` traces why each task starts when it does, and `toPlanningDiagnostics` lists the problems.
|
|
211
212
|
- **Resources:** `calculateResourceLoad` and `levelResources`, with capacity that changes over time (`capacityPeriods`) and assignments that cover only part of a task (`workOffset`, `workDuration`); `projectResourceTimeline` shows a plan by resource, and `buildPlacementInput` keeps unplanned tasks out of the calculation.
|
|
212
|
-
- **Plan updates:** `propagateEdit`, `rescheduleFromStatusDate`, `rescheduleFromActuals` (keeps recorded actuals and forecasts the rest), and `comparePlans`, which separates what you changed from what moved as a result. See [Compare plan scenarios](https://github.com/EightKK/vue-weave/blob/v1.
|
|
213
|
+
- **Plan updates:** `propagateEdit`, `rescheduleFromStatusDate`, `rescheduleFromActuals` (keeps recorded actuals and forecasts the rest), and `comparePlans`, which separates what you changed from what moved as a result. See [Compare plan scenarios](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/scheduling.md#compare-plan-scenarios).
|
|
213
214
|
- **Interchange:** Microsoft Project XML (including calendars, resources and assignments), iCalendar and CSV import and export (`fromMsProjectXml`, `toMsProjectXml`, `fromICalendar`, `toICalendar`, `parseCsv`, `toCsv`), and `scheduleToGraph` for a PERT network diagram.
|
|
214
215
|
|
|
215
216
|
### Linked views, large data and saving
|
|
216
217
|
|
|
217
|
-
- **Linked views:** `useLinkedSelection` links a graph, a Gantt chart and load rows through entity bindings; `revealNode`, `revealBar` and `revealLinkedTarget` move to an item, also inside collapsed groups and rows; `timelineBarsInRange` and `resolveTimeRangeTargets` highlight what was worked on in a time range. See [Linking views](https://github.com/EightKK/vue-weave/blob/v1.
|
|
218
|
-
- **Large data:** `useWindowedData` fetches only the visible window through your `load` function, with aborts, deduplication and retry; graph expansion helpers and `layoutGraphIncrementally` load a graph one hop at a time without moving the nodes on display; `useAsyncGraphLayout` runs a layout in a Worker, and `routingPolicy="preserve"` keeps the engine's routes. See [Loading only what is visible](https://github.com/EightKK/vue-weave/blob/v1.
|
|
218
|
+
- **Linked views:** `useLinkedSelection` links a graph, a Gantt chart and load rows through entity bindings; `revealNode`, `revealBar` and `revealLinkedTarget` move to an item, also inside collapsed groups and rows; `timelineBarsInRange` and `resolveTimeRangeTargets` highlight what was worked on in a time range. See [Linking views](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#linking-views).
|
|
219
|
+
- **Large data:** `useWindowedData` fetches only the visible window through your `load` function, with aborts, deduplication and retry; graph expansion helpers and `layoutGraphIncrementally` load a graph one hop at a time without moving the nodes on display; `useAsyncGraphLayout` runs a layout in a Worker, and `routingPolicy="preserve"` keeps the engine's routes. See [Loading only what is visible](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md#loading-only-what-is-visible).
|
|
219
220
|
- **Views and saving:** `useTimelineView` for searched and sorted rows, `useEditHistory` for undo and redo, `useEditTransaction` to save through your server adapter with conflict handling, and `serializeWeaveSnapshot` and `restoreWeaveSnapshot` for versioned, validated JSON.
|
|
220
221
|
|
|
221
222
|
### Export, themes and accessibility
|
|
@@ -232,16 +233,18 @@ const png = await chart.value!.exportPng({ scale: 2 })
|
|
|
232
233
|
|
|
233
234
|
## Status and support
|
|
234
235
|
|
|
235
|
-
- **Version 1.0.** Releases follow [Semantic Versioning](https://semver.org/): breaking changes are made only in major releases and are listed under "Breaking changes" in the [changelog](https://github.com/EightKK/vue-weave/blob/v1.
|
|
236
|
+
- **Version 1.0.** Releases follow [Semantic Versioning](https://semver.org/): breaking changes are made only in major releases and are listed under "Breaking changes" in the [changelog](https://github.com/EightKK/vue-weave/blob/v1.1.0/CHANGELOG.md). [Compatibility and versioning](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/api.md#compatibility-and-versioning) lists what that covers (exported names and types, props, events, slots, documented `--vw-*` properties and the snapshot format) and what it does not (the exact text of error messages, the emitted `vw-` classes, DOM structure and server-rendered markup).
|
|
236
237
|
- **Vue:** 3.5 or later in 3.x (peer dependency `^3.5.0`).
|
|
237
238
|
- **Modules and TypeScript:** ESM only. Declarations support `Bundler` and `NodeNext` resolution. Item `data` can be typed (`NetworkNode<MyData>`, `TimelineBar<MyData>`), and that type reaches slot props and callbacks without casts.
|
|
238
239
|
- **Node.js:** 22.18 or later for the headless `@eightkk/vue-weave/core` entry, server-side rendering and development.
|
|
239
240
|
- **Browsers:** current evergreen browsers (Chrome, Edge, Firefox and Safari). Automated browser tests run in Chromium only, so the other browsers are not covered by CI.
|
|
240
|
-
- **Accessibility:** keyboard operation and ARIA names are included. Dedicated screen-reader testing has not been done yet (see [Architecture, performance and scope](https://github.com/EightKK/vue-weave/blob/v1.
|
|
241
|
+
- **Accessibility:** keyboard operation and ARIA names are included. Dedicated screen-reader testing has not been done yet (see [Architecture, performance and scope](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/architecture.md)), so do not assume full conformance.
|
|
241
242
|
|
|
242
243
|
## Run the demo
|
|
243
244
|
|
|
244
|
-
|
|
245
|
+
The main page opens the production planning and lot flow demos. Use **Examples** to open the full sample gallery.
|
|
246
|
+
|
|
247
|
+
The demo is hosted on [GitHub Pages](https://eightkk.github.io/vue-weave/) and is rebuilt from `main`, so it can be ahead of the latest release. To run it locally, use Node.js 22.18+ and npm. From a source checkout or GitHub source ZIP, run:
|
|
245
248
|
|
|
246
249
|
```sh
|
|
247
250
|
npm ci
|
|
@@ -255,19 +258,19 @@ On Windows you can double-click `Start.cmd` instead. It serves `preview/` when i
|
|
|
255
258
|
|
|
256
259
|
If you have a prebuilt demo archive containing `preview/` (it may be attached to a release), extract it completely and run `npm start`, or double-click `Start.cmd` on Windows. The prebuilt demo needs Node.js but does not require dependency installation. If you change its sources, `Start.cmd` rebuilds it, which needs npm and an internet connection the first time.
|
|
257
260
|
|
|
258
|
-
For development and verification commands, see [Contributing](https://github.com/EightKK/vue-weave/blob/v1.
|
|
261
|
+
For development and verification commands, see [Contributing](https://github.com/EightKK/vue-weave/blob/v1.1.0/CONTRIBUTING.md).
|
|
259
262
|
|
|
260
263
|
## Documentation
|
|
261
264
|
|
|
262
|
-
- [Public API and input contracts](https://github.com/EightKK/vue-weave/blob/v1.
|
|
263
|
-
- [Vue, Nuxt, custom rendering, time scales and persistence](https://github.com/EightKK/vue-weave/blob/v1.
|
|
264
|
-
- [Architecture, performance and scope](https://github.com/EightKK/vue-weave/blob/v1.
|
|
265
|
-
- [Scheduling and resource load](https://github.com/EightKK/vue-weave/blob/v1.
|
|
266
|
-
- [Contributing and release process](https://github.com/EightKK/vue-weave/blob/v1.
|
|
267
|
-
- [Security and private vulnerability reporting](https://github.com/EightKK/vue-weave/blob/v1.
|
|
268
|
-
- [Code of conduct](https://github.com/EightKK/vue-weave/blob/v1.
|
|
269
|
-
- [Changelog](https://github.com/EightKK/vue-weave/blob/v1.
|
|
265
|
+
- [Public API and input contracts](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/api.md)
|
|
266
|
+
- [Vue, Nuxt, custom rendering, time scales and persistence](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/integration.md)
|
|
267
|
+
- [Architecture, performance and scope](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/architecture.md)
|
|
268
|
+
- [Scheduling and resource load](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/scheduling.md)
|
|
269
|
+
- [Contributing and release process](https://github.com/EightKK/vue-weave/blob/v1.1.0/CONTRIBUTING.md)
|
|
270
|
+
- [Security and private vulnerability reporting](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/security.md)
|
|
271
|
+
- [Code of conduct](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/code-of-conduct.md)
|
|
272
|
+
- [Changelog](https://github.com/EightKK/vue-weave/blob/v1.1.0/CHANGELOG.md)
|
|
270
273
|
|
|
271
274
|
## License
|
|
272
275
|
|
|
273
|
-
MIT. See [LICENSE](https://github.com/EightKK/vue-weave/blob/v1.
|
|
276
|
+
MIT. See [LICENSE](https://github.com/EightKK/vue-weave/blob/v1.1.0/LICENSE). Third-party notices for the prebuilt demo are in [THIRD_PARTY_NOTICES.md](https://github.com/EightKK/vue-weave/blob/v1.1.0/THIRD_PARTY_NOTICES.md) and [Third-party licenses](https://github.com/EightKK/vue-weave/blob/v1.1.0/docs/third-party-licenses.md).
|