CHANGELOG

3.20.1

Bugfix to make it possible to include multiple newlines, like this :

doc.render({
    message: "Title \n\nContent\n\nBaz",
});

The line height of the generated cell will be correctly calculated in this case.

3.20.0

In this version, we fixed multiple issues related to cell height :

First of all, a bit of context: the height of a line is something that has to be written in the xlsx file, and Excel will not automatically change the height of a line if the text exceeds the height.

Excel does this at runtime when you write text from the keyboard, but it doesn't do it when you open an Excel workbook.

We therefore need to simulate the algorithm for changing the cell height.

We use the following input : the width of the cell, the new text in the cell, and the font-size and font-family of that text.

The bugs were the following :

1. The size of the columns was calculated and instead of storing the size for each Excel sheet, there was only one data structure. data structure. Logically, this had serious consequences in the case of multiple sheets. We now fixed this

2. There was also a bug with the loops. cell created by a loop, the height of the cell was miscalculated calculated incorrectly when there were "merged cells" (mergeCell)

3. The last and most complex improvement was that in previous versions, all characters were treated as having the same width. This may be true for some fixed-width font sizes such as Courier, but for Arial for example, the letter "W" and the symbol "!" are obviously not of the same width. The XLSX module now comes uses tables of characters for different font-families to calculate the width of a text to know how many lines of text should be created.

3.19.2

Bugfix browser test to work correctly when the template contains the "&" character, such as :

The following error was thrown :

3.19.1

Add support for preferTemplateFormat.

3.19.0

Improve date support :

• If passing the following as the data :

  doc.render({
      date1: {
          type: "date",
          value: new Date(1561795023000),
          fmt: "mm/dd/yy",
      },
  });
  

  The mm/dd/yy format will be used for that cell, regardless of the previous format of that cell.

• If the current cell has a date format, such as "mmmm/dd/yyyy", then that format will be kept, for example using this code :

  doc.render({
      date1: new Date(1561795023000),
  });
  

3.18.0

Add support for keepWrapping: true to keep existing wrapping even when the text will overflow.

3.17.5

Upgrade module to use NodeNext moduleResolution setting. See explanation here

3.17.4

Bugfix issue when having multiple sheets that contain tags.

Use nullGetter correctly. This could result in having "undefined" show up on your output document.

See nullGetter configuration section.

3.17.3

Update to bugfix an issue in ErrorLocationModule (version 3.9.2 of the ErrorLocationModule).

3.17.2

Use new resolvedId API => requires docxtemplater@3.43.0

3.17.1

Throw specific error during compilation if the parser cannot parse a given tag.

For example, the following tag :

Will now throw an error when running :

const doc = new Docxtemplater(zip, {
    modules: [new XlsxModule()],
});
doc.render(data);

This makes that error show with the error-location module as a comment.

3.17.0

Add possibility to use error-location module together with the XLSX module.

3.16.0

If text wrapping is enabled, and you replace a tag by a long text, the cell height will now be increased accordingly.

For example :

With following code :

doc.render({
    text: "Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.",
});

Will now render :

3.15.0

Allow to template {placeholder} inside sheetname, like in this example :

3.14.5

Add "stringify" function in constructor of the xlsx module.

This allows to render objects the way you want.

3.14.4

Add support for =HYPERLINK("https://ddg.gg", "DDG") in formulas, it will also automatically show up as underline with a blue link color.

3.14.3

When trying to include a document that has no styles.xml or no settings.xml file, the module would throw an error.

Now, the document is included correctly.

3.14.2

When using the inspectModule to getAllTags, avoid showing "undefined" key because the printArea tag or printTitle tag

Requires docxtemplater 3.42.1 or higher

3.14.1

Fix bug when using renderAsync and parser compilation fails : the error should now be shown inside a multierror. To to this, we know use sm.getValueAsync in resolve instead of sm.getValue

3.14.0

Update to allow to set "result" property when having formulas, such as :

doc.render({
    myVal: { type: "formula", value: "A1+B1", result: 42 },
});

3.13.13

Bugfix to set or get xml attributes correctly, even when using tabs instead of spaces in tags attributes

3.13.12

Set module.priority in order to have no more issues related to module ordering

3.13.11

Bugfix when using raw xml without any data value, like this :

With following code :

doc.render({
    // no data
});

The following error was thrown previously :

3.13.10

Upgrade to correctly pass in fileType, contentType, … to resolve

Makes it compatible with docxtemplater 3.40.1

3.13.9

Make xlsx module compatible with docxtemplater@3.40.0

3.13.8

Add module.clone() internal

3.13.7

Bugfix to work correctly (resize height of cell correctly) with html-xlsx module when the HTML output contains bulleted lists.

3.13.6

Bugfix to correctly update print area when the print area contains a "quoted" sheet, like this :

<definedName name="_xlnm.Print_Area" localSheetId="0">'Sheet1'!$B$1:$D$3</definedName>

Previously, such a printarea would not get updated.

3.13.5

Add support for bigints, to allow to render for example 10000000000000000033.

Previously, this value would be internally converted into 10000000000000000000 because of floating arithmetic.

