table/utils

@ckeditor/ckeditor5-table/src/utils

Functions

• getSelectedTableCells( selection ) → Array.<Element>module:table/utils.getSelectedTableCells

  static

  Returns all model table cells that are fully selected (from the outside) within the provided model selection's ranges.

  See source

  To obtain the cells selected from the inside, use getTableCellsContainingSelection.

  Parameters

  selection : Selection

  Returns

  Array.<Element>

• getSelectedTableWidget( selection ) → Element | nullmodule:table/utils.getSelectedTableWidget

  static

  Returns a table widget editing view element if one is selected.

  See source

  Parameters

  selection : Selection | DocumentSelection

  Returns

  Element | null

• getSelectionAffectedTableCells( selection ) → Array.<Element>module:table/utils.getSelectionAffectedTableCells

  static

  Returns all model table cells that are either completely selected by selection ranges or host selection range start positions inside them.

  See source

  Combines getTableCellsContainingSelection and getSelectedTableCells.

  Parameters

  selection : Selection

  Returns

  Array.<Element>

• getTableCellsContainingSelection( selection ) → Array.<Element>module:table/utils.getTableCellsContainingSelection

  static

  Returns all model table cells that the provided model selection's ranges start inside.

  See source

  To obtain the cells selected from the outside, use getSelectedTableCells.

  Parameters

  selection : Selection

  Returns

  Array.<Element>

• getTableWidgetAncestor( selection ) → Element | nullmodule:table/utils.getTableWidgetAncestor

  static

  Returns a table widget editing view element if one is among the selection's ancestors.

  See source

  Parameters

  selection : Selection | DocumentSelection

  Returns

  Element | null

• isTableWidget( viewElement ) → Booleanmodule:table/utils.isTableWidget

  static

  Checks if a given view element is a table widget.

  See source

  Parameters

  viewElement : Element

  Returns

  Boolean

• toTableWidget( viewElement, writer, label ) → Elementmodule:table/utils.toTableWidget

  static

  Converts a given Element to a table widget:

  See source

  • Adds a custom property allowing to recognize the table widget element.
  • Calls the toWidget function with the proper element's label creator.

  Parameters

  viewElement : Element

  writer : DowncastWriter

  An instance of the view writer.

  label : String

  The element's label. It will be concatenated with the table alt attribute if one is present.

  Returns

  Element