Map

Defined in: collections/Map.ts:17

GoJS-compatible: a key/value collection, mirroring go.Map. Named Map to match GoJS’s exact API — import it aliased (e.g. import { Map as GoMap } from 'graphojs') to avoid shadowing the native Map in the same scope.

Type Parameters

K

K

V

V

Constructors

Constructor

new Map<K, V>(coll?): Map<K, V>

Defined in: collections/Map.ts:20

Parameters

coll?

Iterable<IKeyValuePair<K, V>, any, any> | Iterable<readonly [K, V], any, any>

Returns

Map<K, V>

Accessors

count

Get Signature

get count(): number

Defined in: collections/Map.ts:133

Returns

number

---

iterator

Get Signature

get iterator(): Iterator<IKeyValuePair<K, V>>

Defined in: collections/Map.ts:141

Returns

Iterator<IKeyValuePair<K, V>>

---

iteratorKeys

Get Signature

get iteratorKeys(): Iterator<K>

Defined in: collections/Map.ts:145

Returns

Iterator<K>

---

iteratorValues

Get Signature

get iteratorValues(): Iterator<V>

Defined in: collections/Map.ts:153

Returns

Iterator<V>

---

size

Get Signature

get size(): number

Defined in: collections/Map.ts:137

Returns

number

Methods

[iterator]()

[iterator](): Iterator<[K, V]>

Defined in: collections/Map.ts:165

Returns

Iterator<[K, V]>

---

add()

add(key, val): this

Defined in: collections/Map.ts:38

Parameters

key

K

val

V

Returns

this

---

addAll()

addAll(coll): this

Defined in: collections/Map.ts:43

Parameters

coll

Iterable<IKeyValuePair<K, V>, any, any> | Iterable<readonly [K, V], any, any>

Returns

this

---

all()

all(pred): boolean

Defined in: collections/Map.ts:67

Parameters

pred

(a) => boolean

Returns

boolean

---

any()

any(pred): boolean

Defined in: collections/Map.ts:60

Parameters

pred

(a) => boolean

Returns

boolean

---

clear()

clear(): void

Defined in: collections/Map.ts:117

Returns

void

---

contains()

contains(key): boolean

Defined in: collections/Map.ts:97

Parameters

key

K

Returns

boolean

---

copy()

copy(): Map<K, V>

Defined in: collections/Map.ts:121

Returns

Map<K, V>

---

delete()

delete(key): boolean

Defined in: collections/Map.ts:109

Parameters

key

K

Returns

boolean

---

each()

each(func): this

Defined in: collections/Map.ts:74

Parameters

func

(a) => void

Returns

this

---

entries()

entries(): IterableIterator<[K, V]>

Defined in: collections/Map.ts:25

Returns

IterableIterator<[K, V]>

---

filter()

filter(pred): Map<K, V>

Defined in: collections/Map.ts:85

Parameters

pred

(a) => boolean

Returns

Map<K, V>

---

first()

first(): IKeyValuePair<K, V> | null

Defined in: collections/Map.ts:55

Returns

IKeyValuePair<K, V> | null

---

forEach()

forEach(callbackFunc): void

Defined in: collections/Map.ts:161

Parameters

callbackFunc

(value, key, map) => void

Returns

void

---

get()

get(key): V | null

Defined in: collections/Map.ts:101

Parameters

key

K

Returns

V | null

---

getValue()

getValue(key): V | null

Defined in: collections/Map.ts:105

Parameters

key

K

Returns

V | null

---

has()

has(key): boolean

Defined in: collections/Map.ts:93

Parameters

key

K

Returns

boolean

---

keys()

keys(): IterableIterator<K>

Defined in: collections/Map.ts:149

Returns

IterableIterator<K>

---

map()

map<S>(func): Map<K, S>

Defined in: collections/Map.ts:79

Type Parameters

S

S

Parameters

func

(a) => S

Returns

Map<K, S>

---

remove()

remove(key): boolean

Defined in: collections/Map.ts:113

Parameters

key

K

Returns

boolean

---

set()

set(key, val): this

Defined in: collections/Map.ts:33

Parameters

key

K

val

V

Returns

this

---

toArray()

toArray(): IKeyValuePair<K, V>[]

Defined in: collections/Map.ts:125

Returns

IKeyValuePair<K, V>[]

---

toKeySet()

toKeySet(): Set<K>

Defined in: collections/Map.ts:129

Returns

Set<K>

---

toString()

toString(): string

Defined in: collections/Map.ts:29

Returns

string

---

values()

values(): IterableIterator<V>

Defined in: collections/Map.ts:157

Returns

IterableIterator<V>