stream-charts
    Preparing search index...
    interface Props {
        axisAssignments?: Map<string, AxesAssignment>;
        dropDataAfter?: number;
        interpolation?: CurveFactory;
        panEnabled?: boolean;
        timeWindowBehavior?: TimeWindowBehavior;
        withCadenceOf?: number;
        zoomEnabled?: boolean;
        zoomKeyModifiersRequired?: boolean;
    }
    Index

    Properties

    axisAssignments?: Map<string, AxesAssignment>

    Holds the mapping between a series and the axis it uses (is assigned). The map's key holds the series name, and the value is an AxesAssignment object holding the ID of the assigned x-axis and y-axis.

    dropDataAfter?: number

    The number of milliseconds of data to hold in memory before dropping it. Defaults to infinity (i.e. no data is dropped)

    interpolation?: CurveFactory

    The line interpolation curve factory. See the d3 documentation for curves at https://github.com/d3/d3-shape#curves for information on available interpolations

    panEnabled?: boolean

    Enables panning (default is false)

    timeWindowBehavior?: TimeWindowBehavior
    withCadenceOf?: number

    When set, uses a cadence with the specified refresh period (in milliseconds). For plots where the updates are slow (> 100 ms) using a cadence of 10 to 25 ms smooths out the updates and makes the plot updates look cleaner. When updates are around 25 ms or less, then setting the cadence period too small will result in poor update performance. Generally at high update speeds, the cadence is unnecessary. Finally, using cadence, sets the max time to the current time.

    zoomEnabled?: boolean

    Enables zooming (default is false)

    zoomKeyModifiersRequired?: boolean

    When true, requires that the shift or control key be pressed while scrolling in order to activate the zoom