Class Indicator<T>

Creates a indicator that can be calculated over a dataset.

Type parameters

T

Hierarchy

Indicator

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Indicator(name: string, calculate: (dataset: Dataset) => number, options?: IndicatorOptions<T>): Indicator

- Defined in indicator.ts:15
Creates an indicator with definition and configuration.

Parameters
- name: string
  
  Name of the indicator.
- calculate: (dataset: Dataset) => number
  
  Indicator definition function that accepts the Dataset and returns a number.
  - - (dataset: Dataset): number
    - Parameters
      - dataset: Dataset
      Returns number
- Optional options: IndicatorOptions<T>
  
  Indicator configuration object.
Returns Indicator

Properties

Protected _calculate

_calculate: (dataset: Dataset) => number

Type declaration

- (dataset: Dataset): number
- Parameters
  - dataset: Dataset
  Returns number

Protected _name

_name: string

Protected Optional _options

_options: IndicatorOptions<T>

Accessors

name

get name(): string

- Defined in indicator.ts:33
Returns string

options

get options(): undefined | IndicatorOptions<T>

- Defined in indicator.ts:37
Returns undefined | IndicatorOptions<T>

params

get params(): undefined | T

- Defined in indicator.ts:41
Returns undefined | T

Methods

calculate

calculate(dataset: Dataset): number

- Defined in indicator.ts:45
Parameters
- dataset: Dataset
Returns number

spread

spread(dataset: Dataset): Dataset

- Defined in indicator.ts:58
Mutates each quote of the given dataset with a calculated indicator value.

Parameters
- dataset: Dataset
  
  Dataset.
Returns Dataset

Mutated Dataset.

Generated using TypeDoc