Reincharts
    Preparing search index...

    Interface GannFanProps

    interface GannFanProps {
        appearance: {
            edgeFill: string;
            edgeStroke: string;
            edgeStrokeWidth: number;
            fill: string[];
            fontFamily: string;
            fontFill: string;
            fontSize: number;
            r: number;
            stroke: string;
            strokeWidth: number;
        };
        currentPositionOpacity?: number;
        currentPositionRadius?: number;
        currentPositionStroke?: string;
        currentPositionStrokeWidth?: number;
        enabled: boolean;
        fans: any[];
        hoverText: {
            bgFill: string;
            bgHeight: string
            | number;
            bgWidth: string | number;
            enable: boolean;
            fill: string;
            fontFamily: string;
            fontSize: number;
            text: string;
        };
        onComplete?: (e: MouseEvent, newfans: any[], moreProps: any) => void;
        onStart?: () => void;
    }
    Index

    Properties

    appearance currentPositionOpacity? currentPositionRadius? currentPositionStroke? currentPositionStrokeWidth? enabled fans hoverText onComplete? onStart?

    Properties

    appearance: {
        edgeFill: string;
        edgeStroke: string;
        edgeStrokeWidth: number;
        fill: string[];
        fontFamily: string;
        fontFill: string;
        fontSize: number;
        r: number;
        stroke: string;
        strokeWidth: number;
    }

    Styling configuration for the fan appearance including strokes, fills, fonts, and edge styling.

    currentPositionOpacity?: number

    Opacity of the current position indicator.

    currentPositionRadius?: number

    Radius of the current position indicator.

    currentPositionStroke?: string

    Stroke color for the current position indicator.

    currentPositionStrokeWidth?: number

    Width of the current position indicator stroke.

    enabled: boolean

    Whether the Gann fan drawing tool is enabled.

    fans: any[]

    Array of Gann fan objects that get drawn.

    hoverText: {
        bgFill: string;
        bgHeight: string | number;
        bgWidth: string | number;
        enable: boolean;
        fill: string;
        fontFamily: string;
        fontSize: number;
        text: string;
    }

    Configuration for hover text display.

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

    Callback function triggered when fan drawing is completed. newfans is a list of all fans with the new/updated fan included.

    onStart?: () => void

    Callback function triggered when fan drawing starts.

    Settings

    Member Visibility

    On This Page

    Properties