MAIDR Documentation - v4.4.0
    Preparing search index...

    Interface ErrorIntervalConfig

    Configuration for the interval drawn around an estimate. Used when chartType is 'error_bar' or 'forest'.

    MAIDR fixes the interval as ABSOLUTE positions on the value axis, while Recharts' <ErrorBar dataKey> points at an OFFSET from the estimate. Both are accepted here and normalised to absolutes: declare errorKey for the Recharts field, or yMinKey/yMaxKey when the data already holds bounds.

    interface ErrorIntervalConfig {
        errorKey?: string;
        yMinKey?: string;
        yMaxKey?: string;
    }
    Index

    Properties

    errorKey? yMinKey? yMaxKey?

    Properties

    errorKey?: string

    Key holding the interval as an offset from the estimate — the field a <ErrorBar dataKey> points at. A number is a symmetric offset; a [lower, upper] pair is an asymmetric one, exactly as Recharts reads it.

    yMinKey?: string

    Key holding the absolute lower bound. Takes precedence over errorKey.

    yMaxKey?: string

    Key holding the absolute upper bound. Takes precedence over errorKey.

    Settings

    Member Visibility

    On This Page

    Properties