Interface IObservableUndoableList<T>

An observable list that supports undo/redo.

Type Parameters

  • T

Hierarchy

Implemented by

Properties

canRedo: boolean

Whether the object can redo changes.

canUndo: boolean

Whether the object can undo changes.

A signal emitted when the list has changed.

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

length: number

The length of the list.

Notes

This is a read-only property.

type: "List"

The type of this object.

Methods

  • Returns Iterator<T, any, undefined>

  • Begin a compound operation.

    Parameters

    • Optional isUndoAble: boolean

      Whether the operation is undoable. The default is false.

    Returns void

  • Clear the change stack.

    Returns void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

  • End a compound operation.

    Returns void

  • Get the value at the specified index.

    Parameters

    • index: number

      The positive integer index of interest.

    Returns T

    The value at the specified index.

    Undefined Behavior

    An index which is non-integral or out of range.

  • Insert a value into the list at a specific index.

    Parameters

    • index: number

      The index at which to insert the value.

    • value: T

      The value to set at the specified index.

      Complexity

      Linear.

      Iterator Validity

      No changes.

      Notes

      The index will be clamped to the bounds of the list.

      Undefined Behavior

      An index which is non-integral.

    Returns void

  • Insert a set of items into the list at the specified index.

    Parameters

    • index: number

      The index at which to insert the values.

    • values: Iterable<T>

      The values to insert at the specified index.

      Complexity.

      Linear.

      Iterator Validity

      No changes.

      Notes

      The index will be clamped to the bounds of the list.

      Undefined Behavior.

      An index which is non-integral.

    Returns void

  • Move a value from one index to another.

    Parameters

    • fromIndex: number

      The index of the element to move.

    • toIndex: number

      The index to move the element to.

      Complexity

      Constant.

      Iterator Validity

      Iterators pointing at the lesser of the fromIndex and the toIndex and beyond are invalidated.

      Undefined Behavior

      A fromIndex or a toIndex which is non-integral.

    Returns void

  • Add a value to the back of the list.

    Parameters

    • value: T

      The value to add to the back of the list.

    Returns number

    The new length of the list.

    Complexity

    Constant.

    Iterator Validity

    No changes.

  • Push a set of values to the back of the list.

    Parameters

    • values: Iterable<T>

      An iterable set of values to add.

    Returns number

    The new length of the list.

    Complexity

    Linear.

    Iterator Validity

    No changes.

  • Redo an operation.

    Returns void

  • Remove and return the value at a specific index.

    Parameters

    • index: number

      The index of the value of interest.

    Returns T

    The value at the specified index, or undefined if the index is out of range.

    Complexity

    Constant.

    Iterator Validity

    Iterators pointing at the removed value and beyond are invalidated.

    Undefined Behavior

    An index which is non-integral.

  • Remove a range of items from the list.

    Parameters

    • startIndex: number

      The start index of the range to remove (inclusive).

    • endIndex: number

      The end index of the range to remove (exclusive).

    Returns number

    The new length of the list.

    Complexity

    Linear.

    Iterator Validity

    Iterators pointing to the first removed value and beyond are invalid.

    Undefined Behavior

    A startIndex or endIndex which is non-integral.

  • Remove the first occurrence of a value from the list.

    Parameters

    • value: T

      The value of interest.

    Returns number

    The index of the removed value, or -1 if the value is not contained in the list.

    Complexity

    Linear.

    Iterator Validity

    Iterators pointing at the removed value and beyond are invalidated.

  • Set the value at the specified index.

    Parameters

    Returns void

  • Undo an operation.

    Returns void

Generated using TypeDoc