table/utils/common
@ckeditor/ckeditor5-table/src/utils/common
Filtering
Functions
-
createEmptyTableCell( writer, insertPosition, attributes ) → Elementmodule:table/utils/common~createEmptyTableCellA common method to create an empty table cell. It creates a proper model structure as a table cell must have at least one block inside.
Parameters
writer : WriterThe model writer.
insertPosition : PositionThe position at which the table cell should be inserted.
attributes : Record<string, unknown>The element attributes.
Defaults to
{}
Returns
ElementCreated table cell.
-
enableProperty( schema, conversion, options = { options.defaultValue, options.modelAttribute, [options.reduceBoxSides], options.styleName } ) → voidmodule:table/utils/common~enablePropertyEnables conversion for an attribute for simple view-model mappings.
Parameters
schema : Schemaconversion : Conversionoptions : object-
Properties
options.defaultValue : stringThe default value for the specified
modelAttribute.options.modelAttribute : string[ options.reduceBoxSides ] : booleanoptions.styleName : string
Returns
void
-
getSelectionAffectedTable( selection ) → Elementmodule:table/utils/common~getSelectionAffectedTableDepending on the position of the selection we either return the table under cursor or look for the table higher in the hierarchy.
Parameters
selection : DocumentSelection
Returns
-
isHeadingColumnCell( tableUtils, tableCell ) → booleanmodule:table/utils/common~isHeadingColumnCellChecks if a table cell belongs to the heading column section.
Parameters
tableUtils : TableUtilstableCell : Element
Returns
boolean
-
updateNumericAttribute( key, value, item, writer, defaultValue ) → voidmodule:table/utils/common~updateNumericAttributeA common method to update the numeric value. If a value is the default one, it will be unset.
Parameters
key : stringAn attribute key.
value : unknownThe new attribute value.
item : ItemA model item on which the attribute will be set.
writer : WriterdefaultValue : unknownThe default attribute value. If a value is lower or equal, it will be unset.
Defaults to
1
Returns
void
Every day, we work hard to keep our documentation complete. Have you spotted outdated information? Is something missing? Please report it via our issue tracker.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.