ScreenGrid Quick Reference Guide

📖 For complete API documentation with detailed parameter descriptions, return types, and comprehensive examples, see API_REFERENCE.md

This guide provides quick lookup snippets and common patterns. Use it when you know what you're looking for and need a quick reminder.

📦 Module Import Paths

// Main class (unchanged API)
import { ScreenGridLayerGL } from 'screengrid';

// Core modules (pure business logic)
import { Aggregator } from 'screengrid';        // Grid aggregation
import { Projector } from 'screengrid';         // Coordinate projection
import { CellQueryEngine } from 'screengrid';   // Spatial queries

// Geometry placement (v2.1.0+)
import { PlacementEngine, PlacementValidator, PlacementStrategyRegistry, GeometryUtils } from 'screengrid';

// Canvas modules
import { CanvasManager } from 'screengrid';     // Canvas lifecycle
import { Renderer } from 'screengrid';          // Drawing logic

// Event modules
import { EventBinder } from 'screengrid';       // Event attachment
import { EventHandlers } from 'screengrid';     // Event logic

// Glyph utilities & plugins
import { GlyphUtilities } from 'screengrid';    // Glyph drawing
import { GlyphRegistry } from 'screengrid';     // Plugin registry

// Aggregation system (v2.1.0+)
import { AggregationModeRegistry, ScreenGridMode, ScreenHexMode } from 'screengrid';
import { AggregationFunctionRegistry, AggregationFunctions } from 'screengrid';

// Normalization system (v2.1.0+)
import { NormalizationFunctionRegistry, NormalizationFunctions } from 'screengrid';

// Utilities (v2.1.0+)
import { Logger, setDebug } from 'screengrid';  // Debug logging
import { groupBy, extractAttributes, computeStats, groupByTime } from 'screengrid'; // Data utils

// Legend system (v2.0.0+)
import { Legend, LegendDataExtractor, LegendRenderers } from 'screengrid';

// Configuration
import { ConfigManager } from 'screengrid';     // Configuration

🎯 Quick Module Reference

ConfigManager

What: Configuration defaults and merging
When: Use when creating or updating layer config
API:

ConfigManager.create(options)
ConfigManager.update(config, updates)
ConfigManager.isValid(config)

Projector

What: Geographic → Screen space transformation
When: Need to project coordinates
API:

Projector.projectPoints(data, getPos, getWeight, map)
projector.project(data, getPos, getWeight)

Aggregator

What: Grid aggregation algorithm (pure)
When: Aggregate points into grid cells
API:

Aggregator.aggregate(points, data, width, height, cellSize, aggFn, onAfterAggregate)
aggregator.getStats(result)

🛠️ Advanced Hooks Reference

`onAfterAggregate` (Multivariate)

What: Calculate complex stats per cell once per render.
Use case: Averages, medians, or multi-attribute scores.

onAfterAggregate: (cellPoints, aggVal, idx, grid) => ({
  avg: cellPoints.reduce((s, p) => s + p.data.v, 0) / cellPoints.length,
  maxScore: Math.max(...cellPoints.map(p => p.data.score))
})

`onDrawCell` (Context)

What: Draw to canvas with enriched context.

onDrawCell: (ctx, x, y, normVal, cellInfo) => {
  const { customData, isHovered, zoomLevel } = cellInfo;
  // Use customData from onAfterAggregate
  if (isHovered) { /* Highlight effect */ }
}

CellQueryEngine

What: Spatial queries on grid
When: Find cells at point, in bounds, or above threshold
API:

CellQueryEngine.getCellAt(result, point)
CellQueryEngine.getCellsInBounds(result, bounds)
CellQueryEngine.getCellsAboveThreshold(result, threshold)

CanvasManager

What: Canvas lifecycle (create, size, cleanup)
When: Managing canvas overlay
API:

canvasManager.init(map)
canvasManager.getContext()
canvasManager.resize()
canvasManager.cleanup()
canvasManager.getDisplaySize()

Renderer

What: Draw grid to canvas
When: Rendering grid cells
API:

Renderer.render(result, ctx, config)
renderer.renderColors(result, ctx, colorScale)
renderer.renderGlyphs(result, ctx, onDrawCell, size)

