The pages are in English; this contents, the search and the buttons are in Japanese.
Entry points
The API reference lists every export of every entry point with its signature and its doc comment. It is made from the source by pnpm site, so it cannot fall behind the code.
| Entry | What it holds |
|---|---|
@johnmorrisdotca/kyogijo-stadiums | drawKyogijo, drawSurface, drawScore, drawBadge, drawLayers, RANGES, layerTable, describe, winnerOf, statusLabel, isPortrait, statusText; situationText, readSituation, DRIVE_CODES, KYOGIJO_SITUATION_STYLE; OUTCOMES, rampColour; SPORTS, COURT_THEMES, LOOKS, LOOK_NAMES, LOOK_PAIRS, lookPalette, lookStyle, contrastOf, FEATURES, FEATURE_INFO, KYOGIJO_STYLE and its parts (KYOGIJO_LOOK_STYLE, KYOGIJO_FEATURE_STYLE, KYOGIJO_NOTE_STYLE), SOCCER, SOCCER_PITCHES, SOCCER_PROVIDERS, soccerSpec, soccerFrame, rescale, PARKS, PARK_IDS, parkById, parkByWikidata, parkPointsIn, parkSourceUrl, parkUnit, fenceFor; rulesFor, eraChanges, eraStates, eraRange, seasonLabel, footballIn, ERA_SPORTS, ERA_CURRENT, ERA_SOURCES; SURFACE_UNITS, UNITS, convertLength; safeColour, safeLogo, inkOn; fitLines, textWidth, abbreviate, capitals; KYOGIJO_STYLE, KYOGIJO_TEAM_STYLE, KYOGIJO_STRINGS, COLOR_PROPERTIES, VERSION and the option types |
@johnmorrisdotca/kyogijo-stadiums/geometry | FOOTBALL, NHL, NBA, MLB, SOCCER, SOCCER_PITCHES, soccerSpec, soccerPitchClass, fenceAt, fencePoints, threePointJoin, skinJoin, boardsY and the other dimensions; TENNIS, VOLLEYBALL, BEACH_VOLLEYBALL, BADMINTON, PICKLEBALL, TABLE_TENNIS, SWIMMING, WATER_POLO, DIVING, ARTISTIC, SURFACE_UNITS, convertLength, convertPoint, lengthsIn, dimensionsOf, surfaceSize, fenceIn |
@johnmorrisdotca/kyogijo-stadiums/frames | toSurface, fromSurface, convert, convertPoints, flipEnds, attackingIn, registerFrame, frameByName, framesOf, piecewise, span, FRAMES, RETROSHEET_ZONES, zoneToPoint, zoneAt, SOCCER_PROVIDERS, rescale and the frame types |
@johnmorrisdotca/kyogijo-stadiums/zones | zoneAt, zoneAtSurface, zoneName, zoneResolver, the questions (isThreePointer, inPaint, inRestrictedArea, inSlot, inCrease, inPenaltyArea, inSixYardBox, inRedZone, betweenHashes, isFair, overWall, onWarningTrack), homeRun, isHomeRun, wallHeightAt, PARKS_WITHOUT_WALL_HEIGHTS, RULE_IDS and the types: where a point lies by a sport's own rules |
@johnmorrisdotca/kyogijo-stadiums/pointer | clientPointToField, fieldPointToClient, clientPointToFrames and the types: a click on a drawing (made with pointer: true) as a place on the field in a provider's numbers, with its zone |
@johnmorrisdotca/kyogijo-stadiums/target | drawGoalMouth, drawStrikeZone, drawStumps, drawTarget, goalSize, goalZoneIds, targetZoneAt, lengthZoneOf, LENGTH_ZONES, GOAL_SPORTS, TARGET_SPORTS, KYOGIJO_TARGET_STYLE and the types: a goal, the strike zone or the stumps seen end-on, with the shots on them |
@johnmorrisdotca/kyogijo-stadiums/layers | drawLayers, layerTable, renderLayers, outlineOf, OUTCOMES, rampColour, the heat numbers (binGrid, densityGrid), ZONE_SETS, HEAT_RAMPS; FORMATIONS, formationById, positionName; convexHull, delaunay, voronoiCells, polygonArea, polygonCentroid; KYOGIJO_TEAM_STYLE and the layer types |
@johnmorrisdotca/kyogijo-stadiums/charts | nbaShotChart, nhlShotMap, mlbSprayChart, nflPassChart, soccerShotMap, soccerGoalMouth, curlingStones, curlingScore, curlingHeat, curling's statistics (curlingFreeGuards, curlingInPlay, curlingHammers, curlingEndStats, curlingGuardScores, curlingShotStats), splitsChart, passNetwork and the chart types |
@johnmorrisdotca/kyogijo-stadiums/layouts | drawGrid, GRID_PRESETS, GRID_MAX_CELLS, KYOGIJO_GRID_STYLE, backgroundMarkup, resolveBackground, BACKGROUND_PATTERNS and the grid and background types: small multiples with a shared title, subtitle, key and credit line, and the grounds behind a drawing or a grid |
@johnmorrisdotca/kyogijo-stadiums/athletics | laneDraw, raceResults, raceReplay, fieldMarks, formatTime, distanceRun; athleticsPlan, athleticsLeague, racesOf, eventsOf, RACES, RACE_IDS, FIELD_EVENTS, FIELD_EVENT_IDS, raceById, fieldEventById; the track's geometry (lap, pose, stagger, breaklineStagger, laneRadius, laneEdge, distanceOn, firstStart, markRace, staggerOf, scPose); WA_STANDARD_TRACK, WA_SHORT_TRACK, WA_STAGGER_TABLE, WA_SHORT_STAGGER_TABLE, ATHLETICS_LEAGUES, ARENA, SECTOR_REACH, SECTOR_ANGLE, JAVELIN_HALF, KYOGIJO_ATHLETICS_STYLE, KYOGIJO_TRACK_STYLE and the chart and option types: the athletics stadium's plan, races, field events and charts |
@johnmorrisdotca/kyogijo-stadiums/budo | dojo, drawDojo, DOJO_STANDARDS; budoPlan, budoLeague, BUDO_SPORTS, isBudoSport, BUDOKAN_ARENA; the tatami (lay, tint, checker, fourCorners, matCount, shapeOfJo, floorOf, DOJO_SIZES, TATAMI); KIMARITE, KIMARITE_COUNT, kimariteOf, kimariteName; BUDO_LOOKS, lookNames, KYOGIJO_BUDO_STYLE; the figures (IJF_CONTEST, AJJF_CONTEST, IJF_KATA, WKF_KUMITE, WKF_KATA, FIK_SHIAI_JO, JSA_DOHYO, KINTEKI, ENTEKI, the leagues of each sport); HALLS; budoScoreText, budoView and the types: judo, karate, kendo, sumo, kyūdō and the dojo builder |
@johnmorrisdotca/kyogijo-stadiums/skating | skatingPairs, skatingGrid, skatingResults, skatingReplay, figureElements, formatTime, distanceSkated; skatingPlan, skatingLeague, disciplineOf, racesOf, furnitureOf, RACES, RACE_IDS, LONG_TRACK_RACES, SHORT_TRACK_RACES, ELEMENT_KINDS, ELEMENT_NAMES, raceById; the long track's geometry (longOval, pose, startOf, finishAt, laneEdges, laneRadius, outerEdge, markRace) and the short track's (shortOval, shortPose, startingPositions, trackLines); ISU_LONG_TRACK, ISU_LONG_TRACK_TABLE, ISU_SHORT_TRACK, ISU_FIGURE_RINK, SKATING_LEAGUES, FURNITURE, furnitureBoxes, KYOGIJO_SKATING_STYLE and the chart and option types: the skating rinks' plan, races and charts |
@johnmorrisdotca/kyogijo-stadiums/replay | drawFrame, interpolate, trails, possession, activeEvents, eventsBetween, describeEvent, replayLayers, replaySnapshot, replaySummary, replayTable, replayInfo, replayTimes, replayEvents, replayClock, createReplay, REPLAY_SPEEDS, raceTimeline, progressOf, distanceAt, alongPool, formatTime, parseTime and the replay types |
@johnmorrisdotca/kyogijo-stadiums/scene | sceneOf, sceneFromSvg, sceneToSvg, parseSvg, writeSvg, pathCommands and the scene types: the drawing as plain data, and an SVG that needs no stylesheet |
@johnmorrisdotca/kyogijo-stadiums/canvas | drawToCanvas, withAlpha and the context's minimal type: a drawing on a browser's or a Node canvas context |
@johnmorrisdotca/kyogijo-stadiums/d3 | appendSurface, surfaceDomain: a drawing in a d3 selection, placed by your scales |
@johnmorrisdotca/kyogijo-stadiums/plot | surfaceMark, surfaceScales: a drawing as a mark of an Observable Plot, with its scales |
@johnmorrisdotca/kyogijo-stadiums/geojson | sceneToGeoJSON: a drawing as a GeoJSON FeatureCollection, in feet or a provider's frame |
@johnmorrisdotca/kyogijo-stadiums/png | toPNG, PNG_PEER_MISSING: a drawing as PNG bytes in Node, through the optional peer @resvg/resvg-js |
@johnmorrisdotca/kyogijo-stadiums/turn | mountKyogijoTurn, turnMarkup, turnSupported, uprightsFor, describeUprights, TURN_PRESETS, NET_PRESETS, KYOGIJO_TURN_STYLE, the camera (fit, project, cameraMatrix, clampView, drag, step) and the 3D view's types: a surface as a floor that turns, with what stands on it |
@johnmorrisdotca/kyogijo-stadiums/parks | PARKS, PARK_IDS, parkById, parkByWikidata, parkPointsIn, parkWallsIn, parkQuirksIn, parkSourceUrl, parkUnit, fenceFor |
@johnmorrisdotca/kyogijo-stadiums/eras | rulesFor, eraChanges, eraStates, eraRange, seasonLabel, footballIn, ERA_SPORTS, ERA_CURRENT, ERA_SOURCES and the rule types |
@johnmorrisdotca/kyogijo-stadiums/grounds | GROUNDS, GROUND_IDS, groundById, groundByWikidata, groundNameIn, groundsHosting, groundSourceUrl |
@johnmorrisdotca/kyogijo-stadiums/events | EVENTS, EVENT_IDS, EVENT_SOURCES, eventById, eventOptions, eventSources, eventFit, fitOf, conventionPlacement, KYOGIJO_SPECIAL_STYLE and the game types: the special games, a surface set inside another |
@johnmorrisdotca/kyogijo-stadiums/atlas | PLACES, placeById, placesBy, atlasFacets, surfaceOf |
@johnmorrisdotca/kyogijo-stadiums/mount | mountKyogijo (with its replay method), kyogijoElement, containerAspect |
@johnmorrisdotca/kyogijo-stadiums/react | kyogijoProps, kyogijoHtml, createKyogijo |
@johnmorrisdotca/kyogijo-stadiums/element | KyogijoField (with its timeline, replaySettings and replay), defineKyogijoField, optionsFromAttributes, replaySettingsFromAttributes, KYOGIJO_TAG, KYOGIJO_ATTRIBUTES |
@johnmorrisdotca/kyogijo-stadiums/element/define | importing it registers <kyogijo-field> |
Every function of the drawing is pure: it returns new values and never changes what it was given. The renderers (canvas, d3, plot) write to the context, selection or document you hand them, and toPNG returns a promise; each is its own entry and none imports anything from outside the package.