Class DirectionCaret<Value>

A builder of DirectionNode graphs.

connect/disconnect
spawn/erase
move
save/restore
push/pop

Type Parameters

Value

Hierarchy

DirectionCaret

Index

Constructors

Properties

_nodeRoot _nodes _savedNodes

Constructors

constructor

new DirectionCaret<Value>(given?: Value | DirectionNode<Value>): DirectionCaret<Value>
Type Parameters
- Value
Parameters
- Optional given: Value | DirectionNode<Value>
Returns DirectionCaret<Value>
- Defined in DirectionCaret.ts:27

Properties

`Private` _nodeRoot

_nodeRoot: DirectionNode<Value>

`Private` _nodes

_nodes: DirectionNode<Value>[]

`Private` _savedNodes

_savedNodes: {
[key: string]: DirectionNode<Value>;
}

Type declaration

[key: string]: DirectionNode<Value>

Methods

align

align(inDirection: string | Direction, newAlignmentMode?: string | Alignment): void
Aligns the current node in the given direction.

If only the alignment is given, the parent node is aligned in the current direction.

Throws
if the current node is root (alignment is done by the parent, not the child)
Parameters
- inDirection: string | Direction
- Optional newAlignmentMode: string | Alignment
Returns void
- Defined in DirectionCaret.ts:286

at

at(inDirection: string | Direction): DirectionNode<Value>
Parameters
- inDirection: string | Direction
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:408

clearSave

clearSave(id: string): void
Parameters
- id: string
Returns void
- Defined in DirectionCaret.ts:183

clone

clone(): DirectionCaret<Value>
Returns DirectionCaret<Value>
- Defined in DirectionCaret.ts:56

connect

connect(inDirection: string | Direction, node: DirectionNode<Value>): DirectionNode<Value>
Parameters
- inDirection: string | Direction
- node: DirectionNode<Value>
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:77

connectMove

connectMove(inDirection: string | Direction, node: DirectionNode<Value>): DirectionNode<Value>
Parameters
- inDirection: string | Direction
- node: DirectionNode<Value>
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:86

crease

crease(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:116

disconnect

disconnect(inDirection?: string | Direction): DirectionNode<Value>
Parameters
- Optional inDirection: string | Direction
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:98

`Protected` doReplace

doReplace(node: DirectionNode<Value>, given?: Value): void
Parameters
- node: DirectionNode<Value>
- Optional given: Value
Returns void
- Defined in DirectionCaret.ts:48

`Protected` doSpawn

doSpawn(given?: Value | DirectionNode<Value>): DirectionNode<Value>
Parameters
- Optional given: Value | DirectionNode<Value>
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:37

fitExact

fitExact(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:329

fitLoose

fitLoose(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:337

fitNaive

fitNaive(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:345

grow

grow(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:319

has

has(inDirection: string | Direction): boolean
Parameters
- inDirection: string | Direction
Returns boolean
- Defined in DirectionCaret.ts:73

isCreased

isCreased(inDirection?: string | Direction): boolean
Parameters
- Optional inDirection: string | Direction
Returns boolean
- Defined in DirectionCaret.ts:136

move

move(toDirection: string | Direction): void
Parameters
- toDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:145

moveTo

moveTo(node: DirectionNode<any>): void
Move directly to the given node.
Parameters
- node: DirectionNode<any>
  
  the node to move to.
Returns void
- Defined in DirectionCaret.ts:216

node

node(): DirectionNode<Value>
Returns the caret's current node.

Returns
the current node

Throws
if the caret has no node.

Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:66

origin

origin(): DirectionNode<any>
Returns this caret's original root node.

Returns
this caret's original node.

Returns DirectionNode<any>
- Defined in DirectionCaret.ts:225

parent

parent(): DirectionNode<any>
Returns the current node's parent node.

Returns
the parent of the current node

Returns DirectionNode<any>
- Defined in DirectionCaret.ts:234

pop

pop(): void
Moves the caret to the most recently pushed node and removes it from the caret's stack.

See
push

Returns void
- Defined in DirectionCaret.ts:249

pull

pull(given: string | Direction): void
Sets the current node's PreferredAxis to the given direction.

See
readDirection
Parameters
- given: string | Direction
  
  the direction of the neighbor to pull closer to this node
Returns void
- Defined in DirectionCaret.ts:263

push

push(): void
Saves the current node in the caret's stack of DirectionNodes.

See
pop to return to this node.

Returns void
- Defined in DirectionCaret.ts:160

replace

replace(value?: Value): Value
Replaces the current node's value with the given value.

Returns
the original value.
Parameters
- Optional value: Value
  
  the new value. If undefined, then the value is removed.
Returns Value
- Defined in DirectionCaret.ts:388

restore

restore(id: string): void
Moves the caret to the saved node named by the given id.

See
save
Parameters
- id: string
  
  the name of the saved node.
Returns void
- Defined in DirectionCaret.ts:200

root

root(): DirectionNode<Value>
Returns the current node's root node.

Returns
the caret's node root.

Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:272

save

save(id?: string): string
Saves the current node in the caret's map of DirectionNodes using the given key.

Returns
the key used to save the current node

See
restore
Parameters
- Optional id: string
  
  the key for the current node. If undefined, a new key will be created.
Returns string
- Defined in DirectionCaret.ts:172

shrink

shrink(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:309

spawn

spawn(inDirection: string | Direction, newType?: any, newAlignmentMode?: string | Alignment): DirectionNode<Value>
Parameters
- inDirection: string | Direction
- Optional newType: any
- Optional newAlignmentMode: string | Alignment
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:359

spawnMove

spawnMove(inDirection: string | Direction, newType?: Value | DirectionNode<Value>, newAlignmentMode?: string | Alignment): DirectionNode<Value>
Parameters
- inDirection: string | Direction
- Optional newType: Value | DirectionNode<Value>
- Optional newAlignmentMode: string | Alignment
Returns DirectionNode<Value>
- Defined in DirectionCaret.ts:398

uncrease

uncrease(inDirection?: string | Direction): void
Parameters
- Optional inDirection: string | Direction
Returns void
- Defined in DirectionCaret.ts:126

value

value(): Value
Returns Value
- Defined in DirectionCaret.ts:394

Generated using TypeDoc