CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

LiveRange (engine/model)

@ckeditor/ckeditor5-engine/src/model/liverange

class
See source

LiveRange is a type of Range that updates itself as document is changed through operations. It may be used as a bookmark.

Note: Be very careful when dealing with LiveRange. Each LiveRange instance bind events that might have to be unbound. Use detach whenever you don't need LiveRange anymore.

Filtering

Methods

  • constructor()

    Creates a live range.

    See source

    Related:

  • detach()

    Unbinds all events previously bound by LiveRange. Use it whenever you don't need LiveRange instance anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was referring to it).

    See source

  • is( type ) → Boolean

    Checks whether this object is of the given.

    See source
    liveRange.is( 'range' ); // -> true
liveRange.is( 'model:range' ); // -> true
liveRange.is( 'liveRange' ); // -> true
liveRange.is( 'model:liveRange' ); // -> true

liveRange.is( 'view:range' ); // -> false
liveRange.is( 'documentSelection' ); // -> false

    Check the entire list of model objects which implement the is() method.

    Parameters

    type : String

    Returns

    Boolean

  • toRange() → Range

    Creates a range instance that is equal to this live range.

    See source

    Returns

    Range

Static methods

Events

  • change:content( eventInfo, range, data = { data.deletionPosition } )

    Fired when LiveRange instance boundaries have not changed after a change in document but the change took place inside the range, effectively changing its content.

    See source

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    range : Range

    Range with start and end position equal to start and end position of change range.

    data : Object

    Object with additional information about the change.

    Properties
    data.deletionPosition : null

    Due to the nature of this event, this property is always set to null. It is passed for compatibility with the event-change:range event.

  • change:range( eventInfo, oldRange, data = { data.deletionPosition } )

    Fired when LiveRange instance boundaries have changed due to changes in the document.

    See source

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    oldRange : Range

    Range with start and end position equal to start and end position of this live range before it got changed.

    data : Object

    Object with additional information about the change.

    Properties
    data.deletionPosition : Position | null

    Source position for remove and merge changes. Available if the range was moved to the graveyard root, null otherwise.