CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Module

table/utils/common

@ckeditor/ckeditor5-table/src/utils/common

module

Filtering

Functions

  • createEmptyTableCell( writer, insertPosition, attributes ) → Element

    See source

    A 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 : Writer

    The model writer.

    insertPosition : Position

    The position at which the table cell should be inserted.

    attributes : Record<string, unknown>

    The element attributes.

    Defaults to {}

    Returns

    Element

    Created table cell.

  • enableProperty( schema, conversion, options = { options.defaultValue, options.modelAttribute, [options.reduceBoxSides], options.styleName } ) → void

    See source

    Enables conversion for an attribute for simple view-model mappings.

    Parameters

    schema : Schema
    conversion : Conversion
    options : object
    Properties
    options.defaultValue : string

    The default value for the specified modelAttribute.

    options.modelAttribute : string
    [ options.reduceBoxSides ] : boolean
    options.styleName : string

    Returns

    void

  • getSelectionAffectedTable( selection ) → Element

    See source

    Depending 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

    Element

  • isHeadingColumnCell( tableUtils, tableCell ) → boolean

    See source

    Checks if a table cell belongs to the heading column section.

    Parameters

    tableUtils : TableUtils
    tableCell : Element

    Returns

    boolean

  • updateNumericAttribute( key, value, item, writer, defaultValue ) → void

    See source

    A common method to update the numeric value. If a value is the default one, it will be unset.

    Parameters

    key : string

    An attribute key.

    value : unknown

    The new attribute value.

    item : Item

    A model item on which the attribute will be set.

    writer : Writer
    defaultValue : unknown

    The default attribute value. If a value is lower or equal, it will be unset.

    Defaults to 1

    Returns

    void