Interface: CoreTraceModule<C>

Experimental

A trace type (plan §4.4). schema is the single source of truth for the trace's own attributes; common attributes (visible, name, opacity, …, and xaxis/yaxis for cartesian traces) are added by the registry.

Type Parameters

Type Parameter	Default type
C extends Children	Children

Properties

Property	Modifier	Type	Description
animatable?	readonly	readonly string[]	Experimental Attribute paths that support transitions (E7.3).
calc?	readonly	unknown	Experimental
categories	readonly	readonly TraceCategory[]	Experimental
colorbar?	readonly	unknown	Experimental
crossTraceCalc?	readonly	unknown	Experimental
hoverPoints?	readonly	unknown	Experimental
layoutSchema?	readonly	Children	Experimental Layout attributes owned by this trace type (e.g. barmode), coerced when a trace of this type is present.
legendIcon?	readonly	unknown	Experimental
meta	readonly	TraceModuleMeta	Experimental
plot?	readonly	unknown	Experimental
schema	readonly	ObjectNode<C>	Experimental
selectPoints?	readonly	unknown	Experimental
type	readonly	string	Experimental

Methods

axisHints()?

optional axisHints(trace): TraceAxisHints | undefined;

Experimental

Axis defaults a cartesian trace asks for (ADR-029), called with the defaulted trace while the axes are defaulted: hidden axes, equal scales, and where its positions are when they are not in x / y. Return undefined (or leave the method out) for a trace that is drawn on its axes like any other. The 3D scenes ask it of their traces too, for their three axes.

Parameters

Parameter	Type
trace	FullTrace

Returns

TraceAxisHints | undefined

---

supplyDefaults()

supplyDefaults(
   traceIn,
   traceOut,
   ctx
): void;

Experimental

Fill traceOut from traceIn using ctx.coerce. Called after common attributes are coerced, and only for traces with visible !== false.

Parameters

Parameter	Type
traceIn	Readonly<Record<string, unknown>>
traceOut	FullTrace
ctx	TraceDefaultsContext

Returns

void

---

supplyLayoutDefaults()?

optional supplyLayoutDefaults(
   layoutIn,
   layoutOut,
   ctx
): void;

Experimental

Extra layout defaults logic, run after layoutSchema is coerced.

Parameters

Parameter	Type
layoutIn	Readonly<Record<string, unknown>>
layoutOut	FullLayout
ctx	LayoutDefaultsContext

Returns

void