table/converters/downcast
Interfaces
module:table/converters/downcast~DowncastTableOptions
Functions
convertParagraphInTableCell( options = { [options.asWidget] } ) → DowncastElementCreatorFunctioninternalmodule:table/converters/downcast~convertParagraphInTableCellOverrides paragraph inside table cell conversion.
This converter:
- should be used to override default paragraph conversion.
- It will only convert
<paragraph>placed directly inside<tableCell>. - For a single paragraph without attributes it returns
<span>to simulate data table. - For all other cases it returns
<p>element.
Parameters
options : object- Properties
[ options.asWidget ] : booleanIf set to
true, the downcast conversion will produce a widget.
Defaults to
{}
Returns
DowncastElementCreatorFunctionElement creator.
convertPlainTable( editor ) → DowncastElementCreatorFunctionmodule:table/converters/downcast~convertPlainTablemodule:table/converters/downcast~convertPlainTableCaptionDowncasts a plain table caption (also used in the clipboard pipeline).
Parameters
editor : Editor
Returns
downcastCell( options = { [options.asWidget], options.cellTypeEnabled } ) → DowncastElementCreatorFunctioninternalmodule:table/converters/downcast~downcastCellModel table cell element to view
<td>or<th>element conversion helper.This conversion helper will create proper
<th>elements for table cells that are in the heading section (heading row or column) and<td>otherwise.Parameters
options : object- Properties
[ options.asWidget ] : booleanIf set to
true, the downcast conversion will produce a widget.options.cellTypeEnabled : () => booleanIf returns
true, the downcast conversion will use thetableCellTypeattribute to determine cell type.
Returns
DowncastElementCreatorFunctionElement creator.
downcastPlainTable( table, conversionApi, editor ) → ViewElementmodule:table/converters/downcast~downcastPlainTableDowncasts a plain table.
Parameters
table : ModelElementTable model element.
conversionApi : DowncastConversionApiThe conversion API object.
editor : EditorThe editor instance.
Returns
ViewElementCreated element.
downcastRow() → DowncastElementCreatorFunctioninternalmodule:table/converters/downcast~downcastRowModel table row element to view
<tr>element conversion helper.Returns
DowncastElementCreatorFunctionElement creator.
downcastTable( tableUtils, options ) → DowncastElementCreatorFunctioninternalmodule:table/converters/downcast~downcastTableModel table element to view table element conversion helper.
Parameters
tableUtils : TableUtilsoptions : DowncastTableOptions
Returns
downcastTableBorderAndBackgroundAttributes( editor ) → voidmodule:table/converters/downcast~downcastTableBorderAndBackgroundAttributesRegisters border and background attributes converters for plain tables or when the clipboard pipeline is used.
Parameters
editor : Editor
Returns
void
isSingleParagraphWithoutAttributes( modelElement ) → booleaninternalmodule:table/converters/downcast~isSingleParagraphWithoutAttributesChecks if given model
<paragraph>is an only child of a parent (<tableCell>) and if it has any attribute set.The paragraph should be converted in the editing view to:
- If returned
true- to a<span class="ck-table-bogus-paragraph"> - If returned
false- to a<p>
Parameters
modelElement : ModelElement
Returns
boolean
- If returned