PluginRegistry

Documentation

Documentation / @elitechart/core / PluginRegistry

Defined in: plugin/registry.ts:37

Per-chart map of registered plugins, keyed by plugin id. Most embedders use the chart.registerPlugin(...) / unregisterPlugin facade rather than touching the registry directly.

Example

code

import { PluginRegistry } from '@elitechart/core';
const reg = new PluginRegistry();
reg.register(myIndicatorPlugin);
for (const p of reg.listByKind('indicator')) console.log(p.name);

Constructors

Constructor

code

new PluginRegistry(): PluginRegistry;

Returns

PluginRegistry

Accessors

size

Get Signature

code

get size(): number;

Defined in: plugin/registry.ts:83

Returns

number

Methods

clear()

code

clear(): void;

Defined in: plugin/registry.ts:79

Returns

void

get()

code

get(id): AnyPlugin | undefined;

Defined in: plugin/registry.ts:63

Parameters

id

string

Returns

AnyPlugin | undefined

has()

code

has(id): boolean;

Defined in: plugin/registry.ts:67

Parameters

id

string

Returns

boolean

list()

code

list(): readonly AnyPlugin[];

Defined in: plugin/registry.ts:71

Returns

readonly AnyPlugin[]

listByKind()

code

listByKind(kind): readonly AnyPlugin[];

Defined in: plugin/registry.ts:75

Parameters

kind

"drawing" | "indicator" | "overlay"

Returns

readonly AnyPlugin[]

register()

code

register(plugin): RegistrationResult;

Defined in: plugin/registry.ts:40

Parameters

plugin

Returns

RegistrationResult

unregister()

code

unregister(id): boolean;

Defined in: plugin/registry.ts:59

Parameters

id

string

Returns

boolean