stream-charts
    Preparing search index...

    Interface UseChartValues<D, S, TM, AR, A>

    The values exposed through the useChart react hook

    The unique ID for the chart

    The root element for the chart

    The SVG element which is the container for this chart

    interface UseChartValues<
        D,
        S extends SeriesStyle,
        TM,
        AR extends BaseAxisRange,
        A extends BaseAxis,
    > {
        axes: UseAxesValues<AR, A>;
        backgroundColor: string;
        chartId: number;
        color: string;
        container: SVGSVGElement | null;
        hoveredSeriesRef: MutableRefObject<string | null>;
        mainG: GSelection | null;
        mouse: UseMouseValues<D, TM>;
        seriesFilter: RegExp;
        seriesStyles: Map<string, S>;
        svgStyle: Partial<SvgStyle>;
        tooltip: UseTooltipValues<D, TM>;
    }

    Type Parameters

    • D

      The type of the series' datum

    • S extends SeriesStyle

      The type of the series style

    • TM

      The type of the tooltip's metadata (data about the series data)

    • AR extends BaseAxisRange
    • A extends BaseAxis
    Index

    Properties

    axes backgroundColor chartId color container hoveredSeriesRef mainG mouse seriesFilter seriesStyles svgStyle tooltip

    Properties

    axes: UseAxesValues<AR, A>
    backgroundColor: string

    The base/default background color. This can be overridden by the Props.svgStyle property.

    chartId: number

    Unique ID for the chart

    color: string

    Base color

    container: SVGSVGElement | null

    The SVG element which is the container for this chart

    hoveredSeriesRef: MutableRefObject<string | null>

    Ref tracking the currently-hovered series name (null when nothing is hovered). Updated by the Legend; read by plots so new path elements use the correct stroke.

    mainG: GSelection | null

    The root element for the chart

    mouse: UseMouseValues<D, TM>
    seriesFilter: RegExp

    A regular expression uses against the series names to determine which series to show in the chart

    seriesStyles: Map<string, S>

    A map(series_name -> series_line_style)

    svgStyle: Partial<SvgStyle>

    Overrides for the SVG style

    tooltip: UseTooltipValues<D, TM>

    Settings

    Member Visibility

    On This Page

    Properties