DowncastConversionApi
Conversion interface that is registered for given DowncastDispatcher and is passed as one of parameters when dispatcher fires its events.
Properties
module:engine/conversion/downcastdispatcher~DowncastConversionApi#consumableStores 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.
module:engine/conversion/downcastdispatcher~DowncastConversionApi#dispatcherThe
DowncastDispatcherinstance.module:engine/conversion/downcastdispatcher~DowncastConversionApi#mapperThe
Mapperinstance.options : Record<string, unknown>module:engine/conversion/downcastdispatcher~DowncastConversionApi#optionsAn object with an additional configuration which can be used during the conversion process. Available only for data downcast conversion.
module:engine/conversion/downcastdispatcher~DowncastConversionApi#schemaThe
ModelSchemainstance set for the model that is downcast.module:engine/conversion/downcastdispatcher~DowncastConversionApi#writerThe
ViewDowncastWriterinstance used to manipulate the data during conversion.
Methods
canReuseView( element ) → booleanmodule:engine/conversion/downcastdispatcher~DowncastConversionApi#canReuseViewconvertAttributes( item ) → voidmodule:engine/conversion/downcastdispatcher~DowncastConversionApi#convertAttributesTriggers conversion of attributes of a specified item.
Parameters
item : ModelItemThe model item to trigger attribute conversion on.
Returns
void
convertChildren( element ) → voidmodule:engine/conversion/downcastdispatcher~DowncastConversionApi#convertChildrenTriggers conversion of children of a specified element.
Parameters
element : ModelElementThe model element to trigger children insert conversion on.
Returns
void
convertItem( item ) → voidmodule:engine/conversion/downcastdispatcher~DowncastConversionApi#convertItemTriggers conversion of a specified item. This conversion is triggered within (as a separate process of) the parent conversion.
Parameters
item : ModelItemThe model item to trigger nested insert conversion on.
Returns
void