Reincharts
    Preparing search index...

    Interface SvgPathAnnotationProps

    interface SvgPathAnnotationProps {
        className?: string;
        data?: any;
        fill?: string | ((data: any) => string);
        onClick?: (
            e: MouseEvent,
            data: {
                data: any;
                xScale?: ScaleContinuousNumeric<number, number, never>;
                yScale?: ScaleContinuousNumeric<number, number, never>;
            },
        ) => void;
        opacity?: number;
        path: (data: any) => string;
        pathHeight: number;
        pathWidth: number;
        plotData: any[];
        stroke?: string;
        tooltip?: string | ((data: any) => string);
        x?:
            | number
            | (
                (
                    __namedParameters: {
                        data: any;
                        plotData: any[];
                        xAccessor: (data: any) => any;
                        xScale: ScaleContinuousNumeric<number, number>;
                    },
                ) => number
            );
        xAccessor?: (data: any) => any;
        xScale?: ScaleContinuousNumeric<number, number, never>;
        y?:
            | number
            | (
                (
                    __namedParameters: {
                        data: any;
                        plotData: any[];
                        yScale: ScaleContinuousNumeric<number, number>;
                    },
                ) => number
            );
        yScale?: ScaleContinuousNumeric<number, number, never>;
    }
    Index

    Properties

    className? data? fill? onClick? opacity? path pathHeight pathWidth plotData stroke? tooltip? x? xAccessor? xScale? y? yScale?

    Properties

    className?: string

    CSS class name for styling the SVG path annotation.

    data?: any

    Data point associated with this annotation.

    fill?: string | ((data: any) => string)

    Fill color for the SVG path, can be static string or function based on data.

    onClick?: (
        e: MouseEvent,
        data: {
            data: any;
            xScale?: ScaleContinuousNumeric<number, number, never>;
            yScale?: ScaleContinuousNumeric<number, number, never>;
        },
    ) => void

    Click event handler that receives mouse event and scale/data data.

    opacity?: number

    Opacity level of the SVG path (0-1).

    path: (data: any) => string

    Function that generates the SVG path string based on data.

    pathHeight: number

    Height of the SVG path in pixels.

    pathWidth: number

    Width of the SVG path in pixels.

    plotData: any[]

    Array of plot data points.

    stroke?: string

    Stroke color for the SVG path border.

    tooltip?: string | ((data: any) => string)

    Tooltip text to display on hover, can be static string or function based on data.

    x?:
        | number
        | (
            (
                __namedParameters: {
                    data: any;
                    plotData: any[];
                    xAccessor: (data: any) => any;
                    xScale: ScaleContinuousNumeric<number, number>;
                },
            ) => number
        )

    X position of the annotation, can be static number or function that calculates position based on scales and data.

    xAccessor?: (data: any) => any

    Function to extract x-value from data points.

    xScale?: ScaleContinuousNumeric<number, number, never>

    D3 scale for x-axis positioning.

    y?:
        | number
        | (
            (
                __namedParameters: {
                    data: any;
                    plotData: any[];
                    yScale: ScaleContinuousNumeric<number, number>;
                },
            ) => number
        )

    Y position of the annotation, can be static number or function that calculates position based on scales and data.

    yScale?: ScaleContinuousNumeric<number, number, never>

    D3 scale for y-axis positioning.

    Settings

    Member Visibility

    On This Page

    Properties