Class ShadeInfo
java.lang.Object
com.motivewave.platform.sdk.common.BaseInfo
com.motivewave.platform.sdk.common.ShadeInfo
- All Implemented Interfaces:
Cloneable
Describes shading information between two lines described by lineKey1 and lineKey2.
-
Constructor Summary
ConstructorDescriptionConstructor.ShadeInfo
(String lineKey1, double value, Enums.ShadeType type, Color color, boolean enabled) Constructor.ShadeInfo
(String lineKey1, String lineKey2, double value, Enums.ShadeType type, Color color, boolean enabled) Constructor.ShadeInfo
(String lineKey1, String lineKey2, Enums.ShadeType type, Color color, boolean enabled) Constructor. -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a clone (copy) of this object.static ShadeInfo
getColor()
Gets the color used for drawing the shade.Gets the key for the first line/path.Gets the key for the second line/path.String[][]
Gets the set of line pairs for applying this shade to multiple line pairs (shade type BOTH only)Gets the key pairs for drawing multiple shades public String[] getLinePairs() { return linePairs; } /** Gets the type of shade (above, below, both).double
getValue()
Gets the absolute value for determining the shade area.
-
Constructor Details
-
ShadeInfo
Constructor.- Parameters:
lineKey1
- identifies the line for shadingvalue
- shade valuetype
- type of shade (above, below, both)color
- shade colorenabled
- true if this shade is enabled
-
ShadeInfo
public ShadeInfo(String lineKey1, String lineKey2, Enums.ShadeType type, Color color, boolean enabled) Constructor.- Parameters:
lineKey1
- identifies the first line/path for shadinglineKey2
- identifies the second line/path for shadingtype
- type of shade (above, below, both)color
- shade colorenabled
- true if this shade is enabled
-
ShadeInfo
Constructor.- Parameters:
linePairs
- set of line pairs for the shading (ShadeType.BOTH)color
- shade colorenabled
- true if this shade is enabled
-
ShadeInfo
public ShadeInfo(String lineKey1, String lineKey2, double value, Enums.ShadeType type, Color color, boolean enabled) Constructor.- Parameters:
lineKey1
- identifies the first line/path for shadinglineKey2
- identifies the second line/path for shadingvalue
- shade valuetype
- type of shade (above, below, both)color
- shade colorenabled
- true if this shade is enabled
-
-
Method Details
-
getColor
Gets the color used for drawing the shade.- Returns:
- color used to draw the shade
-
getLineKey1
Gets the key for the first line/path.- Returns:
- key for the first line/path
-
getLineKey2
Gets the key for the second line/path.- Returns:
- key for the second line/path
-
getLinePairs
Gets the set of line pairs for applying this shade to multiple line pairs (shade type BOTH only)- Returns:
- line pairs for applying the shade
-
getShadeType
Gets the key pairs for drawing multiple shades public String[] getLinePairs() { return linePairs; } /** Gets the type of shade (above, below, both).- Returns:
- type of shade
-
getValue
public double getValue()Gets the absolute value for determining the shade area.- Returns:
- absolute value for determining the shade area
-
clone
Creates a clone (copy) of this object. -
toJson
-
fromJson
-