API - v4.1.5 ​

Table of contents ​

Hex Enumerations ​

• Orientation

Traverser Enumerations ​

• Rotation

Grid Enumerations ​

• Direction

Classes ​

• Grid
• Hex

Coordinates Interfaces ​

• AxialCoordinates
• CubeCoordinates
• OffsetCoordinates
• Point

Hex Interfaces ​

• HexOptions
• HexSettings

Traverser Interfaces ​

• LineAsVectorOptions
• LineBetweenOptions
• RectangleOptions
• RingFromRadiusOptions
• RingOptions
• SpiralOptions

Grid Interfaces ​

• GridAsJSON
• HexIterable
• HexStore
• HexTraversable

Other Interfaces ​

• BoundingBox
• Ellipse

Coordinates Type Aliases ​

• HexCoordinates
• PartialCubeCoordinates
• TupleCoordinates

Hex Type Aliases ​

• HexConstructor
• HexOffset

Traverser Type Aliases ​

• Traverser

Hex Variables ​

• defaultHexSettings

Coordinates Functions ​

• completeCube
• isAxial
• isOffset
• isTuple
• toCube
• tupleToCube

Hex Functions ​

• createHexDimensions
• createHexOrigin
• defineHex
• equals
• hexToOffset
• hexToPoint
• offsetToCube
• pointToCube
• round
• translate

Traverser Functions ​

• concat
• fromCoordinates
• line
• move
• rectangle
• repeat
• repeatWith
• ring
• spiral

Other Functions ​

• distance
• isPoint
• neighborOf
• offsetFromZero

Coordinates Type Aliases ​

HexCoordinates ​

HexCoordinates: PartialCubeCoordinates | OffsetCoordinates | TupleCoordinates

Defined in ​

hex/types.ts:61

PartialCubeCoordinates ​

PartialCubeCoordinates: { q?: number ; r: number ; s: number } | { q: number ; r?: number ; s: number } | { q: number ; r: number ; s?: number }

Defined in ​

hex/types.ts:48

TupleCoordinates ​

TupleCoordinates: [q: number, r: number, s?: number]

Defined in ​

hex/types.ts:56

Hex Type Aliases ​

HexConstructor ​

HexConstructor<T>: (coordinates?: HexCoordinates) => T

Type parameters ​

Type declaration ​

(coordinates?)

Parameters ​

Defined in ​

hex/types.ts:119

HexOffset ​

HexOffset: 1 | -1

Defined in ​

hex/types.ts:76

Traverser Type Aliases ​

Traverser ​

Traverser<T, R>: (createHex: (coordinates?: HexCoordinates) => T, cursor?: HexCoordinates) => R

Type parameters ​

Type declaration ​

(createHex, cursor?): R

Parameters ​

Returns ​

R

Defined in ​

grid/types.ts:6

Hex Variables ​

defaultHexSettings ​

Const defaultHexSettings: HexSettings

Defined in ​

hex/hex.ts:133

Coordinates Functions ​

completeCube ​

completeCube(«destructured»): CubeCoordinates

Parameters ​

Returns ​

CubeCoordinates

Defined in ​

hex/functions/completeCube.ts:7

isAxial ​

isAxial(value): value is AxialCoordinates

Parameters ​

Returns ​

value is AxialCoordinates

Defined in ​

utils/isAxial.ts:8

isOffset ​

isOffset(value): value is OffsetCoordinates

Parameters ​

Returns ​

value is OffsetCoordinates

Defined in ​

utils/isOffset.ts:8

isTuple ​

isTuple(value): value is TupleCoordinates

Parameters ​

Returns ​

value is TupleCoordinates

Defined in ​

utils/isTuple.ts:7

toCube ​

toCube(hexSettings, coordinates): CubeCoordinates

Util for converting offset/axial/cube/tuple coordinates to cube coordinates.

Parameters ​

Returns ​

CubeCoordinates

Defined in ​

hex/functions/toCube.ts:12

tupleToCube ​

tupleToCube(«destructured»): Object

Parameters ​

Returns ​

Object

Defined in ​

utils/tupleToCube.ts:6

Hex Functions ​

createHexDimensions ​

createHexDimensions(radius): Ellipse

