Reincharts
    Preparing search index...

    Interface HoverTooltipProps

    interface HoverTooltipProps {
        background?: {
            fillStyle?: string;
            height?: number;
            strokeStyle?: string;
            width?: number;
        };
        backgroundShapeCanvas: (
            props: HoverTooltipProps,
            __namedParameters: { height: number; width: number },
            ctx: CanvasRenderingContext2D,
        ) => void;
        chartId?: string | number;
        fontFamily?: string;
        fontFill?: string;
        fontSize?: number;
        origin?: (
            props: HoverTooltipProps,
            moreProps: any,
            bgSize: { height: number; width: number },
            pointWidth: number,
        ) => [number, number];
        tooltip: {
            content: (
                data: any,
            ) => {
                x: string;
                y: { label: string; stroke?: string; value?: string }[];
            };
        };
        tooltipCanvas: (
            props: HoverTooltipProps,
            content: any,
            ctx: CanvasRenderingContext2D,
        ) => void;
        toolTipFillStyle?: string;
        toolTipStrokeStyle?: string;
        toolTipStrokeWidth?: number;
        yAccessor: (data: any) => number;
    }
    Index

    Properties

    background? backgroundShapeCanvas chartId? fontFamily? fontFill? fontSize? origin? tooltip tooltipCanvas toolTipFillStyle? toolTipStrokeStyle? toolTipStrokeWidth? yAccessor

    Properties

    background?: {
        fillStyle?: string;
        height?: number;
        strokeStyle?: string;
        width?: number;
    }

    Background styling configuration for the tooltip.

    Type Declaration

    • OptionalfillStyle?: string

      Fill color for the tooltip background.

    • Optionalheight?: number

      Height of the tooltip background.

    • OptionalstrokeStyle?: string

      Stroke color for the tooltip background border.

    • Optionalwidth?: number

      Width of the tooltip background.

    backgroundShapeCanvas: (
        props: HoverTooltipProps,
        __namedParameters: { height: number; width: number },
        ctx: CanvasRenderingContext2D,
    ) => void

    Custom function to draw the tooltip background shape on canvas.

    chartId?: string | number

    ID of the chart this tooltip belongs to.

    fontFamily?: string

    Font family for the tooltip text.

    fontFill?: string

    Fill color for the tooltip text.

    fontSize?: number

    Font size for the tooltip text.

    origin?: (
        props: HoverTooltipProps,
        moreProps: any,
        bgSize: { height: number; width: number },
        pointWidth: number,
    ) => [number, number]

    Function to calculate the tooltip position origin.

    tooltip: {
        content: (
            data: any,
        ) => { x: string; y: { label: string; stroke?: string; value?: string }[] };
    }

    Configuration for tooltip content generation.

    Type Declaration

    • content: (
          data: any,
      ) => { x: string; y: { label: string; stroke?: string; value?: string }[] }

      Function to generate tooltip content from data.

    tooltipCanvas: (
        props: HoverTooltipProps,
        content: any,
        ctx: CanvasRenderingContext2D,
    ) => void

    Custom function to render tooltip content on canvas.

    toolTipFillStyle?: string

    Fill color for the tooltip container.

    toolTipStrokeStyle?: string

    Stroke color for the tooltip container border.

    toolTipStrokeWidth?: number

    Width of the tooltip container border.

    yAccessor: (data: any) => number

    Function to access Y-axis values from data for tooltip positioning.

    Settings

    Member Visibility

    On This Page

    Properties