com.dukascopy.api
Interface IChart

All Superinterfaces:

IChartPanel, java.lang.Iterable<IChartObject>

public interface IChart
extends java.lang.Iterable<IChartObject>, IChartPanel

Allows to draw graphical objects on the chart

draw

@Deprecated
IChartObject draw(java.lang.String key,
                             IChart.Type type,
                             long time1,
                             double price1,
                             long time2,
                             double price2,
                             long time3,
                             double price3)

Deprecated. - this method is deprecated. please use IChartObjectFactory create() method() instead.

Draws graphical object that requires up to 3 points

Parameters:

key - unique id of the object

type - type of the object

time1 - time of first point

price1 - price of first point

time2 - time of second point

price2 - price of second point

time3 - time of third point

price3 - price of third point

Returns:

graphical object

draw

@Deprecated
IChartObject draw(java.lang.String key,
                             IChart.Type type,
                             long time1,
                             double price1,
                             long time2,
                             double price2)

Deprecated. - this method is deprecated. please use IChartObjectFactory create() method() instead.

Draws graphical object that requires up to 2 points

Parameters:

key - unique id of the object

type - type of the object

time1 - time of first point

price1 - price of first point

time2 - time of second point

price2 - price of second point

Returns:

graphical object

draw

@Deprecated
IChartObject draw(java.lang.String key,
                             IChart.Type type,
                             long time1,
                             double price1)

Deprecated. - this method is deprecated. please use IChartObjectFactory create() method() instead.

Draws graphical object that requires only 1 point

Parameters:

key - unique id of the object

type - type of the object

time1 - time of the point

price1 - price of the point

Returns:

graphical object

drawUnlocked

@Deprecated
IChartObject drawUnlocked(java.lang.String key,
                                     IChart.Type type,
                                     long time1,
                                     double price1,
                                     long time2,
                                     double price2,
                                     long time3,
                                     double price3)

Deprecated. - this method is deprecated. please use addToMainChartUnlocked() method instead. Draws graphical object that requires up to 3 points. Object can be selected, moved and changed by the user

Parameters:

key - unique id of the object

type - type of the object

time1 - time of first point

price1 - price of first point

time2 - time of second point

price2 - price of second point

time3 - time of third point

price3 - price of third point

Returns:

graphical object

drawUnlocked

@Deprecated
IChartObject drawUnlocked(java.lang.String key,
                                     IChart.Type type,
                                     long time1,
                                     double price1,
                                     long time2,
                                     double price2)

Deprecated. - this method is deprecated. please use addToMainChartUnlocked() method instead. Draws graphical object that requires up to 2 points. Object can be selected, moved and changed by the user

Parameters:

key - unique id of the object

type - type of the object

time1 - time of first point

price1 - price of first point

time2 - time of second point

price2 - price of second point

Returns:

graphical object

drawUnlocked

@Deprecated
IChartObject drawUnlocked(java.lang.String key,
                                     IChart.Type type,
                                     long time1,
                                     double price1)

Deprecated. - this method is deprecated. please use addToMainChartUnlocked() method instead.

Draws graphical object that requires only 1 point. Object can be selected, moved and changed by the user

Parameters:

key - unique id of the object

type - type of the object

time1 - time of the point

price1 - price of the point

Returns:

graphical object

move

void move(IChartObject objectToMove,
          long newTime,
          double newPrice)

Moves graphical object to new coordinates. Do not initiate chart repaint immediately, use IChart.repaint() method if necessary.

Parameters:

objectToMove - chart object to move

newTime - new time coordinate

newPrice - new price coordinate

move

void move(java.lang.String chartObjectKey,
          long newTime,
          double newPrice)

Moves graphical object to new coordinates. Do not initiate chart repaint immediately, use IChart.repaint() method if necessary.

Parameters:

chartObjectKey - key of the chart object to move

newTime - new time coordinate

newPrice - new price coordinate

comment

void comment(java.lang.String comment)

Writes a comment in the upper left corner. Line is splitted by new line characters

Parameters:

comment - string to display

setCommentHorizontalPosition

void setCommentHorizontalPosition(int position)

Sets the horizontal position of the comment's text.

Parameters:

position - One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT

Throws:

java.lang.IllegalArgumentException

See Also:

#getCommentHorizontalPosition()}, java.swing.SwingConstants

getCommentHorizontalPosition

int getCommentHorizontalPosition()

Returns the horizontal position of the comment's text.

Returns:

One of the following constants defined in SwingConstants: LEFT, CENTER, RIGHT.

See Also:

setCommentHorizontalPosition(int)

setCommentVerticalPosition

void setCommentVerticalPosition(int position)

Sets the vertical position of the comment's text.

