Interface: FrameInput<D>

An animation frame (figure.frames[i], addFrames): trace and layout changes applied as one step, like Plotly's frames.

Type Parameters

Type Parameter	Default type	Description
D extends object	TraceInput	The trace type (see FigureInput).

Indexable

[key: string]: unknown

Properties

Property	Modifier	Type	Description
baseframe?	readonly	string | number	Name of a frame this one extends: its data and layout apply first.
data?	readonly	readonly (Partial<D> | null | undefined)[]	Trace changes, merged into the traces listed in traces (default: trace i for data[i]). A frame's trace may leave out type.
group?	readonly	string | number	Group name: animate('group') plays the frames of a group in order.
layout?	readonly	Readonly<Record<string, unknown>>	Layout changes (attribute strings such as 'xaxis.range' work too).
name?	readonly	string | number	Name to animate to (numbers are converted to strings). Unnamed frames get 'frame N'.
traces?	readonly	number | readonly number[]	Trace indices data applies to.