Set<T> class

NOTE: For 2.0 the #constructor argument has changed. Set now optionally accepts a collection, and only checks types in TypeScript.

An unordered iterable collection that cannot contain two instances of the same value. In TypeScript it is a generic class that enforces at compile-time the type of elements that may be added to the Set.

An example usage:

  var set = new go.Set();  // In TypeScript: new go.Set<string>();
  set.add("orange");
  set.add("apple");
  set.add("orange");
  // now set.count === 2
  // and set.contains("orange") === true
  // and set.contains("banana") === false

You can iterate over the items in a Set:

  var it = aSet.iterator;
  while (it.next()) {
    . . . it.value . . .
  }

Or:

  aSet.each(val => {
      . . . val . . .
    });

Although not precisely implementing the features of the EcmaScript 6 Set class, this GoJS Set class has synonyms for the following methods and property:

add(val): #add
delete(val): #remove
has(val): #contains
clear(): #clear
size: #count

The constructor now takes an optional Iterable or Array argument that provides the initial elements for the new Set.

Note that GoJS iteration is quite different than ES6 iteration, so that functionality has not been made somewhat compatible. These collection classes were defined in GoJS before the ES6 collection classes were proposed.

Implemented types

Iterable<T>

Available extensions

Annotations

@JS()
@staticInterop

Constructors

Set.new([Object? coll]): factory

Properties

count → num: Available on Iterable<T>, provided by the Iterable$Typings extension
This read-only property is the number of elements in the collection.
no setter
count ↔ num: Available on Set<T>, provided by the Set$Typings extension
This read-only property is the number of elements in the Set.
getter/setter pair
first ↔ T? Function(): Available on Iterable<T>, provided by the Iterable$Typings extension

getter/setter pair
hashCode → int: The hash code for this object.
no setterinherited
iterator ↔ Iterator<T>: Available on Iterable<T>, provided by the Iterable$Typings extension
Gets an Iterator that can iterate over the items in the collection.
getter/setter pair
iterator ↔ Iterator<T>: Available on Set<T>, provided by the Set$Typings extension
Gets an object that you can use for iterating over the Set. The value will be a member of the Set. Typical usage:
getter/setter pair
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
size ↔ num: Available on Set<T>, provided by the Set$Typings extension
This read-only property is the number of elements in the Set.
getter/setter pair

Methods

add(T val) → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Adds a given value to the Set, if not already present.
addAll(Object coll) → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Adds all of the values of a collection to this Set.
all(bool pred(T)) → bool: Available on Set<T>, provided by the Set$Typings extension
This is true if all invocations of the given predicate on items in the collection are true.
any(bool pred(T)) → bool: Available on Set<T>, provided by the Set$Typings extension
This is true if any invocation of the given predicate on items in the collection is true.
clear() → void: Available on Set<T>, provided by the Set$Typings extension
Clears the Set. This sets the #count to zero.
contains(T val) → bool: Available on Set<T>, provided by the Set$Typings extension
Returns whether the given value is in this Set. @param {T} val The value to check. @return {boolean} Whether or not the value is contained within the Set.
containsAll(Iterable<T> coll) → bool: Available on Set<T>, provided by the Set$Typings extension
Returns true if all of the values of a given collection are in this Set. @param {Iterable.
containsAny(Iterable<T> coll) → bool: Available on Set<T>, provided by the Set$Typings extension
Returns true if any of the values of a given collection are in this Set. @param {Iterable.
copy() → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Makes a shallow copy of this Set. The values are not copied, so if they are objects they may continue to be shared with the original Set. @expose @return {Set.
delete(T val) → bool: Available on Set<T>, provided by the Set$Typings extension
Removes a value (if found) from the Set.
each(void func(T)) → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Call the given function on each item in the collection. @expose @param {function(T)} func This function must not modify the collection. @return {Set.
filter(bool pred(T)) → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Call the given predicate on each item in the collection and for each item that it returns true, collect the item in a new Set.
first() → T?: Available on Set<T>, provided by the Set$Typings extension
Returns the first item in the collection, or null if there is none. @return {T|null} This returns null if there are no items in the collection.
has(T val) → bool: Available on Set<T>, provided by the Set$Typings extension
Returns whether the given value is in this Set. @param {T} val The value to check. @return {boolean} Whether or not the value is contained within the Set.
map<S>(S func(T)) → Set<S>: Available on Set<T>, provided by the Set$Typings extension
Call the given function on each item in the collection and collect the results in a new Set.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
remove(T val) → bool: Available on Set<T>, provided by the Set$Typings extension
Removes a value (if found) from the Set.
removeAll(Object coll) → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Removes all of the values of a collection from this Set.
retainAll(Iterable<T> coll) → Set<T>: Available on Set<T>, provided by the Set$Typings extension
Removes from this Set all items that are not in the given collection.
toArray() → Array<T>: Available on Set<T>, provided by the Set$Typings extension
Produces a JavaScript Array from the contents of this Set. @return {Array.
toList() → List<T>: Available on Set<T>, provided by the Set$Typings extension
Converts the Set to a List. Because there is no ordering within a Set, the values in the List may be in any order. @return {List.
toString() → String: A string representation of this object.
inherited
toString$() → String: Available on Set<T>, provided by the Set$Typings extension
@return {string}

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

hashId(Object obj) → num?: (undocumented) Get the unique hash ID for an object; may return undefined.
hashIdUnique(Object obj) → num: (undocumented) Get the unique hash ID for an object, making it if necessary.
uniqueHash(Object obj) → void: (undocumented) Set the unique hash ID for an object. This should be called at the beginning of each constructor that does not inherit from another class.