EventBinder

What: Attach/detach events
When: Managing event lifecycle
API:

eventBinder.bind(map, handlers)
eventBinder.unbind()
eventBinder.bindEvent(name, handler)
eventBinder.unbindEvent(name)

EventHandlers

What: Event handler logic
When: Processing map events
API:

EventHandlers.handleHover(event, engine, callback)
EventHandlers.handleClick(event, engine, callback)
EventHandlers.handleZoom(map, config, callback)
EventHandlers.handleMove(callback)

GlyphUtilities

What: Glyph drawing functions
When: Custom visualization in cells
API:

GlyphUtilities.drawCircleGlyph(ctx, x, y, r, color, alpha)
GlyphUtilities.drawBarGlyph(ctx, x, y, vals, max, size, colors)
GlyphUtilities.drawPieGlyph(ctx, x, y, vals, radius, colors)
GlyphUtilities.drawScatterGlyph(ctx, x, y, points, size, color)
GlyphUtilities.drawDonutGlyph(ctx, x, y, vals, outer, inner, colors)
GlyphUtilities.drawHeatmapGlyph(ctx, x, y, r, normVal, colorScale)
GlyphUtilities.drawRadialBarGlyph(ctx, x, y, vals, max, radius, color)
GlyphUtilities.drawTimeSeriesGlyph(ctx, x, y, data, size, options)

GlyphRegistry (v2.0.0+)

What: Plugin registry for reusable glyphs
When: Register custom glyph plugins
API:

GlyphRegistry.register(name, plugin, { overwrite })
GlyphRegistry.get(name)
GlyphRegistry.has(name)
GlyphRegistry.list()
GlyphRegistry.unregister(name)

AggregationModeRegistry (v2.1.0+)

What: Registry for aggregation modes
When: Use or register custom aggregation modes
API:

AggregationModeRegistry.register(name, mode)
AggregationModeRegistry.get(name)
ScreenGridMode             // Rectangular mode
ScreenHexMode              // Hexagonal mode (v2.2.0+)

AggregationFunctions (v2.1.0+)

What: Built-in aggregation functions
When: Customize aggregation behavior
API:

AggregationFunctions.sum      // Default
AggregationFunctions.mean
AggregationFunctions.count
AggregationFunctions.max
AggregationFunctions.min
AggregationFunctionRegistry.register(name, fn)

NormalizationFunctions (v2.1.0+)

What: Built-in normalization functions
When: Customize normalization strategy
API:

NormalizationFunctions.maxLocal     // Default
NormalizationFunctions.maxGlobal
NormalizationFunctions.zScore
NormalizationFunctions.percentile
NormalizationFunctionRegistry.register(name, fn)

Logger (v2.1.0+)

What: Debug logging utility
When: Troubleshooting and development
API:

setDebug(true)                    // Enable globally
Logger.log('message')
Logger.warn('warning')
Logger.error('error')             // Always shown

Data Utilities (v2.1.0+)

What: Data processing helpers
When: Extract/aggregate cellData
API:

groupBy(cellData, key, value, aggregator)
extractAttributes(cellData, extractors)
computeStats(cellData, valueExtractor)
groupByTime(cellData, time, value, period)

Legend (v2.0.0+)

What: Auto-generated legends
When: Display data-driven legends
API:

legend = new Legend({ layer, type, position, title })
legend.update(gridData, config)
legend.show() / legend.hide()
legend.remove()

Placement Modules (v2.1.0+)

What: Geometry placement for non-point inputs
When: Use GeoJSON with polygons/lines
API:

PlacementEngine.processFeatures(features, config)
PlacementValidator.validate(config)
PlacementStrategyRegistry.get(strategy)
GeometryUtils.getCentroid(geometry)

ScreenGridLayerGL

What: Orchestrator (main class)
When: Using the library normally
API:

layer = new ScreenGridLayerGL(options)
layer.setData(newData)
layer.setConfig(updates)
layer.getCellAt(point)
layer.getCellsInBounds(bounds)
layer.getGridStats()

💼 Use Case Examples

Basic Grid Visualization

import { ScreenGridLayerGL } from 'screengrid';

