Package velox.api.layer0.data

Class IndicatorDefinitionUserMessage

java.lang.Object
velox.api.layer0.data.IndicatorDefinitionUserMessage
@Deprecated public class IndicatorDefinitionUserMessage extends Object
Deprecated.
Allows defining indicators, similar to Recorder API. You may use it for now in L0 addons, but for L1 use Indicator API or the Screen Space Painter API instead.
See Also:

  • Field Details

    • id

      public final int id
      Deprecated.

    • alias

      public final String alias
      Deprecated.

    • indicatorName

      public final String indicatorName
      Deprecated.

    • mainLineStyleMask

      public final short mainLineStyleMask
      Deprecated.

    • mainLineStyleMultiplier

      public final short mainLineStyleMultiplier
      Deprecated.

    • mainLineWidth

      public final int mainLineWidth
      Deprecated.

    • lineColor

      public final Color lineColor
      Deprecated.

    • rightLineStyleMask

      public final short rightLineStyleMask
      Deprecated.

    • rightLineStyleMultiplier

      public final short rightLineStyleMultiplier
      Deprecated.

    • rightLineWidth

      public final int rightLineWidth
      Deprecated.

    • icon

      public final BufferedImage icon
      Deprecated.

    • iconOffsetX

      public final int iconOffsetX
      Deprecated.

    • iconOffsetY

      public final int iconOffsetY
      Deprecated.

    • showOnMainChart

      public final boolean showOnMainChart
      Deprecated.

    • valueFormat

      public final String valueFormat
      Deprecated.

  • Constructor Details

    • IndicatorDefinitionUserMessage

      public IndicatorDefinitionUserMessage(int id, String alias, String indicatorName, short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, Color lineColor, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth, BufferedImage icon, int iconOffsetX, int iconOffsetY, boolean showOnMainChart, 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
      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
      icon - icon displayed at points defined by IndicatorPointUserMessage; 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:
      IllegalFormatException - invalid valueFormat argument

    • IndicatorDefinitionUserMessage

      public IndicatorDefinitionUserMessage(int id, String alias, String indicatorName, short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, Color lineColor, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth, 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
      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
      icon - icon displayed at points defined by IndicatorPointUserMessage; 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, String alias, short mainLineStyleMask, short mainLineStyleMultiplier, int mainLineWidth, Color lineColor, short rightLineStyleMask, short rightLineStyleMultiplier, int rightLineWidth, 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