NeoChessRef

neo-chess-board

---

Defined in: src/react/NeoChessBoard.tsx:223

Properties

addArrow()

addArrow: (arrow) => void

Defined in: src/react/NeoChessBoard.tsx:228

Parameters

arrow

color?

string

from

`${string}${number}`

to

`${string}${number}`

Returns

void

---

addClockTime()

addClockTime: (color, milliseconds) => void

Defined in: src/react/NeoChessBoard.tsx:236

Parameters

color

Color

milliseconds

number

Returns

void

---

addHighlight()

addHighlight: (square, type) => void

Defined in: src/react/NeoChessBoard.tsx:229

Parameters

square

`${string}${number}`

type

string

Returns

void

---

clearArrows()

clearArrows: () => void

Defined in: src/react/NeoChessBoard.tsx:230

Returns

void

---

clearHighlights()

clearHighlights: () => void

Defined in: src/react/NeoChessBoard.tsx:231

Returns

void

---

getBoard()

getBoard: () => NeoChessBoard | null

Defined in: src/react/NeoChessBoard.tsx:225

Returns

NeoChessBoard | null

---

getClockState()

getClockState: () => ClockState | null

Defined in: src/react/NeoChessBoard.tsx:232

Returns

ClockState | null

---

pauseClock()

pauseClock: () => void

Defined in: src/react/NeoChessBoard.tsx:234

Returns

void

---

requestPuzzleHint()?

optional requestPuzzleHint: (type?) => void

Defined in: src/react/NeoChessBoard.tsx:238

Parameters

type?

"text" | "origin-highlight"

Returns

void

---

resetClock()

resetClock: (config?) => void

Defined in: src/react/NeoChessBoard.tsx:237

Parameters

config?

Partial\<ClockConfig> | null

Returns

void

---

setClockTime()

setClockTime: (color, milliseconds) => void

Defined in: src/react/NeoChessBoard.tsx:235

Parameters

color

Color

milliseconds

number

Returns

void

---

startClock()

startClock: () => void

Defined in: src/react/NeoChessBoard.tsx:233

Returns

void