3.13.4

Bugfix to allow for dates, fmt with hours, minutes, and seconds :

doc.render({
    date: {
        type: "date",
        value: new Date(1561799335622) /* 29th June 2019*/,
        fmt: "DD/MM/YYYY hh:mm:ss",
    },
});

3.13.3

Bugfix to correctly handle dates. Previously, dates were handled only with following code :

doc.render({
    date: {
        type: "date",
        value: new Date(1561799335622) /* 29th June 2019*/,
        fmt: "DD/MM/YYYY",
    },
});

Now it is also possible to write the following :

doc.render({
    date: {
        type: "date",
        value: "2019-06-29T07:57:03.000Z",
    },
});

This means that you can also use dates when you're using a JSON api (or when you are using the docker version).

3.13.2

Update to allow creation of HTML-xlsx module

3.13.1

Performance bufix when using XLSX module with many cells in async mode.

In prior versions, the async version of docxtemplater would be twice slower than the sync version if all data getters resolved immediately.

Now, the async version should be faster than before.

3.13.0

Performance bugfix :

In prior versions, the xlsx module was taking a lot of time when generating over 50000 cells.

Previously the generation of 50000 cells could take up to 7 minutes, now it should normally take less than 5 seconds.

3.12.1

Bugfix to correctly apply the alignment property when having data with new lines.

In previous versions, if a cell was left aligned, if the data contained a new line, the rendered cell would be wrongfully left aligned.

3.12.0

Bugfix when used together with the image module :

If the image is an image that uses the "description" tag, and is present inside a loop, the image is now correctly replaced.

This module requires version 3.19.0 of the xlsx module or higher

3.11.7

Update to work well with new angular parser (from docxtemplater/expressions.js), when using {this} as a numeric value.

In previous versions, this value would be converted to a string and formatted as such.

3.11.6

If using a corrupt character in some value, throw an error during generation.

For example,

doc.render({
    name: `John${String.fromCharCode(0x02)}Doe`,
});

Will now fail, in the same way that it fails on docx or pptx documents.

3.11.5

Avoid possible issue of "Maximum call stack size exceeded"

3.11.4

Bugfix : Previously, every unclosed loop would show the error twice.

The template :

(with no closing loop tag) would show two errors.

The error is no more duplicated.

3.11.3

Calculate correct image size even when having merged cell

3.11.2

Remove the single quotes in sheetnames when parsing a range.

3.11.1

Update to add forceFullCalc="1" and calcCompleted="0" after generation

3.11.0

Add containerWidth and containerHeight attributes to image tags.

3.10.3

Bugfix following regression :

When having a "#REF" in the printarea or printtitle

3.10.2

Update to make module compatible with docxtemplater@3.30.0

Fixes following error :

3.10.1

Bugfix corruption when having calcChain and some loops will "move" formulas.

3.10.0

Enhance height calculation of rows for loops + inner loops.

Add getRowHeight function to customize the height calculation

3.9.3

Bugfix corruption when using horizontal loop expand module with cells after Z. The previous version was generating a cell named "A@5", which is disallowed (the cell name after Z should be AA).

3.9.2

Bugfix corruption when using styles inside cells with placeholders.

Bugfix error when having an "infinite" range, like :

"$A:$K" or "$1:$10"

It gave the following error :

3.9.1

Bugfix corruption when using a cell that has multiple styles (for example partially bold), and that has a {placeholder} in it.

3.9.0

When used together with the image module 3.13.0 or higher, Add possibility to replace images in Excel documents (using the description field).

3.8.6

Update typing files to add new option innerLoopNewLine.

3.8.5

Add option innerLoopNewLine to disable insertion of newlines inside innerloops.

3.8.4

Bugfix escaping of special characters such as <, >, & in async mode (with renderAsync)

3.8.3

Improve rendering speed a lot (and minimize output size), when using loops that contain a lot of empty cells.

Sometimes, rows can contain up to 16000 cells :

<c r="O2"/>
<c r="P2"/>
....
<c r="EEA2"/>
<c r="EEB2"/>
<c r="EEC2"/>
<c r="EED2"/>
<c r="EEE2"/>

3.8.2

Bugfix to avoid this error when generating a document :

3.8.1

Bugfix related to 3.8.0

Whitespace in

doc.render({ name: "      John" });

will now be correctly rendered.

This will work both with spacing and newlines

3.8.0

Always render spaces in xlsx files. Previously, spaces such as the following would not be rendered (sometimes) :

doc.render({ name: "     John" });

By always ensuring the use of <t xml:space="preserve">, the spaces are now shown correctly.

Make module compatible with docxtemplater@3.28.0. Please make sure to update docxtemplater to 3.28.0 at the same time you update this module. The internal change made is the use of the new matchers API which fixes bugs that were triggered depending on the order of the modules that are attached to the instance. Now the order of the modules should not matter as expected.

3.7.3

Update to make module work well together with docxtemplater 3.27

3.7.2

Update to make module work well together with docxtemplater 3.26.3

3.7.1

Return errors properly when there is an unopened tag or an unclosed tag.