Parameters ​

Returns ​

Ellipse

Defined in ​

hex/functions/createHexDimensions.ts:7

createHexDimensions(boundingBox, orientation): Ellipse

Parameters ​

Returns ​

Ellipse

Defined in ​

hex/functions/createHexDimensions.ts:8

createHexDimensions(ellipse): Ellipse

Parameters ​

Returns ​

Ellipse

Defined in ​

hex/functions/createHexDimensions.ts:9

createHexOrigin ​

createHexOrigin(input, boundingBox): Point

Parameters ​

Returns ​

Point

Defined in ​

hex/functions/createHexOrigin.ts:7

createHexOrigin(input): Point

Parameters ​

Returns ​

Point

Defined in ​

hex/functions/createHexOrigin.ts:8

defineHex ​

defineHex(hexOptions?): typeof Hex

Parameters ​

Returns ​

typeof Hex

Defined in ​

hex/functions/defineHex.ts:9

equals ​

equals(a, b): boolean

Parameters ​

Returns ​

boolean

Defined in ​

hex/functions/equals.ts:7

equals(a, b): boolean

Parameters ​

Returns ​

boolean

Defined in ​

hex/functions/equals.ts:11

hexToOffset ​

hexToOffset(«destructured»): OffsetCoordinates

Parameters ​

Returns ​

OffsetCoordinates

Defined in ​

hex/functions/hexToOffset.ts:18

hexToPoint ​

hexToPoint(«destructured»): Point

Parameters ​

Returns ​

Point

Defined in ​

hex/functions/hexToPoint.ts:7

offsetToCube ​

offsetToCube(«destructured», «destructured»): CubeCoordinates

Parameters ​

Returns ​

CubeCoordinates

Defined in ​

hex/functions/offsetToCube.ts:27

pointToCube ​

pointToCube(«destructured», «destructured»): CubeCoordinates

Parameters ​

Returns ​

CubeCoordinates

Defined in ​

hex/functions/pointToCube.ts:10

round ​

round(coordinates): CubeCoordinates

Parameters ​

Returns ​

CubeCoordinates

Defined in ​

hex/functions/round.ts:7

translate ​

translate<T>(hex, delta): T

Type parameters ​

Parameters ​

Returns ​

T

Defined in ​

hex/functions/translate.ts:8

translate(coordinates, delta): CubeCoordinates

Parameters ​

Returns ​

CubeCoordinates

Defined in ​

hex/functions/translate.ts:9

Traverser Functions ​

concat ​

concat<T>(traversers): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/concat.ts:7

fromCoordinates ​

fromCoordinates<T>(...coordinates): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/fromCoordinates.ts:8

line ​

line<T>(options): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/line.ts:8

line<T>(options): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/line.ts:9

move ​

move<T>(direction): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/move.ts:9

rectangle ​

rectangle<T>(options): Traverser<T>

Remarks

The rectangle will only have 90° corners for the directions North, East, South and West.

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/rectangle.ts:14

rectangle<T>(cornerA, cornerB): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/rectangle.ts:15

repeat ​

repeat<T>(times, traversers): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/repeat.ts:8

repeatWith ​

repeatWith<T>(sources, branches, «destructured»?): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/repeatWith.ts:8

ring ​

ring<T>(options): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/ring.ts:9

ring<T>(options): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/ring.ts:10

spiral ​

spiral<T>(«destructured»): Traverser<T>

Type parameters ​

Parameters ​

Returns ​

Traverser<T>

Defined in ​

grid/traversers/spiral.ts:10

Other Functions ​

distance ​

distance(hexSettings, from, to): number

Parameters ​

Returns ​

number

Defined in ​

grid/functions/distance.ts:3

isPoint ​

isPoint(value): value is Point

Parameters ​

Returns ​

value is Point

Defined in ​

utils/isPoint.ts:5

neighborOf ​

neighborOf<T>(hex, direction): T

Type parameters ​

Parameters ​

Returns ​

T

Defined in ​

grid/functions/neighborOf.ts:47

offsetFromZero ​

offsetFromZero(offset, distance): number

Parameters ​

Returns ​

number

Defined in ​

utils/offsetFromZero.ts:6