Reference · SVG boards and materials
drawfunction
A self-contained board drawing; no browser globals and no random SVG ids.
Import it
import { draw } from "@johnmorrisdotca/tobiishi/draw";
Definition
function draw(game: Game, options?: { material?: Material; theme?: Partial<Theme>; selected?: number | null; title?: string; }): string
Parameters
| Name | Type | Description |
|---|---|---|
game | Readonly<{ board: Board; start: readonly boolean[]; pegs: readonly boolean[]; target: number | null; history: readonly Jump[]; helped: boolean; }> | The immutable native peg position, board, target, history and assistance marker. |
options (optional) | { material?: Material; theme?: Partial<Theme>; selected?: number | null; title?: string; } | Optional native SVG material, palette, selected hole and title, or mount settings specified by this signature. |
Returns
string
A self-contained board drawing; no browser globals and no random SVG ids.
Examples
import { makeBoard, newGame } from "@johnmorrisdotca/tobiishi";
import { draw } from "@johnmorrisdotca/tobiishi/draw";
const board = makeBoard("Three holes",[{x:0,y:0},{x:1,y:0},{x:2,y:0}]);
const game = newGame(board,[true,true,false],2);
console.log(draw(game,{material:"wood",title:"Three pegs"}).startsWith("<svg"));trueWhat it prints (run when this page was built)