Constants¶

197 enumerations across 16 categories.

Enumerations Array filter Types¶

ArrayFilterExclusiveType¶

ArrayFilterExclusiveType

Exclusive filter type; will exclude all matching values.

Type: enum

ArrayFilterGreaterThanType¶

ArrayFilterGreaterThanType

GreaterThan filter type; will include all greater values.

Type: enum

ArrayFilterInclusiveType¶

ArrayFilterInclusiveType

Inclusive filter type; will include all matching values.

Type: enum

ArrayFilterLessThanType¶

ArrayFilterLessThanType

LessThan filter type; will include all lesser values.

Type: enum

Enumerations Candle Pattern¶

AbandonedBabyType¶

AbandonedBabyType

Constant for the AbandonedBabyType enumeration.

Type: enum

AdvanceBlockType¶

AdvanceBlockType

Constant for the AdvanceBlockType enumeration.

Type: enum

BeltHoldType¶

BeltHoldType

Constant for the BeltHoldType enumeration.

Type: enum

BreakawayType¶

BreakawayType

Constant for the BreakawayType enumeration.

Type: enum

ClosingMarubozuType¶

ClosingMarubozuType

Constant for the ClosingMarubozuType enumeration.

Type: enum

ConcealBabysWallType¶

ConcealBabysWallType

Constant for the ConcealBabysWallType enumeration.

Type: enum

CounterAttackType¶

CounterAttackType

Constant for the CounterAttackType enumeration.

Type: enum

DarkCloudCoverType¶

DarkCloudCoverType

Constant for the DarkCloudCoverType enumeration.

Type: enum

DojiStarType¶

DojiStarType

Constant for the DojiStarType enumeration.

Type: enum

DojiType¶

DojiType

Constant for the DojiType enumeration.

Type: enum

DragonflyDojiType¶

DragonflyDojiType

Constant for the DragonflyDojiType enumeration.

Type: enum

EngulfingType¶

EngulfingType

Constant for the EngulfingType enumeration.

Type: enum

EveningDojiStarType¶

EveningDojiStarType

Constant for the EveningDojiStarType enumeration.

Type: enum

EveningStarType¶

EveningStarType

Constant for the EveningStarType enumeration.

Type: enum

GapSideSideWhiteType¶

GapSideSideWhiteType

Constant for the GapSideSideWhiteType enumeration.

Type: enum

GravestoneDojiType¶

GravestoneDojiType

Constant for the GravestoneDojiType enumeration.

Type: enum

HammerType¶

HammerType

Constant for the HammerType enumeration.

Type: enum

HangingManType¶

HangingManType

Constant for the HangingManType enumeration.

Type: enum

HaramiCrossType¶

HaramiCrossType

Constant for the HaramiCrossType enumeration.

Type: enum

HaramiType¶

HaramiType

Constant for the HaramiType enumeration.

Type: enum

HignWaveType¶

HignWaveType

Constant for the HignWaveType enumeration.

Type: enum

HikkakeModType¶

HikkakeModType

Constant for the HikkakeModType enumeration.

Type: enum

HikkakeType¶

HikkakeType

Constant for the HikkakeType enumeration.

Type: enum

HomingPigeonType¶

HomingPigeonType

Constant for the HomingPigeonType enumeration.

Type: enum

IdenticalThreeCrowsType¶

IdenticalThreeCrowsType

Constant for the IdenticalThreeCrowsType enumeration.

Type: enum

InNeckType¶

InNeckType

Constant for the InNeckType enumeration.

Type: enum

InvertedHammerType¶

InvertedHammerType

Constant for the InvertedHammerType enumeration.

Type: enum

KickingByLengthType¶

KickingByLengthType

Constant for the KickingByLengthType enumeration.

Type: enum

KickingType¶

KickingType

Constant for the KickingType enumeration.

Type: enum

LadderBottomType¶

LadderBottomType

Constant for the LadderBottomType enumeration.

Type: enum

LongLeggedDojiType¶

LongLeggedDojiType

Constant for the LongLeggedDojiType enumeration.

Type: enum

LongLineType¶

LongLineType

Constant for the LongLineType enumeration.

Type: enum

MarubozuType¶

MarubozuType

Constant for the MarubozuType enumeration.

Type: enum

MatchingLowType¶

MatchingLowType

Constant for the MatchingLowType enumeration.

Type: enum

MatHoldType¶

MatHoldType

Constant for the MatHoldType enumeration.

Type: enum

MorningDojiStarType¶

MorningDojiStarType

Constant for the MorningDojiStarType enumeration.

Type: enum

MorningStarType¶

MorningStarType

Constant for the MorningStarType enumeration.

Type: enum

OnNeckType¶

OnNeckType

Constant for the OnNeckType enumeration.

Type: enum

PiercingType¶

PiercingType

