Skip to main content

Interface: FrameBar

Defined in: layout/frame.ts:225

Properties​

a11yLabel​

a11yLabel: string

Defined in: layout/frame.ts:263

What a screen reader announces: ${label}, ${formatStartAndEnd(bar, ctx)}, or the dates alone when label is '' (#421 C5) — a nameless Entry still reads its dates, never a leading ", ". Library-derived text, not consumer render output — same precedent as label (plans/01 §4: "no user render output in the frame"). Composed here because it needs the dataset zone and inclusive-end formatting, both time/-only.

entryId​

entryId: EntryId

Defined in: layout/frame.ts:227

flags​

flags: BarFlags

Defined in: layout/frame.ts:240

height​

height: number

Defined in: layout/frame.ts:239

id​

id: BarId

Defined in: layout/frame.ts:226

label​

label: string

Defined in: layout/frame.ts:235

What a backend renders as the bar's label (#26) — LayoutInput.barLabelFor's own answer for this Bar's Entry, or the Bar's own label when no resolver is bound. '' when the Entry has no name and no resolver names a Field with a value: no label paints, and a barRenderer sees no ctx.label either (#421 C5).

locked?​

optional locked?: boolean

Defined in: layout/frame.ts:243

true when the Entry's bar does not move for a user (a locked Entry). Absent otherwise. render/ stamps it as data-locked.

rowId​

rowId: RowId

Defined in: layout/frame.ts:228

span​

span: BarSpanKind

Defined in: layout/frame.ts:257

What barSpan did to this bar's painted [x, x + width) extent: 'exact' for the entry's own span, painted whole; 'clipped' for that same span cut at a content edge — x/width are not the entry's own start/end here, so a reader that wants the real dates reads the Entry, not this geometry (#436 branch review); 'minimum' for one barSpan widened to reach minBarWidthPx, and 'fixed' for a Bar that carries its own box (ADR 0022) — both of those two may also be shifted or width-capped to stay inside the content. One value, because a bar is never two of these at once — data-span is one attribute slot, so the type mirrors the DOM it feeds.

States a fact about the paint, not a judgement on the variant (plans/01 §2.5 bans a variant check here); a consumer tells a clipped, floored, or fixed bar apart by pairing this with variant. render/ stamps it as data-span="clipped", "minimum", or "fixed" (02 §4) — 'exact' alone carries no attribute, since it is the paint a reader assumes by default.

variant​

variant: string

Defined in: layout/frame.ts:230

The variant this bar draws as (ADR 0018) — the data-variant render/ stamps.

width​

width: number

Defined in: layout/frame.ts:238

x​

x: number

Defined in: layout/frame.ts:236

y​

y: number

Defined in: layout/frame.ts:237