Skip to main content

Type Alias: BarLabelPolicy

BarLabelPolicy = "fitBar" | "inside" | "outside" | "insideOrNone" | "none"

Defined in: layout/renderer.ts:101

Where the default bar label paints, when no barRenderer already owns the bar's content. 'fitBar' (the default) reads inside when the label fits, outside to the right when it does not, and falls back to inside, ellipsised, when neither fits — a family with the shipped range: 'fitDataset' and gridWidth: 'fitColumns'. 'inside' and 'outside' force one placement regardless of fit (ellipsised inside, or clipped at the pane edge outside — the same load-bearing fallback 'fitBar''s third clause takes). 'insideOrNone' also reads the fit predicate 'fitBar' already computes, but spends a bar that doesn't fit on no label at all rather than on an outside placement — a consumer painting contiguous bars edge to edge (a day-tile grid, #435) cannot let a label escape into the next bar the way 'fitBar''s and 'outside''s fallbacks both do. 'none' paints no label at all regardless of fit, and — like 'insideOrNone' on a bar that doesn't fit — a barRenderer sees no ctx.label either: one answer to "did the consumer ask for a label", for the library's own paint and for a renderer's alike.

Named Policy, not BarLabels: this is one Gantt-wide or per-variant setting's policy half (#421 C5). BarLabels below is the wider public type a consumer actually writes.