Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 77x 146x 146x 146x 146x 146x 146x 146x 334x 334x 2x 2x 332x 334x 334x 334x 77x 1x 242x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 12x 462x 77x 146x 334x 334x 326x 326x 326x 1304x 1304x 334x 333x 333x 333x 333x 334x 59x 334x 1x 77x 77x 146x 334x 334x 146x 77x 146x 6x 6x 6x 6x 6x 6x 4x 146x 63x 63x 63x 63x 63x 30x 4x 12x 10x 77x 54x 23x 23x 23x 43x 43x 43x 43x 43x 43x 43x 43x 43x 43x 6x 6x 6x 133x 133x 133x 133x 1437x | import { BorderKeys } from '../../formatHandlers/utils/borderKeys';
import { combineBorderValue, extractBorderValues } from '../../domUtils/style/borderValues';
import { mutateBlock, mutateSegment } from '../common/mutate';
import { setTableCellBackgroundColor } from './setTableCellBackgroundColor';
import { TableBorderFormat } from '../../constants/TableBorderFormat';
import { updateTableCellMetadata } from '../metadata/updateTableCellMetadata';
import { updateTableMetadata } from '../metadata/updateTableMetadata';
import type {
BorderFormat,
ReadonlyContentModelTable,
ShallowMutableContentModelTableRow,
TableMetadataFormat,
} from 'roosterjs-content-model-types';
const DEFAULT_FORMAT: TableMetadataFormat = {
topBorderColor: '#ABABAB',
bottomBorderColor: '#ABABAB',
verticalBorderColor: '#ABABAB',
hasHeaderRow: false,
hasFirstColumn: false,
hasBandedRows: false,
hasBandedColumns: false,
bgColorEven: null,
bgColorOdd: '#ABABAB20',
headerRowColor: '#ABABAB',
tableBorderFormat: TableBorderFormat.Default,
verticalAlign: null,
};
type MetaOverrides = {
bgColorOverrides: boolean[][];
vAlignOverrides: boolean[][];
borderOverrides: boolean[][];
};
/**
* Apply table format from table metadata and the passed in new format
* @param table The table to apply format to
* @param newFormat @optional New format to apply. When passed, this value will be merged into existing metadata format and default format
* @param keepCellShade @optional When pass true, table cells with customized shade color will not be overwritten. @default false
*/
export function applyTableFormat(
table: ReadonlyContentModelTable,
newFormat?: TableMetadataFormat,
keepCellShade?: boolean
) {
const mutableTable = mutateBlock(table);
const { rows } = mutableTable;
updateTableMetadata(mutableTable, format => {
const effectiveMetadata: TableMetadataFormat = {
...DEFAULT_FORMAT,
...format,
...newFormat,
};
const metaOverrides: MetaOverrides = updateOverrides(rows, !keepCellShade);
formatCells(rows, effectiveMetadata, metaOverrides);
setFirstColumnFormatBorders(rows, effectiveMetadata);
setHeaderRowFormat(rows, effectiveMetadata, metaOverrides);
return effectiveMetadata;
});
}
function updateOverrides(
rows: ShallowMutableContentModelTableRow[],
removeCellShade: boolean
): MetaOverrides {
const overrides: MetaOverrides = {
bgColorOverrides: [],
vAlignOverrides: [],
borderOverrides: [],
};
rows.forEach(row => {
const bgColorOverrides: boolean[] = [];
const vAlignOverrides: boolean[] = [];
const borderOverrides: boolean[] = [];
overrides.bgColorOverrides.push(bgColorOverrides);
overrides.vAlignOverrides.push(vAlignOverrides);
overrides.borderOverrides.push(borderOverrides);
row.cells.forEach(cell => {
updateTableCellMetadata(mutateBlock(cell), metadata => {
if (metadata && removeCellShade) {
bgColorOverrides.push(false);
delete metadata.bgColorOverride;
} else {
bgColorOverrides.push(!!metadata?.bgColorOverride);
}
vAlignOverrides.push(!!metadata?.vAlignOverride);
borderOverrides.push(!!metadata?.borderOverride);
return metadata;
});
});
});
return overrides;
}
type ShouldUseTransparentBorder = (indexProp: {
firstRow: boolean;
lastRow: boolean;
firstColumn: boolean;
lastColumn: boolean;
}) => [boolean, boolean, boolean, boolean];
const BorderFormatters: Record<number, ShouldUseTransparentBorder | undefined> = {
[TableBorderFormat.Default]: _ => [false, false, false, false],
[TableBorderFormat.ListWithSideBorders]: ({ lastColumn, firstColumn }) => [
false,
!lastColumn,
false,
!firstColumn,
],
[TableBorderFormat.FirstColumnHeaderExternal]: ({
firstColumn,
firstRow,
lastColumn,
lastRow,
}) => [
!firstRow,
(!lastColumn && !firstColumn) || (firstColumn && firstRow),
!lastRow && !firstRow,
!firstColumn,
],
[TableBorderFormat.NoHeaderBorders]: ({ firstRow, firstColumn, lastColumn }) => [
firstRow,
firstRow || lastColumn,
false,
firstRow || firstColumn,
],
[TableBorderFormat.NoSideBorders]: ({ firstColumn, lastColumn }) => [
false,
lastColumn,
false,
firstColumn,
],
[TableBorderFormat.EspecialType1]: ({ firstRow, firstColumn }) => [
firstColumn && !firstRow,
firstRow,
firstColumn && !firstRow,
firstRow && !firstColumn,
],
[TableBorderFormat.EspecialType2]: ({ firstRow, firstColumn }) => [
!firstRow,
firstRow || !firstColumn,
!firstRow,
!firstColumn,
],
[TableBorderFormat.EspecialType3]: ({ firstColumn, firstRow }) => [
true,
firstRow || !firstColumn,
!firstRow,
true,
],
[TableBorderFormat.Clear]: () => [true, true, true, true],
};
/*
* Apply vertical align, borders, and background color to all cells in the table
*/
function formatCells(
rows: ShallowMutableContentModelTableRow[],
format: TableMetadataFormat,
metaOverrides: MetaOverrides
) {
const {
hasBandedRows,
hasBandedColumns,
bgColorOdd,
bgColorEven,
hasFirstColumn,
hasHeaderRow,
} = format;
rows.forEach((row, rowIndex) => {
row.cells.forEach((readonlyCell, colIndex) => {
const cell = mutateBlock(readonlyCell);
// Format Borders
if (
!metaOverrides.borderOverrides[rowIndex][colIndex] &&
typeof format.tableBorderFormat == 'number'
) {
const transparentBorderMatrix = BorderFormatters[format.tableBorderFormat]?.({
firstRow: rowIndex === 0,
lastRow: rowIndex === rows.length - 1,
firstColumn: colIndex === 0,
lastColumn: colIndex === row.cells.length - 1,
});
const formatColor = [
format.topBorderColor,
format.verticalBorderColor,
format.bottomBorderColor,
format.verticalBorderColor,
];
transparentBorderMatrix?.forEach((alwaysUseTransparent, i) => {
const borderColor = (!alwaysUseTransparent && formatColor[i]) || '';
cell.format[BorderKeys[i]] = combineBorderValue({
style: getBorderStyleFromColor(borderColor),
width: '1px',
color: borderColor,
});
});
}
// Format Background Color
if (!metaOverrides.bgColorOverrides[rowIndex][colIndex]) {
const bandedColumnMod = hasFirstColumn ? 0 : 1;
const bandedRowMod = hasHeaderRow ? 0 : 1;
const color =
hasBandedRows || hasBandedColumns
? (hasBandedColumns && colIndex % 2 != bandedColumnMod) ||
(hasBandedRows && rowIndex % 2 != bandedRowMod)
? bgColorOdd
: bgColorEven
: bgColorEven; /* bgColorEven is the default color */
setTableCellBackgroundColor(
cell,
color,
false /*isColorOverride*/,
true /*applyToSegments*/
);
}
// Format Vertical Align
if (format.verticalAlign && !metaOverrides.vAlignOverrides[rowIndex][colIndex]) {
cell.format.verticalAlign = format.verticalAlign;
}
// Format Header
cell.isHeader = false;
});
});
}
/**
* Set the first column format borders for the table as well as header property
* @param rows The rows of the table
* @param format The table metadata format
*/
export function setFirstColumnFormatBorders(
rows: ShallowMutableContentModelTableRow[],
format: Partial<TableMetadataFormat>
) {
const customStyles = format.hasFirstColumn ? format.firstColumnCustomStyles : undefined;
rows.forEach((row, rowIndex) => {
row.cells.forEach((readonlyCell, cellIndex) => {
const cell = mutateBlock(readonlyCell);
if (cellIndex === 0) {
if (rowIndex == 0) {
cell.isHeader = !!format.hasHeaderRow;
}
if (format.hasFirstColumn && customStyles) {
setStyleIfDefined(cell.format, 'textAlign', customStyles.textAlign);
setBorderColorIfExists(cell.format, 'borderTop', customStyles.borderTopColor);
setBorderColorIfExists(
cell.format,
'borderRight',
customStyles.borderRightColor
);
setBorderColorIfExists(
cell.format,
'borderBottom',
customStyles.borderBottomColor
);
setBorderColorIfExists(cell.format, 'borderLeft', customStyles.borderLeftColor);
if (customStyles.backgroundColor) {
setTableCellBackgroundColor(
cell,
customStyles.backgroundColor,
false /*isColorOverride*/,
true /*applyToSegments*/
);
}
}
for (const block of cell.blocks) {
if (block.blockType == 'Paragraph') {
for (const segment of block.segments) {
mutateSegment(block, segment, cellSegment => {
Iif (format.hasFirstColumn) {
setStyleIfDefined(
cellSegment.format,
'fontWeight',
customStyles?.fontWeight ?? 'bold'
);
setStyleIfDefined(
cell.format,
'textAlign',
customStyles?.textAlign
);
setStyleIfDefined(
cell.format,
'fontWeight',
customStyles?.fontWeight ?? 'bold'
);
setStyleIfDefined(
cellSegment.format,
'italic',
customStyles?.italic
);
} else Iif (
cellSegment.format.fontWeight == 'bold' &&
cell.format.fontWeight == 'bold'
) {
delete cellSegment.format.fontWeight;
delete cell.format.fontWeight;
}
});
}
}
}
}
});
});
}
function setBorderColorIfExists(format: BorderFormat, key: keyof BorderFormat, value?: string) {
if (value !== undefined) {
setBorderColor(format, key, value);
}
}
function setStyleIfDefined<T, K extends keyof T>(format: T, key: K, value: T[K] | undefined) {
if (value !== undefined) {
format[key] = value;
}
}
function setHeaderRowFormat(
rows: ShallowMutableContentModelTableRow[],
format: TableMetadataFormat,
metaOverrides: MetaOverrides
) {
if (!format.hasHeaderRow) {
return;
}
const rowIndex = 0;
const customStyles = format.headerRowCustomStyles;
rows[rowIndex]?.cells.forEach((readonlyCell, cellIndex) => {
const cell = mutateBlock(readonlyCell);
cell.isHeader = true;
cell.format.fontWeight = customStyles?.fontWeight ?? 'bold';
Eif (format.headerRowColor) {
Eif (!metaOverrides.bgColorOverrides[rowIndex][cellIndex]) {
setTableCellBackgroundColor(
cell,
format.headerRowColor,
false /*isColorOverride*/,
true /*applyToSegments*/
);
}
setBorderColor(
cell.format,
'borderTop',
customStyles?.borderTopColor ?? format.headerRowColor
);
setBorderColor(
cell.format,
'borderRight',
customStyles?.borderRightColor ?? format.headerRowColor
);
setBorderColor(
cell.format,
'borderLeft',
customStyles?.borderLeftColor ?? format.headerRowColor
);
}
if (customStyles) {
setStyleIfDefined(cell.format, 'textAlign', customStyles.textAlign);
setBorderColorIfExists(cell.format, 'borderBottom', customStyles.borderBottomColor);
for (const block of cell.blocks) {
if (block.blockType == 'Paragraph') {
for (const segment of block.segments) {
mutateSegment(block, segment, cellSegment => {
if (customStyles.italic) {
cellSegment.format.italic = customStyles.italic;
} else if (cellSegment.format.italic) {
delete cellSegment.format.italic;
}
});
}
}
}
}
});
}
/**
* @param format The cell format to set the border color
* @param key The border key to set the color
* @param value The color to set. If not given, it removes the color and sets the style to transparent
*/
function setBorderColor(format: BorderFormat, key: keyof BorderFormat, value?: string) {
const border = extractBorderValues(format[key]);
border.color = value || '';
border.style = getBorderStyleFromColor(border.color);
format[key] = combineBorderValue(border);
}
function getBorderStyleFromColor(color?: string): string {
return !color || color == 'transparent' ? 'none' : 'solid';
}
|