const layer = new ScreenGridLayerGL({
  data: myData,
  cellSizePixels: 50
});
map.addLayer(layer);

Independent Aggregation (e.g., for analysis)

import { Projector, Aggregator } from 'screengrid';

const projector = new Projector(map);
const aggregator = new Aggregator();

const points = projector.project(data, d => d.coords, d => d.value);
const grid = aggregator.aggregate(points, data, 800, 600, 50);
const stats = aggregator.getStats(grid);
console.log(`Found ${stats.cellsWithData} cells with data`);

Advanced Hover/Click

import { CellQueryEngine } from 'screengrid';

const engine = new CellQueryEngine(gridData);

map.on('mousemove', (e) => {
  const cell = engine.getCellAt({ x: e.point.x, y: e.point.y });
  if (cell) {
    console.log(`Cell [${cell.col}, ${cell.row}] = ${cell.value}`);
  }
});

Custom Glyph Drawing

import { ScreenGridLayerGL, GlyphUtilities } from 'screengrid';

const layer = new ScreenGridLayerGL({
  enableGlyphs: true,
  onDrawCell: (ctx, x, y, norm, info) => {
    GlyphUtilities.drawPieGlyph(
      ctx, x, y,
      [10, 20, 30], 15,
      ['#ff0000', '#00ff00', '#0000ff']
    );
  }
});
map.addLayer(layer);

Region Analysis

import { CellQueryEngine } from 'screengrid';

const engine = new CellQueryEngine(gridData);

// Get all cells in a region
const cells = engine.getCellsInBounds({
  minX: 100, minY: 100, maxX: 300, maxY: 300
});

// Get high-value hotspots
const hotspots = engine.getCellsAboveThreshold(50);
console.log(`Found ${hotspots.length} hotspots`);

📊 Module Dependency Graph

┌─────────────────────────────────┐
│    ScreenGridLayerGL            │
│    (Main Class - Orchestrator)  │
└──────────────┬──────────────────┘
               │
    ┌──────────┼──────────┬─────────────┬──────────┐
    │          │          │             │          │
    ▼          ▼          ▼             ▼          ▼
┌────────┐ ┌───────┐ ┌──────────┐ ┌────────┐ ┌──────────┐
│Config  │ │Canvas │ │Events    │ │Core    │ │Glyphs    │
│Manager │ │Mgr    │ │Binder    │ │Logic   │ │Utilities │
└────────┘ └───┬───┘ └────┬─────┘ └───┬────┘ │          │
              │           │           │      │          │
              └───────────┼───────────┘      │          │
                          │                  │          │
                    ┌─────▼──────┐          │          │
                    │Renderer    │ ◄────────┘          │
                    │Event       │                     │
                    │Handlers    │ ◄─────────────────┬─┘
                    └────────────┘                   │
                                               ┌─────▼────┐
                                               │Cell Query│
                                               │Engine    │
                                               └──────────┘

Legend:
┌─────┐ = Single responsibility module
└─────┘ = Composed by orchestrator
  │
  ▼ = Dependency arrow

Key Points:

Core modules (bottom) have NO dependencies on canvas/UI
Orchestrator (top) composes all modules
Glyphs are pure drawing utilities
Clear separation of concerns

🔍 File Location Reference

src/
├── index.js
│   └── Exports all modules
│
├── ScreenGridLayerGL.js
│   └── Main orchestrator class
│
├── config/
│   └── ConfigManager.js
│
├── core/
│   ├── Projector.js
│   ├── Aggregator.js
│   └── CellQueryEngine.js
│
├── canvas/
│   ├── CanvasManager.js
│   └── Renderer.js
│
├── events/
│   ├── EventBinder.js
│   └── EventHandlers.js
│
└── glyphs/
    └── GlyphUtilities.js

✨ New Methods & Features

Added in v2.2.0

// Hexagonal aggregation mode
aggregationMode: 'screen-hex'
aggregationModeConfig: { hexSize: 50, showBackground: true }

Added in v2.1.0

// Geometry input (non-point geometries)
source: geojsonData
placement: { strategy: 'centroid', spacing: { meters: 200 } }
renderMode: 'feature-anchors'
anchorSizePixels: 18