Parameters:

position - One of the following constants defined in SwingConstants: TOP, CENTER, BOTTM

Throws:

java.lang.IllegalArgumentException

See Also:

getCommentVerticalPosition(), SwingConstants

getCommentVerticalPosition

int getCommentVerticalPosition()

Returns the vertical position of the comment's text.

Returns:

One of the following constants defined in SwingConstants: TOP, CENTER, BOTTOM.

See Also:

setCommentVerticalPosition(int)

setCommentFont

void setCommentFont(java.awt.Font font)

Sets the comment's font.

Parameters:

font - the desired Font for comment

See Also:

Component.getFont()

getCommentFont

java.awt.Font getCommentFont()

Gets the comment's font.

Returns:

comment's font; if a font has not been set for comment, then the font defined in chart's theme for drawings is returned

See Also:

setCommentFont(Font)

setCommentColor

void setCommentColor(java.awt.Color color)

Sets the foreground color of comment.

Parameters:

color - the color to become comment's foreground color if this parameter is null, then used default text font defined in chart's theme

See Also:

getCommentColor()

getCommentColor

java.awt.Color getCommentColor()

Gets the foreground color of comment.

Returns:

comments's foreground color if comment does not have a foreground color, then used default text font defined in chart's theme

See Also:

setCommentColor(Color)

get

IChartObject get(java.lang.String key)

Returns IChartObject instance by key if any exist on this panel.

Specified by:

get in interface IChartPanel

Parameters:

key - unique id

Returns:

IChartObject or null if no object was found by specified key

remove

IChartObject remove(java.lang.String key)

Deletes graphical object from this panel by key.

Specified by:

remove in interface IChartPanel

remove

void remove(IChartObject chartObject)

Deletes specified graphical object from this panel.

Specified by:

remove in interface IChartPanel

remove

java.util.List<IChartObject> remove(java.util.List<IChartObject> chartObjects)

Deletes graphical objects

Parameters:

chartObjects -

Returns:

list of all graphical objects that were actually removed from chart

getAll

java.util.List<IChartObject> getAll()

Returns all graphical objects on this panel.

Specified by:

getAll in interface IChartPanel

Returns:

list of all graphical objects on the chart

removeAll

void removeAll()

Removes all graphical objects from this panel.

Specified by:

removeAll in interface IChartPanel

size

int size()

Returns number of the graphical objects on the chart

Returns:

number of the graphical objects on the chart

priceMin

@Deprecated
double priceMin(int index)

Deprecated. use IChartPanel.getMinPrice()

Returns minimal value of the vertical scale.

Parameters:

index - of the (sub-)window

Returns:

minimal value of the vertical scale

priceMax

@Deprecated
double priceMax(int index)

Deprecated. use IChartPanel.getMaxPrice()

Returns maximal value of the vertical scale.

Parameters:

index - of the (sub-)window

Returns:

maximal value of the vertical scale

setVerticalAxisScale

void setVerticalAxisScale(double minPriceValue,
                          double maxPriceValue)

Sets minimal and maximal value of the vertical scale of the current chart when it is maximally expanded. Note: automatically switches off chart price range autoscaling.

Parameters:

minPriceValue - minimal value of the vertical scale

maxpriceValue - maximal value of the vertical scale

setVerticalAutoscale

void setVerticalAutoscale(boolean autoscale)

Switches on/off chart vertical autoscale mode. When autoscale switched off chart is draggable vertically

Parameters:

autoscale -

getBarsCount

int getBarsCount()

Returns amount of bars visible on the screen

Returns:

amount of bars visible on the screen

windowsTotal

int windowsTotal()

Returns count of indicator windows on the chart (including main chart).

Returns:

total count of chart windows (main window + indicator subwindows)

getInstrument

Instrument getInstrument()

Returns instrument of the chart

Returns:

instrument of the chart

See Also:

getFeedDescriptor()

setInstrument

void setInstrument(Instrument instrument)

Deprecated. 

Sets chart's instrument

Parameters:

instrument -

getSelectedPeriod

Period getSelectedPeriod()

Returns selected period

Returns:

selected period

See Also:

getFeedDescriptor()

getSelectedOfferSide

OfferSide getSelectedOfferSide()

Returns selected offer side

Returns:

selected offer side

See Also:

getFeedDescriptor()

addIndicator

@Deprecated
void addIndicator(IIndicator indicator)

Deprecated. please use IChartPanel.add(IIndicator) method

Add indicator to the chart

Parameters:

indicator - as IIndicator

addIndicator

@Deprecated
void addIndicator(IIndicator indicator,
                             java.lang.Object[] optParams)

Deprecated. Please use IChartPanel.add(IIndicator, Object[]) method

