@ckeditor/ckeditor5-table 38.1.0 → 38.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (167) hide show
  1. package/build/table.js +1 -1
  2. package/build/table.js.map +1 -0
  3. package/package.json +2 -2
  4. package/src/augmentation.d.ts +76 -76
  5. package/src/augmentation.js +5 -5
  6. package/src/commands/insertcolumncommand.d.ts +55 -55
  7. package/src/commands/insertcolumncommand.js +67 -67
  8. package/src/commands/insertrowcommand.d.ts +54 -54
  9. package/src/commands/insertrowcommand.js +66 -66
  10. package/src/commands/inserttablecommand.d.ts +44 -44
  11. package/src/commands/inserttablecommand.js +69 -69
  12. package/src/commands/mergecellcommand.d.ts +68 -68
  13. package/src/commands/mergecellcommand.js +198 -198
  14. package/src/commands/mergecellscommand.d.ts +28 -28
  15. package/src/commands/mergecellscommand.js +94 -94
  16. package/src/commands/removecolumncommand.d.ts +29 -29
  17. package/src/commands/removecolumncommand.js +109 -109
  18. package/src/commands/removerowcommand.d.ts +29 -29
  19. package/src/commands/removerowcommand.js +82 -82
  20. package/src/commands/selectcolumncommand.d.ts +33 -33
  21. package/src/commands/selectcolumncommand.js +60 -60
  22. package/src/commands/selectrowcommand.d.ts +33 -33
  23. package/src/commands/selectrowcommand.js +56 -56
  24. package/src/commands/setheadercolumncommand.d.ts +50 -50
  25. package/src/commands/setheadercolumncommand.js +71 -71
  26. package/src/commands/setheaderrowcommand.d.ts +53 -53
  27. package/src/commands/setheaderrowcommand.js +79 -79
  28. package/src/commands/splitcellcommand.d.ts +43 -43
  29. package/src/commands/splitcellcommand.js +54 -54
  30. package/src/converters/downcast.d.ts +63 -63
  31. package/src/converters/downcast.js +146 -146
  32. package/src/converters/table-caption-post-fixer.d.ts +20 -20
  33. package/src/converters/table-caption-post-fixer.js +53 -53
  34. package/src/converters/table-cell-paragraph-post-fixer.d.ts +32 -32
  35. package/src/converters/table-cell-paragraph-post-fixer.js +107 -107
  36. package/src/converters/table-cell-refresh-handler.d.ts +18 -18
  37. package/src/converters/table-cell-refresh-handler.js +45 -45
  38. package/src/converters/table-headings-refresh-handler.d.ts +17 -17
  39. package/src/converters/table-headings-refresh-handler.js +49 -49
  40. package/src/converters/table-layout-post-fixer.d.ts +226 -226
  41. package/src/converters/table-layout-post-fixer.js +367 -367
  42. package/src/converters/tableproperties.d.ts +54 -54
  43. package/src/converters/tableproperties.js +159 -159
  44. package/src/converters/upcasttable.d.ts +49 -49
  45. package/src/converters/upcasttable.js +243 -243
  46. package/src/index.d.ts +60 -60
  47. package/src/index.js +30 -30
  48. package/src/plaintableoutput.d.ts +26 -26
  49. package/src/plaintableoutput.js +123 -123
  50. package/src/table.d.ts +40 -40
  51. package/src/table.js +44 -44
  52. package/src/tablecaption/tablecaptionediting.d.ts +63 -63
  53. package/src/tablecaption/tablecaptionediting.js +122 -122
  54. package/src/tablecaption/tablecaptionui.d.ts +21 -21
  55. package/src/tablecaption/tablecaptionui.js +57 -57
  56. package/src/tablecaption/toggletablecaptioncommand.d.ts +68 -68
  57. package/src/tablecaption/toggletablecaptioncommand.js +104 -104
  58. package/src/tablecaption/utils.d.ts +42 -42
  59. package/src/tablecaption/utils.js +67 -67
  60. package/src/tablecaption.d.ts +24 -24
  61. package/src/tablecaption.js +28 -28
  62. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.d.ts +32 -32
  63. package/src/tablecellproperties/commands/tablecellbackgroundcolorcommand.js +30 -30
  64. package/src/tablecellproperties/commands/tablecellbordercolorcommand.d.ts +37 -37
  65. package/src/tablecellproperties/commands/tablecellbordercolorcommand.js +44 -44
  66. package/src/tablecellproperties/commands/tablecellborderstylecommand.d.ts +37 -37
  67. package/src/tablecellproperties/commands/tablecellborderstylecommand.js +44 -44
  68. package/src/tablecellproperties/commands/tablecellborderwidthcommand.d.ts +51 -51
  69. package/src/tablecellproperties/commands/tablecellborderwidthcommand.js +64 -64
  70. package/src/tablecellproperties/commands/tablecellheightcommand.d.ts +46 -46
  71. package/src/tablecellproperties/commands/tablecellheightcommand.js +51 -51
  72. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts +32 -32
  73. package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js +30 -30
  74. package/src/tablecellproperties/commands/tablecellpaddingcommand.d.ts +51 -51
  75. package/src/tablecellproperties/commands/tablecellpaddingcommand.js +64 -64
  76. package/src/tablecellproperties/commands/tablecellpropertycommand.d.ts +62 -62
  77. package/src/tablecellproperties/commands/tablecellpropertycommand.js +92 -92
  78. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.d.ts +40 -40
  79. package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js +38 -38
  80. package/src/tablecellproperties/tablecellpropertiesediting.d.ts +43 -43
  81. package/src/tablecellproperties/tablecellpropertiesediting.js +241 -241
  82. package/src/tablecellproperties/tablecellpropertiesui.d.ts +112 -112
  83. package/src/tablecellproperties/tablecellpropertiesui.js +328 -328
  84. package/src/tablecellproperties/ui/tablecellpropertiesview.d.ts +227 -227
  85. package/src/tablecellproperties/ui/tablecellpropertiesview.js +537 -537
  86. package/src/tablecellproperties.d.ts +30 -30
  87. package/src/tablecellproperties.js +34 -34
  88. package/src/tablecellwidth/commands/tablecellwidthcommand.d.ts +46 -46
  89. package/src/tablecellwidth/commands/tablecellwidthcommand.js +51 -51
  90. package/src/tablecellwidth/tablecellwidthediting.d.ts +29 -29
  91. package/src/tablecellwidth/tablecellwidthediting.js +45 -45
  92. package/src/tableclipboard.d.ts +65 -65
  93. package/src/tableclipboard.js +450 -450
  94. package/src/tablecolumnresize/constants.d.ts +20 -20
  95. package/src/tablecolumnresize/constants.js +20 -20
  96. package/src/tablecolumnresize/converters.d.ts +18 -18
  97. package/src/tablecolumnresize/converters.js +45 -45
  98. package/src/tablecolumnresize/tablecolumnresizeediting.d.ts +139 -139
  99. package/src/tablecolumnresize/tablecolumnresizeediting.js +571 -571
  100. package/src/tablecolumnresize/tablewidthscommand.d.ts +38 -38
  101. package/src/tablecolumnresize/tablewidthscommand.js +61 -61
  102. package/src/tablecolumnresize/utils.d.ts +141 -141
  103. package/src/tablecolumnresize/utils.js +330 -330
  104. package/src/tablecolumnresize.d.ts +26 -26
  105. package/src/tablecolumnresize.js +30 -30
  106. package/src/tableconfig.d.ts +331 -331
  107. package/src/tableconfig.js +5 -5
  108. package/src/tableediting.d.ts +98 -98
  109. package/src/tableediting.js +191 -191
  110. package/src/tablekeyboard.d.ts +68 -68
  111. package/src/tablekeyboard.js +279 -279
  112. package/src/tablemouse/mouseeventsobserver.d.ts +62 -62
  113. package/src/tablemouse/mouseeventsobserver.js +35 -35
  114. package/src/tablemouse.d.ts +48 -48
  115. package/src/tablemouse.js +172 -172
  116. package/src/tableproperties/commands/tablealignmentcommand.d.ts +32 -32
  117. package/src/tableproperties/commands/tablealignmentcommand.js +30 -30
  118. package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts +32 -32
  119. package/src/tableproperties/commands/tablebackgroundcolorcommand.js +30 -30
  120. package/src/tableproperties/commands/tablebordercolorcommand.d.ts +37 -37
  121. package/src/tableproperties/commands/tablebordercolorcommand.js +44 -44
  122. package/src/tableproperties/commands/tableborderstylecommand.d.ts +37 -37
  123. package/src/tableproperties/commands/tableborderstylecommand.js +44 -44
  124. package/src/tableproperties/commands/tableborderwidthcommand.d.ts +51 -51
  125. package/src/tableproperties/commands/tableborderwidthcommand.js +64 -64
  126. package/src/tableproperties/commands/tableheightcommand.d.ts +46 -46
  127. package/src/tableproperties/commands/tableheightcommand.js +54 -54
  128. package/src/tableproperties/commands/tablepropertycommand.d.ts +61 -61
  129. package/src/tableproperties/commands/tablepropertycommand.js +80 -80
  130. package/src/tableproperties/commands/tablewidthcommand.d.ts +46 -46
  131. package/src/tableproperties/commands/tablewidthcommand.js +54 -54
  132. package/src/tableproperties/tablepropertiesediting.d.ts +40 -40
  133. package/src/tableproperties/tablepropertiesediting.js +206 -206
  134. package/src/tableproperties/tablepropertiesui.d.ts +114 -114
  135. package/src/tableproperties/tablepropertiesui.js +319 -319
  136. package/src/tableproperties/ui/tablepropertiesview.d.ts +203 -203
  137. package/src/tableproperties/ui/tablepropertiesview.js +455 -455
  138. package/src/tableproperties.d.ts +30 -30
  139. package/src/tableproperties.js +34 -34
  140. package/src/tableselection.d.ts +107 -107
  141. package/src/tableselection.js +297 -297
  142. package/src/tabletoolbar.d.ts +32 -32
  143. package/src/tabletoolbar.js +57 -57
  144. package/src/tableui.d.ts +53 -53
  145. package/src/tableui.js +309 -309
  146. package/src/tableutils.d.ts +448 -448
  147. package/src/tableutils.js +1041 -1041
  148. package/src/tablewalker.d.ts +323 -323
  149. package/src/tablewalker.js +333 -333
  150. package/src/ui/colorinputview.d.ts +143 -143
  151. package/src/ui/colorinputview.js +248 -248
  152. package/src/ui/formrowview.d.ts +61 -61
  153. package/src/ui/formrowview.js +57 -57
  154. package/src/ui/inserttableview.d.ts +77 -77
  155. package/src/ui/inserttableview.js +169 -169
  156. package/src/utils/common.d.ts +42 -42
  157. package/src/utils/common.js +57 -57
  158. package/src/utils/structure.d.ts +245 -245
  159. package/src/utils/structure.js +426 -426
  160. package/src/utils/table-properties.d.ts +67 -67
  161. package/src/utils/table-properties.js +86 -86
  162. package/src/utils/ui/contextualballoon.d.ts +34 -34
  163. package/src/utils/ui/contextualballoon.js +106 -106
  164. package/src/utils/ui/table-properties.d.ts +193 -193
  165. package/src/utils/ui/table-properties.js +360 -360
  166. package/src/utils/ui/widget.d.ts +16 -16
  167. package/src/utils/ui/widget.js +38 -38
