CKEditor Ecosystem Documentation
Search
Report an issue
Home/CKEditor 5/API
Class

ImageLoadObserver (image/image)

@ckeditor/ckeditor5-image/src/image/imageloadobserver

class

Observes all new images added to the Document, fires event-imageLoaded and event-layoutChanged event every time when the new image has been loaded.

Note: This event is not fired for images that has been added to the document and rendered as complete (already loaded).

Filtering

Properties

  • document : Document

    readonly inherited

    Reference to the Document object.

  • isEnabled : Boolean

    readonly inherited

    State of the observer. If it is disabled events will not be fired.

  • view : View

    readonly inherited

    Instance of the view controller.

  • _observedElements : Set.<HTMLElement>

    private

    List of img DOM elements that are observed by this observer.

Methods

  • constructor( view )

    inherited

    Creates an instance of the observer.

    Parameters

    view : View
    Overrides: Observer#constructor

  • destroy()

    inherited

    Disables and destroys the observer, among others removes event listeners created by the observer.

    Overrides: Observer#destroy

  • disable()

    inherited

    Disables the observer. This method is called before rendering to prevent firing events during rendering.

  • enable()

    inherited

    Enables the observer. This method is called when the observer is registered to the View and after rendering (all observers are disabled before rendering).

    A typical use case for disabling observers is that mutation observers need to be disabled for the rendering. However, a child class may not need to be disabled, so it can implement an empty method.

  • observe( domElement, name )

    inherited

    Starts observing the given root element.

    Parameters

    domElement : HTMLElement
    name : String

    The name of the root element.

    Overrides: Observer#observe

  • _fireEvents( domEvent )

    protected

    Fires event-layoutChanged and event-imageLoaded if observer is enabled.

    Parameters

    domEvent : Event

    The DOM event.

  • _updateObservedElements( domRoot, viewNode )

    private

    Updates the list of observed <img/> elements.

    Parameters

    domRoot : HTMLElement

    DOM root element.

    viewNode : Element

    View element where children have changed.