Skip to content

update README.md and READEME_zh.md #1319

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.

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 9, 2020
Merged

update README.md and READEME_zh.md #1319

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1036,7 +1036,7 @@ ws.getCell('B1').note = {
};
```

### <a>Cell Comments Properties</a>
### Cell Comments Properties[⬆](#contents)<!-- Link generated with jump2header -->

The following table defines the properties supported by cell comments.

Expand All @@ -1058,7 +1058,7 @@ ws.getCell('B1').note.margins = {
}
```

### Supported Margins Properties
### Supported Margins Properties[⬆](#contents)<!-- Link generated with jump2header -->

| Property | Required | Default Value | Description |
| -------- | -------- | ------------- | ----------- |
Expand All @@ -1078,9 +1078,6 @@ ws.getCell('B1').note.protection = {
};
```


## Tables[⬆](#contents)<!-- Link generated with jump2header -->
Copy link
Member

@alubbe alubbe Jun 8, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

was this meant to be deleted?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this line is repeated.
excel_tables


### Supported Protection Properties[⬆](#contents)<!-- Link generated with jump2header -->

| Property | Required | Default Value | Description |
Expand All @@ -1090,8 +1087,6 @@ ws.getCell('B1').note.protection = {

Note: Locked objects are valid only when the worksheet is protected.



### Cell Comments EditAs[⬆](#contents)<!-- Link generated with jump2header -->

The cell comments can also have the property 'editAs' which will control how the comments is anchored to the cell(s).
Expand Down Expand Up @@ -2228,7 +2223,7 @@ Note that it is possible to build the entire workbook without committing any row

#### Streaming XLSX[⬆](#contents)<!-- Link generated with jump2header -->

##### Streaming XLSX Writer
##### Streaming XLSX Writer(#contents)<!-- Link generated with jump2header -->

The streaming XLSX workbook writer is available in the ExcelJS.stream.xlsx namespace.

Expand Down Expand Up @@ -2305,7 +2300,7 @@ await workbook.commit();
// ... the stream has been written
```

##### Streaming XLSX Reader
##### Streaming XLSX Reader(#contents)<!-- Link generated with jump2header -->

The streaming XLSX workbook reader is available in the ExcelJS.stream.xlsx namespace.

Expand All @@ -2332,7 +2327,7 @@ for await (const worksheetReader of workbookReader) {

Please note that `worksheetReader` returns an array of rows rather than each row individually for performance reasons: https://github.com/nodejs/node/issues/31979

###### Iterating over all events
###### Iterating over all events(#contents)<!-- Link generated with jump2header -->

Events on workbook are 'worksheet', 'shared-strings' and 'hyperlinks'. Events on worksheet are 'row' and 'hyperlinks'.

Expand All @@ -2355,7 +2350,7 @@ for await (const {eventType, value} of workbook.parse()) {
}
```

###### Readable stream
###### Readable stream(#contents)<!-- Link generated with jump2header -->

While we strongly encourage to use async iteration, we also expose a streaming interface for backwards compatibility.

Expand Down
Loading