interface PointFigureOptions {
    atrMultiplier?: number;
    atrPeriod?: number;
    boxSize?: number;
    method?: PointFigureMethod;
    mode?: PointFigureBoxMode;
    percent?: number;
    reversal?: number;
}

Properties

atrMultiplier?: number

ATR multiplier for mode: 'atr'. Default 1.

atrPeriod?: number

ATR lookback for mode: 'atr' and 'atrPercent'. Default 14; floored, at least 1.

boxSize?: number

Box size for mode: 'fixed'. Required unless another mode is chosen.

Which prices drive the column. Default 'hl'.

How the box size is resolved. Default 'fixed'.

percent?: number

Box as a percentage of price for mode: 'percent', or of the ATR for 'atrPercent' (e.g. 0.5 = 0.5%).

reversal?: number

Boxes of counter-move needed to start a new column. Default 3; floored, at least 1.