Global

Methods

anchor(x, y) → {Anchor}

Creates a new Anchor

Parameters:

Name	Type	Description
`x`	number
`y`	number

Source:

anchor.js, line 140

Returns:

Type: Anchor

cast(value) → {Vector}

Parameters:

Name	Type	Description
`value`	Vector \| number

Source:

vector.js, line 24

Returns:

Type: Vector

columns()

Source:

shuffler.js, line 41

diameter(value) → {Size}

Parameters:

Name	Type	Description
`value`	Vector \| number

Source:

size.js, line 26

Returns:

Type: Size

grid()

Source:

shuffler.js, line 27

line()

Source:

shuffler.js, line 63

noise(maxDistance) → {Shuffler}

Parameters:

Name	Type	Description
`maxDistance`	Vector

Source:

shuffler.js, line 126

Returns:

Type: Shuffler

noop()

Source:

shuffler.js, line 140

padder(padding, width, height) → {Shuffler}

Parameters:

Name	Type	Description
`padding`	number
`width`	number
`height`	number

Source:

shuffler.js, line 102

Returns:

Type: Shuffler

radius(value) → {Size}

Parameters:

Name	Type	Description
`value`	Vector \| number

Source:

size.js, line 14

Returns:

Type: Size

random(maxX, maxY) → {Shuffler}

Parameters:

Name	Type	Description
`maxX`	number
`maxY`	number

Source:

shuffler.js, line 20

Returns:

Type: Shuffler

vector(x, y) → {Vector}

Parameters:

Name	Type	Description
`x`	number
`y`	number

Source:

vector.js, line 16

Returns:

Type: Vector

Type Definitions

Action()

Source:

painter.js, line 10

Axis

Type:

Vertical | Horizontal

Source:

axis.js, line 3

CanvasConnectionListener(piece, figure, targetPiece, targetFigure)

Parameters:

Name	Type	Description
`piece`	Piece	the connecting piece
`figure`	Figure	the visual representation of the connecting piece
`targetPiece`	Piece	the target connected piece
`targetFigure`	Figure	the visual representation of the target connected

Source:

canvas.js, line 31

CanvasMetadata

Type:

object

Properties:

Name	Type	Attributes	Description
`id`	string	<optional>
`targetPosition`	Vector	<optional>
`currentPosition`	Vector	<optional>
`color`	string	<optional>
`fixed`	boolean	<optional>
`strokeColor`	string	<optional>
`image`	ImageLike	<optional>
`label`	LabelMetadata	<optional>

Source:

canvas.js, line 55

CanvasTranslationListener(piece, figure, dx, dy)

Parameters:

Name	Type	Description
`piece`	Piece	the translated piece
`figure`	Figure	the visual representation of the translated piece
`dx`	number	the horizontal displacement
`dy`	number	the vertical displacement

Source:

canvas.js, line 39

ConnectionListener(piece, target)

Parameters:

Name	Type	Description
`piece`	Piece
`target`	Piece

Source:

piece.js, line 15

DragMode

Type:

TryDisconnection | ForceDisconnection | ForceConnection

Source:

drag-mode.js, line 3

Figure

Type:

object

Properties:

Name	Type	Attributes	Description
`shape`	Shape
`group`	Group
`label`	Label	<optional>

Source:

canvas.js, line 24

Figure

Type:

Figure

Source:

konva-painter.js, line 37

Group

Type:

Group

Source:

konva-painter.js, line 38

ImageLike

Type:

HTMLImageElement | HTMLCanvasElement | ImageMetadata

Source:

image-metadata.js, line 10

ImageMetadata

Type:

object

Properties:

Name	Type	Attributes	Description
`content`	HTMLImageElement \| HTMLCanvasElement
`offset`	Vector	<optional>
`scale`	number	<optional>

Source:

image-metadata.js, line 3

Insert

A connection element of a piece

Type:

Tab | Slot | None

Source:

insert.js, line 1

InsertsGenerator(index) → {Insert}

A function for generating Inserts sequentially

Parameters:

Name	Type	Description
`index`	number	the position of the element to be generated in the sequence

Source:

sequence.js, line 3

Returns:

Type: Insert

Label

Type:

object

Source:

canvas.js, line 18

LabelMetadata

Type:

object

Properties:

Name	Type	Attributes	Description
`text`	string	<optional>
`fontSize`	number	<optional>
`x`	number	<optional>
`y`	number	<optional>

Source:

canvas.js, line 47

Mapper(value) → {B}

Parameters:

Name	Type	Description
`value`	A

Source:

prelude.js, line 10

Returns:

Type: B

Orthogonal

Type:

Object

Properties:

Name	Type	Description
`up`	A
`down`	A
`left`	A
`right`	A

Source:

prelude.js, line 1

Outline

Type:

Squared | Rounded

Source:

outline.js, line 4

PieceCondition(puzzle) → {boolean}

Parameters:

Name	Type	Description
`puzzle`	Piece

Source:

validator.js, line 83

Returns:

Type: boolean

PieceConfig

Type:

Object

Properties:

Name	Type	Attributes	Description
`centralAnchor`	Vector	<optional>
`size`	Size	<optional>
`metadata`	any	<optional>

Source:

piece.js, line 21

PieceDump

A piece primitive representation that can be easily stringified, exchanged and persisted

Type:

object

Properties:

Name	Type	Attributes	Description
`centralAnchor`	Vector
`size`	Size	<optional>
`metadata`	any
`connections`	Orthogonal.<object>	<optional>
`structure`	string

Source:

piece.js, line 28

PuzzleCondition(puzzle) → {boolean}

Parameters:

Name	Type	Description
`puzzle`	Puzzle

Source:

validator.js, line 90

Returns:

Type: boolean

PuzzleDump

A puzzle primitive representation that can be easily stringified, exchanged and persisted

Type:

object

Properties:

Name	Type	Description
`pieceRadius`	Vector
`proximity`	number
`pieces`	Array.<PieceDump>

Source:

puzzle.js, line 10

Settings

Type:

object

Properties:

Name	Type	Attributes	Description
`pieceRadius`	Vector \| number	<optional>
`proximity`	number	<optional>

Source:

puzzle.js, line 19

Size

Type:

Object

Properties:

Name	Type	Description
`radius`	Vector
`diameter`	Vector

Source:

size.js, line 3

SpatialMetadata

Type:

object

Properties:

Name	Type	Attributes	Description
`targetPosition`	Vector	<optional>
`currentPosition`	Vector	<optional>

Source:

spatial-metadata.js, line 6

Structure

Type:

object

Properties:

Name	Type	Attributes	Description
`up`	Insert	<optional>
`left`	Insert	<optional>
`down`	Insert	<optional>
`right`	Insert	<optional>

Source:

structure.js, line 4

Template

Type:

object

Properties:

Name	Type	Attributes	Description
`structure`	StructureLike
`size`	Size	<optional>
`metadata`	CanvasMetadata

Source:

canvas.js, line 67

TranslationListener(piece, dx, dy)

Parameters:

Name	Type	Description
`piece`	Piece
`dx`	number
`dy`	number

Source:

piece.js, line 8

ValidationListener(puzzle)

Parameters:

Name	Type	Description
`puzzle`	Puzzle

Source:

validator.js, line 9

Validator

Type:

PieceValidator | PuzzleValidator | NullValidator

Source:

validator.js, line 5

Vector

Type:

object

Properties:

Name	Type	Description
`x`	number
`y`	number

Source:

vector.js, line 3

VectorAction(dx, dy)

Parameters:

Name	Type	Description
`dx`	number
`dy`	number

Source:

painter.js, line 4