ChartIQ SDK Legacy Documentation -

Class: AboveCandle

STX.Marker. AboveCandle

new AboveCandle(params)

AboveCandle is a sample Marker placement handler that positions markers above the candles on the chart. This is equivalent to a "placementFunction" in the previous version of Markers. You can create your own marker placement objects by following the same pattern.

Parameters:
Name Type Description
params Object

Parameters inherited from STX.Marker
Example
new STX.Marker.AboveCandle({
			    stx: stxx,
			    xPositioner: "date",
			    x: stxx.masterData[i].DT,
			    label: "events",
			    node: newNode
			});

Methods

<static> placementFunction(params)

Sample placementFuncion override used to draw markers above a particular candle, bar or line value regardless of marker.params.y and marker.params.yPositioner settings.

Parameters:
Name Type Description
params Object

Parameters including the list of markers and placement details

Properties
Name Type Description
stx STXChart

The chart object
arr Array

The array of markers to place
panel Object

The panel where the markers are to be placed
firstTick Number

The first tick displayed on the chart
lastTick Number

The last tick displayed on the chart