Skip to content
EliteChart

IndicatorInputSpec

Documentation


Documentation / @elitechart/core / IndicatorInputSpec

Defined in: plugin/types.ts:73

Schema describing a user-configurable indicator input (used by the settings UI to render the right control).

Example

code
const period: IndicatorInputSpec = {
  key: 'period', label: 'Period', type: 'number',
  min: 1, max: 200, step: 1,
};

Properties

key

code
readonly key: string;

Defined in: plugin/types.ts:74


label

code
readonly label: string;

Defined in: plugin/types.ts:75


max?

code
readonly optional max?: number;

Defined in: plugin/types.ts:78


min?

code
readonly optional min?: number;

Defined in: plugin/types.ts:77


options?

code
readonly optional options?: readonly {
  label: string;
  value: string;
}[];

Defined in: plugin/types.ts:80


step?

code
readonly optional step?: number;

Defined in: plugin/types.ts:79


type

code
readonly type: "number" | "boolean" | "color" | "enum";

Defined in: plugin/types.ts:76