Constant for the PiercingType enumeration.

Type: enum

RickshawManType¶

RickshawManType

Constant for the RickshawManType enumeration.

Type: enum

RiseFallThreeMethodsType¶

RiseFallThreeMethodsType

Constant for the RiseFallThreeMethodsType enumeration.

Type: enum

SeparatingLinesType¶

SeparatingLinesType

Constant for the SeparatingLinesType enumeration.

Type: enum

ShootingStarType¶

ShootingStarType

Constant for the ShootingStarType enumeration.

Type: enum

ShortLineType¶

ShortLineType

Constant for the ShortLineType enumeration.

Type: enum

SimpleDoubleDownCandleType¶

SimpleDoubleDownCandleType

Constant for the SimpleDoubleDownCandleType enumeration.

Type: enum

SimpleDoubleUpCandleType¶

SimpleDoubleUpCandleType

Constant for the SimpleDoubleUpCandleType enumeration.

Type: enum

SimpleDownCandleType¶

SimpleDownCandleType

Constant for the SimpleDownCandleType enumeration.

Type: enum

SimpleUpCandleType¶

SimpleUpCandleType

Constant for the SimpleUpCandleType enumeration.

Type: enum

SpinningTopType¶

SpinningTopType

Constant for the SpinningTopType enumeration.

Type: enum

StalledPatternType¶

StalledPatternType

Constant for the StalledPatternType enumeration.

Type: enum

StickSandwichType¶

StickSandwichType

Constant for the StickSandwichType enumeration.

Type: enum

TakuriType¶

TakuriType

Constant for the TakuriType enumeration.

Type: enum

TasukiGapType¶

TasukiGapType

Constant for the TasukiGapType enumeration.

Type: enum

ThreeBlackCrowsType¶

ThreeBlackCrowsType

Constant for the ThreeBlackCrowsType enumeration.

Type: enum

ThreeInsideType¶

ThreeInsideType

Constant for the ThreeInsideType enumeration.

Type: enum

ThreeLineStrikeType¶

ThreeLineStrikeType

Constant for the ThreeLineStrikeType enumeration.

Type: enum

ThreeOutsideType¶

ThreeOutsideType

Constant for the ThreeOutsideType enumeration.

Type: enum

ThreeStarsInSouthType¶

ThreeStarsInSouthType

Constant for the ThreeStarsInSouthType enumeration.

Type: enum

ThreeWhiteSoldiersType¶

ThreeWhiteSoldiersType

Constant for the ThreeWhiteSoldiersType enumeration.

Type: enum

ThrustingType¶

ThrustingType

Constant for the ThrustingType enumeration.

Type: enum

TristarType¶

TristarType

Constant for the TristarType enumeration.

Type: enum

TwoCrowsType¶

TwoCrowsType

Constant for the TwoCrowsType enumeration.

Type: enum

UniqueThreeRiverType¶

UniqueThreeRiverType

Constant for the UniqueThreeRiverType enumeration.

Type: enum

UpsideGapTwoCrowsType¶

UpsideGapTwoCrowsType

Constant for the UpsideGapTwoCrowsType enumeration.

Type: enum

XSideGapThreeMethodsType¶

XSideGapThreeMethodsType

Constant for the XSideGapThreeMethodsType enumeration.

Type: enum

Enumerations Charting¶

Candlestick¶

Candlestick

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

CandlestickHLC¶

CandlestickHLC

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

CloseLine¶

CloseLine

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

Dashed¶

Dashed

Constant representing the line decoration. Used by LineOptions() for example.

Type: enum

Dotted¶

Dotted

Constant representing the line decoration. Used by LineOptions() for example.

Type: enum

HeikinAshi¶

HeikinAshi

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

HLC¶

HLC

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

LeftAxis¶

LeftAxis

Constant representing the chart axis. Used ChartSetAxisOptions() for example.

Type: enum

Line¶

Line

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

LinearAxis¶

LinearAxis

Constant representing the chart axis type. Used ChartSetOptions() for example.

Type: enum

Mountain¶

Mountain

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

OHLC¶

OHLC

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

PercentageAxis¶

PercentageAxis

Constant representing the chart axis type. Used ChartSetOptions() for example.

Type: enum

RightAxis¶

RightAxis

Constant representing the chart axis. Used ChartSetAxisOptions() for example.

Type: enum

ShapeAdd¶

ShapeAdd

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeCircle¶

ShapeCircle

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeCross¶

ShapeCross

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeDash¶

ShapeDash

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeDiamond¶

ShapeDiamond

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeSquare¶

ShapeSquare

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeText¶

ShapeText

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeTriangleDown¶

ShapeTriangleDown

Constant representing the shape type. Used PlotShapes().

Type: enum

ShapeTriangleUp¶

ShapeTriangleUp

Constant representing the shape type. Used PlotShapes().

