velox.api.layer0.data

Class IndicatorDefinitionUserMessage

java.lang.Object

velox.api.layer0.data.IndicatorDefinitionUserMessage

Deprecated.

@Deprecated
public class IndicatorDefinitionUserMessage
extends java.lang.Object

Allows defining indicators, similar to Recorder API. Will be removed in the future in favor of L2-api based solution

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	alias Deprecated.
java.awt.image.BufferedImage	icon Deprecated.
int	iconOffsetX Deprecated.
int	iconOffsetY Deprecated.
int	id Deprecated.
java.lang.String	indicatorName Deprecated.
java.awt.Color	lineColor Deprecated.
short	mainLineStyleMask Deprecated.
short	mainLineStyleMultiplier Deprecated.
int	mainLineWidth Deprecated.
short	rightLineStyleMask Deprecated.
short	rightLineStyleMultiplier Deprecated.
int	rightLineWidth Deprecated.
boolean	showOnMainChart Deprecated.
java.lang.String	valueFormat Deprecated.

Constructor Summary

Constructors

Constructor and Description
IndicatorDefinitionUserMessage(int id, java.lang.String alias, short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, java.awt.Color lineColor, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth, java.awt.image.BufferedImage icon, int iconOffsetX, int iconOffsetY, boolean showOnMainChart) Deprecated.
IndicatorDefinitionUserMessage(int id, java.lang.String alias, java.lang.String indicatorName, short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, java.awt.Color lineColor, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth, java.awt.image.BufferedImage icon, int iconOffsetX, int iconOffsetY, boolean showOnMainChart) Deprecated. Define new custom indicator
IndicatorDefinitionUserMessage(int id, java.lang.String alias, java.lang.String indicatorName, short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, java.awt.Color lineColor, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth, java.awt.image.BufferedImage icon, int iconOffsetX, int iconOffsetY, boolean showOnMainChart, java.lang.String valueFormat) Deprecated. Define new custom indicator

Method Summary

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public final int id

Deprecated.

alias

public final java.lang.String alias

Deprecated.

indicatorName

public final java.lang.String indicatorName

Deprecated.

mainLineStyleMask

public final short mainLineStyleMask

Deprecated.

mainLineStyleMultiplier

public final short mainLineStyleMultiplier

Deprecated.

mainLineWidth

public final int mainLineWidth

Deprecated.

lineColor

public final java.awt.Color lineColor

Deprecated.

rightLineStyleMask

public final short rightLineStyleMask

Deprecated.

rightLineStyleMultiplier

public final short rightLineStyleMultiplier

Deprecated.

rightLineWidth

public final int rightLineWidth

Deprecated.

icon

public final java.awt.image.BufferedImage icon

Deprecated.

iconOffsetX

public final int iconOffsetX

Deprecated.

iconOffsetY

public final int iconOffsetY

Deprecated.

showOnMainChart

public final boolean showOnMainChart

Deprecated.

valueFormat

public final java.lang.String valueFormat

Deprecated.

Constructor Detail

IndicatorDefinitionUserMessage

public IndicatorDefinitionUserMessage(int id,
                                      java.lang.String alias,
                                      java.lang.String indicatorName,
                                      short mainLineStyleMask,
                                      short mainLineStyleMultiplier,
                                      int mainLineWidth,
                                      java.awt.Color lineColor,
                                      short rightLineStyleMask,
                                      short rightLineStyleMultiplier,
                                      int rightLineWidth,
                                      java.awt.image.BufferedImage icon,
                                      int iconOffsetX,
                                      int iconOffsetY,
                                      boolean showOnMainChart,
                                      java.lang.String valueFormat)

Deprecated.

Define new custom indicator

Parameters:

id - indicator id (used to reference it later)

alias - alias of the instrument indicator is applied to

indicatorName - name shown in Bookmap UI

mainLineStyleMask - style of the line to the left of current time line, one bits mean visible pixels, zero bits - invisible; use 0 to hide the line

mainLineStyleMultiplier - how many pixels correspond to one bit of mainLineStyleMask

mainLineWidth - width of the line to the left of current time line

lineColor - color of the line to the left of current time line

rightLineStyleMask - style of the line to the right of current time line (extension), one bits mean visible pixels, zero bits - invisible; use 0 to hide the line

rightLineStyleMultiplier - how many pixels correspond to one bit of rightLineStyleMask

rightLineWidth - width of the line to the right of current time line

rightLineColor - color of the line to the right of current time line

icon - icon displayed at points defined by #onIndicatorPoint(long, int, double); use null if you don't want any

iconOffsetX - offset of the icon by X axis (positive offset moves icon to the right)

iconOffsetY - offset of the icon by Y axis (positive offset moves icon to the top)

showOnMainChart - true to show on main chart, false to show on bottom panel

valueFormat - format used to convert value to string; null keeps default formatting, non-null values are passed to String.format(String, Object...)

Throws:

java.util.IllegalFormatException - invalid valueFormat argument

IndicatorDefinitionUserMessage

public IndicatorDefinitionUserMessage(int id,
                                      java.lang.String alias,
                                      java.lang.String indicatorName,
                                      short mainLineStyleMask,
                                      short mainLineStyleMultiplier,
                                      int mainLineWidth,
                                      java.awt.Color lineColor,
                                      short rightLineStyleMask,
                                      short rightLineStyleMultiplier,
                                      int rightLineWidth,
                                      java.awt.image.BufferedImage icon,
                                      int iconOffsetX,
                                      int iconOffsetY,
                                      boolean showOnMainChart)

Deprecated.

Define new custom indicator

Parameters:

id - indicator id (used to reference it later)

alias - alias of the instrument indicator is applied to

indicatorName - name shown in Bookmap UI

mainLineStyleMask - style of the line to the left of current time line, one bits mean visible pixels, zero bits - invisible; use 0 to hide the line

mainLineStyleMultiplier - how many pixels correspond to one bit of mainLineStyleMask

mainLineWidth - width of the line to the left of current time line

lineColor - color of the line to the left of current time line

rightLineStyleMask - style of the line to the right of current time line (extension), one bits mean visible pixels, zero bits - invisible; use 0 to hide the line

rightLineStyleMultiplier - how many pixels correspond to one bit of rightLineStyleMask

rightLineWidth - width of the line to the right of current time line

rightLineColor - color of the line to the right of current time line

icon - icon displayed at points defined by #onIndicatorPoint(long, int, double); use null if you don't want any

iconOffsetX - offset of the icon by X axis (positive offset moves icon to the right)

iconOffsetY - offset of the icon by Y axis (positive offset moves icon to the top)

showOnMainChart - true to show on main chart, false to show on bottom panel

IndicatorDefinitionUserMessage

@Deprecated
public IndicatorDefinitionUserMessage(int id,
                                                   java.lang.String alias,
                                                   short mainLineStyleMask,
                                                   short mainLineStyleMultiplier,
                                                   int mainLineWidth,
                                                   java.awt.Color lineColor,
                                                   short rightLineStyleMask,
                                                   short rightLineStyleMultiplier,
                                                   int rightLineWidth,
                                                   java.awt.image.BufferedImage icon,
                                                   int iconOffsetX,
                                                   int iconOffsetY,
                                                   boolean showOnMainChart)

Deprecated.

Use IndicatorDefinitionUserMessage(int, String, String, short, short, int, Color, short, short, int, BufferedImage, int, int, boolean) instead