API Reference

Complete API documentation for d3-hockey.

Core Components

Component	Description
Rink	Main visualization class
EventLayer	Individual event markers
HeatmapLayer	Continuous density maps
HexbinLayer	Hexagonal binning/density maps
BaseLayer	Abstract base for custom layers
LayerManager	Layer lifecycle management

Reference

Page	Description
Types	Core TypeScript definitions
Utilities	Coordinate, color, scale, and data utilities

Quick Example

import { Rink, NHLDataManager } from "d3-hockey";

const manager = await NHLDataManager.fromGameId("2023020001");
const shots = manager.getAllEvents({ shotsOnly: true });

new Rink("#container")
  .width(900)
  .height(450)
  .render()
  .addEvents(shots, {
    id: "shots",
    color: (d) => (d.type === "goal" ? "gold" : "blue"),
  });

Exports

// Classes
export {
  Rink,
  EventLayer,
  HexbinLayer,
  HeatmapLayer,
  BaseLayer,
  LayerManager,
  NHLDataManager,
};

// Core types
export type {
  NHLCoordinate,
  SVGCoordinate,
  PeriodInfo,
  HockeyEvent,
  Accessor,
  RinkConfig,
  RinkColors,
  RenderDimensions,
  HockeyEventSymbolType,
  AnimationEasing,
};

// Layer types
export type {
  BaseLayerConfig,
  EventLayerConfig,
  EventRenderContext,
  HexbinLayerConfig,
  HexbinRenderContext,
  HeatmapLayerConfig,
  HeatmapRenderContext,
  HeatmapGridData,
  AggregationFunction,
  BuiltInAggregation,
};

// NHL types
export type {
  NHLEvent,
  NHLPlayByPlayResponse,
  NHLEventWithLocation,
  NHLEventWithoutLocation,
  NHLPlayerResponse,
  NHLPlayerInfo,
  NHLTeamInfo,
  NHLBaseEvent,
  PeriodDescriptor,
  EventDetailsWithLocation,
  GoalEvent,
  ShotOnGoalEvent,
  MissedShotEvent,
  BlockedShotEvent,
  HitEvent,
  GiveawayEvent,
  TakeawayEvent,
  PenaltyEvent,
  FetchOptions,
  TeamData,
  ParseOptions,
};

// Type guards
export {
  hasLocation,
  isGoal,
  isShotOnGoal,
  isMissedShot,
  isBlockedShot,
  isHit,
  isGiveaway,
  isTakeaway,
  isPenalty,
  isShotEvent,
  NHL_EVENT_TYPE_CODES,
};

// Coordinate utilities
export {
  nhlToSVG,
  svgToNHL,
  flipCoordinatesByPeriod,
  normalizeCoordinate,
  calculateScale,
  getDistance,
  getZone,
};

// Data utilities
export {
  hasValidCoordinates,
  validateCoordinates,
  filterByZone,
  filterByTeam,
  filterByPeriod,
  groupBy,
  calculateStats,
};

// Color utilities
export {
  NHL_TEAM_COLORS,
  getTeamColors,
  getTeamPrimaryColor,
  HOCKEY_COLOR_SCALES,
  createColorScale,
  getShotResultColor,
  getOpacity,
  colorByProperty,
  colorByTeam,
  colorByCategory,
  colorGradient,
  colorByCondition,
};

// Scale utilities
export {
  scaleRadiusByProperty,
  scaleOpacityByProperty,
  scaleByProperty,
  scaleSqrtByProperty,
  scaleLogByProperty,
  scaleByThresholds,
  type ScaleOptions,
  type RadiusScaleOptions,
  type OpacityScaleOptions,
};

// Parser functions
export {
  nhlEventToHockeyEvent,
  parseNHLEvents,
  parseNHLPlayByPlay,
  parseNHLEventsWithFilter,
  parseNHLEventsByTeam,
};