Class: Grid<T> ​

Type parameters ​

Implements ​

• HexIterable<T>
• HexTraversable<T>

Table of contents ​

Constructors ​

• constructor

Accessors ​

• hexPrototype
• pixelHeight
• pixelWidth
• size

Methods ​

• [iterator]
• createHex
• distance
• filter
• forEach
• fromIterable
• fromJSON
• getHex
• hasHex
• map
• neighborOf
• pointToHex
• reduce
• setHexes
• toArray
• toJSON
• toString
• traverse

Constructors ​

constructor ​

new Grid<T>(hexClass)

Type parameters ​

Parameters ​

Defined in ​

grid/grid.ts:87

new Grid<T>(hexClass, traversers)

Type parameters ​

Parameters ​

Defined in ​

grid/grid.ts:88

new Grid<T>(hexClass, hexes)

Type parameters ​

Parameters ​

Defined in ​

grid/grid.ts:89

new Grid<T>(grid)

Type parameters ​

Parameters ​

Defined in ​

grid/grid.ts:90

Accessors ​

hexPrototype ​

get hexPrototype(): T

Returns ​

T

Defined in ​

grid/grid.ts:79

pixelHeight ​

get pixelHeight(): number

Returns ​

number

Defined in ​

grid/grid.ts:60

pixelWidth ​

get pixelWidth(): number

Returns ​

number

Defined in ​

grid/grid.ts:45

size ​

get size(): number

Returns ​

number

Implementation of ​

HexTraversable.size

Defined in ​

grid/grid.ts:41

Methods ​

[iterator] ​

[iterator](): IterableIterator<T>

Returns ​

IterableIterator<T>

Implementation of ​

HexIterable.[iterator]

Defined in ​

grid/grid.ts:75

createHex ​

createHex(coordinates?): T

Parameters ​

Returns ​

T

Implementation of ​

HexTraversable.createHex

Defined in ​

grid/grid.ts:105

distance ​

distance(from, to, options?): number

Parameters ​

Returns ​

number

Defined in ​

grid/grid.ts:221

distance(from, to, options): undefined | number

Parameters ​

Returns ​

undefined | number

Defined in ​

grid/grid.ts:222

filter ​

filter(predicate): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexIterable.filter

Defined in ​

grid/grid.ts:126

forEach ​

forEach(fn): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexIterable.forEach

Defined in ​

grid/grid.ts:167

fromIterable ​

Static fromIterable<T>(hexes): Grid<T>

Type parameters ​

Parameters ​

Returns ​

Grid<T>

Defined in ​

grid/grid.ts:8

fromJSON ​

Static fromJSON<T, R>(«destructured», hexFactory?): Grid<R>

Type parameters ​

Parameters ​

Returns ​

Grid<R>

Defined in ​

grid/grid.ts:18

getHex ​

getHex(coordinates): undefined | T

Parameters ​

Returns ​

undefined | T

Implementation of ​

HexTraversable.getHex

Defined in ​

grid/grid.ts:109

hasHex ​

hasHex(hex): boolean

Parameters ​

Returns ​

boolean

Implementation of ​

HexTraversable.hasHex

Defined in ​

grid/grid.ts:114

map ​

map(fn): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexIterable.map

Defined in ​

grid/grid.ts:136

neighborOf ​

neighborOf(coordinates, direction, options?): T

Parameters ​

Returns ​

T

Defined in ​

grid/grid.ts:233

neighborOf(coordinates, direction, options): undefined | T

Parameters ​

Returns ​

undefined | T

Defined in ​

grid/grid.ts:234

pointToHex ​

pointToHex(point, options?): T

Parameters ​

Returns ​

T

Defined in ​

grid/grid.ts:212

pointToHex(point, options): undefined | T

Parameters ​

Returns ​

undefined | T

Defined in ​

grid/grid.ts:213

reduce ​

reduce(reducer): T

Parameters ​

Returns ​

T

Implementation of ​

HexIterable.reduce

Defined in ​

grid/grid.ts:174

reduce(reducer, initialValue): T

Parameters ​

Returns ​

T

Implementation of ​

HexIterable.reduce

Defined in ​

grid/grid.ts:175

reduce<R>(reducer, initialValue): R

Type parameters ​

Parameters ​

Returns ​

R

Implementation of ​

HexIterable.reduce

Defined in ​

grid/grid.ts:176

setHexes ​

setHexes(hexesOrCoordinates): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexTraversable.setHexes

Defined in ​

grid/grid.ts:118

toArray ​

toArray(): T[]

Returns ​

T[]

Implementation of ​

HexIterable.toArray

Defined in ​

grid/grid.ts:196

toJSON ​

toJSON(): GridAsJSON<T>

Returns ​

GridAsJSON<T>

Defined in ​

grid/grid.ts:201

toString ​

toString(): string

Returns ​

string

Defined in ​

grid/grid.ts:208

traverse ​

traverse(traversers, options?): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexTraversable.traverse

Defined in ​

grid/grid.ts:146

traverse(hexes, options?): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexTraversable.traverse

Defined in ​

grid/grid.ts:147

traverse(grid, options?): Grid<T>

Parameters ​

Returns ​

Grid<T>

Implementation of ​

HexTraversable.traverse

Defined in ​

grid/grid.ts:148