Interface: ComponentModule

Experimental

A layout component (plan E22.3): core's layout schema/defaults plus optional margin pushes and drawing. Axes (E3.4), legend (E5.2), title (E5.1), … are components; so are third-party watermarks or brushes.

Extends

• CoreComponentModule

Properties

Property	Modifier	Type	Description	Inherited from
draw?	readonly	ComponentRenderer	Experimental	-
kind?	readonly	"component"	Experimental	-
layoutSchema?	readonly	Children	Experimental	CoreComponentModule.layoutSchema
name	readonly	string	Experimental	CoreComponentModule.name
order?	readonly	number	Experimental Draw order among components (lower first; ties keep registration order). Default 0.	-

Methods

extremes()?

optional extremes(ctx):
  | Readonly<Record<string, AxisExtremes>>
  | undefined;

Experimental

Autorange contributions, by axis id ('x', 'y2'), merged with the traces' extremes: e.g. data-referenced shapes (Plotly's shapes/calc_autorange.js). Called on every autorange pass; axes have their types and scales, ranges are not final yet.

Parameters

Parameter	Type
ctx	ComponentExtremesContext

Returns

| Readonly<Record<string, AxisExtremes>> | undefined

---

pushMargin()?

optional pushMargin(ctx):
  | MarginPush
  | readonly MarginPush[]
  | undefined;

Experimental

Parameters

Parameter	Type
ctx	ComponentLayoutContext

Returns

| MarginPush | readonly MarginPush[] | undefined

---

supplyLayoutDefaults()?

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

Experimental

Parameters

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

Returns

void

Inherited from

CoreComponentModule.supplyLayoutDefaults