public class

CandlestickSeriesStyle

extends SeriesStyle
java.lang.Object
   ↳ com.shinobicontrols.charts.SeriesStyle
     ↳ com.shinobicontrols.charts.CandlestickSeriesStyle

Class Overview

Visual style properties for CandlestickSeries. If you make any styling changes after the chart has been displayed, you should call redrawChart().

Summary

Public Constructors
CandlestickSeriesStyle()
Constructs a new CandlestickSeriesStyle object.
CandlestickSeriesStyle(CandlestickSeriesStyle candlestickSeriesStyle)
Constructs a new CandlestickSeriesStyle object taking its values from the given CandlestickSeriesStyle.
Public Methods
int getFallingColor()
Gets the color of the body of the candlestick if the point is falling.
int getFallingColorGradient()
Gets the gradient color of the body of the candlestick if the point is falling.
Float getInterSeriesSetPadding()
Gets the proportion of padding to use between each set of series.
int getOutlineColor()
Gets the color of the candlestick's outline.
float getOutlineWidth()
Gets the width of the candlestick's outline, in device independent pixels.
int getRisingColor()
Gets the color of the body of the candlestick if the point is rising.
int getRisingColorGradient()
Gets the gradient color of the body of the candlestick if the point is rising.
int getStickColor()
Gets the color of the candlestick's 'high' and 'low' sticks.
float getStickWidth()
Gets the width of the candlestick's stick, in device independent pixels.
void setFallingColor(int color)
Sets the color of the body of the candlestick if the point is falling.
void setFallingColorGradient(int color)
Sets the gradient color of the body of the candlestick if the point is falling.
void setInterSeriesSetPadding(Float interSeriesSetPadding)
Sets the proportion of padding to use between each set of series.
void setOutlineColor(int color)
Sets the color of the candlestick's outline.
void setOutlineWidth(float width)
Sets the width of the candlestick's outline, in device independent pixels.
void setRisingColor(int color)
Sets the color of the body of the candlestick if the point is rising.
void setRisingColorGradient(int color)
Sets the gradient color of the body of the candlestick if the point is rising.
void setStickColor(int color)
Sets the color of the candlestick's 'high' and 'low' sticks.
void setStickWidth(float width)
Sets the width of the candlestick's stick, in device independent pixels.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public CandlestickSeriesStyle ()

Constructs a new CandlestickSeriesStyle object.

public CandlestickSeriesStyle (CandlestickSeriesStyle candlestickSeriesStyle)

Constructs a new CandlestickSeriesStyle object taking its values from the given CandlestickSeriesStyle. If this CandlestickSeriesStyle is null then the default style values will be used.

Parameters
candlestickSeriesStyle the CandlestickSeriesStyle to copy values from

Public Methods

public int getFallingColor ()

Gets the color of the body of the candlestick if the point is falling.

Note, this property can be applied on a per-point basis by performing individual point styling. See SeriesStyleProvider for more details.

Returns
  • The color of the body of the OHLC point if the point is falling.

public int getFallingColorGradient ()

Gets the gradient color of the body of the candlestick if the point is falling.

Note, this property can be applied on a per-point basis by performing individual point styling. See SeriesStyleProvider for more details.

Returns
  • The gradient color of the body of the candlestick if the point is rising.

public Float getInterSeriesSetPadding ()

Gets the proportion of padding to use between each set of series. Candlestick Series which share the same axis are grouped into sets. A set is constructed at each data point. Therefore, series which share the same data point will be grouped into the same set.

Note: If the series does not calculate barColumnSpacing individually (that is, where the CandlestickSeries#calculateBarColumnSpacingIndividually has not been called, passing in true) then this value is ignored.

Returns
  • A proportion of available space, from 0.0 to 1.0, but not including 1.0 (0.0 > x < 1.0). May be null

public int getOutlineColor ()

Gets the color of the candlestick's outline.

Note, this property can be applied on a per-point basis by performing individual point styling. See SeriesStyleProvider for more details.

Returns
  • The color of the candlestick's outline.

public float getOutlineWidth ()

Gets the width of the candlestick's outline, in device independent pixels.

Note, this property is applicable to the whole series and is ignored for individual point styling.

Returns
  • The width of the candlestick's outline, in device independent pixels.

public int getRisingColor ()

Gets the color of the body of the candlestick if the point is rising.

Note, this property can be applied on a per-point basis by performing individual point styling. See SeriesStyleProvider for more details.

Returns
  • The color of the body of the candlestick if the point is rising.

public int getRisingColorGradient ()

Gets the gradient color of the body of the candlestick if the point is rising.

Note, this property can be applied on a per-point basis by performing individual point styling. See SeriesStyleProvider for more details.

Returns
  • The gradient color of the body of the candlestick if the point is rising.

public int getStickColor ()

Gets the color of the candlestick's 'high' and 'low' sticks.

Note, this property can be applied on a per-point basis by performing individual point styling. See SeriesStyleProvider for more details.

Returns
  • The color of the candlestick's 'high' and 'low' sticks.

public float getStickWidth ()

Gets the width of the candlestick's stick, in device independent pixels.

Note, this property is applicable to the whole series and is ignored for individual point styling.

Returns
  • The width of the candlestick's stick, in device independent pixels.

public void setFallingColor (int color)

Sets the color of the body of the candlestick if the point is falling.

Parameters
color The color of the body of the OHLC point if the point is falling.

public void setFallingColorGradient (int color)

Sets the gradient color of the body of the candlestick if the point is falling.

Parameters
color The gradient color of the body of the candlestick if the point is rising.

public void setInterSeriesSetPadding (Float interSeriesSetPadding)

Sets the proportion of padding to use between each set of series. Candlestick Series which share the same axis are grouped into sets. A set is constructed at each data point. Therefore, series which share the same data point will be grouped into the same set.

Passing a null value will result in the interSeriesSetPadding value being used from the AxisStyle object.

If you call this method after the chart has been displayed you should call chart .redrawChart().

Note: If the series does not calculate barColumnSpacing individually (that is, where the CandlestickSeries#calculateBarColumnSpacingIndividually has not been called, passing in true) then this value is ignored.

Parameters
interSeriesSetPadding A proportion of available space, from 0.0 to 1.0, but not including 1.0 (0.0 > x < 1.0)

public void setOutlineColor (int color)

Sets the color of the candlestick's outline.

Parameters
color The color of the candlestick's outline.

public void setOutlineWidth (float width)

Sets the width of the candlestick's outline, in device independent pixels.

Parameters
width The width of the candlestick's outline, in device independent pixels.

public void setRisingColor (int color)

Sets the color of the body of the candlestick if the point is rising.

Parameters
color The color of the body of the candlestick if the point is rising.
See Also

public void setRisingColorGradient (int color)

Sets the gradient color of the body of the candlestick if the point is rising.

Parameters
color The gradient color of the body of the candlestick if the point is rising.

public void setStickColor (int color)

Sets the color of the candlestick's 'high' and 'low' sticks.

Parameters
color The color of the candlestick's 'high' and 'low' sticks.
See Also

public void setStickWidth (float width)

Sets the width of the candlestick's stick, in device independent pixels.

Parameters
width The width of the candlestick's stick, in device independent pixels.
See Also