@@ -1,426 +1,426 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import { default as TableWalker } from '../tablewalker';
6
- import { createEmptyTableCell, updateNumericAttribute } from './common';
7
- /**
8
- * Returns a cropped table according to given dimensions.
9
-
10
- * To return a cropped table that starts at first row and first column and end in third row and column:
11
- *
12
- * ```ts
13
- * const croppedTable = cropTableToDimensions( table, {
14
- * startRow: 1,
15
- * endRow: 3,
16
- * startColumn: 1,
17
- * endColumn: 3
18
- * }, writer );
19
- * ```
20
- *
21
- * Calling the code above for the table below:
22
- *
23
- * 0 1 2 3 4 0 1 2
24
- * ┌───┬───┬───┬───┬───┐
25
- * 0 │ a │ b │ c │ d │ e │
26
- * ├───┴───┤ ├───┴───┤ ┌───┬───┬───┐
27
- * 1 │ f │ │ g │ │ │ │ g │ 0
28
- * ├───┬───┴───┼───┬───┤ will return: ├───┴───┼───┤
29
- * 2 │ h │ i │ j │ k │ │ i │ j │ 1
30
- * ├───┤ ├───┤ │ │ ├───┤
31
- * 3 │ l │ │ m │ │ │ │ m │ 2
32
- * ├───┼───┬───┤ ├───┤ └───────┴───┘
33
- * 4 │ n │ o │ p │ │ q │
34
- * └───┴───┴───┴───┴───┘
35
- */
36
- export function cropTableToDimensions(sourceTable, cropDimensions, writer) {
37
- const { startRow, startColumn, endRow, endColumn } = cropDimensions;
38
- // Create empty table with empty rows equal to crop height.
39
- const croppedTable = writer.createElement('table');
40
- const cropHeight = endRow - startRow + 1;
41
- for (let i = 0; i < cropHeight; i++) {
42
- writer.insertElement('tableRow', croppedTable, 'end');
43
- }
44
- const tableMap = [...new TableWalker(sourceTable, { startRow, endRow, startColumn, endColumn, includeAllSlots: true })];
45
- // Iterate over source table slots (including empty - spanned - ones).
46
- for (const { row: sourceRow, column: sourceColumn, cell: tableCell, isAnchor, cellAnchorRow, cellAnchorColumn } of tableMap) {
47
- // Row index in cropped table.
48
- const rowInCroppedTable = sourceRow - startRow;
49
- const row = croppedTable.getChild(rowInCroppedTable);
50
- // For empty slots: fill the gap with empty table cell.
51
- if (!isAnchor) {
52
- // But fill the gap only if the spanning cell is anchored outside cropped area.
53
- // In the table from method jsdoc those cells are: "c" & "f".
54
- if (cellAnchorRow < startRow || cellAnchorColumn < startColumn) {
55
- createEmptyTableCell(writer, writer.createPositionAt(row, 'end'));
56
- }
57
- }
58
- // Otherwise clone the cell with all children and trim if it exceeds cropped area.
59
- else {
60
- const tableCellCopy = writer.cloneElement(tableCell);
61
- writer.append(tableCellCopy, row);
62
- // Trim table if it exceeds cropped area.
63
- // In the table from method jsdoc those cells are: "g" & "m".
64
- trimTableCellIfNeeded(tableCellCopy, sourceRow, sourceColumn, endRow, endColumn, writer);
65
- }
66
- }
67
- // Adjust heading rows & columns in cropped table if crop selection includes headings parts.
68
- addHeadingsToCroppedTable(croppedTable, sourceTable, startRow, startColumn, writer);
69
- return croppedTable;
70
- }
71
- /**
72
- * Returns slot info of cells that starts above and overlaps a given row.
73
- *
74
- * In a table below, passing `overlapRow = 3`
75
- *
76
- * ┌───┬───┬───┬───┬───┐
77
- * 0 │ a │ b │ c │ d │ e │
78
- * │ ├───┼───┼───┼───┤
79
- * 1 │ │ f │ g │ h │ i │
80
- * ├───┤ ├───┼───┤ │
81
- * 2 │ j │ │ k │ l │ │
82
- * │ │ │ ├───┼───┤
83
- * 3 │ │ │ │ m │ n │ <- overlap row to check
84
- * ├───┼───┤ │ ├───│
85
- * 4 │ o │ p │ │ │ q │
86
- * └───┴───┴───┴───┴───┘
87
- *
88
- * will return slot info for cells: "j", "f", "k".
89
- *
90
- * @param table The table to check.
91
- * @param overlapRow The index of the row to check.
92
- * @param startRow row to start analysis. Use it when it is known that the cells above that row will not overlap. Default value is 0.
93
- */
94
- export function getVerticallyOverlappingCells(table, overlapRow, startRow = 0) {
95
- const cells = [];
96
- const tableWalker = new TableWalker(table, { startRow, endRow: overlapRow - 1 });
97
- for (const slotInfo of tableWalker) {
98
- const { row, cellHeight } = slotInfo;
99
- const cellEndRow = row + cellHeight - 1;
100
- if (row < overlapRow && overlapRow <= cellEndRow) {
101
- cells.push(slotInfo);
102
- }
103
- }
104
- return cells;
105
- }
106
- /**
107
- * Splits the table cell horizontally.
108
- *
109
- * @returns Created table cell, if any were created.
110
- */
111
- export function splitHorizontally(tableCell, splitRow, writer) {
112
- const tableRow = tableCell.parent;
113
- const table = tableRow.parent;
114
- const rowIndex = tableRow.index;
115
- const rowspan = parseInt(tableCell.getAttribute('rowspan'));
116
- const newRowspan = splitRow - rowIndex;
117
- const newCellAttributes = {};
118
- const newCellRowSpan = rowspan - newRowspan;
119
- if (newCellRowSpan > 1) {
120
- newCellAttributes.rowspan = newCellRowSpan;
121
- }
122
- const colspan = parseInt(tableCell.getAttribute('colspan') || '1');
123
- if (colspan > 1) {
124
- newCellAttributes.colspan = colspan;
125
- }
126
- const startRow = rowIndex;
127
- const endRow = startRow + newRowspan;
128
- const tableMap = [...new TableWalker(table, { startRow, endRow, includeAllSlots: true })];
129
- let newCell = null;
130
- let columnIndex;
131
- for (const tableSlot of tableMap) {
132
- const { row, column, cell } = tableSlot;
133
- if (cell === tableCell && columnIndex === undefined) {
134
- columnIndex = column;
135
- }
136
- if (columnIndex !== undefined && columnIndex === column && row === endRow) {
137
- newCell = createEmptyTableCell(writer, tableSlot.getPositionBefore(), newCellAttributes);
138
- }
139
- }
140
- // Update the rowspan attribute after updating table.
141
- updateNumericAttribute('rowspan', newRowspan, tableCell, writer);
142
- return newCell;
143
- }
144
- /**
145
- * Returns slot info of cells that starts before and overlaps a given column.
146
- *
147
- * In a table below, passing `overlapColumn = 3`
148
- *
149
- * 0 1 2 3 4
150
- * ┌───────┬───────┬───┐
151
- * │ a │ b │ c │
152
- * │───┬───┴───────┼───┤
153
- * │ d │ e │ f │
154
- * ├───┼───┬───────┴───┤
155
- * │ g │ h │ i │
156
- * ├───┼───┼───┬───────┤
157
- * │ j │ k │ l │ m │
158
- * ├───┼───┴───┼───┬───┤
159
- * │ n │ o │ p │ q │
160
- * └───┴───────┴───┴───┘
161
- * ^
162
- * Overlap column to check
163
- *
164
- * will return slot info for cells: "b", "e", "i".
165
- *
166
- * @param table The table to check.
167
- * @param overlapColumn The index of the column to check.
168
- */
169
- export function getHorizontallyOverlappingCells(table, overlapColumn) {
170
- const cellsToSplit = [];
171
- const tableWalker = new TableWalker(table);
172
- for (const slotInfo of tableWalker) {
173
- const { column, cellWidth } = slotInfo;
174
- const cellEndColumn = column + cellWidth - 1;
175
- if (column < overlapColumn && overlapColumn <= cellEndColumn) {
176
- cellsToSplit.push(slotInfo);
177
- }
178
- }
179
- return cellsToSplit;
180
- }
181
- /**
182
- * Splits the table cell vertically.
183
- *
184
- * @param columnIndex The table cell column index.
185
- * @param splitColumn The index of column to split cell on.
186
- * @returns Created table cell.
187
- */
188
- export function splitVertically(tableCell, columnIndex, splitColumn, writer) {
189
- const colspan = parseInt(tableCell.getAttribute('colspan'));
190
- const newColspan = splitColumn - columnIndex;
191
- const newCellAttributes = {};
192
- const newCellColSpan = colspan - newColspan;
193
- if (newCellColSpan > 1) {
194
- newCellAttributes.colspan = newCellColSpan;
195
- }
196
- const rowspan = parseInt(tableCell.getAttribute('rowspan') || '1');
197
- if (rowspan > 1) {
198
- newCellAttributes.rowspan = rowspan;
199
- }
200
- const newCell = createEmptyTableCell(writer, writer.createPositionAfter(tableCell), newCellAttributes);
201
- // Update the colspan attribute after updating table.
202
- updateNumericAttribute('colspan', newColspan, tableCell, writer);
203
- return newCell;
204
- }
205
- /**
206
- * Adjusts table cell dimensions to not exceed limit row and column.
207
- *
208
- * If table cell width (or height) covers a column (or row) that is after a limit column (or row)
209
- * this method will trim "colspan" (or "rowspan") attribute so the table cell will fit in a defined limits.
210
- */
211
- export function trimTableCellIfNeeded(tableCell, cellRow, cellColumn, limitRow, limitColumn, writer) {
212
- const colspan = parseInt(tableCell.getAttribute('colspan') || '1');
213
- const rowspan = parseInt(tableCell.getAttribute('rowspan') || '1');
214
- const endColumn = cellColumn + colspan - 1;
215
- if (endColumn > limitColumn) {
216
- const trimmedSpan = limitColumn - cellColumn + 1;
217
- updateNumericAttribute('colspan', trimmedSpan, tableCell, writer, 1);
218
- }
219
- const endRow = cellRow + rowspan - 1;
220
- if (endRow > limitRow) {
221
- const trimmedSpan = limitRow - cellRow + 1;
222
- updateNumericAttribute('rowspan', trimmedSpan, tableCell, writer, 1);
223
- }
224
- }
225
- /**
226
- * Sets proper heading attributes to a cropped table.
227
- */
228
- function addHeadingsToCroppedTable(croppedTable, sourceTable, startRow, startColumn, writer) {
229
- const headingRows = parseInt(sourceTable.getAttribute('headingRows') || '0');
230
- if (headingRows > 0) {
231
- const headingRowsInCrop = headingRows - startRow;
232
- updateNumericAttribute('headingRows', headingRowsInCrop, croppedTable, writer, 0);
233
- }
234
- const headingColumns = parseInt(sourceTable.getAttribute('headingColumns') || '0');
235
- if (headingColumns > 0) {
236
- const headingColumnsInCrop = headingColumns - startColumn;
237
- updateNumericAttribute('headingColumns', headingColumnsInCrop, croppedTable, writer, 0);
238
- }
239
- }
240
- /**
241
- * Removes columns that have no cells anchored.
242
- *
243
- * In table below:
244
- *
245
- * +----+----+----+----+----+----+----+
246
- * | 00 | 01 | 03 | 04 | 06 |
247
- * +----+----+----+----+ +----+
248
- * | 10 | 11 | 13 | | 16 |
249
- * +----+----+----+----+----+----+----+
250
- * | 20 | 21 | 23 | 24 | 26 |
251
- * +----+----+----+----+----+----+----+
252
- * ^--- empty ---^
253
- *
254
- * Will remove columns 2 and 5.
255
- *
256
- * **Note:** This is a low-level helper method for clearing invalid model state when doing table modifications.
257
- * To remove a column from a table use {@link module:table/tableutils~TableUtils#removeColumns `TableUtils.removeColumns()`}.
258
- *
259
- * @internal
260
- * @returns True if removed some columns.
261
- */
262
- export function removeEmptyColumns(table, tableUtils) {
263
- const width = tableUtils.getColumns(table);
264
- const columnsMap = new Array(width).fill(0);
265
- for (const { column } of new TableWalker(table)) {
266
- columnsMap[column]++;
267
- }
268
- const emptyColumns = columnsMap.reduce((result, cellsCount, column) => {
269
- return cellsCount ? result : [...result, column];
270
- }, []);
271
- if (emptyColumns.length > 0) {
272
- // Remove only last empty column because it will recurrently trigger removing empty rows.
273
- const emptyColumn = emptyColumns[emptyColumns.length - 1];
274
- // @if CK_DEBUG_TABLE // console.log( `Removing empty column: ${ emptyColumn }.` );
275
- tableUtils.removeColumns(table, { at: emptyColumn });
276
- return true;
277
- }
278
- return false;
279
- }
280
- /**
281
- * Removes rows that have no cells anchored.
282
- *
283
- * In table below:
284
- *
285
- * +----+----+----+
286
- * | 00 | 01 | 02 |
287
- * +----+----+----+
288
- * | 10 | 11 | 12 |
289
- * + + + +
290
- * | | | | <-- empty
291
- * +----+----+----+
292
- * | 30 | 31 | 32 |
293
- * +----+----+----+
294
- * | 40 | 42 |
295
- * + + +
296
- * | | | <-- empty
297
- * +----+----+----+
298
- * | 60 | 61 | 62 |
299
- * +----+----+----+
300
- *
301
- * Will remove rows 2 and 5.
302
- *
303
- * **Note:** This is a low-level helper method for clearing invalid model state when doing table modifications.
304
- * To remove a row from a table use {@link module:table/tableutils~TableUtils#removeRows `TableUtils.removeRows()`}.
305
- *
306
- * @internal
307
- * @returns True if removed some rows.
308
- */
309
- export function removeEmptyRows(table, tableUtils) {
310
- const emptyRows = [];
311
- const tableRowCount = tableUtils.getRows(table);
312
- for (let rowIndex = 0; rowIndex < tableRowCount; rowIndex++) {
313
- const tableRow = table.getChild(rowIndex);
314
- if (tableRow.isEmpty) {
315
- emptyRows.push(rowIndex);
316
- }
317
- }
318
- if (emptyRows.length > 0) {
319
- // Remove only last empty row because it will recurrently trigger removing empty columns.
320
- const emptyRow = emptyRows[emptyRows.length - 1];
321
- // @if CK_DEBUG_TABLE // console.log( `Removing empty row: ${ emptyRow }.` );
322
- tableUtils.removeRows(table, { at: emptyRow });
323
- return true;
324
- }
325
- return false;
326
- }
327
- /**
328
- * Removes rows and columns that have no cells anchored.
329
- *
330
- * In table below:
331
- *
332
- * +----+----+----+----+
333
- * | 00 | 02 |
334
- * +----+----+ +
335
- * | 10 | |
336
- * +----+----+----+----+
337
- * | 20 | 22 | 23 |
338
- * + + + +
339
- * | | | | <-- empty row
340
- * +----+----+----+----+
341
- * ^--- empty column
342
- *
343
- * Will remove row 3 and column 1.
344
- *
345
- * **Note:** This is a low-level helper method for clearing invalid model state when doing table modifications.
346
- * To remove a rows from a table use {@link module:table/tableutils~TableUtils#removeRows `TableUtils.removeRows()`} and
347
- * {@link module:table/tableutils~TableUtils#removeColumns `TableUtils.removeColumns()`} to remove a column.
348
- *
349
- * @internal
350
- */
351
- export function removeEmptyRowsColumns(table, tableUtils) {
352
- const removedColumns = removeEmptyColumns(table, tableUtils);
353
- // If there was some columns removed then cleaning empty rows was already triggered.
354
- if (!removedColumns) {
355
- removeEmptyRows(table, tableUtils);
356
- }
357
- }
358
- /**
359
- * Returns adjusted last row index if selection covers part of a row with empty slots (spanned by other cells).
360
- * The `dimensions.lastRow` is equal to last row index but selection might be bigger.
361
- *
362
- * This happens *only* on rectangular selection so we analyze a case like this:
363
- *
364
- * +---+---+---+---+
365
- * 0 | a | b | c | d |
366
- * + + +---+---+
367
- * 1 | | e | f | g |
368
- * + +---+ +---+
369
- * 2 | | h | | i | <- last row, each cell has rowspan = 2,
370
- * + + + + + so we need to return 3, not 2
371
- * 3 | | | | |
372
- * +---+---+---+---+
373
- *
374
- * @returns Adjusted last row index.
375
- */
376
- export function adjustLastRowIndex(table, dimensions) {
377
- const lastRowMap = Array.from(new TableWalker(table, {
378
- startColumn: dimensions.firstColumn,
379
- endColumn: dimensions.lastColumn,
380
- row: dimensions.lastRow
381
- }));
382
- const everyCellHasSingleRowspan = lastRowMap.every(({ cellHeight }) => cellHeight === 1);
383
- // It is a "flat" row, so the last row index is OK.
384
- if (everyCellHasSingleRowspan) {
385
- return dimensions.lastRow;
386
- }
387
- // Otherwise get any cell's rowspan and adjust the last row index.
388
- const rowspanAdjustment = lastRowMap[0].cellHeight - 1;
389
- return dimensions.lastRow + rowspanAdjustment;
390
- }
391
- /**
392
- * Returns adjusted last column index if selection covers part of a column with empty slots (spanned by other cells).
393
- * The `dimensions.lastColumn` is equal to last column index but selection might be bigger.
394
- *
395
- * This happens *only* on rectangular selection so we analyze a case like this:
396
- *
397
- * 0 1 2 3
398
- * +---+---+---+---+
399
- * | a |
400
- * +---+---+---+---+
401
- * | b | c | d |
402
- * +---+---+---+---+
403
- * | e | f |
404
- * +---+---+---+---+
405
- * | g | h |
406
- * +---+---+---+---+
407
- * ^
408
- * last column, each cell has colspan = 2, so we need to return 3, not 2
409
- *
410
- * @returns Adjusted last column index.
411
- */
412
- export function adjustLastColumnIndex(table, dimensions) {
413
- const lastColumnMap = Array.from(new TableWalker(table, {
414
- startRow: dimensions.firstRow,
415
- endRow: dimensions.lastRow,
416
- column: dimensions.lastColumn
417
- }));
418
- const everyCellHasSingleColspan = lastColumnMap.every(({ cellWidth }) => cellWidth === 1);
419
- // It is a "flat" column, so the last column index is OK.
420
- if (everyCellHasSingleColspan) {
421
- return dimensions.lastColumn;
422
- }
423
- // Otherwise get any cell's colspan and adjust the last column index.
424
- const colspanAdjustment = lastColumnMap[0].cellWidth - 1;
425
- return dimensions.lastColumn + colspanAdjustment;
426
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import { default as TableWalker } from '../tablewalker';
6
+ import { createEmptyTableCell, updateNumericAttribute } from './common';
7
+ /**
8
+ * Returns a cropped table according to given dimensions.
9
+
10
+ * To return a cropped table that starts at first row and first column and end in third row and column:
11
+ *
12
+ * ```ts
13
+ * const croppedTable = cropTableToDimensions( table, {
14
+ * startRow: 1,
15
+ * endRow: 3,
16
+ * startColumn: 1,
17
+ * endColumn: 3
18
+ * }, writer );
19
+ * ```
20
+ *
21
+ * Calling the code above for the table below:
22
+ *
23
+ * 0 1 2 3 4 0 1 2
24
+ * ┌───┬───┬───┬───┬───┐
25
+ * 0 │ a │ b │ c │ d │ e │
26
+ * ├───┴───┤ ├───┴───┤ ┌───┬───┬───┐
27
+ * 1 │ f │ │ g │ │ │ │ g │ 0
28
+ * ├───┬───┴───┼───┬───┤ will return: ├───┴───┼───┤
29
+ * 2 │ h │ i │ j │ k │ │ i │ j │ 1
30
+ * ├───┤ ├───┤ │ │ ├───┤
31
+ * 3 │ l │ │ m │ │ │ │ m │ 2
32
+ * ├───┼───┬───┤ ├───┤ └───────┴───┘
33
+ * 4 │ n │ o │ p │ │ q │
34
+ * └───┴───┴───┴───┴───┘
35
+ */
36
+ export function cropTableToDimensions(sourceTable, cropDimensions, writer) {
37
+ const { startRow, startColumn, endRow, endColumn } = cropDimensions;
38
+ // Create empty table with empty rows equal to crop height.
39
+ const croppedTable = writer.createElement('table');
40
+ const cropHeight = endRow - startRow + 1;
41
+ for (let i = 0; i < cropHeight; i++) {
42
+ writer.insertElement('tableRow', croppedTable, 'end');
43
+ }
44
+ const tableMap = [...new TableWalker(sourceTable, { startRow, endRow, startColumn, endColumn, includeAllSlots: true })];
45
+ // Iterate over source table slots (including empty - spanned - ones).
46
+ for (const { row: sourceRow, column: sourceColumn, cell: tableCell, isAnchor, cellAnchorRow, cellAnchorColumn } of tableMap) {
47
+ // Row index in cropped table.
48
+ const rowInCroppedTable = sourceRow - startRow;
49
+ const row = croppedTable.getChild(rowInCroppedTable);
50
+ // For empty slots: fill the gap with empty table cell.
51
+ if (!isAnchor) {
52
+ // But fill the gap only if the spanning cell is anchored outside cropped area.
53
+ // In the table from method jsdoc those cells are: "c" & "f".
54
+ if (cellAnchorRow < startRow || cellAnchorColumn < startColumn) {
55
+ createEmptyTableCell(writer, writer.createPositionAt(row, 'end'));
56
+ }
57
+ }
58
+ // Otherwise clone the cell with all children and trim if it exceeds cropped area.
59
+ else {
60
+ const tableCellCopy = writer.cloneElement(tableCell);
61
+ writer.append(tableCellCopy, row);
62
+ // Trim table if it exceeds cropped area.
63
+ // In the table from method jsdoc those cells are: "g" & "m".
64
+ trimTableCellIfNeeded(tableCellCopy, sourceRow, sourceColumn, endRow, endColumn, writer);
65
+ }
66
+ }
67
+ // Adjust heading rows & columns in cropped table if crop selection includes headings parts.
68
+ addHeadingsToCroppedTable(croppedTable, sourceTable, startRow, startColumn, writer);
69
+ return croppedTable;
70
+ }
71
+ /**
72
+ * Returns slot info of cells that starts above and overlaps a given row.
73
+ *
74
+ * In a table below, passing `overlapRow = 3`
75
+ *
76
+ * ┌───┬───┬───┬───┬───┐
77
+ * 0 │ a │ b │ c │ d │ e │
78
+ * │ ├───┼───┼───┼───┤
79
+ * 1 │ │ f │ g │ h │ i │
80
+ * ├───┤ ├───┼───┤ │
81
+ * 2 │ j │ │ k │ l │ │
82
+ * │ │ │ ├───┼───┤
83
+ * 3 │ │ │ │ m │ n │ <- overlap row to check
84
+ * ├───┼───┤ │ ├───│
85
+ * 4 │ o │ p │ │ │ q │
86
+ * └───┴───┴───┴───┴───┘
87
+ *
88
+ * will return slot info for cells: "j", "f", "k".
89
+ *
90
+ * @param table The table to check.
91
+ * @param overlapRow The index of the row to check.
92
+ * @param startRow row to start analysis. Use it when it is known that the cells above that row will not overlap. Default value is 0.
93
+ */
94
+ export function getVerticallyOverlappingCells(table, overlapRow, startRow = 0) {
95
+ const cells = [];
96
+ const tableWalker = new TableWalker(table, { startRow, endRow: overlapRow - 1 });
97
+ for (const slotInfo of tableWalker) {
98
+ const { row, cellHeight } = slotInfo;
99
+ const cellEndRow = row + cellHeight - 1;
100
+ if (row < overlapRow && overlapRow <= cellEndRow) {
101
+ cells.push(slotInfo);
102
+ }
103
+ }
104
+ return cells;
105
+ }
106
+ /**
107
+ * Splits the table cell horizontally.
108
+ *
109
+ * @returns Created table cell, if any were created.
110
+ */
111
+ export function splitHorizontally(tableCell, splitRow, writer) {
112
+ const tableRow = tableCell.parent;
113
+ const table = tableRow.parent;
114
+ const rowIndex = tableRow.index;
115
+ const rowspan = parseInt(tableCell.getAttribute('rowspan'));
116
+ const newRowspan = splitRow - rowIndex;
117
+ const newCellAttributes = {};
118
+ const newCellRowSpan = rowspan - newRowspan;
119
+ if (newCellRowSpan > 1) {
120
+ newCellAttributes.rowspan = newCellRowSpan;
121
+ }
122
+ const colspan = parseInt(tableCell.getAttribute('colspan') || '1');
123
+ if (colspan > 1) {
124
+ newCellAttributes.colspan = colspan;
125
+ }
126
+ const startRow = rowIndex;
127
+ const endRow = startRow + newRowspan;
128
+ const tableMap = [...new TableWalker(table, { startRow, endRow, includeAllSlots: true })];
129
+ let newCell = null;
130
+ let columnIndex;
131
+ for (const tableSlot of tableMap) {
132
+ const { row, column, cell } = tableSlot;
133
+ if (cell === tableCell && columnIndex === undefined) {
134
+ columnIndex = column;
135
+ }
136
+ if (columnIndex !== undefined && columnIndex === column && row === endRow) {
137
+ newCell = createEmptyTableCell(writer, tableSlot.getPositionBefore(), newCellAttributes);
138
+ }
139
+ }
140
+ // Update the rowspan attribute after updating table.
141
+ updateNumericAttribute('rowspan', newRowspan, tableCell, writer);
142
+ return newCell;
143
+ }
144
+ /**
145
+ * Returns slot info of cells that starts before and overlaps a given column.
146
+ *
147
+ * In a table below, passing `overlapColumn = 3`
148
+ *
149
+ * 0 1 2 3 4
150
+ * ┌───────┬───────┬───┐
151
+ * │ a │ b │ c │
152
+ * │───┬───┴───────┼───┤
153
+ * │ d │ e │ f │
154
+ * ├───┼───┬───────┴───┤
155
+ * │ g │ h │ i │
156
+ * ├───┼───┼───┬───────┤
157
+ * │ j │ k │ l │ m │
158
+ * ├───┼───┴───┼───┬───┤
159
+ * │ n │ o │ p │ q │
160
+ * └───┴───────┴───┴───┘
161
+ * ^
162
+ * Overlap column to check
163
+ *
164
+ * will return slot info for cells: "b", "e", "i".
165
+ *
166
+ * @param table The table to check.
167
+ * @param overlapColumn The index of the column to check.
168
+ */
169
+ export function getHorizontallyOverlappingCells(table, overlapColumn) {
170
+ const cellsToSplit = [];
171
+ const tableWalker = new TableWalker(table);
172
+ for (const slotInfo of tableWalker) {
173
+ const { column, cellWidth } = slotInfo;
174
+ const cellEndColumn = column + cellWidth - 1;
175
+ if (column < overlapColumn && overlapColumn <= cellEndColumn) {
176
+ cellsToSplit.push(slotInfo);
177
+ }
178
+ }
179
+ return cellsToSplit;
180
+ }
181
+ /**
182
+ * Splits the table cell vertically.
183
+ *
184
+ * @param columnIndex The table cell column index.
185
+ * @param splitColumn The index of column to split cell on.
186
+ * @returns Created table cell.
187
+ */
188
+ export function splitVertically(tableCell, columnIndex, splitColumn, writer) {
189
+ const colspan = parseInt(tableCell.getAttribute('colspan'));
190
+ const newColspan = splitColumn - columnIndex;
191
+ const newCellAttributes = {};
192
+ const newCellColSpan = colspan - newColspan;
193
+ if (newCellColSpan > 1) {
194
+ newCellAttributes.colspan = newCellColSpan;
195
+ }
196
+ const rowspan = parseInt(tableCell.getAttribute('rowspan') || '1');
197
+ if (rowspan > 1) {
198
+ newCellAttributes.rowspan = rowspan;
199
+ }
200
+ const newCell = createEmptyTableCell(writer, writer.createPositionAfter(tableCell), newCellAttributes);
201
+ // Update the colspan attribute after updating table.
202
+ updateNumericAttribute('colspan', newColspan, tableCell, writer);
203
+ return newCell;
204
+ }
205
+ /**
206
+ * Adjusts table cell dimensions to not exceed limit row and column.
207
+ *
208
+ * If table cell width (or height) covers a column (or row) that is after a limit column (or row)
209
+ * this method will trim "colspan" (or "rowspan") attribute so the table cell will fit in a defined limits.
210
+ */
211
+ export function trimTableCellIfNeeded(tableCell, cellRow, cellColumn, limitRow, limitColumn, writer) {
212
+ const colspan = parseInt(tableCell.getAttribute('colspan') || '1');
213
+ const rowspan = parseInt(tableCell.getAttribute('rowspan') || '1');
214
+ const endColumn = cellColumn + colspan - 1;
215
+ if (endColumn > limitColumn) {
216
+ const trimmedSpan = limitColumn - cellColumn + 1;
217
+ updateNumericAttribute('colspan', trimmedSpan, tableCell, writer, 1);
218
+ }
219
+ const endRow = cellRow + rowspan - 1;
220
+ if (endRow > limitRow) {
221
+ const trimmedSpan = limitRow - cellRow + 1;
222
+ updateNumericAttribute('rowspan', trimmedSpan, tableCell, writer, 1);
223
+ }
224
+ }
225
+ /**
226
+ * Sets proper heading attributes to a cropped table.
227
+ */
228
+ function addHeadingsToCroppedTable(croppedTable, sourceTable, startRow, startColumn, writer) {
229
+ const headingRows = parseInt(sourceTable.getAttribute('headingRows') || '0');
230
+ if (headingRows > 0) {
231
+ const headingRowsInCrop = headingRows - startRow;
232
+ updateNumericAttribute('headingRows', headingRowsInCrop, croppedTable, writer, 0);
233
+ }
234
+ const headingColumns = parseInt(sourceTable.getAttribute('headingColumns') || '0');
235
+ if (headingColumns > 0) {
236
+ const headingColumnsInCrop = headingColumns - startColumn;
237
+ updateNumericAttribute('headingColumns', headingColumnsInCrop, croppedTable, writer, 0);
238
+ }
239
+ }
240
+ /**
241
+ * Removes columns that have no cells anchored.
242
+ *
243
+ * In table below:
244
+ *
245
+ * +----+----+----+----+----+----+----+
246
+ * | 00 | 01 | 03 | 04 | 06 |
247
+ * +----+----+----+----+ +----+
248
+ * | 10 | 11 | 13 | | 16 |
249
+ * +----+----+----+----+----+----+----+
250
+ * | 20 | 21 | 23 | 24 | 26 |
251
+ * +----+----+----+----+----+----+----+
252
+ * ^--- empty ---^
253
+ *
254
+ * Will remove columns 2 and 5.
255
+ *
256
+ * **Note:** This is a low-level helper method for clearing invalid model state when doing table modifications.
257
+ * To remove a column from a table use {@link module:table/tableutils~TableUtils#removeColumns `TableUtils.removeColumns()`}.
258
+ *
259
+ * @internal
260
+ * @returns True if removed some columns.
261
+ */
262
+ export function removeEmptyColumns(table, tableUtils) {
263
+ const width = tableUtils.getColumns(table);
264
+ const columnsMap = new Array(width).fill(0);
265
+ for (const { column } of new TableWalker(table)) {
266
+ columnsMap[column]++;
267
+ }
268
+ const emptyColumns = columnsMap.reduce((result, cellsCount, column) => {
269
+ return cellsCount ? result : [...result, column];
270
+ }, []);
271
+ if (emptyColumns.length > 0) {
272
+ // Remove only last empty column because it will recurrently trigger removing empty rows.
273
+ const emptyColumn = emptyColumns[emptyColumns.length - 1];
274
+ // @if CK_DEBUG_TABLE // console.log( `Removing empty column: ${ emptyColumn }.` );
275
+ tableUtils.removeColumns(table, { at: emptyColumn });
276
+ return true;
277
+ }
278
+ return false;
279
+ }
280
+ /**
281
+ * Removes rows that have no cells anchored.
282
+ *
283
+ * In table below:
284
+ *
285
+ * +----+----+----+
286
+ * | 00 | 01 | 02 |
287
+ * +----+----+----+
288
+ * | 10 | 11 | 12 |
289
+ * + + + +
290
+ * | | | | <-- empty
291
+ * +----+----+----+
292
+ * | 30 | 31 | 32 |
293
+ * +----+----+----+
294
+ * | 40 | 42 |
295
+ * + + +
296
+ * | | | <-- empty
297
+ * +----+----+----+
298
+ * | 60 | 61 | 62 |
299
+ * +----+----+----+
300
+ *
301
+ * Will remove rows 2 and 5.
302
+ *
303
+ * **Note:** This is a low-level helper method for clearing invalid model state when doing table modifications.
304
+ * To remove a row from a table use {@link module:table/tableutils~TableUtils#removeRows `TableUtils.removeRows()`}.
305
+ *
306
+ * @internal
307
+ * @returns True if removed some rows.
308
+ */
309
+ export function removeEmptyRows(table, tableUtils) {
310
+ const emptyRows = [];
311
+ const tableRowCount = tableUtils.getRows(table);
312
+ for (let rowIndex = 0; rowIndex < tableRowCount; rowIndex++) {
313
+ const tableRow = table.getChild(rowIndex);
314
+ if (tableRow.isEmpty) {
315
+ emptyRows.push(rowIndex);
316
+ }
317
+ }
318
+ if (emptyRows.length > 0) {
319
+ // Remove only last empty row because it will recurrently trigger removing empty columns.
320
+ const emptyRow = emptyRows[emptyRows.length - 1];
321
+ // @if CK_DEBUG_TABLE // console.log( `Removing empty row: ${ emptyRow }.` );
322
+ tableUtils.removeRows(table, { at: emptyRow });
323
+ return true;
324
+ }
325
+ return false;
326
+ }
327
+ /**
328
+ * Removes rows and columns that have no cells anchored.
329
+ *
330
+ * In table below:
331
+ *
332
+ * +----+----+----+----+
333
+ * | 00 | 02 |
334
+ * +----+----+ +
335
+ * | 10 | |
336
+ * +----+----+----+----+
337
+ * | 20 | 22 | 23 |
338
+ * + + + +
339
+ * | | | | <-- empty row
340
+ * +----+----+----+----+
341
+ * ^--- empty column
342
+ *
343
+ * Will remove row 3 and column 1.
344
+ *
345
+ * **Note:** This is a low-level helper method for clearing invalid model state when doing table modifications.
346
+ * To remove a rows from a table use {@link module:table/tableutils~TableUtils#removeRows `TableUtils.removeRows()`} and
347
+ * {@link module:table/tableutils~TableUtils#removeColumns `TableUtils.removeColumns()`} to remove a column.
348
+ *
349
+ * @internal
350
+ */
351
+ export function removeEmptyRowsColumns(table, tableUtils) {
352
+ const removedColumns = removeEmptyColumns(table, tableUtils);
353
+ // If there was some columns removed then cleaning empty rows was already triggered.
354
+ if (!removedColumns) {
355
+ removeEmptyRows(table, tableUtils);
356
+ }
357
+ }
358
+ /**
359
+ * Returns adjusted last row index if selection covers part of a row with empty slots (spanned by other cells).
360
+ * The `dimensions.lastRow` is equal to last row index but selection might be bigger.
361
+ *
362
+ * This happens *only* on rectangular selection so we analyze a case like this:
363
+ *
364
+ * +---+---+---+---+
365
+ * 0 | a | b | c | d |
366
+ * + + +---+---+
367
+ * 1 | | e | f | g |
368
+ * + +---+ +---+
369
+ * 2 | | h | | i | <- last row, each cell has rowspan = 2,
370
+ * + + + + + so we need to return 3, not 2
371
+ * 3 | | | | |
372
+ * +---+---+---+---+
373
+ *
374
+ * @returns Adjusted last row index.
375
+ */
376
+ export function adjustLastRowIndex(table, dimensions) {
377
+ const lastRowMap = Array.from(new TableWalker(table, {
378
+ startColumn: dimensions.firstColumn,
379
+ endColumn: dimensions.lastColumn,
380
+ row: dimensions.lastRow
381
+ }));
382
+ const everyCellHasSingleRowspan = lastRowMap.every(({ cellHeight }) => cellHeight === 1);
383
+ // It is a "flat" row, so the last row index is OK.
384
+ if (everyCellHasSingleRowspan) {
385
+ return dimensions.lastRow;
386
+ }
387
+ // Otherwise get any cell's rowspan and adjust the last row index.
388
+ const rowspanAdjustment = lastRowMap[0].cellHeight - 1;
389
+ return dimensions.lastRow + rowspanAdjustment;
390
+ }
391
+ /**
392
+ * Returns adjusted last column index if selection covers part of a column with empty slots (spanned by other cells).
393
+ * The `dimensions.lastColumn` is equal to last column index but selection might be bigger.
394
+ *
395
+ * This happens *only* on rectangular selection so we analyze a case like this:
396
+ *
397
+ * 0 1 2 3
398
+ * +---+---+---+---+
399
+ * | a |
400
+ * +---+---+---+---+
401
+ * | b | c | d |
402
+ * +---+---+---+---+
403
+ * | e | f |
404
+ * +---+---+---+---+
405
+ * | g | h |
406
+ * +---+---+---+---+
407
+ * ^
408
+ * last column, each cell has colspan = 2, so we need to return 3, not 2
409
+ *
410
+ * @returns Adjusted last column index.
411
+ */
412
+ export function adjustLastColumnIndex(table, dimensions) {
413
+ const lastColumnMap = Array.from(new TableWalker(table, {
414
+ startRow: dimensions.firstRow,
415
+ endRow: dimensions.lastRow,
416
+ column: dimensions.lastColumn
417
+ }));
418
+ const everyCellHasSingleColspan = lastColumnMap.every(({ cellWidth }) => cellWidth === 1);
419
+ // It is a "flat" column, so the last column index is OK.
420
+ if (everyCellHasSingleColspan) {
421
+ return dimensions.lastColumn;
422
+ }
423
+ // Otherwise get any cell's colspan and adjust the last column index.
424
+ const colspanAdjustment = lastColumnMap[0].cellWidth - 1;
425
+ return dimensions.lastColumn + colspanAdjustment;
426
+ }