Dropped features reference
Added in Handsontable 19.0.0An XLSX import or export can meet something the other side cannot hold. The plugin then reports it under a key instead of failing. This page lists every key, what it means, and which engine reports it.
How keys are reported
- Import: one console warning per call names the engine and every key that applied. An import that a newer import replaced while its file was being read, or that the plugin was disabled during, prints none. The same keys come back on
result.dropped, as a list of names. The counts are not reported. - Export: one console warning per call names the engine and every key that applied.
In the Reported by column, Both means the built-in engine and ExcelJS report the key. A key reported by one engine only says so.
Four groups of keys end in a value: cellType: in the inferred type name, and conditionalFormatting:, dataValidation:, and numFmt: in a value from the file. The value is cut to 64 characters, and its control characters are replaced. After 32 distinct values across those groups in one import, the rest are reported as <group>:other.
Dropped on import
| Key | Reported by | What it means |
|---|---|---|
cellStyles | Both | The workbook carries cell styling and importStyles is off, whatever the license unlocks. Recorded only then: with importStyles: true, styling the grid cannot carry (theme fills, gradients, font size and name, wrapped or rotated text) is lost with no entry. The built-in engine does not count the default alignment LibreOffice writes on every cell, or the workbook’s default font, as styling. |
cellStyles:borders | Both | importStyles is on, the workbook carries borders, and the CustomBorders plugin is not enabled on the grid. |
comments | Both | The workbook carries cell comments and the Comments plugin is not enabled, whatever the license unlocks. Set comments: true to import them. |
comment:header | Both | A comment on a row the import promotes to column headers. A header cannot hold a comment, so the note is lost whatever your license unlocks and whether or not the Comments plugin is on. |
threadedComments | Both | The workbook carries Excel 365 threaded comments. Each thread imports as one cell comment holding the comment and its replies, one per line, without authors or dates. |
comment:unreadable | ExcelJS | A comment stored as plain text, which ExcelJS reads as empty. The built-in engine reads it. |
mergeCells, hiddenRows, hiddenColumns | Both | The workbook carries the feature, and the plugin of that name is not registered. Recorded only when the result is applied. |
cellType:<name> | Both | A column or cell got a type that is not registered, such as intl-datetime when you register modules one by one. The cells import as text. Recorded only when the result is applied. |
dataValidation:<type> | Both | A non-list data validation, which has no grid equivalent. |
dataValidation:unresolvedList | Both | A list validation whose source cannot be read: a formula such as INDIRECT(), a defined name, or a range on a sheet the workbook does not hold. An inline list, and a range on the same or another sheet, become a dropdown column. |
numFmt:<pattern> | Both | A number format with no Intl.NumberFormat equivalent, one the import does not apply, or one longer than 255 characters. The ExcelJS engine also records it for a cell whose value it cannot read as a date under that format; the cell imports empty. See number formats. |
formula:noCachedValue | Both | A formula imported as a value (the Formulas plugin is off, importFormulas is false, or it is an array formula reported as formula:arraySpill) with no cached result in the file. The cell imports empty; the formula is listed in result.formulas. openpyxl writes every formula this way. |
formula:outOfRange | Both | A formula whose reference would land before the imported window’s origin or past the sheet maximum. Its cached value is imported instead. A reference past the window’s end stays live and points at an empty cell. |
formula:otherSheet | Both | A formula referencing a sheet the Formulas plugin’s engine does not hold, another workbook, or a range of sheets. Its cached value is imported, and the formula is listed in result.formulas. A reference to the imported sheet’s own name is read as a reference to the grid. |
formula:arraySpill | Both | An array formula that HyperFormula cannot evaluate the way Excel did. Either HyperFormula cannot spill it over the cells the file gives it, so it would show #SPILL! (HyperFormula sizes FILTER by its input range, not by its result), or it shows an error where the file holds a value. For example, HyperFormula shows #VALUE! for an array that is only a range (=A1:A3), a range name, or INDEX(A1:A3,0). The array formula and the cells it covers import their cached values, and the formula is listed in result.formulas. |
formula:spillReference | Both | A formula using Excel’s spill operator (=SUM(B1#)) or implicit intersection (=@A1:A3). Excel stores them as the ANCHORARRAY and SINGLE functions, which HyperFormula does not have. The formula imports its cached value and is listed in result.formulas. |
formula:definedName | Both | A formula using a workbook name the import could not add to the Formulas plugin’s engine (see definedNames:unsupported). Its cached value is imported. |
definedNames:unsupported | Both | A workbook name the import cannot read: a definition longer than 32,768 characters or a scope that names no sheet (built-in engine, recorded when the file is read), or any name the ExcelJS engine reads, because ExcelJS loses the scope (recorded only when a formula uses the name). Or a workbook name the Formulas plugin’s engine cannot take: a relative reference, a reference into a dropped header row or column, a sheet the engine does not hold, a name HyperFormula refuses, a name that calls a function HyperFormula lacks (such as UNIQUE), a workbook name whose definition uses a name the imported sheet also defines (the import adds the sheet’s one in its place), or a name defined over such a name. Or a name past the import’s defined-name limits: a definition longer than 8,192 characters, one read after 262,144 characters of definitions, or one whose ranges cover more than 100,000 cells, or bring the import’s names past 1,000,000. Or a name the engine fails to add while the result is applied: the import removes it again and adds this entry to result.dropped. The formulas over that name are already in the grid by then, with no cached value left to fall back on, so they show #NAME?. The import adds every other name to the engine (result.namedExpressions), so the formulas using them stay live. A name the engine already defines with the same definition, at workbook scope or on the grid’s own sheet, stays live (built-in engine only). One it defines differently keeps its own definition, and the formulas over it import their cached values. A name scoped to another sheet is ignored. |
formula:tooLong | Built-in | A formula longer than 32,768 characters. The cell keeps its cached value. |
formula:dataTable | Built-in | An Excel what-if data table. Its cells keep their cached values; nothing recalculates. The ExcelJS engine does not report it. |
definedNames:truncated | Built-in | The workbook defines more than 65,536 names. A formula over a later name can show #NAME?. |
cellValue:date | Built-in | A t="d" date cell whose value is not an ISO 8601 date. The cell imports empty. |
cellValue:sharedString | Built-in | A text cell pointing at a shared string the workbook does not hold. The cell imports empty. |
cellValue:richValue | Built-in | A cell holding an Excel 365 rich value the engine does not read: a linked data type, such as Stocks or Geography, or an error with no known code. The cell imports the #VALUE! Excel caches for it. |
conditionalFormatting:<kind> | Built-in | A colorScale, dataBar, or iconSet rule, or a rule Excel stores only in its 2010 extension (the 3 Triangles, 3 Stars, and 5 Boxes icon sets, or a rule whose formula refers to another sheet). The engine leaves it out of result.conditionalFormatting. The ExcelJS engine reads colorScale, dataBar, and iconSet rules complete. |
conditionalFormatting:unparsedRef | Both | A conditional formatting range the plugin could not parse. The rule’s other ranges are still returned on result.conditionalFormatting. |
layoutDirection | Both | The sheet’s direction disagrees with the grid’s. Recorded only when the result is applied. The grid resolves layoutDirection at initialization, so construct it with layoutDirection: 'rtl' for a right-to-left workbook. The direction is on result.layoutDirection either way. |
sheetProtection:password | Both | The sheet is protected with a password. The file carries only a hash, so no password is recovered. readOnly cells are still derived from the protection. |
images | Both | The sheet carries a picture, a shape, a chart, or an Excel 365 in-cell picture. The grid has no home for them. The ExcelJS engine reports pictures only. |
tables | Both | The sheet defines Excel tables. Their values are imported; the definitions are not. |
autoFilter | Both | The sheet carries an auto-filter range. Configure the Filters plugin instead. |
hyperlink | Both | A cell is a hyperlink. Its text is imported; the URL is not. |
richText | Both | A cell mixes formatting inside one string. The text is imported; the per-run formatting is not. |
chartSheets, dialogSheets, macroSheets | Built-in | The workbook holds such a sheet. It is skipped, and a numeric sheet option counts worksheets only. A legacy module sheet, a <sheet> with an empty relationship id, counts as a macro sheet; a <sheet> with no relationship id at all is refused. The ExcelJS engine skips it with no entry. |
vbaProject | Built-in | The workbook carries macros (an .xlsm file). The data is imported; the macros are never read or run. |
license:xlsx:<id> | Both | A feature the file carried, the import was asked to bring over, and the license did not include that part of the XLSX add-on, so the import skipped that part of the file. A file without the feature gets no entry, and neither does a feature your options left out: importStyles, importLayout, or importFormulas set to false, inferCellTypes: false for data validation, or no Comments plugin for comments. Header groups are the exception: a merged header band that the license turns into plain labels is named as license:xlsx:layout even with importLayout: false. One entry per skipped part: license:xlsx:formulas, license:xlsx:layout, license:xlsx:comments, license:xlsx:styles, license:xlsx:conditional_formatting, license:xlsx:data_validation, or license:xlsx:protection. With importStyles: true, when your tier leaves out cell styles, this entry replaces cellStyles. With the Comments plugin on, when your tier leaves out comments, it replaces comments. A note in the header band is always reported as comment:header, never as a license entry. The plugin’s console warning names these entries in its own sentence, The xlsx import skipped features your license does not unlock: <ids>., not in the dropped-features warning. |
Pivot tables, outline groups, sparklines, and scenarios are lost with no entry on either engine.
Dropped on export
| Key | Reported by | What it means |
|---|---|---|
compressionLevel | Built-in | You set a numeric compression level other than 6, which the built-in engine cannot honor. The Compression Streams API has no level parameter. Pass compression: false to store the entries instead. |
merge:overlap | Both | Two merged ranges overlap. The later one is skipped. |
cellText:truncated | Both | A text value longer than 32,767 characters was cut. |
columnWidth:clamped, rowHeight:clamped | Both | A column or row wider or taller than Excel stores was written at the limit. |
conditionalFormatting:<type> | Built-in; ExcelJS for some rules | A rule kind the built-in engine does not write, such as colorScale, dataBar, or iconSet. ExcelJS reports those three only for a rule it cannot write, such as one with no cfvo thresholds. For a rule kind it does not know, such as duplicateValues or uniqueValues, ExcelJS writes an empty block and reports nothing. The names containsBlanks, notContainsBlanks, containsErrors, and notContainsErrors are operator values of a containsText rule, not kinds of their own. |
conditionalFormatting:invalid | Both | An entry that is not a rule object with a string type. The rule is skipped. |
conditionalFormatting:expression | Both | An expression rule with no formulae. The rule is skipped. |
conditionalFormatting:timePeriod | Both | A timePeriod rule with no timePeriod string, or with no formulae and a period other than today, yesterday, tomorrow, last7Days, thisWeek, lastWeek, nextWeek, thisMonth, lastMonth, or nextMonth. The rule is skipped. For the periods listed, both engines build the formula themselves. |
conditionalFormatting:other | Both | The bucket for rule kinds past 32 distinct ones in one export. |
dynamicArrays | ExcelJS | A dynamic array formula that spills over more than one cell. ExcelJS writes it as a legacy (CSE) array, so Excel shows it in braces and the range is fixed. A one-cell dynamic array, such as IFS, is written as a one-cell legacy array, which computes the same value, so it is not reported. The built-in engine writes dynamic arrays. |
formula:arrayExcluded | Both | An array formula whose spill crosses a row or column the file leaves out (hidden with exportHiddenRows: false, trimmed, or filtered), runs past the edge of the export, overlaps another array, or covers a merged cell (a one-cell dynamic array can sit on a merged cell). It is written as a plain formula in its first cell, with the spilled cells as values. Excel opens such a formula with an @ and shows one value. An import of the file does the same: when the formula is one call to a function that returns an array, such as =SEQUENCE(3), the cell imports its value and the formula is reported as formula:arraySpill. |
definedNames:unsupported | Both | A named expression the export cannot write. The built-in engine leaves out a name that is not valid in Excel (a spelling like a cell reference such as ZZZ1 or an R1C1 reference such as R, or a duplicate), one that points at a sheet the export does not write, one with an unqualified reference, one that starts or ends on a row or column the file leaves out, one defined over a name it leaves out, one whose definition HyperFormula could not parse (it stores =#ERROR! for it), and a sheet-scoped one whose definition uses a name the file holds for that sheet, or a workbook name the file does not hold. ExcelJS also leaves out every name that is not workbook-scoped, a constant, or a range over 100,000 cells in total. When grids with different Formulas engines define a name differently, only the first grid’s definition is written. |
formula:definedName | Both | A formula over a named expression the file does not hold (see definedNames:unsupported), or over a name another grid’s engine defines differently in the same export. The formula is written as its value, so Excel neither shows #NAME? nor reads the other grid’s definition. |
Related articles
Related guides
Related API reference
Plugins