// Aggregation functions
aggregationFunction: 'mean' | 'sum' | 'count' | 'max' | 'min'
aggregationFunction: AggregationFunctions.mean

// Normalization functions
normalizationFunction: 'max-local' | 'max-global' | 'z-score' | 'percentile'
normalizationFunction: NormalizationFunctions.zScore
normalizationContext: { globalMax: 1000 }

// Data utilities
groupBy, extractAttributes, computeStats, groupByTime

// Logger
setDebug(true), Logger.log()

Added in v2.0.0

// Glyph plugin system
glyph: 'circle' | 'bar' | 'pie' | 'heatmap'
GlyphRegistry.register(name, plugin)

// Legend system
Legend class
legend = new Legend({ layer, type, position })

// Time series glyph
GlyphUtilities.drawTimeSeriesGlyph(...)

// Additional glyph types
GlyphUtilities.drawDonutGlyph(...)
GlyphUtilities.drawHeatmapGlyph(...)
GlyphUtilities.drawRadialBarGlyph(...)

Added to Aggregator

aggregator.getStats(result)
// Returns: {totalCells, cellsWithData, maxValue, minValue, avgValue, totalValue}

Added to CellQueryEngine

engine.getCellsInBounds(bounds)
engine.getCellsAboveThreshold(threshold)

Added to ScreenGridLayerGL

layer.getGridStats()        // Get aggregation statistics
layer.getCellsInBounds(...) // Region query

🎓 Common Patterns

Pattern 1: Basic Layer Setup

const layer = new ScreenGridLayerGL(options);
map.addLayer(layer);

Pattern 2: Real-time Data Updates

layer.setData(newData);
layer.render();

Pattern 3: Interactive Queries

map.on('mousemove', (e) => {
  const cell = layer.getCellAt({x: e.point.x, y: e.point.y});
  if (cell) updateUI(cell);
});

Pattern 4: Module Composition

const projector = new Projector(map);
const aggregator = new Aggregator();
const engine = new CellQueryEngine();

// Use independently
const points = projector.project(data, pos, weight);
const result = aggregator.aggregate(points, data, w, h, size);
engine.setAggregationResult(result);

Pattern 5: Custom Rendering

const layer = new ScreenGridLayerGL({
  enableGlyphs: true,
  onDrawCell: (ctx, x, y, norm, info) => {
    // Draw custom visualization
  }
});

🚀 Performance Tips

Use Aggregator independently for calculations without rendering
Reuse CellQueryEngine instead of recalculating queries
Cache aggregation results if data hasn't changed
Use getStats() for analytics without full rendering

📚 Documentation

Complete API Reference: docs/API_REFERENCE.md - Comprehensive API documentation with all methods, parameters, and examples
Architecture Guide: docs/ARCHITECTURE.md - Module design and architecture details
Usage Guide: docs/USAGE.md - Development, examples, and troubleshooting
Glyph Drawing Guide: docs/GLYPH_DRAWING_GUIDE.md - Comprehensive glyph visualization guide
Plugin Ecosystem: docs/PLUGIN_GLYPH_ECOSYSTEM.md - Plugin system documentation
Spatio-Temporal Guide: docs/SPATIO_TEMPORAL_GUIDE.md - Time series visualization patterns
Geometry Input: docs/GEOMETRY_INPUT_AND_PLACEMENT.md - Non-point geometry workflows
Placement Config: docs/PLACEMENT_CONFIG.md - Formal placement configuration schema
Data Utilities: docs/DATA_UTILITIES.md - Utility functions for data processing
Cartography & Design: docs/CARTOGRAPHY_AND_MULTIVARIATE_DESIGN.md - Design patterns and principles

✅ Backward Compatibility

Good news: All original code works unchanged!

// All of this still works exactly the same:
const layer = new ScreenGridLayerGL({...});
map.addLayer(layer);
layer.setData(newData);
layer.setConfig(updates);
ScreenGridLayerGL.drawCircleGlyph(...);  // Static method still available

The refactoring is 100% backward compatible with the original API.

FilesExpand file tree

QUICK_REFERENCE.md

Latest commit

History