CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

DowncastConversionApi (engine/conversion)

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

interface
See source

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.

    See source

  • dispatcher : DowncastDispatcher

    The DowncastDispatcher instance.

    See source

  • mapper : Mapper

    The Mapper instance.

    See source

  • options : Object

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

    See source

  • schema : Schema

    The Schema instance set for the model that is downcast.

    See source

  • writer : DowncastWriter

    The DowncastWriter instance used to manipulate the data during conversion.

    See source

Methods

  • convertAttributes( item )

    Triggers conversion of attributes of a specified item.

    See source

    Parameters

    item : Item

    The model item to trigger attribute conversion on.

  • convertChildren( element )

    Triggers conversion of children of a specified element.

    See source

    Parameters

    element : Element

    The model element to trigger children insert conversion on.

  • convertItem( item )

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

    See source

    Parameters

    item : Item

    The model item to trigger nested insert conversion on.