Interface

DowncastConversionApi (engine/conversion)

@ckeditor/ckeditor5-engine/src/conversion/downcastdispatcher

interface

Conversion interface that is registered for given DowncastDispatcher and is passed as one of parameters when dispatcher fires its events.

Filtering

Properties

  • consumable : ModelConsumable

    Stores the information about what parts of a processed model item are still waiting to be handled. After a piece of a model item was converted, an appropriate consumable value should be consumed.

  • dispatcher : DowncastDispatcher

  • mapper : Mapper

    The Mapper instance.

  • options : Record<string, unknown>

    An object with an additional configuration which can be used during the conversion process. Available only for data downcast conversion.

  • schema : Schema

    The Schema instance set for the model that is downcast.

  • writer : DowncastWriter

    The DowncastWriter instance used to manipulate the data during conversion.

Methods

  • canReuseView( element ) → boolean

    Parameters

    element : Element

    Returns

    boolean
  • convertAttributes( item ) → void

    Triggers conversion of attributes of a specified item.

    Parameters

    item : Item

    The model item to trigger attribute conversion on.

    Returns

    void
  • convertChildren( element ) → void

    Triggers conversion of children of a specified element.

    Parameters

    element : Element

    The model element to trigger children insert conversion on.

    Returns

    void
  • convertItem( item ) → void

    Triggers conversion of a specified item. This conversion is triggered within (as a separate process of) the parent conversion.

    Parameters

    item : Item

    The model item to trigger nested insert conversion on.

    Returns

    void