Package com.motivewave.platform.sdk.common

Class SeriesInfo

java.lang.Object
com.motivewave.platform.sdk.common.BaseInfo
com.motivewave.platform.sdk.common.TagInfo
com.motivewave.platform.sdk.common.SeriesInfo
All Implemented Interfaces:
Cloneable
Direct Known Subclasses:
PathInfo, PriceBarInfo
public abstract class SeriesInfo extends TagInfo

  • Constructor Details

    • SeriesInfo

      protected SeriesInfo(Color color, Color color2, Color color3, Color color4, float[] dash, float strokeWidth, double fixedWidth, double gradientCenter, boolean continuous, int maxPoints, int barCenter, Enums.ColorPolicy colorPolicy, String tag, boolean showTag, boolean showTagValue, TextStyle style, boolean enabled)

  • Method Details

    • getColor

      public Color getColor()
      Gets the main color of the path lines and points.
      Returns:
      main color for drawing the path

    • setColor

      public SeriesInfo setColor(Color color)
      Creates a copy of the object and sets main color of the path.
      Parameters:
      color - main color
      Returns:
      copy of the object

    • getColor2

      public Color getColor2()
      Gets the secondary color of the path lines and points. Typically upward trending points use color and downward trending use color2
      Returns:
      color for downward trending parts of the path

    • getColor3

      public Color getColor3()
      Gets the tertiary color of the path lines and points. The purpose of this color depends on the Color Policy
      Returns:
      tertiary color

    • getColor4

      public Color getColor4()
      Gets the quaternary color of the path lines and points. The purpose of this color depends on the Color Policy
      Returns:
      quaternary color

    • getDash

      public float[] getDash()
      Gets the dash style for the lines connecting the path points (null for solid line).
      Returns:
      dash style

    • setDash

      public SeriesInfo setDash(float[] dash)
      Creates a copy of the object and sets dash style
      Parameters:
      dash - dash style
      Returns:
      copy of the object

    • getWidth

      @Deprecated public float getWidth()
      Deprecated.
      use getStrokeWidth instead
      Gets the width of the lines connecting the path points.
      Returns:
      the width of the path line

    • getStrokeWidth

      public float getStrokeWidth()
      Gets the width of the lines connecting the path points.
      Returns:
      the width of the path line

    • setWidth

      @Deprecated public SeriesInfo setWidth(float width)
      Deprecated.
      use getStrokeWidth instead
      Creates a copy of the object and sets the width of the lines connecting path points.
      Parameters:
      width - width of the path line
      Returns:
      copy of the object with the width set

    • setStrokeWidth

      public SeriesInfo setStrokeWidth(float width)
      Creates a copy of the object and sets the width of the lines connecting path points.
      Parameters:
      width - width of the path line
      Returns:
      copy of the object with the width set

    • getMaxPoints

      public int getMaxPoints()
      Gets the max points to show.
      Returns:
      the maximum number of points to show.

    • isShowAllPoints

      public boolean isShowAllPoints()
      Indicates if all points should be shown.
      Returns:
      true if all points should be shown.

    • isContinuous

      public boolean isContinuous()
      Indicates if the series is continuous.
      Returns:
      true if the series is continuous

    • getColorPolicy

      public Enums.ColorPolicy getColorPolicy()
      Indicates the policy for applying colors to the series of values.
      Returns:
      color policy for applying colors

    • isGradient

      @Deprecated public boolean isGradient()
      Deprecated.
      use getColorPolicy instead
      Indicates if the color is a gradient.
      Returns:
      true if the path color is a gradient

    • getGradientCenter

      public Double getGradientCenter()
      Gets the gradient center (real value). If this value is null, then the gradient will center will be determined automatically.
      Returns:
      gradient center (null if automatically determined)

    • getBarCenter

      public int getBarCenter()
      Gets the center point for drawing bars (positive/negative bars).
      Returns:
      center point for drawing bars

    • getFixedWidth

      public Integer getFixedWidth()
      Gets the fixed width for drawing the bars (null for dynamic width). This property is only used if show as bars is true.
      Returns:
      fixed bar width (null for dynamic)

    • getFixedWidthDouble

      public double getFixedWidthDouble()

    • clone

      public SeriesInfo clone()
      Creates a clone (copy) of this object.
      Overrides:
      clone in class TagInfo
      Returns:
      clone of this object

    • toJson

      public Object toJson(BaseInfo def1)
      Specified by:
      toJson in class BaseInfo