NEWS.md
Provide new argument calc_chain to wb_load(). This is set to FALSE per default, to ignore the calculation chain if it is found. This change only reflects files imported from third party spreadsheet software and should not be visible to the user. 461
Tweaks to wb_data(). Dims is now optional and will select data similar to wb_to_df(), similar it allows passing down other wb_to_df() arguments. Though, it probably is a good idea not be to creative passing down arguments, not all will result in a usable wb_data object. 462
Add hidden argument and change the default for heights to NULL in set_row_heights(). This allows changing the row height and/or hiding selected rows. This does not yet provide a way to hide rows per default. 475
Add wb_add_chartsheet() for chart sheet support. Along with internal cleanup around chart sheet code. 466
Fix wb_freeze_pane(). This changes the load logic a bit. Previously we put everything into sheetViews (the frozen pane is part of this). Though wb_freeze_pane() assumes that freezePane is used. We now try to be smart and split sheetViews upon loading. 465
Previously, adding mschart objects to sheets was only possible if (1) the worksheet already contained a drawing (if the workbook was loaded) or (2) to the last sheet of the workbook. This has now been fixed. Adding mschart objects to any worksheet in the workbook is now possible as intended. 458
Really fix double xml escaping when saving. 467
Improving the drawing logic. There are some workbooks with various drawings per sheet and previously there were combinations possible that were not reflecting this. 478
Provide rvg support via wb_add_drawing(). This allows integrating rvg plots into xlsx files. 449
Improve print options. Defaults to printing grid lines, if the worksheet contains grid lines. 440
Support reading files with form control. 426
Handle input files with chart extensions. 443
Improve writing styles to workbook. Previously every cell was checked, this has been changed to check unique styles. 423
Implement reading custom file properties. 418
Improved add_named_region(). This function includes now various xml options. 386
Add … as argument to read_xlsx() and wb_read(). 381
Allow reading files with xml namespace created by third party software. 405
Update or remove calculation chain when overwriting formulas in a workbook. 438
Fix double xml escaping when saving. 435
Minor tweak for POSIXct dates and try to avoid the notorious 29Feb1900. 424
Implement reading customXml folder for input files with connection. 419
Fixed saving files with <sheetPr/> tag. Previously this was wrapped in a second sheetPr node. This issue occurs with xlsm files only. 417
Fixed a case where embedded files were assigned incorrectly in worksheet relationships. This caused corrupted output. 403
Remove merge_ functions for styles. 450
Previously if a loaded workbook contained formulas pointing to cells modified by openxlsx2, these formulas were not updated, once the workbook was opened in spreadsheet software. This is now enforced, unless the option openxlsx2.disableFullCalcOnLoad is set. In this case we would respect the original calculation properties of the workbook.
wb_save() no longer returns the path that the object was saved to, but instead the wbWorkbook object, invisibly. This is consistent with the behavior of others wrappers. 378
Remove never used all.equal.wbWorkbook(). The idea was nice, but it never developed into something useful.
Remove never used wb_chart_sheet() function. 399
set_sheetview() in sheets. Can be used to provide a wbWorkbook function and wrapper in the future. 399
Functions adding data to a workbook now bring an applyCellStyle argument. If this is TRUE openxlsx2 will apply a numeric style, if FALSE we will simply add the numeric value without additional styling and use the previous cell style. 365
Reading from file or workbook with showFormula now returns all formulas found in the workbook. Previously only those with type e or str were returned. Now we will be able to see formulas like hyperlinks too. 352
Moved data validation list from x14 to data validation. This enables data validation lists without x14 extension openxlsx 386. 347
Removed build_cell_merges() and replaced it with a plain R solution. 390
Improvements to setting column widths. Previously values set by set_col_widths() were a little off. This has now been improved. There are still corner cases where the column width set with openxlsx2 does not match those shown in spreadsheet software. Notable differences can be seen with floating point values (e.g., 10L works while 10.1 is slightly off) and with column width on Mac. 350
Improve rowNames when writing data to worksheet. Previously the name for the rownames column defaulted to 1. This has been changed. Now with data it defaults to an empty cell and with a data table it defaults to _rowNames_. 375
Fix the workbook xml relationship file to not include a reference to shared strings per default. This solves 360 for plain data files written from openxlsx2. 363
Adding cell styles has been streamlined to increase consistency. This includes all style functions like wb_add_font() and covers all cases of hyperlinks. 365
Fix cloning pivot charts. 361
Fix loading and writing files with slicers. Loading would add a few empty slicer xml files to Content_Types and workbook.xml.rels. 361
Align the logic for writing data to empty worksheets and updating/writing to worksheets with data. This removes update_cell_loop() and changes how update_cell() behaves. Not only does this remove duplicated code, it also brings great speed improvements (issue 356). 356
It is now possible to use special characters in formulas without coding. Previously & had to be encoded like & 251
Previously deprecated names.wbWorkbook() and names<-.wbWorkbook() have been removed. 367
Conditional style defaults for create_dxfs_style() have changed to be more permissive. Previously we shipped a default font, default font size and font color. This has been changed to better reflect a behavior the user expects. 343
New argument startCol in read to data frame functions wb_to_df(), wb_read() and read_xlsx(). 330
New function wb_colour() to ease working with color vectors used in openxlsx2 styles. 292
Deprecated get_cell_style() and set_cell_style() in favor of newly introduced wrapper functions wb_get_cell_style() and wb_set_cell_style(). 306
Improvements to wb_clone_worksheet(). Cloning of chartsheets as well as worksheets containing charts, pivot tables, drawings and tables is now possible or tweaked. Slicers are removed from the cloned worksheet. 305
Allow writing class data.table. 313
Provide na.numbers for reading functions, that convert numbers to NA in R output. Handle na.strings in write_xlsx(). 301
Add new option to add sparklines with various style options to worksheets: wb_add_sparklines(). Sparklines can be created with create_sparklines(). The manual page contains an example. 280
Add new options to data validation. allow type custom, add arguments errorStyle, errorTitle, error, promptTitle, prompt. 271
Provide wb_clone_sheet_style(). This improves upon the now deprecatedcloneSheetStyle() that existed as an early draft. 233
wb$add_data() now checks earlier for missing x argument. 246
Worksheets added to a wbWorkbook no longer contain default references to the drawings and vmlDrawings directories. Previously, these references were added as rId1 and rId2 even if the worksheet did not contain any drawing (e.g., an image or a chart) or vml drawing (e.g., a comment or a button). In such cases certain third party software, strictly following the references in worksheet or Content_Types complained about missing files and the import of such files failed completely. 311
Implement loading of user defined chartShapes. Previously this was not implemented instead the previous logic assumed that every sheet has a matching drawing. With chartShapes this no longer is true. The number of drawings and the number of worksheets/chartsheets must not match. 323
When loading files with charts, they are now imported into the wbWorkbook object. Previously they were simply copied. This will allow easier interaction with charts in the future. 304
Moving the data validation code from the workbook to the worksheet. Also, data_validation_list() is no longer stored in dataValidationLst. It has been moved to extLst, fixing a bug when saving and adding another data validation list. The code for retrieving the date origin from a workbook has been improved and get_date_origin(wb, origin = TRUE) now returns the origin as an integer from a wbWorkbook. 299
Removed level4 from XML functions. There was only a single use case for a level4 function that has been solved differently. If level4 is needed, this can be solved using a level3 and additional level2 functions. In addition xml_nodes now return nodes for all reachable nestings, therefore xml_node("<a/><a/>", "a") will now return a character vector of length two. For xml_node("<a/><b/>", "a") only a single character vector is returned. 280
Changes to various internal pugixml functions, to improve handling of XML strings. 279
Provide internal helper xml_rm_child() to remove children of XML strings. 273
Fixes a bug in update_cell() that slowed down writing on worksheets with data. In addition, this function has been cleaned up and further improved. It is no longer exported, as users only need to use wb_add_data() or write_data(), each of which calls update_cell() under the hood. 275 276
Various (mostly internal) changes to conditional_formatting. Created style_mgr integration for dxf (cf-styles) and cleaned up internal code. The syntax has changed slightly, see conditional formatting vignette for reference. Add whitespace argument to read_xml(). 268
wb_to_df(), wb_read() and read_xls() has changed.Data adding functions now ship a dims argument that can be used to determine the startCol and startRow for any x object that is added to the worksheet. Works with add_data(), add_data_table(), add_formula() and their underlying write_ functions as well as with the wrappers.
Provide optional na.strings argument when writing data to sheets. It can be used to add a custom character string when writing numeric data.
Improve writing NA, NaN, and -Inf/Inf. NA will be converted to #N/A; NaN will be converted to #VALUE!; Inf will be converted to #NUM!. The same conversion is not applied when reading from a workbook. 256
Many wbWorkbook methods now contain default sheet values of current_sheet() or next_sheet() (e.g., $add_worksheet(sheet = next_sheet()), $write_data(sheet = curret_sheet()). These internal waiver functions allow the wbWorkbook object to use default expectations for what sheet to interact with. This allows the easier workflow of wb$add_worksheet()$add_data(x = data.frame()) where $add_worksheet() knows to add a new worksheet (with a default name), sets that new worksheet to the current worksheet, and then $add_data() picks up the new sheet and places the data there. 165, 179
New functions wb_add_cell_style() and wb$add_cell_style() to simplify the creation of cell styles for cells on the sheet. This provides a fast way to create cell styles for regions on the worksheet. The cells for which the cell format is to be created must already exist on the worksheet. If the cells already contain a cell format, it will be preserved, except for the updated cell format entries, which will always be created. The function is applied to a continuous cell of the worksheet. 230
New functions wb_add_numfmt() and wb$add_numfmt() to simplify the creation of number formats for cells on the sheet. This provides a fast way to create number formats for regions on the worksheet. The cells for which the number format is to be created must already exist on the worksheet. If the cells already contain a cell style, it will be preserved, except for the number format, which will always be created. The function is applied to a continuous cell of the worksheet. 229
New functions wb_add_font() and wb$add_font() to simplify the creation of fonts for cells on the sheet. This provides a fast way to create fonts for regions on the worksheet. The cells for which the font is to be created must already exist on the worksheet. If the cells already contain a cell style, it will be preserved, except for the font, which will always be created. The function is applied to a continuous cell of the worksheet. 228
New functions wb_add_fill() and wb$add_fill() to simplify the creation of fills for cells on the sheet. This provides a fast way to create color filled regions on the worksheet. The cells for which the fill is to be created must already exist on the worksheet. If the cells already contain a cell style, it will be preserved, except for the filled color, which will always be created. The function is applied to a continuous cell of the worksheet and allows to change the color of every n-th column or row. 222
New functions wb_add_border() and wb$add_border() to simplify the creation of borders for cells on the sheet. This is especially useful when creating surrounding borders with different border styles for various cells. The cells for which the border is to be created must already exist on the worksheet. If the cells already contain a cell style, it will be preserved, except for the border, which will always be created. The function is applied to a continuous cell of the worksheet and allows to change the horizontal and vertical internal border grid independently. 220
Enable reading tables with wb_to_df(). Tables are handled similar to defined names. 193
Several enhancements have been added for checking and validation worksheet names 165
wbWorkbook$add_worksheet() the provided name is checked for illegal characters (see note in Breaking changes)wbWorkbook$get_sheet_names() (wb_get_sheet_names() wrapper) added. These return both the formatted and original sheet nameswbWorkbook$set_sheet_names() (wb_set_sheet_names()) added
names.wbWorkbook() and names<-.wbWorkbook() deprecatedwbWorkbook$setSheetName() deprecatedclean_worksheet_names() added to support removing characters that are not allowed in worksheet namesVarious fixes to enable handling of non unicode R environments 243
Fix an issue with broken pageSetup reference causing corrupt excel files 216
Fix reading and writing comments from workbooks that already provide comments 209
Fix an issue with broken xml in Excels vml files and enable opening xlsm files with wb$open() 202
Instruct parser to import nodes with whitespaces. This fixes a complaint in spreadsheet software. 189
Remove reference to printerSettings.bin when loading. This binary blob is not included and the reference caused file corruption warnings. 185
Fix loading and writing xlsx files with with workbook$extLst. Previously if the loaded sheet contains a slicer, a second extLst was added which confused spreadsheet software. Now both are combined into a single node.
Fix writing xlsx file with multiple entries of conditional formatting type databar on any sheet. 174
Cell fields cm, ph and vm are now implemented for reading and writing. This is the first step to handle functions that use metadata. 173
wbWorkbook: $open() no longer overwrites the $path field to the temporary file 171
When writing to existing workbooks, the default value for removeCellStyle is now FALSE. Therefore if a cell contains a style, it is attempted to replace the value, but not the style of the cell itself.
wb_conditional_formatting() is deprecated in favor of wb_add_conditional_formatting() and wbWorkbook$add_conditional_formatting().
type must now match exactly one of: "expression", "colorScale", "dataBar", "duplicatedValues", "containsText", "notContainsText", "beginsWith", "endsWith", "between", "topN", "bottomN"
Assigning a new worksheet with an illegal character now prompts an error 165. See ?clean_worksheet_name for an easy method of replacing bad characters.
openxlsx2Coerce() (which was called on x objects when adding data to a workbook) has been removed. Users can no longer pass some arbitrary objects and will need to format these objects appropriately or rely on as.data.frame methods 167
xl_open(file = ) is no longer valid and will throw a warning; first argument has been changes to x to highlight that xl_open() can be called on a file path or a wbWorkbook object 171
Remove wb$createFontNode() which was never used.
Switch to modern xlsx template, when creating workbooks. Imported workbooks will use the imported template
Rewrite wb$tables to use a data frame approach. This simplifies the code a bit and makes it easier to implement more upcoming changes 191
Update of internal pugixml library
The two functions write_data() and write_datatable() now use the same internal function write_data_table() to add data to the sheet. This simplifies the code and ensures that both functions are tested. In the same pull request, the documentation has been updated and the stack= option, which was not present before, has been removed 175
wbWorkbook$validate_sheet() added as an object methods
private wbWorkbook field original_sheet_names added to track the original names passed to sheets
private $get_sheet() removed in favor of more explicit
private wbWorkbook methods additions:
$get_sheet_id_max(), $get_sheet_index() for getting ids$get_sheet_name() for getting a sheet name$set_single_sheet_name() for setting sheet names$pappend() general private appending$validate_new_sheet() for checking new sheet names$append_workbook_field() for self$workbook[[field]]
$append_sheet_rels() for self$worksheet_rels[[sheet]]
$get_worksheet() to replace $ws()