GoJS API
/ to search
    Preparing search index...

    Interface IMapIterator<K, T>

    GoJS® Diagramming Components
    version 4.0.0
    by Northwoods Software®

    This interface defines properties and methods for iterating over a Map; it provides the next predicate and the key and value read-only properties.

    Iterating over Maps is very similar to an Iterator<IKeyValuePair>, but not exactly, because the type of the value property is T, not an IKeyValuePair.

    Typical usage is:

     const it = aMap.iterator;
     while (it.next()) {
       const key = it.key;
       const val = it.value;
     }
    see

    Iterator

    interface IMapIterator<K, T> {
        count: number;
        iterator: IMapIterator<K, T>;
        key: K;
        value: T;
        all(pred: (x: IKeyValuePair<K, T>) => boolean): boolean;
        any(pred: (x: IKeyValuePair<K, T>) => boolean): boolean;
        each(func: (x: IKeyValuePair<K, T>) => void): IMapIterator<K, T>;
        first(): IKeyValuePair<K, T> | null;
        next(): boolean;
        reset(): void;
    }

    Type Parameters

    • K
    • T
    Index

    Methods

    all any each first next reset

    Properties

    count iterator key value

    Methods

    • This is true if all invocations of the given predicate on items in the collection are true.

      Call the given predicate on each item in the collection. As soon as a call returns false, this returns false. Otherwise this returns true. For an empty collection this returns true.

      This automatically reset's itself when it is called.

      Parameters

      • pred: (x: IKeyValuePair<K, T>) => boolean

        This function must not have any side-effects.

      Returns boolean

      True if all predicate calls are true; false otherwise.

    • This is true if any invocation of the given predicate on items in the collection is true.

      Call the given predicate on each item in the collection. As soon as a call returns true, this returns true. Otherwise this returns false. For an empty collection this returns false.

      This automatically reset's itself when it is called.

      Parameters

      • pred: (x: IKeyValuePair<K, T>) => boolean

        This function must not have any side-effects.

      Returns boolean

      True if any predicate call is true; false otherwise.

    • Advance if needed to the first item in the collection and return it, or return null if there is none. Returns a key/value pair, not a value.

      Returns IKeyValuePair<K, T> | null

    • Call this method to advance the iterator to the next item in the collection. This should be called before accessing any value.

      Returns boolean

      whether another item is available; when true the value of value will be that item.

    • Start this iterator all over again.

      Returns void

    Properties

    count: number

    This read-only property is the total number of items in the iterated collection.

    iterator: IMapIterator<K, T>

    Returns itself, which is convenient for code that expects an Iterable instead of an Iterator.

    key: K

    Gets the current key in the collection, assuming next has just returned true.

    value: T

    Gets the current value in the collection, assuming next has just returned true.

    Member Visibility

    On This Page

    Methods
    Properties