API REFERENCE

SankeyStreamSource

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

Type declaration

typescript
export interface SankeyStreamSource {
  readonly length: number;
  readonly capacity: number;
  readonly dropped: number;
  push(link: SankeyLinkInput): void;
  pushBatch(links: ReadonlyArray<SankeyLinkInput>): void;
  shift(count: number): void;
  replace(links: ReadonlyArray<SankeyLinkInput>): void;
  snapshot(): SankeyLinkInput[];
  subscribe(listener: (event: SankeyStreamEvent) => void): () => void;
}