image/image/converters
@ckeditor/ckeditor5-image/src/image/converters
Filtering
Functions
-
internal
downcastImageAttribute( imageUtils, imageType, attributeKey ) → ( DowncastDispatcher ) => void
module:image/image/converters~downcastImageAttribute
Converter used to convert a given image attribute from the model to the view.
Parameters
imageUtils : ImageUtils
imageType : 'imageBlock' | 'imageInline'
The type of the image.
attributeKey : string
The name of the attribute to convert.
Returns
( DowncastDispatcher ) => void
-
internal
downcastSourcesAttribute( imageUtils ) → ( DowncastDispatcher ) => void
module:image/image/converters~downcastSourcesAttribute
Converts the
source
model attribute to the<picture><source /><source />...<img /></picture>
view structure.Parameters
imageUtils : ImageUtils
Returns
( DowncastDispatcher ) => void
-
internal
downcastSrcsetAttribute( imageUtils, imageType ) → ( DowncastDispatcher ) => void
module:image/image/converters~downcastSrcsetAttribute
Converter used to convert the
srcset
model image attribute to thesrcset
andsizes
attributes in the view.Parameters
imageUtils : ImageUtils
imageType : 'imageBlock' | 'imageInline'
The type of the image.
Returns
( DowncastDispatcher ) => void
-
internal
upcastImageFigure( imageUtils ) → ( UpcastDispatcher ) => void
module:image/image/converters~upcastImageFigure
Returns a function that converts the image view representation:
<figure class="image"><img src="..." alt="..."></img></figure>
to the model representation:
<imageBlock src="..." alt="..."></imageBlock>
The entire content of the
<figure>
element except the first<img>
is being converted as children of the<imageBlock>
model element.Parameters
imageUtils : ImageUtils
Returns
( UpcastDispatcher ) => void
-
internal
upcastPicture( imageUtils ) → ( UpcastDispatcher ) => void
module:image/image/converters~upcastPicture
Returns a function that converts the image view representation:
<picture><source ... /><source ... />...<img ... /></picture>
to the model representation as the
sources
attribute:<image[Block|Inline] ... sources="..."></image[Block|Inline]>
Parameters
imageUtils : ImageUtils
Returns
( UpcastDispatcher ) => void
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.
With the release of version 42.0.0, we have rewritten much of our documentation to reflect the new import paths and features. We appreciate your feedback to help us ensure its accuracy and completeness.