stream-charts
    Preparing search index...

    Interface Props<CD, D>

    interface Props<CD extends ChartData, D> {
        children: Element | Element[];
        onSubscribe?: (subscription: Subscription) => void;
        onUpdateChartTime?: (time: number) => void;
        onUpdateData?: (seriesName: string, data: D[]) => void;
        seriesObservable?: Observable<CD>;
        shouldSubscribe?: boolean;
        windowingTime?: number;
    }

    Type Parameters

    Index

    Properties

    children onSubscribe? onUpdateChartTime? onUpdateData? seriesObservable? shouldSubscribe? windowingTime?

    Properties

    children: Element | Element[]
    onSubscribe?: (subscription: Subscription) => void

    Callback function that is called when the chart subscribes to the observable

    Type Declaration

      • (subscription: Subscription): void

      • Parameters

        • subscription: Subscription

          The subscription resulting form the subscribe action

        Returns void

    onUpdateChartTime?: (time: number) => void
    onUpdateData?: (seriesName: string, data: D[]) => void

    Callback function that is called when new data arrives to the chart.

    Type Declaration

      • (seriesName: string, data: D[]): void

      • Parameters

        • seriesName: string

          The name of the series for which new data arrived

        • data: D[]

          The new data that arrived in the windowing tine

        Returns void

    UseChartValues.windowingTime

    seriesObservable?: Observable<CD>
    shouldSubscribe?: boolean
    windowingTime?: number

    Settings

    Member Visibility

    On This Page

    Properties