Interface: TraceA11y

Experimental

The parts of a trace module that TraceModule.a11y loads on first use.

Methods

describe()?

optional describe(ctx): TraceDescription | undefined;

Experimental

See TraceModule.describe.

Parameters

Parameter	Type
ctx	DescribeContext<never>

Returns

TraceDescription | undefined

---

keyboardPoints()?

optional keyboardPoints(
   calc,
   trace,
   ctx
): KeyboardStops | undefined;

Experimental

See TraceModule.keyboardPoints.

Parameters

Parameter	Type
calc	never
trace	FullTrace
ctx	HoverContext

Returns

KeyboardStops | undefined

---

keyboardView()?

optional keyboardView(
   trace,
   ctx,
   action
): Readonly<Record<string, unknown>> | undefined;

Experimental

Keys that move the view of a trace that is not on cartesian axes (3D scenes, maps): + / - ('zoomIn', 'zoomOut'), Shift + arrows ('panLeft', 'panRight', 'panUp', 'panDown': a scene orbits its camera, a map pans or turns) and 0 ('reset'). Returns the relayout that does it, applied like a drag's (a GUI relayout), or undefined when the key does nothing here.

Parameters

Parameter	Type
trace	FullTrace
ctx	HoverContext
action	string

Returns

Readonly<Record<string, unknown>> | undefined

---

keyboardViewSay()?

optional keyboardViewSay(
   trace,
   ctx,
   action,
   update
):
  | readonly [string, Readonly<Record<string, string>> | undefined]
  | undefined;

Experimental

The announcement of a view key this trace took instead of "Zoomed in.", "View rotated." or "View reset." (a map says where its view is now): an English sentence template, which is also its key in a locale dictionary, and values for its placeholders, as in KeyboardPoint.say. update is what keyboardView just returned for action; asked before it is applied. undefined keeps the runtime's sentence.

Parameters

Parameter	Type
trace	FullTrace
ctx	HoverContext
action	string
update	Readonly<Record<string, unknown>>

Returns

| readonly [string, Readonly<Record<string, string>> | undefined] | undefined