Type: enum

Smooth¶

Smooth

Constant representing the line style. Used by LineOptions() for example.

Type: enum

Solid¶

Solid

Constant representing the line decoration. Used by LineOptions() for example.

Type: enum

Spiked¶

Spiked

Constant representing the line style. Used by LineOptions() for example.

Type: enum

Spread¶

Spread

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

SpreadCandle¶

SpreadCandle

Constant representing the price plot. Used by PlotPrice() or ChartSetOptions()

Type: enum

Step¶

Step

Constant representing the line style. Used by LineOptions() for example.

Type: enum

StepAfter¶

StepAfter

Constant representing the line style. Used by LineOptions() for example.

Type: enum

StepBefore¶

StepBefore

Constant representing the line style. Used by LineOptions() for example.

Type: enum

Enumerations Color¶

Aqua¶

Aqua([opacity])

Enumeration, returns a color hex string. Can be used as Aqua, Aqua() or with a specific opacity Aqua(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of aqua (#00FFFF)

Black¶

Black([opacity])

Enumeration, returns a color hex string. Can be used as Black, Black() or with a specific opacity Black(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of black (#000000)

Blue¶

Blue([opacity])

Enumeration, returns a color hex string. Can be used as Blue, Blue() or with a specific opacity Blue(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of blue (#0000CC)

Color¶

Color(r, g, b, [a])

Creates an RGBA color string.

Parameters:

Name	Type	Required	Description
`r`	`number`	Yes	The red component value for the new color. Valid values are 0 through 255.
`g`	`number`	Yes	The green component value for the new color. Valid values are 0 through 255.
`b`	`number`	Yes	The blue component value for the new color. Valid values are 0 through 255.
`a`	`number`	No	The alpha component value for the new color. Valid values are 0 through 255.

Returns: string

Returns an RGBA color string.

Cyan¶

Cyan([opacity])

Enumeration, returns a color hex string. Can be used as Cyan, Cyan() or with a specific opacity Cyan(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of cyan (#00CCCC)

DarkGray¶

DarkGray([opacity])

Enumeration, returns a color hex string. Can be used as DarkGray, DarkGray() or with a specific opacity DarkGray(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of darkgray (#808080)

DarkGreen¶

DarkGreen([opacity])

Enumeration, returns a color hex string. Can be used as DarkGreen, DarkGreen() or with a specific opacity DarkGreen(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of darkgreen (#008000)

Fuchsia¶

Fuchsia([opacity])

Enumeration, returns a color hex string. Can be used as Fuchsia, Fuchsia() or with a specific opacity Fuchsia(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of fuchsia (#FF00FF)

Gold¶

Gold([opacity])

Enumeration, returns a color hex string. Can be used as Gold, Gold() or with a specific opacity Gold(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of gold (#CC9900)

Gray¶

Gray([opacity])

Enumeration, returns a color hex string. Can be used as Gray, Gray() or with a specific opacity Gray(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of gray (#C0C0C0)

Green¶

Green([opacity])

Enumeration, returns a color hex string. Can be used as Green, Green() or with a specific opacity Green(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of green (#00FF00)

Maroon¶

Maroon([opacity])

Enumeration, returns a color hex string. Can be used as Maroon, Maroon() or with a specific opacity Maroon(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of maroon (#800000)

Olive¶

Olive([opacity])

Enumeration, returns a color hex string. Can be used as Olive, Olive() or with a specific opacity Olive(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of olive (#808000)

Orange¶

Orange([opacity])

Enumeration, returns a color hex string. Can be used as Orange, Orange() or with a specific opacity Orange(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of orange (#FF8000)

Purple¶

Purple([opacity])

Enumeration, returns a color hex string. Can be used as Purple, Purple() or with a specific opacity Purple(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of purple (#FF1a8c)

Red¶

Red([opacity])

Enumeration, returns a color hex string. Can be used as Red, Red() or with a specific opacity Red(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of red (#FF0000)

SkyBlue¶

SkyBlue([opacity])

Enumeration, returns a color hex string. Can be used as SkyBlue, SkyBlue() or with a specific opacity SkyBlue(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of skyblue (#33CCFF)

Teal¶

Teal([opacity])

Enumeration, returns a color hex string. Can be used as Teal, Teal() or with a specific opacity Teal(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of teal (#008080)

White¶

White([opacity])

Enumeration, returns a color hex string. Can be used as White, White() or with a specific opacity White(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of white (#FFFFFF)

Yellow¶

Yellow([opacity])

Enumeration, returns a color hex string. Can be used as Yellow, Yellow() or with a specific opacity Yellow(10).

Parameters:

Name	Type	Required	Description
`opacity`	`number`	No	The color opacity, 0-100. By default 100.

Returns: string

Returns hex string of yellow (#FFFF00)