NotificationsYou must be signed in to change notification settings
Fork1.9k
Star15k

Supports setting cell comment properties#1159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Jump to bottom

Merged

Siemienik merged 6 commits intoexceljs:masterfromAlanscut:note_properties

May 23, 2020

Merged

Supports setting cell comment properties#1159

Siemienik merged 6 commits intoexceljs:masterfromAlanscut:note_properties

May 23, 2020

Conversation

Copy link

Member

changes

The purpose of this PR is to support the setting of cell comment properties. Currently only the protection, margin and object position properties are supported.
Please let me know if this PR needs anything else.

Alanscut added2 commits

March 9, 2020 18:52

Supports setting cell comment properties

b1a5e8a

update index.d.ts

247e312

Alanscut mentioned this pull request

Mar 21, 2020

Support setting margins from cell comments#1155

Closed

Copy link

Member

Siemienik commentedMar 31, 2020•
edited
Loading

@Alanscut, many changes are here, should we make a review session through zoom.us?

Copy link

MemberAuthor

@Siemienik Sorry for replying so late. I am looking forward to video communication with you, but English is not my native language, video communication will be very difficult for me. I would rather explain my purpose and plan in writing, hope you not mind.

Purpose:

excel.js currently only supports inserting annotations, but does not allow users to set the corresponding properties of annotations. This PR is to solve this problem.

Code:

This PR will support setting protection, margin and object position attributes. I also want to support font, alignment, size and color and line attributes, so that users can insert comments flexibly.

lib / utils / under-dash.js
deepMerge () is to deeply merge the attributes of the source object to the current object without interfering with each other.
lib / xlsx / xform / comment / style / vml-position-xform.js
This file is to support location object properties.
lib / xlsx / xform / comment / style / vml-protection-xform.js
This is to support protection attributes.
lib / xlsx / xform / comment / vml-textbox-xform.js
This is to support margin attributes.

This PR is a new feature and will not affect the original function, and all test cases are successful.

Demo

constExcel=require('../../lib/exceljs.nodejs');constworkbook=newExcel.Workbook();constws2=workbook.addWorksheet('sheet1');ws2.getCell('A1').value='Hello';ws2.getCell('A1').note='Hello, ExcelJS!';ws2.getCell('A5').value='world';ws2.getCell('A5').note={texts:[{'font':{'size':12,'color':{'theme':0,},'name':'Calibri','family':2,'scheme':'minor',},'text':'hello exceljs',}],margins:{insetmode:'custom',inset:[0.55,0.55,0.45,0.45],},protection:{locked:'True',lockText:'True',},editAs:'absolute',};constfileName1='./read/issue_comments_padding.xlsx';workbook.xlsx.writeFile(fileName1).then(()=>{console.log('ok');});

XML

// vmlDrawing1.vml<v:shapeid="_x0000_s1026"type="#_x0000_t202"style="position:absolute; margin-left:105.3pt;margin-top:10.5pt;width:97.8pt;height:59.1pt;z-index:1;visibility:hidden"fillcolor="infoBackground [80]"strokecolor="none [81]"o:insetmode="custom">    <v:fillcolor2="infoBackground [80]" />    <v:shadowcolor="none [81]"obscured="t" />    <v:patho:connecttype="none" />    <v:textboxstyle="mso-direction-alt:auto"inset="5.5mm,5.5mm,4.5mm,4.5mm">      <divstyle="text-align:left" />    </v:textbox>    <x:ClientDataObjectType="Note">      <x:MoveWithCells />      <x:SizeWithCells />      <x:Anchor>1, 6, 3, 14, 3, 2, 7, 16</x:Anchor>      <x:Locked>True</x:Locked>      <x:AutoFill>False</x:AutoFill>      <x:LockText>True</x:LockText>      <x:Row>4</x:Row>      <x:Column>0</x:Column>    </x:ClientData>  </v:shape>