Reincharts
    Preparing search index...

    Interface ChartProps

    interface ChartProps {
        flipYScale?: boolean;
        height?: number | ((height: number) => number);
        id: string | number;
        onContextMenu?: (event: MouseEvent, moreProps: any) => void;
        onDoubleClick?: (event: MouseEvent, moreProps: any) => void;
        origin?:
            | number[]
            | ((width: number, height: number, chartHeight: number) => number[]);
        padding?: number | { bottom: number; top: number };
        yExtents?: number[] | ((data: any) => number) | ((data: any) => number[]);
        yExtentsCalculator?: (
            options: {
                displayXAccessor: any;
                fullData: any[];
                plotData: any[];
                xAccessor: any;
                xDomain: any;
            },
        ) => number[];
        yPan?: boolean;
        yPanEnabled?: boolean;
        yScale?: ScaleContinuousNumeric<number, number, never>;
    }
    Index

    Properties

    flipYScale? height? id onContextMenu? onDoubleClick? origin? padding? yExtents? yExtentsCalculator? yPan? yPanEnabled? yScale?

    Properties

    flipYScale?: boolean

    Whether to flip the Y scale direction.

    height?: number | ((height: number) => number)

    Height of the chart or function to calculate height.

    id: string | number

    Unique identifier for the chart.

    onContextMenu?: (event: MouseEvent, moreProps: any) => void

    Context menu event handler.

    onDoubleClick?: (event: MouseEvent, moreProps: any) => void

    Double click event handler.

    origin?:
        | number[]
        | ((width: number, height: number, chartHeight: number) => number[])

    Origin position of the chart.

    padding?: number | { bottom: number; top: number }

    Padding around the chart content.

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

    Y extents for the chart scale. Accepts:

    • a static number array to set a fixed domain,
    • a function returning a single number for each data point, to compute a dynamic domain,
    • a function returning an array of numbers (e.g., [low, high]) to include multiple values per data point.
    yExtentsCalculator?: (
        options: {
            displayXAccessor: any;
            fullData: any[];
            plotData: any[];
            xAccessor: any;
            xDomain: any;
        },
    ) => number[]

    Custom Y extents calculator function.

    yPan?: boolean

    Whether Y panning is enabled.

    yPanEnabled?: boolean

    Whether Y pan is currently enabled.

    yScale?: ScaleContinuousNumeric<number, number, never>

    Y scale instance to use.

    Settings

    Member Visibility

    On This Page

    Properties