Add indicator to the chart by specifying initial optional parameters values If optParams equals to null - default ones will be taken instead

Parameters:

indicator - as IIndicator

optParams - as Object[]

addIndicator

@Deprecated
void addIndicator(IIndicator indicator,
                             java.lang.Object[] optParams,
                             java.awt.Color[] outputColors,
                             OutputParameterInfo.DrawingStyle[] outputDrawingStyles,
                             int[] outputWidths)

Deprecated. Please use #add(IIndicator, Object[], Color[], DrawingStyle[], int[]) method

Add indicator to the chart by specifying initial optional parameters values, curves colors, drawing styles and line widths If output params are nulls - default ones will be taken instead

Parameters:

indicator - as IIndicator

optParams - as Object[]

outputColors - as Color[]

outputDrawingStyles - as DrawingStyle[]

outputWidths - as int[]

addSubIndicator

@Deprecated
void addSubIndicator(java.lang.Integer subChartId,
                                IIndicator indicator)

Deprecated. use getIndicatorPanels() and IChartPanel.add(IIndicator) methods.

Add sub indicator

Parameters:

subChartId -

indicator - as IIndicator

removeIndicator

void removeIndicator(IIndicator indicator)

Remove specified indicator from this panel.

Specified by:

removeIndicator in interface IChartPanel

Parameters:

indicator - instance of IIndicator interface

getIndicators

java.util.List<IIndicator> getIndicators()

Returns all indicators on chart (including sub panels)

Specified by:

getIndicators in interface IChartPanel

Returns:

List

getDataType

DataType getDataType()

Returns selected Data Type

Returns:

selected Data Type

See Also:

getFeedDescriptor()

getPriceRange

PriceRange getPriceRange()

The method returns currently selected Price Range on chart

Returns:

selected Price Range

See Also:

getFeedDescriptor()

getReversalAmount

ReversalAmount getReversalAmount()

The method returns currently selected Reversal Amount on the Point And Figure chart For non P&F charts null will be returned

Returns:

selected Reversal Amount

See Also:

getFeedDescriptor()

getFilter

Filter getFilter()

Returns current filter

Returns:

filter

See Also:

getFeedDescriptor()

getFeedDescriptor

IFeedDescriptor getFeedDescriptor()

Returns chart state described by bean IFeedDescriptor

Returns:

chart state described by bean IFeedDescriptor

repaint

void repaint()

Refresh and repaint chart

getChartObjectFactory

IChartObjectFactory getChartObjectFactory()

Returns IChartObjectFactory instance. This factory provides convenience methods to create various graphics objects.

Returns:

IChartObjectFactory instance.

addToMainChart

@Deprecated
void addToMainChart(IChartObject object)

Deprecated. Please use IChartPanel.add(IChartObject) method

Adds object of IChartObject super type to main chart window. Please note that only one instance of object can be added per main chart window.

Parameters:

object - - instance of IChartObject super type.

Throws:

java.lang.IllegalArgumentException - - if object is already present on any of main charts.

addToSubChart

@Deprecated
void addToSubChart(java.lang.Integer subChartId,
                              int indicatorId,
                              IChartObject object)

Deprecated. use getIndicatorPanels() and IIndicatorPanel.add(IChartObject) methods

Adds object of IChartObject super type to sub chart window with specified subChartId and indicatorId. Please note that only one instance of object can be added per sub chart window.

Parameters:

subChartId - - sub chart id.

indicatorId - - indicator function id.

object - - instance of IChartObject super type.

Throws:

java.lang.IllegalArgumentException - - if object is already present on any of sub charts.

addToMainChartUnlocked

@Deprecated
void addToMainChartUnlocked(IChartObject object)

Deprecated. Please, use method @link addToMainChart(IChartObject) There is no objects division onto locked and unlocked anymore

Adds object of IChartObject super type to unlocked objects pool of main chart window. Please note that only one instance of object can be added to unlocked objects pool per main chart window.

Parameters:

object - - instance of IChartObject super type.

Throws:

java.lang.IllegalArgumentException - - if object is already present on any of main charts unlocked objects pool.

isChartObjectUnlocked

@Deprecated
java.lang.Boolean isChartObjectUnlocked(IChartObject chartObject)

Deprecated. There is no objects division onto locked and unlocked anymore, so this method will always return false

Checks whether chartObject is unlocked or not. Returns null if chart does not contain specified chartObject

Parameters:

chartObject -

Returns:

true - chartObject is unlocked, false - if not, null - chartObject does not belong to this chart.

getTickBarSize

TickBarSize getTickBarSize()

The method returns currently selected Trade Bar Size on Tick Bar chart For non Tick Bar charts null might be returned

Returns:

