Reincharts
    Preparing search index...

    Interface DrawingProps

    interface DrawingProps {
        appearance: {
            selectedStroke: string;
            selectedStrokeWidth: number;
            stroke: string;
            strokeWidth: number;
            tolerance: number;
        };
        currentPositionOpacity?: number;
        currentPositionRadius?: number;
        currentPositionStroke?: string;
        currentPositionStrokeWidth?: number;
        drawings: {
            appearance?: {
                selectedStroke: string;
                selectedStrokeWidth: number;
                stroke: string;
                strokeWidth: number;
                tolerance: number;
            };
            points: [number, number][];
            selected?: boolean;
        }[];
        enabled: boolean;
        hoverText: {
            bgFill: string;
            bgHeight: string
            | number;
            bgWidth: string | number;
            enable: boolean;
            fill: string;
            fontFamily: string;
            fontSize: number;
            text: string;
        };
        onComplete?: (e: MouseEvent, newDrawings: any[], moreProps: any) => void;
        onSelect?: (
            e: MouseEvent,
            index: undefined | number,
            moreProps: any,
        ) => void;
        onStart?: () => void;
    }
    Index

    Properties

    appearance currentPositionOpacity? currentPositionRadius? currentPositionStroke? currentPositionStrokeWidth? drawings enabled hoverText onComplete? onSelect? onStart?

    Properties

    appearance: {
        selectedStroke: string;
        selectedStrokeWidth: number;
        stroke: string;
        strokeWidth: number;
        tolerance: number;
    }

    Styling configuration for the drawing appearance.

    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.

    drawings: {
        appearance?: {
            selectedStroke: string;
            selectedStrokeWidth: number;
            stroke: string;
            strokeWidth: number;
            tolerance: number;
        };
        points: [number, number][];
        selected?: boolean;
    }[]

    Array of drawing objects that get drawn.

    enabled: boolean

    Whether the drawing tool is enabled.

    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, newDrawings: any[], moreProps: any) => void

    Callback function triggered when drawing is completed. newDrawings is a list of all drawings with the new/updated drawing included.

    onSelect?: (e: MouseEvent, index: undefined | number, moreProps: any) => void

    Callback function triggered when a drawing is selected. index is the selected drawing index

    onStart?: () => void

    Callback function triggered when drawing starts.

    Settings

    Member Visibility

    On This Page

    Properties