image/image/utils
Functions
-
createBlockImageViewElement( writer ) → ViewContainerElement
internalmodule:image/image/utils~createBlockImageViewElement
Creates a view element representing the block image.
<figure class="image"><img></img></figure>
Note that
alt
andsrc
attributes are converted separately, so they are not included.Parameters
writer : ViewDowncastWriter
Returns
-
createInlineImageViewElement( writer ) → ViewContainerElement
internalmodule:image/image/utils~createInlineImageViewElement
Creates a view element representing the inline image.
<span class="image-inline"><img></img></span>
Note that
alt
andsrc
attributes are converted separately, so they are not included.Parameters
writer : ViewDowncastWriter
Returns
-
determineImageTypeForInsertionAtSelection( schema, selection ) → 'imageBlock' | 'imageInline'
internalmodule:image/image/utils~determineImageTypeForInsertionAtSelection
Considering the current model selection, it returns the name of the model image element (
'imageBlock'
or'imageInline'
) that will make most sense from the UX perspective if a new image was inserted (also: uploaded, dropped, pasted) at that selection.The assumption is that inserting images into empty blocks or on other block widgets should produce block images. Inline images should be inserted in other cases, e.g. in paragraphs that already contain some text.
Parameters
schema : ModelSchema
selection : ModelSelection | ModelDocumentSelection
Returns
'imageBlock' | 'imageInline'
-
getImgViewElementMatcher( editor, matchImageType ) → MatcherPattern
internalmodule:image/image/utils~getImgViewElementMatcher
A function returning a
MatcherPattern
for a particular type of View images.Parameters
editor : Editor
matchImageType : 'imageBlock' | 'imageInline'
The type of created image.
Returns
-
getSizeValueIfInPx( size ) → null | number
internalmodule:image/image/utils~getSizeValueIfInPx
Returns parsed value of the size, but only if it contains unit: px.
Parameters
size : undefined | string
Returns
null | number
-
widthAndHeightStylesAreBothSet( viewElement ) → boolean
internalmodule:image/image/utils~widthAndHeightStylesAreBothSet
Returns true if both styles (width and height) are set.
If both image styles: width & height are set, they will override the image width & height attributes in the browser. In this case, the image looks the same as if these styles were applied to attributes instead of styles. That's why we can upcast these styles to width & height attributes instead of resizedWidth and resizedHeight.
Parameters
viewElement : ViewElement
Returns
boolean