API REFERENCE

SunburstStreamSource

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

Type declaration

typescript
export interface SunburstStreamSource {
  readonly length: number;
  readonly capacity: number;
  readonly dropped: number;
  push(node: SunburstNodeInput): void;
  pushBatch(nodes: ReadonlyArray<SunburstNodeInput>): void;
  shift(count: number): void;
  replace(nodes: ReadonlyArray<SunburstNodeInput>): void;
  snapshot(): SunburstNodeInput[];
  subscribe(listener: (event: SunburstStreamEvent) => void): () => void;
}