table/tablecaption/utils

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

Functions

• getCaptionFromModelSelection( selection ) → Element | nullmodule:table/tablecaption/utils~getCaptionFromModelSelection

  See source

  Returns the caption model element for a model selection. Returns null if the selection has no caption element ancestor.

  Parameters

  selection : DocumentSelection

  The selection checked for caption presence.

  Returns

  Element | null

• getCaptionFromTableModelElement( tableModelElement ) → Element | nullmodule:table/tablecaption/utils~getCaptionFromTableModelElement

  See source

  Returns the caption model element from a given table element. Returns null if no caption is found.

  Parameters

  tableModelElement : Element

  Table element in which we will try to find a caption element.

  Returns

  Element | null

• getSelectionAffectedTable( selection ) → Elementmodule:table/tablecaption/utils~getSelectionAffectedTable

  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

• isTable( modelElement ) → booleanmodule:table/tablecaption/utils~isTable

  See source

  Checks if the provided model element is a table.

  Parameters

  modelElement : null | Element | DocumentFragment

  Element to check if it is a table.

  Returns

  boolean

• matchTableCaptionViewElement( element ) → object | nullmodule:table/tablecaption/utils~matchTableCaptionViewElement

  See source

  Matcher pattern. Checks if a given element is a caption.

  There are two possible forms of the valid caption:

  • A <figcaption> element inside a <figure class="table"> element.
  • A <caption> inside a .

    Parameters

    element : Element

    Returns

    object | null

    Returns the object accepted by Matcher or null if the element cannot be matched.

    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.