PointFigure

forge.barsfunctionSince Forge API 1
Signaturepython
forge.bars.PointFigure(box: float | Param | Mapping[str, Any] | str,*,unit: str = 'pips',reversal: int | Param = 3,one_box: bool = False,event: str = 'column',basis: str | Param | None = None,day_boundary: str | None = None,on_closure: str | None = None,anchor: str | float | None = None) -> BarDecl

Point and figure columns. box is a size, an ATR or percent box, or "traditional".

Parameters

NameTypeDefault
boxfloat | Param | Mapping[str, Any] | str
unitstr'pips'
reversalint | Param3
one_boxboolFalse
eventstr'column'
basisstr | Param | NoneNone
day_boundarystr | NoneNone
on_closurestr | NoneNone
anchorstr | float | NoneNone

reversal (default 3) counts boxes; event is "column" (default) or "box".