Interface: ChartRegistry

Properties

Property	Modifier	Type	Description
core	readonly	Registry	The core registry: schemas, templates, defaults and edit-type planning.

Methods

components()

components(): readonly ComponentModule[];

Components in draw order (order, then registration order).

Returns

readonly ComponentModule[]

---

getComponent()

getComponent(name): ComponentModule | undefined;

Parameters

Parameter	Type
name	string

Returns

ComponentModule | undefined

---

getTrace()

getTrace(type):
  | TraceModule<unknown, Children>
  | undefined;

Parameters

Parameter	Type
type	string

Returns

| TraceModule<unknown, Children> | undefined

---

list()

list(): RegistryListing;

Introspection: everything registered.

Returns

RegistryListing

---

register()

register(...modules): ChartRegistry;

Register trace modules, components, templates and locales, in any mix. Registering the same object again is a no-op; registering a different module under a taken name replaces it and warns. Locales ({ moduleType: 'locale', name, dictionary, format }, plotly.js's shape) merge silently as in Plotly: a module without a dictionary or format keeps the earlier one.

Parameters

Parameter	Type
...modules	readonly Registrable[]

Returns

ChartRegistry

---

setDefaultTemplate()

setDefaultTemplate(name): ChartRegistry;

Set the template applied when layout.template is unset, by registered name, or undefined for none (Plotly's schema defaults). Applies from the next render of each chart (any update, react or new chart). Warns when the name is not registered.

Parameters

Parameter	Type
name	string | undefined

Returns

ChartRegistry

Example

registry.setDefaultTemplate('plotly-classic'); // Plotly's look for figures without a template