Skip to content

Interface: FigureInput<D, L> ​

A figure as passed by the user (plan ADR-001).

Generic so that one shape serves every bundle: the defaults accept any trace and type the base layout (partial bundles, plugins); FigureInput<ScatterTrace | BarTrace> types the traces a partial bundle registers; the full bundle's Figure is FigureInput<Data, Layout>, every built-in trace and layout attribute typed.

Type Parameters ​

Type ParameterDefault typeDescription
D extends objectTraceInputThe trace type: a union discriminated on type, such as Data.
L extends objectLayoutInputThe layout type.

Properties ​

PropertyTypeDescription
config?Config-
data?readonly D[]-
datasets?Readonly<Record<string, Readonly<Record<string, unknown>>>>Named column tables that traces reference with dataset: 'name' and '@column' strings (plan E1.6), e.g. { sales: { date: [...], revenue: Float64Array } }.
frames?readonly FrameInput<D>[]-
layout?L-

Released under the MIT License.