IIndicatorDrawingSupport (JForex API 2.12.46 API)

```
public interface IIndicatorDrawingSupport
```
Various helper methods to be able to draw indicators

Author:

Dmitry Shohov

Method Summary

Methods
Modifier and Type	Method and Description
`IBar[]`	`getCandles()` Returns array of candles.
`float`	`getCandleWidthInPixels()` Candle width in pixels
`int`	`getChartHeight()` Returns height of the panel in pixels where drawing should happen
`int`	`getChartWidth()` Returns width of the panel in pixels where drawing should happen
`Color`	`getDowntrendColor()` Returns downtrend color for this indicator
`int`	`getIndexOfFirstCandleOnScreen()` Index in the array of values and candles.
`Instrument`	`getInstrument()` Returns instrument of the chart
`JFTimeZone`	`getJFTimeZone()` Returns time zone of the chart.
`double`	`getMaxPrice()` Returns the maximum value of the price scale.
`long`	`getMaxTime()` Returns the maximum time scale value.
`float`	`getMiddleOfCandle(int index)` X coordinate of the candle with index
`double`	`getMinPrice()` Returns the minimum value of the price scale.
`long`	`getMinTime()` Returns the minimum time scale value.
`int`	`getNumberOfCandlesOnScreen()` Returns number of candles currently visible on the screen.
`OfferSide`	`getOfferSide()` Return offer side of the chart or null if this is ticks chart
`Period`	`getPeriod()` Returns period of the chart.
`float`	`getSpaceBetweenCandlesInPixels()` Returns number of pixels between two candles
`int`	`getXForTime(long time)` Return X coordinate for the specified time.
`float`	`getYForValue(double value)` Returns Y coordinate for the specified value.
`float`	`getYForValue(int value)` Returns Y coordinate for the specified value.
`boolean`	`isChartPanel()` Returns true if Graphics passed to drawOutput method belong to main chart (where candles are shown) or false if it belongs to separate panel created for this indicator (when IndicatorInfo.isOverChart returns false).
`boolean`	`isLastCandleInProgress()` Returns true if the last candle is not fully formed yet
`boolean`	`isTimeAggregatedPeriod()` Returns current period is whether time aggregated or not.

- Method Detail
  - isChartPanel
```
boolean isChartPanel()
```
    Returns true if Graphics passed to drawOutput method belong to main chart (where candles are shown) or false if it belongs to separate panel created for this indicator (when IndicatorInfo.isOverChart returns false).
    
    Returns:
    true for main chart and false for indicator panel under chart
  - getNumberOfCandlesOnScreen
```
int getNumberOfCandlesOnScreen()
```
    Returns number of candles currently visible on the screen. This values is usually less than size of the array with values and array with candles
    
    Returns:
    number of candles currently visible on the screen
  - getIndexOfFirstCandleOnScreen
```
int getIndexOfFirstCandleOnScreen()
```
    Index in the array of values and candles. Points to the first candle that is visible on the screen. Depending on type of the output (simple line for example) it may be a good idea to draw only values starting from the candle before first visible candle and to the candle after last visible candle
    
    Returns:
    index of the first visible candle in the array of values and candles
  - getCandleWidthInPixels
```
float getCandleWidthInPixels()
```
    Candle width in pixels
    
    Returns:
    candle width in pixels
  - getSpaceBetweenCandlesInPixels
```
float getSpaceBetweenCandlesInPixels()
```
    Returns number of pixels between two candles
    
    Returns:
    number of pixels between two candles
  - getMiddleOfCandle
```
float getMiddleOfCandle(int index)
```
    X coordinate of the candle with index
    
    Parameters:
    index - index of the candles or/and value
    
    Returns:
    x coordinate of the candle
  - getYForValue
```
float getYForValue(double value)
```
    Returns Y coordinate for the specified value. Coordinate is calculated depending on minimum and maximum values for indicator
    
    Parameters:
    value - indicator value
    
    Returns:
    y coordinate for the specified value
  - getXForTime
```
int getXForTime(long time)
```
    Return X coordinate for the specified time. Coordinate is calculated depending on data sequence currently displayed on chart
    
    Parameters:
    time - time to get x coordinate for
    
    Returns:
    x coordinate for the specified time
  - getYForValue
```
float getYForValue(int value)
```
    Returns Y coordinate for the specified value. Coordinate is calculated depending on minimum and maximum values for indicator
    
    Parameters:
    value - indicator value
    
    Returns:
    y coordinate for the specified value
  - getCandles
```
IBar[] getCandles()
```
    Returns array of candles. Each one of the candle corresponds to the value with the same index in the array of values for the current output
    
    Returns:
    array of candles with the same size as the size of the output values array
  - isLastCandleInProgress
```
boolean isLastCandleInProgress()
```
    Returns true if the last candle is not fully formed yet
    
    Returns:
    true if last candle is in-progress candle
  - getChartWidth
```
int getChartWidth()
```
    Returns width of the panel in pixels where drawing should happen
    
    Returns:
    width of the chart
  - getChartHeight
```
int getChartHeight()
```
    Returns height of the panel in pixels where drawing should happen
    
    Returns:
    height of the chart
  - getInstrument
```
Instrument getInstrument()
```
    Returns instrument of the chart
    
    Returns:
    instrument of the chart
  - getPeriod
```
Period getPeriod()
```
    Returns period of the chart. Note: returns base period for price aggregated periods.
    
    Returns:
    period of the chart
  - getJFTimeZone
```
JFTimeZone getJFTimeZone()
```
    Returns time zone of the chart.
    
    Returns:
    time zone of the chart
  - getOfferSide
```
OfferSide getOfferSide()
```
    Return offer side of the chart or null if this is ticks chart
    
    Returns:
    offer side of the chart or null if this is ticks chart
  - getDowntrendColor
```
Color getDowntrendColor()
```
    Returns downtrend color for this indicator
    
    Returns:
    downtrend color for this indicator
  - getMinPrice
```
double getMinPrice()
```
    Returns the minimum value of the price scale.
    
    Returns:
    minimum value of the price scale.
  - getMaxPrice
```
double getMaxPrice()
```
    Returns the maximum value of the price scale.
    
    Returns:
    maximum value of the price scale.
  - getMinTime
```
long getMinTime()
```
    Returns the minimum time scale value.
    
    Returns:
    minimum time scale value
  - getMaxTime
```
long getMaxTime()
```
    Returns the maximum time scale value.
    
    Returns:
    maximum time scale value
  - isTimeAggregatedPeriod
```
boolean isTimeAggregatedPeriod()
```
    Returns current period is whether time aggregated or not.
    
    Returns:
    current period is whether time aggregated or not.

Interface IIndicatorDrawingSupport

Method Summary

Method Detail

isChartPanel

getNumberOfCandlesOnScreen

getIndexOfFirstCandleOnScreen

getCandleWidthInPixels

getSpaceBetweenCandlesInPixels

getMiddleOfCandle

getYForValue

getXForTime

getYForValue

getCandles

isLastCandleInProgress

getChartWidth

getChartHeight

getInstrument

getPeriod

getJFTimeZone

getOfferSide

getDowntrendColor

getMinPrice

getMaxPrice

getMinTime

getMaxTime

isTimeAggregatedPeriod