OptionaltitleOverrides the layer's announced title. Maps to MaidrLayer.title.
Names the chart; use DeclarationBase.name to say which layer of it this is.
OptionalnameNames this layer among sibling layers. Maps to MaidrLayer.name.
Announced on a layer switch in place of the trace type, so a hue-split figure says "Male" and "Female" rather than "error_bar plot" twice.
TraceType.SURVIVAL — the string 'survival'.
OptionalcensoredField marking a sample as a censored time. Maps to SurvivalPoint.censored.
true, 1, '1' and 'true' count as censored; anything else does
not — the flag arrives as a boolean, as a 0/1 indicator or as the string
one of those was parsed from, and '0' is truthy in every one of those
readings but censors nobody. The same table decides
ForestDeclaration.pooled.
Deliberately not aliased to event, which most survival datasets
carry with the opposite meaning: a 1 there is the event happening, which
is exactly the times that are not censored.
OptionalyField holding the confidence band's lower bound at this time. Maps to
SurvivalPoint.yMin.
OptionalyField holding the confidence band's upper bound at this time. Maps to
SurvivalPoint.yMax.
OptionalstepWhere the curve jumps between times. Maps to MaidrLayer.stepDirection.
'hv' is what a Kaplan-Meier curve means — survival holds until an event
drops it — but MAIDR substitutes no default of its own, so declare it
rather than letting the description stay silent about the convention.
OptionalcensoredCompanion series drawing the censoring ticks, when they come from their
own data join rather than from a censored column on the curve.
Each tick is merged into this layer at the time its x gives, and the
companion is suppressed from becoming a layer of its own. Highcharts
charts that already pair with linkedTo need not repeat themselves here.
OptionalbandCompanion series drawing the confidence band, merged in by x as above.
OptionalmergeAbsorb following sibling series of the same drawn kind into this layer as further arms of the same curve, as ManhattanDeclaration.merge absorbs further points into one cloud.
On by default, because a survival figure is one figure whose arms belong
together: treated and control are read against each other, and two arms
split into two layers is a reader switching layers to compare the two
numbers the chart exists to compare. SurvivalTrace carries an arm per
row, so the arms stay individually navigable either way.
Set false for the rare figure whose curves are genuinely separate
charts. A second arm needs no declaration block of its own.
A Kaplan-Meier survival curve drawn as a step line.
What a survival figure carries beyond a step chart is the two things it is read for: which times were censored, and how wide the confidence band is. Censoring marks are drawn as ticks rather than as steps, and 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.
Example