Reincharts
    Preparing search index...

    Interface TrendLineProps

    interface TrendLineProps {
        appearance: {
            edgeFill: string;
            edgeStroke: string;
            edgeStrokeWidth: number;
            strokeDasharray: strokeDashTypes;
            strokeStyle: string;
            strokeWidth: number;
        };
        currentPositionOpacity?: number;
        currentPositionRadius?: number;
        currentPositionStroke?: string;
        currentPositionStrokeWidth?: number;
        enabled: boolean;
        hoverText: object;
        onComplete?: (e: MouseEvent, newTrends: any[], moreProps: any) => void;
        onStart?: (e: MouseEvent, moreProps: any) => void;
        shouldDisableSnap?: (e: MouseEvent) => boolean;
        snap?: boolean;
        snapTo?: (data: any) => number | number[];
        trends: any[];
        type: "XLINE" | "RAY" | "LINE";
    }
    Index

    Properties

    appearance currentPositionOpacity? currentPositionRadius? currentPositionStroke? currentPositionStrokeWidth? enabled hoverText onComplete? onStart? shouldDisableSnap? snap? snapTo? trends type

    Properties

    appearance: {
        edgeFill: string;
        edgeStroke: string;
        edgeStrokeWidth: number;
        strokeDasharray: strokeDashTypes;
        strokeStyle: string;
        strokeWidth: number;
    }

    Styling configuration for the trendline appearance.

    currentPositionOpacity?: number

    Opacity of the current position indicator.

    currentPositionRadius?: number

    Radius of the current position indicator.

    currentPositionStroke?: string

    Color of the current position indicator.

    currentPositionStrokeWidth?: number

    Width of the current position indicator.

    enabled: boolean

    Enable or disable the interactive trendline tool.

    hoverText: object

    Configuration for text to display while a trendline is hovered over.

    onComplete?: (e: MouseEvent, newTrends: any[], moreProps: any) => void

    Callback function triggered when trendline drawing is completed. newTrends is a list of all trends with the new/updated trend included.

    onStart?: (e: MouseEvent, moreProps: any) => void

    Callback function triggered when trendline drawing starts.

    shouldDisableSnap?: (e: MouseEvent) => boolean

    Function to determine when snapping should be disabled.

    snap?: boolean

    Enable snapping to data points.

    snapTo?: (data: any) => number | number[]

    Function or value to determine snap target position.

    trends: any[]

    Array of trendline objects that get drawn.

    type: "XLINE" | "RAY" | "LINE"

    Type of trendline drawing.

    Settings

    Member Visibility

    On This Page

    Properties