ReoGrid ReoGrid Web

セルコメント

v1.4.0 から、任意のセルにコメント(Excel の「メモ/ノート」)を添付できます。コメントの付いたセルには赤い角マーカーが表示され、ホバーでバブルが現れます。コメントは単一作成者のメモで — スレッド返信は意図的に対象外です。

Note: コメントの作成は Pro 機能です。読み取り(getComment・getComments・hasComment)は Lite で動作するため、Pro で作成した — または xlsx から読み取った — コメントは無償版でも表示されます。

コメントの設定

1 セルにつき 1 コメントです。ワークシート上で行・列指定、またはセルハンドル経由で設定します。

import { createReogrid } from '@reogrid/pro'

const grid = createReogrid({ workspace: '#app' })
const ws = grid.worksheet

// 行・列指定 — コメントの数値 id を返す
ws.setComment(0, 2, '税抜の単価です。', { author: '経理' })

// セルハンドル経由
ws.cell('B2').setComment('4 個以上で数量割引が適用されます。', { author: 'QA' })

同じセルで再度 setComment を呼ぶと既存のメモが置き換わります。

SetCommentOptions

オプション型説明
authorstring作成者名(xlsx <authors> にも書き出し)。
visiblebooleanコメントボックスを常時表示に固定(往復のため保持。v1 は常にマーカー+ホバーバブルを表示)。
実行結果
コメントは赤い三角マーカーで表示され、ホバーすると作成者付きで開く。(下の表はこの画像のために補ったもの)
コメントは赤い三角マーカーで表示され、ホバーすると作成者付きで開く。(下の表はこの画像のために補ったもの)

コメントの読み取り(Lite で読み取り可)

ws.getComment(0, 2)   // CellComment | null
ws.hasComment(0, 2)   // boolean
ws.getComments()      // シート上の readonly CellComment[]
ws.cell('B2').getComment()

CellComment は { id, row, col, text, author?, visible? } です。

更新と削除

ws.setCommentVisible(0, 2, true)  // 常時表示フラグを切り替え
ws.removeComment(0, 2)            // 1 つのコメントを削除(削除できたら true)
ws.clearComments()                // シート上の全コメントを削除

表示

コメントの付いた各セルには右上に小さな赤い三角が描画され、セルにホバーするとバブルにコメント文が表示されます。visible フラグは将来の常時表示ボックスのために I/O を通じて保持されますが、v1 では常にマーカー+ホバーの挙動になります。

永続化:xlsx・JSON ともに往復

  • xlsx: v1.6.0 から、コメントは .xlsx を往復します。エクスポートはコメントパートと、Excel が併せて要求する従来形式の VML ボックスを書き出すため、メモは本文・作成者・常時表示かどうかを保ったまま Excel を往復します。呼ぶものはなく、saveAsXlsx で自動的に行われます。
  • ReoGrid JSON: コメントは ReoGrid JSON で完全に往復します。

v1.6.0 より前、コメントは xlsx から読めるものの書き戻せなかったため、コメント付きのブックを保存するとすべてのメモが消えていました。その回避策として JSON に保存していた場合、もう必要ありません。

コメントは v1.6.0 から並べ替えにも追従します。sortRows は以前コメントを元の行に残していたため、並べ替えたあとメモが別の行の内容に付いているように見えていました。

関連項目

このページは役に立ちましたか?
ニュースレター

開発の最新情報をお届けします

新しいリリース・機能追加・お知らせをいち早く受け取るには、
メーリングリストにご登録ください。