selected Tick Bar Size

See Also:

getFeedDescriptor()

getStrategyChartObjects

java.util.List<IChartObject> getStrategyChartObjects()

The method returns List of chart objects created by current strategy Empty list is returned if no objects were created Null is never returned

Returns:

chart objects that were create by current strategy

getImage

java.awt.image.BufferedImage getImage()

Creates a BufferedImage snapshot of this chart at the given moment.

Returns:

BufferedImage snapshot of current chart at the method invocation moment.

setDataPresentationType

void setDataPresentationType(DataType.DataPresentationType presentationType)

Applies DataPresentationType to current chart. Use getDataType().getSupportedPresentationTypes() to get all allowed values. Use getDataType().isPresentationTypeSupported(DataPresentationType presentationType) to check whether current DataType supports presentationType or not.

Parameters:

presentationType - one of DataPresentationType constants, supported by current DataType

Throws:

java.lang.IllegalArgumentException - if DataPresentationType is not supported by current DataType

See Also:

getDataType()

getDataPresentationType

DataType.DataPresentationType getDataPresentationType()

Returns charts' current DataType.DataPresentationType. Depends on current DataType value

See Also:

getDataType()

selectDrawing

void selectDrawing(java.lang.String key)

Select specified drawing by key. Note: locked drawings cannot be selected.

Parameters:

key -

See Also:

IChartObject.isLocked(), IChartObject.setLocked(boolean)

selectDrawing

void selectDrawing(IChartObject chartObject)

Select specified drawing. Note: locked drawings cannot be selected.

Parameters:

chartObject -

See Also:

IChartObject.isLocked(), IChartObject.setLocked(boolean)

navigateAndSelectDrawing

void navigateAndSelectDrawing(java.lang.String key)

Navigates to and selects specified drawing by key. Note: locked drawings cannot be selected.

Parameters:

key -

See Also:

IChartObject.isLocked(), IChartObject.setLocked(boolean)

navigateAndSelectDrawing

void navigateAndSelectDrawing(IChartObject chartObject)

Navigates to and selects specified drawing. Note: locked drawings cannot be selected.

Parameters:

chartObject -

See Also:

IChartObject.isLocked(), IChartObject.setLocked(boolean)

getIndicatorPanels

java.util.List<IIndicatorPanel> getIndicatorPanels()

Returns current chart active sub panels.

Returns:

list of panels

addSubIndicator

@Deprecated
void addSubIndicator(IIndicator indicator)

Deprecated. use IChartPanel.add(IIndicator)

Creates new sub panel and adds indicator onto it.

Parameters:

indicator -

addSubIndicatorByPanelIndex

@Deprecated
void addSubIndicatorByPanelIndex(java.lang.Integer subPanelIndex,
                                            IIndicator indicator)

Deprecated. use getIndicatorPanels() and IChartPanel.add(IIndicator) methods

Adds indicator to chart sub panel with specified index (not ID).

Parameters:

subPanelIndex -

indicator -

Throws:

java.lang.IllegalStateException - in case of incorrect subPanelIndex or indicator is not designed for sub panel.

addToSubChart

@Deprecated
void addToSubChart(int subPanelIndex,
                              IChartObject chartObject)

Deprecated. use getIndicatorPanels() and IIndicatorPanel.add(IChartObject) methods

Adds object of IChartObject type to sub chart panel with specified index. Please note that only one instance of object can be added on chart.

Parameters:

subPanelIndex -

chartObject -

Throws:

java.lang.IllegalArgumentException - in case of incorrect index

getLastRequestedData

ITimedData[] getLastRequestedData()

Returns data feed objects that are plotted on the chart at the given moment. The 0th element stands for the first visible data feed object on the chart, and the last element - for the last visible data feed object on the chart. Object type depends on getDataType()

Returns:

data feed objects that are plotted on the chart at the given moment.

getLastCalculatedIndicatorOutputs

java.util.Map<IIndicator,java.lang.Object[]> getLastCalculatedIndicatorOutputs()

Returns outputs of the indicators that are plotted on the chart at the given moment. Each Object in Object[] stands for an output array of an indicator. In each output array that is represented by an Object (of Object[]), the 0th element stands for the first visible data feed object on the chart, and the last element - for the data feed object element on the chart.

Returns:

outputs of the indicators that are plotted on the chart at the given moment.

getMinTime

long getMinTime()

Returns the minimal time axis value.

Returns:

minimal time axis value

getMaxTime

long getMaxTime()

Returns the maximal time axis value. Note that for charts of DataType other than DataType.TICKS or DataType.TIME_PERIOD_AGGREGATION, the maximal time value is the one of the last feed data element.

Returns:

maximal time axis value