リファレンス

SVGの盤

import { … } from "@johnmorrisdotca/meikyuu/draw";

最小化と gzip 圧縮をしたサイズは 8.7 kB（読み込むものをすべて含み、esbuild で計測）

リファレンスの説明と例は英語です。見出しと目次は日本語です。

Meikyuu's drawing: a maze or an arrow board as SVG text, with its boards, its line colours, the style that gives the drawing its look, and the words it says in English and Japanese. A separate entry (@johnmorrisdotca/meikyuu/draw), so a server that only builds mazes never loads any of it.

エクスポート

名前	種類	概要
`arrowColour`	関数	The colour of arrow number `id`.
`arrowMarkup`	関数	The arrow's picture: its stem, its head, and a padlock if it is locked.
`boardLookOf`	関数	The look a board name or board object means.
`doorPlace`	関数	Where a door is: the middle of its gap in the wall, and the way out through it as a unit vector.
`drawArrows`	関数	Render the native arrow board, locked/present arrows and optional hint as SVG text.
`DrawArrowsOptions`	型	AN ARROW BOARD AS SVG TEXT: a faint dot on every cell of the picture, and each arrow on it as a line through its cells with a head at the end it points from.
`drawMaze`	関数	The maze as SVG text.
`DrawMazeOptions`	型	Native maze appearance, current trail, collected keys, stones, hints, label and SVG presentation choices.
`fixed`	関数	A number as short text: two decimals at most, so a drawing is small.
`framed`	関数	The rectangle to look at to see the whole of a shape with a margin of `pad` cells.
`linePath`	関数	A line through the middles of the cells, in order.
`lookAttributes`	関数	The attributes (as text) that make an element a Meikyuu drawing: its class, its look, and its custom properties.
`lookStyle`	関数	The inline custom properties a look needs: none for plain paper with the default line, which the style gives.
`marksOf`	関数	The marks on a maze: the start, the goal or exit, the doors and the keys, as SVG.
`MazeLook`	型	What a maze looks like: every option that does not depend on where the line is.
`MEIKYUU_ARROW_COLOURS`	定数	The colours of each arrow on an arrow board, in turn.
`MEIKYUU_BOARD_NAMES`	定数	The supported named native maze board appearances.
`MEIKYUU_BOARDS`	定数	The paper, wall, frame and default trail colours of every named maze board.
`MEIKYUU_STRINGS`	定数	Native English and Japanese labels, announcements and interpolation templates.
`MEIKYUU_STYLE`	定数	The scoped native SVG styles for mazes and arrow boards.
`MEIKYUU_TRAIL_NAMES`	定数	The supported named native trail colours.
`MEIKYUU_TRAILS`	定数	The light and dark colours of every named trail.
`MeikyuuBoardLook`	型	A board's colours: the paper, the walls, the frame, whether it is a dark board, and the line that shows on it when none is chosen.
`MeikyuuBoardName`	型	A supported named maze board appearance.
`MeikyuuLanguage`	型	THE WORDS MEIKYUU SAYS, in English and Japanese: what a screen reader hears of a drawing, what the buttons and the lines under a playable board say, and the names of the shapes and the ways to play.
`meikyuuLanguageOf`	関数	The language a `lang` attribute asks for: Japanese for any `ja`, English for everything else.
`meikyuuSay`	関数	A line in a language, with its `{name}` values filled in, and its `One` form when `n` is 1.
`MeikyuuTrailName`	型	A supported named trail palette.
`standingWalls`	関数	Every wall of the maze that is standing: between cells that are not joined, and round the outside, except the doors.
`stonesOf`	関数	The stones laid on a maze, as SVG: each a marble (`mk-stone`) with a small gleam (`mk-gleam`) on the cell, one unit across being a cell.
`wallPath`	関数	The path data for a wall: a line, or an arc round the middle of a circle maze.

ソースを見る GitHub で編集@johnmorrisdotca/meikyuu 3.2.0 のソースから作成しました。

この日本語は、まだ日本語を母語とする方の確認を受けていません。訂正を歓迎します。