PhpSpredsheetを使ってセルにコメントを設定する

はじめに

PhpSpredsheetを使って、スケジュール表を作ることになりました。

スケジュールの期間に必要な情報を書き込むほどの幅が無いので、コメントを設定することになりました。

今回は、コメントの設定方法を備忘録します。

コメントの設定

コメントの設定を調べるのに以下のURLを利用しました。

■公式ドキュメント

https://phpspreadsheet.readthedocs.io/en/latest/topics/recipes/#add-a-comment-to-a-cell

■Github

https://github.com/PHPOffice/PhpSpreadsheet/blob/0e8fde9be6d3918ffe030bed0ba0297bfe330c4d/src/PhpSpreadsheet/Comment.php#L75-L82

//対象のセルのコメント
$Comment = $spreadsheet->getActiveSheet()->getComment('E11');

// コメントの作成者
//@param string $author
$Comment->setAuthor('kabanoki');

// コメント本文
//@param string
$Comment->getText()->createTextRun("コメント：\r\n改行後のコメントが表示されます。");

// コメント枠の幅
// @param string px or pt
$Comment->setWidth('300px');

// コメント枠の高さ
// @param string px or pt
$Comment->setHeight('300px');

// マージンレフト
// @param string px or pt
$Comment->setMarginLeft('300px');

// マージントップ
// @param string px or pt
$Comment->setMarginTop('300px');

//起動時にコメントを展開しているか
// @param bool
$Comment->setVisible(false)

//文字の配置
// @param string $alignment see Style\Alignment::HORIZONTAL_*
$Comment->setAlignment(\PhpOffice\PhpSpreadsheet\Style\Alignment::HORIZONTAL_RIGHT)

まとめ

セルにコメントを設定する方法でした。

今日はこの辺でー