API REFERENCE

HeatmapStreamSource

The HeatmapStreamSource type declaration and related types. Optional fields are marked with ?.

Type declaration

typescript
export interface HeatmapStreamSource {
  push(cell: HeatmapDatum | HeatmapTuple): void;
  pushBatch(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): void;
  shift(count: number): void;
  replace(cells: ReadonlyArray<HeatmapDatum | HeatmapTuple>): void;
  snapshot(): HeatmapDatum[];
  latest(): HeatmapDatum | undefined;
  subscribe(listener: (event: HeatmapStreamEvent) => void): () => void;
  readonly length: number;
  readonly capacity: number;
}