Sign up (with export icon)

image/image/utils

Api-module icon module

Functions

  • Chevron-right icon

    Creates a view element representing the block image.

    <figure class="image"><img></img></figure>
    
    Copy code

    Note that alt and src attributes are converted separately, so they are not included.

    Parameters

    writer : ViewDowncastWriter

    Returns

    ViewContainerElement
  • Chevron-right icon

    Creates a view element representing the inline image.

    <span class="image-inline"><img></img></span>
    
    Copy code

    Note that alt and src attributes are converted separately, so they are not included.

    Parameters

    writer : ViewDowncastWriter

    Returns

    ViewContainerElement
  • Chevron-right icon

    determineImageTypeForInsertionAtSelection( schema, selection ) → 'imageBlock' | 'imageInline'
    internal

    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'
  • Chevron-right icon

    getImgViewElementMatcher( editor, matchImageType ) → MatcherPattern
    internal

    A function returning a MatcherPattern for a particular type of View images.

    Parameters

    editor : Editor
    matchImageType : 'imageBlock' | 'imageInline'

    The type of created image.

    Returns

    MatcherPattern
  • Chevron-right icon

    getSizeValueIfInPx( size ) → null | number
    internal

    Returns parsed value of the size, but only if it contains unit: px.

    Parameters

    size : undefined | string

    Returns

    null | number
  • Chevron-right icon

    widthAndHeightStylesAreBothSet( viewElement ) → boolean
    internal

    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