Previously, the error "Error !!" was raised, without any better explanation.

3.7.0

Add support for {@rawXML} tag to be able to add formatted text to a given cell.

3.6.4

When using a loop containing a mergecell, with no data, that would put the number of mergecells of the document to 0 (no more mergecells in that sheet), the resulting document would be corrupted.

Now, the document is no more corrupted in this case.

3.6.3

Use @xmldom/xmldom instead of xmldom, see this github issue

3.6.2

Generate files in built with correct filename In previous versions, the filename was always build/docxtemplater.js. Now the filename is build/xlsxmodule.js The .min.js file is also created now.

3.6.1

Avoid corruption of document when using {>user} tag followed by an empty cell (that is formatted for example but has no value inside it)

Fixes this github issue

3.6.0

Make it possible to insert XLSX formulas, by using the library like this :

doc.render({ computation: { type: "formula", value: "A1+B1" } });

3.5.3

Make module work correctly when using docxtemplater >= 3.22.1 with >, <, …

Add typescript definitions for public API

3.5.2

Bugfix when having multiple merge cells inside a loop, fixes this bug report.

3.5.1

Bugfix when using multiple loops on same line, for example on :

Previously, this would generate the message : The tag "loop" is closed by the tag "cond"

3.5.0

Add horizontal loop feature with ">" prefix.

Fixes this github issue

3.4.3

Bugfix printarea when using async mode (with resolveData)

The stacktrace was :

3.4.2

Automatically update printarea when having loops

3.4.1

Bugfix to make Image replacement work in async mode (you need access to both modules image and xlsx)

3.4.0

Add support for ImageModule together with XLSXModule to insert images with {%image} (you need access to both modules)

3.3.7

Bugfix to allow to have loop at the right of a merged cell, and have the merged-cell auto expand.

3.3.6

Bugfix when having table with filters with loops.

In previous versions, the filter would not apply to the newly created rows.

Now, it does apply to all rows, ie the table is expanded when adding data.

3.3.5

Performance improvements for big loops.

Loops of more than 5000 elements will now be significantly faster.

3.3.4

Fix xlsx module to work with docxtemplater 3.18.2.

If you use docxtemplater 3.19.0 or higher, you have to use docxtemplater-xlsx module 3.3.4 or higher or you will see some rendered values duplicated at multiple points in the generated spreadsheet.

3.3.3

Bugfix issue "Cannot read property 'type' of null" when using null value in a cell

3.3.2

Add support for templating headers and footers.

3.3.1

Bugfix corruption when using xlsx table with multiline header

3.3.0

Add support for inverted loops (to show a cell if a value is falsy), for example :

3.2.9

Avoid corruption when using array formulas (For example <f t="array" ref="C3"/>)

3.2.8

Add fullCalcOnLoad="1" to force recalc when opening file on Excel. (This does not work on Libreoffice)

3.2.7

Preserve height of rows if there is no placeholder within the cell

This avoids the following error that would occur previously:

3.2.6

Declare supportedFileTypes, which allows to use this module with the new docxtemplater constructor which was introduced in docxtemplater 3.17.

3.2.5

• Bugfix to use format specified in cell when converting string cell to int, instead of taking the "General" format, even when cell contains specific styles such as borders

3.2.4

• Bugfix to use format specified in cell when converting string cell to int, instead of taking the "General" format

3.2.3

• Bugfix when having <, >, or & in a tablecell

3.2.2

• Reuse same style of existing cell as much as possible (keep borders, font-sizes, colors, …)
• Handle the case of implicit numFmtId

3.2.1

• Avoid corruption for multiline content in a single cell

3.2.0

• Add support for having multiple conditions inside a single cell, for example :

  {#cond1}foo{/cond1}{#cond2}bar{/cond2}

• Keep font-style (bold, italic, …) from cell when converting to a numeric cell.

• Allow nested inner loops, for example :

  {#cond1}{#cond2}{text}{/}{/}

3.1.6

• Bugfix when having merged cells beyond AA, the end of the merge cell was reversed (for example "AC1:AG2" would be transformed into "AC1:GA2"

3.1.5

Bugfix when having merged cells beyond AA , for example between Z1 and AA5, the document was corrupted

Bugfix when having excel file which has only formulas (no static content), the module was throwing this error

Bugfix when having excel file which had a dragged formula, the module was throwing an error :

3.1.4

Bugfix when having multiple merge cells within multiple sheets, the renderer would produce corrupt spreadsheets.

Bugfix when having a formula which value computes to "" (an empty string), the following error was shown :

3.1.3

Make sure numFmt is added as the firstchild of stylesheet in styles.xml

3.1.2

Update to work with latest docxtemplater, version 3.15.4

3.1.1

Update module to work with docxtemplater 3.15.1 and above

3.1.0

Multiple improvements for loops and styles

Add support for merged cells inside loops, and before or after loops

3.0.2

Add support for xlsm filetype

3.0.1

• Bugfix when using this module on a docx document, this no more fails.

• Bugfix when creating XLSXModule without any option (a stacktrace was shown in 3.0.0)

3.0.0

• Initial release