Skip to content
EliteChart

IndicatorCatalogEntry

Documentation


Documentation / @elitechart/core / IndicatorCatalogEntry

Defined in: ui/indicators-dialog.ts:24

A single indicator catalog entry. Catalog is fed into the dialog at construction; rows render in left-sidebar category order.

Example

code
const entry: IndicatorCatalogEntry = {
  id: 'sma',
  name: 'Simple Moving Average',
  category: 'moving-averages',
  subTab: 'indicators',
  description: 'Arithmetic mean over a rolling window.',
  defaultParams: { period: 20 },
};

Properties

category

code
readonly category: IndicatorCategory;

Defined in: ui/indicators-dialog.ts:27


defaultParams?

code
readonly optional defaultParams?: Readonly<Record<string, unknown>>;

Defined in: ui/indicators-dialog.ts:35

Optional default parameters forwarded to the onAdd callback. The dialog is agnostic — the embedder can seed the indicator with these values or ignore them.


description?

code
readonly optional description?: string;

Defined in: ui/indicators-dialog.ts:29


id

code
readonly id: string;

Defined in: ui/indicators-dialog.ts:25


name

code
readonly name: string;

Defined in: ui/indicators-dialog.ts:26


subTab

code
readonly subTab: IndicatorSubTab;

Defined in: ui/indicators-dialog.ts:28