This folder contains the in-depth documentation for the ScreenGrid library. For a high-level overview and installation instructions, see the repository root README.md.
QUICK_REFERENCE.md – One-page cheat sheet and module overviewAPI_REFERENCE.md – Complete, up-to-date public API referenceARCHITECTURE.md – Architecture and module-level designUSAGE.md – Running examples, local dev, troubleshootingGEOMETRY_INPUT_AND_PLACEMENT.md – Geometry input, placement strategies, render modesPLACEMENT_CONFIG.md – Formal placement config shape and validation rulesGLYPH_DRAWING_GUIDE.md – Glyphs with onDrawCell, multivariate and temporal patternsPLUGIN_GLYPH_ECOSYSTEM.md – Plugin glyph registry, built‑ins, custom pluginsPLUGIN_GLYPHS.md – Design note for the plugin system (kept for background context)SPATIO_TEMPORAL_GUIDE.md – Focused guide for spatio‑temporal/time‑series use casesCARTOGRAPHY_AND_MULTIVARIATE_DESIGN.md – Design philosophy and cartographic patternsQUICK_REFERENCE.md if you already know ScreenGrid and just need reminders.API_REFERENCE.md when you need exact option names, defaults, and method signatures.ARCHITECTURE.md if you are extending the library or reading the source.GLYPH_DRAWING_GUIDE.md and PLUGIN_GLYPH_ECOSYSTEM.md when designing glyph‑based visualizations.GEOMETRY_INPUT_AND_PLACEMENT.md + PLACEMENT_CONFIG.md for non‑point geometry workflows (polygons/lines and feature‑anchor mode).The documents in this folder describe the refactored, modular v2.x codebase:
src/ and the root README.md.source, placement, renderMode, anchorSizePixels) is documented in GEOMETRY_INPUT_AND_PLACEMENT.md and PLACEMENT_CONFIG.md.glyph, glyphConfig, GlyphRegistry) and legend integration are documented in GLYPH_DRAWING_GUIDE.md and PLUGIN_GLYPH_ECOSYSTEM.md.If you find any mismatch between the docs and the runtime API, treat API_REFERENCE.md and the root README.md as the source of truth.