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

    Interface SurvivalCurveConfig

    Configuration for Kaplan-Meier survival curves. Optional when chartType is 'survival'.

    The key arrays map 1:1 with yKeys — the i-th entry belongs to the i-th arm — the same way fillKeys names the i-th series.

    interface SurvivalCurveConfig {
        censoredKeys?: string[];
        yMinKeys?: string[];
        yMaxKeys?: string[];
        stepDirection?: StepDirection;
    }
    Index

    Properties

    censoredKeys? yMinKeys? yMaxKeys? stepDirection?

    Properties

    censoredKeys?: string[]

    Keys whose truthy value marks a censored time, one per arm.

    Censoring is not an event: the curve does not step there. A reader who cannot tell a censored time from an ordinary one cannot tell a flat tail backed by two hundred subjects from one backed by three.

    yMinKeys?: string[]

    Keys for the lower bound of the confidence band, one per arm.

    yMaxKeys?: string[]

    Keys for the upper bound of the confidence band, one per arm.

    stepDirection?: StepDirection

    Where the curve jumps between times. Defaults to 'hv', which is what <Line type="stepAfter"> draws and what a Kaplan-Meier curve means: survival holds until an event drops it. Declare 'vh' for a curve drawn with type="stepBefore".

    Settings

    Member Visibility

    On This Page

    Properties