Class Chart2D

Method Details

• addAxisXBottom

  public void addAxisXBottom(AAxis<?> axisX)

  Adds the given x axis to the list of internal bottom x axes.

  The given axis must not be contained before (e.g. as right y axis or bottom x axis...).

  Parameters:

  axisX - the additional bottom x axis.

• addAxisXTop

  public void addAxisXTop(AAxis<?> axisX)

  Adds the given x axis to the list of internal top x axes.

  The given axis must not be contained before (e.g. as right y axis or bottom x axis...).

  Parameters:

  axisX - the additional top x axis.

• addAxisYLeft

  public void addAxisYLeft(AAxis<?> axisY)

  Adds the given y axis to the list of internal left y axes.

  The given axis must not be contained before (e.g. as right y axis or bottom x axis...).

  Parameters:

  axisY - the additional left y axis.

• addAxisYRight

  public void addAxisYRight(AAxis<?> axisY)

  Adds the given y axis to the list of internal right y axes.

  The given axis must not be contained before (e.g. as right y axis or bottom x axis...).

  Parameters:

  axisY - the additional right y axis.

• addTrace

  public final void addTrace(ITrace2D points)

  Convenience method that adds the trace to this chart with relation to the first bottom x axis and the first left y axis. It will be painted (if it's ITrace2D.isVisible() returns true) in this chart.

  This method will trigger a PropertyChangeEvent being fired on all instances registered by Container.addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) (registered with String argument IAxis.PROPERTY_ADD_REMOVE_TRACE) on the internal bottom x axis and left y axis.

  Parameters:

  points - the trace to add.

  See Also:

  • IAxis.PROPERTY_ADD_REMOVE_TRACE
  • addTrace(ITrace2D, IAxis, IAxis)

• addTrace

  public final void addTrace(ITrace2D points, IAxis<?> xAxis, IAxis<?> yAxis)

  Adds the trace to this chart with relation to the given x axis and y axis. It will be painted (if it's ITrace2D.isVisible() returns true) in this chart.

  This method will trigger a PropertyChangeEvent being fired on all instances registered by Container.addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) (registered with String argument IAxis.PROPERTY_ADD_REMOVE_TRACE) on the axis of this chart.

  The given x and y axis will be responsible for computation of the scale of this trace.

  Parameters:

  points - the trace to add.

  xAxis - the x axis responsible for the scale of this trace - it has to be contained in this chart or an exception will be thrown.

  yAxis - the y axis responsible for the scale of this trace - it has to be contained in this chart or an exception will be thrown.

  See Also:

  • IAxis.PROPERTY_ADD_REMOVE_TRACE

• createToolTip

  public JToolTip createToolTip()

  Overrides:

  createToolTip in class JComponent

  See Also:

  • JComponent.createToolTip()

• destroy

  public void destroy()

  Destroys the chart.

  This method is only of interest if you have an application that dynamically adds and removes charts. So if you use the same Chart2D object(s) during the applications lifetime there is no need to use this method.

• enablePointHighlighting

  public boolean enablePointHighlighting(boolean onoff)

  Switches point highlighting on or off depending on the given argument.

  Turning off this removes a MouseMotionListener and therefore avoids receiving a lot of mouse events which will result in potentially very expensive (many traces with many points) computations to find the nearest point corresponding to the mouse pointer. So dropping the point highlighting feature may result in much better real time performance.

  Keep in mind that the view part of point highlighting is configured by configuring the point highlighters for your traces: ITrace2D.addPointHighlighter(IPointPainter).

  This method might trigger a PropertyChangeEvent being fired on all instances registered by Container.addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) (registered with String argument PROPERTY_POINT_HIGHLIGHTING_ENABLED).

  Parameters:

  onoff - if true the closest point to the cursor will be highlighted, if false you might gain performance by having this feature turned off!

  Returns:

  true if a change of this state did take place (you did not call this at least twice with the same argument).

  See Also:

  • ITrace2D.addPointHighlighter(IPointPainter)
  • isEnabledPointHighlighting()

• finalize

  protected void finalize() throws Throwable

  Cleanup when this instance is dropped.

  Overrides:

  finalize in class Object

  Throws:

  Throwable - if a finalizer of a superclass fails.

  See Also:

  • Object.finalize()

• findAxesOfTrace

  public IAxis<?>[] findAxesOfTrace(ITrace2D trace)

  Returns an array with the x (position 0) and the y axis (position 1) of the given trace if it is correctly set up. If the given trace is not set up correctly with this chart a missing axis in one dimension will be reflected in null on the corresponding position

  Parameters:

  trace - the trace to find the axes of.

  Returns:

  an array with the x (position 0) and the y axis (position 1) of the given trace if it is correctly set up.

• getAxes

  public final List<IAxis<?>> getAxes()

  Returns the List<IAxis> with all axes of the chart.

  Returns:

  the List<IAxis> with all axes of the chart

• getAxesXBottom

  public final List<IAxis<?>> getAxesXBottom()

  Returns the List<IAxis> with instances that are painted in x dimension on the bottom of the chart.

  Caution! The original list is returned so modifications of it will cause unpredictable side effects.

  Returns:

  the List<IAxis> with instances that are painted in x dimension on the bottom of the chart.

• getAxesXTop

  public final List<IAxis<?>> getAxesXTop()

  Returns the List<IAxis> with instances that are painted in x dimension on top of the chart.

  Caution! The original list is returned so modifications of it will cause unpredictable side effects.

  Returns:

  the List<IAxis> with instances that are painted in x dimension on top of the chart.

• getAxesYLeft

  public final List<IAxis<?>> getAxesYLeft()

  Returns the List<IAxis> with instances that are painted in y dimension on the left side of the chart.

  Caution! The original list is returned so modifications of it will cause unpredictable side effects.

  Returns:

  the List<IAxis> with instances that are painted in y dimension on the left side of the chart.

• getAxesYRight

  public final List<IAxis<?>> getAxesYRight()

  Returns the List<IAxis> with instances that are painted in y dimension on the right side of the chart.

  Caution! The original list is returned so modifications of it will cause unpredictable side effects.

  Returns:

  the List<IAxis> with instances that are painted in y dimension on the right side of the chart.

• getAxisTickPainter

  public IAxisTickPainter getAxisTickPainter()

  Returns the painter for the ticks of the axis.

  Returns:

  Returns the painter for the ticks of the axis.

• getAxisX

  public final IAxis<?> getAxisX()

  Returns the first bottom axis for the x dimension.

  Returns:

  the first bottom axis for the x dimension.

• getAxisX

  public IAxis<?> getAxisX(ITrace2D trace)

  Returns the x axis that the given trace belongs to or null if this trace does not belong to any x axis of this chart.

  Parameters:

  trace - the trace to find the corresponding x axis of this chart for.

  Returns:

  the x axis that the given trace belongs to or null if this trace does not belong to any x axis of this chart.

• getAxisY

  public final IAxis<?> getAxisY()

  Returns the first left axis for the y dimension.

  Returns:

  the first left axis for the y dimension.

• getAxisY

  public IAxis<?> getAxisY(ITrace2D trace)

  Returns the y axis that the given trace belongs to or null if this trace does not belong to any y axis of this chart.

  Parameters:

  trace - the trace to find the corresponding y axis of this chart for.

  Returns:

  the y axis that the given trace belongs to or null if this trace does not belong to any y axis of this chart.

• getGridColor

  public final Color getGridColor()

  Returns the color of the grid.

  Returns:

  the color of the grid.

• getHeight

  public int getHeight()

  Overrides:

  getHeight in class JComponent

  See Also:

  • JComponent.getHeight()

• getMinPaintLatency

  public int getMinPaintLatency()

  Returns the chart - wide setting for the ms to give a repaint operation time for collecting several repaint requests into one (performance vs. update speed).

  Returns:

  the setting for the ms to give a repaint operation time for collecting several repaint requests into one (performance vs. update speed).

• getNearestPointEuclid

  public ITracePoint2D getNearestPointEuclid(int mouseEventX, int mouseEventY)

  Returns the nearest ITracePoint2D to the given mouse event's screen coordinates in Euclid distance.

  This method is expensive and should not be used when rendering fast changing charts with many points.

  Using the Manhattan distance is much faster than Euclid distance as it only includes basic addition an absolute value for computation per point (vs. square root, addition and quadrature for Euclid distance). However the euclid distance spans a circle for the nearest points which is visually more normal for end users than the Manhattan distance which forms a rhombus and reaches far distances in only one dimension.

  Parameters:

  mouseEventX - the x pixel value relative to the chart (e.g.: MouseEvent.getY()).

  mouseEventY - the y pixel value relative to the chart (e.g.: MouseEvent.getY()).

  Returns:

  the nearest ITracePoint2D to the given mouse event's screen coordinates.

• getNearestPointEuclid

  public ITracePoint2D getNearestPointEuclid(MouseEvent me)

  Returns the nearest MouseEvent to the given mouse event's screen coordinates in Euclid distance.

  This method is expensive and should not be used when rendering fast changing charts with many points.

  Note that the given mouse event should be an event fired on this chart component. Else results will point to the nearest point of the chart in the direction of the mouse event's position.

  Using the Manhattan distance is much faster than Euclid distance as it only includes basic addition an absolute value for computation per point (vs. square root, addition and quadrature for Euclid distance). However the euclid distance spans a circle for the nearest points which is visually more normal for end users than the Manhattan distance which forms a rhombus and reaches far distances in only one dimension.

  Parameters:

  me - a mouse event fired on this component.

  Returns:

  nearest MouseEvent to the given mouse event's screen coordinates or null if the chart is empty.

• getNearestPointManhattan

  public ITracePoint2D getNearestPointManhattan(int mouseEventX, int mouseEventY)

  Returns the nearest ITracePoint2D to the given mouse event's screen coordinates in Manhattan distance.

  This method is expensive and should not be used when rendering fast changing charts with many points.

  Using the Manhattan distance is much faster than Euclid distance as it only includes basic addition an absolute value for computation per point (vs. square root, addition and quadrature for Euclid distance). However the euclid distance spans a circle for the nearest points which is visually more normal for end users than the Manhattan distance which forms a rhombus and reaches far distances in only one dimension.

  Parameters:

  mouseEventX - the x pixel value relative to the chart (e.g.: MouseEvent.getY()).

  mouseEventY - the y pixel value relative to the chart (e.g.: MouseEvent.getY()).

  Returns:

  the nearest ITracePoint2D to the given mouse event's screen coordinates.

• getNearestPointManhattan

  public ITracePoint2D getNearestPointManhattan(MouseEvent me)

  Returns the nearest MouseEvent to the given mouse event's screen coordinates in Manhattan distance.

  This method is expensive and should not be used when rendering fast changing charts with many points.

  Note that the given mouse event should be an event fired on this chart component. Else results will point to the nearest point of the chart in the direction of the mouse event's position.

  Using the Manhattan distance is much faster than Euclid distance as it only includes basic addition an absolute value for computation per point (vs. square root, addition and quadrature for Euclid distance). However the euclid distance spans a circle for the nearest points which is visually more normal for end users than the Manhattan distance which forms a rhombus and reaches far distances in only one dimension.

  Parameters:

  me - a mouse event fired on this component.

  Returns:

  nearest MouseEvent to the given mouse event's screen coordinates or null if the chart is empty.

• getPointFinder

  public IPointFinder getPointFinder()

  Returns the point finder used to find the nearest point corresponding to a mouse event.

  Returns:

  the point finder used to find the nearest point corresponding to a mouse event.

• getPreferredSize

  public Dimension getPreferredSize()

  Overrides:

  getPreferredSize in class JComponent

  See Also:

  • JComponent.getPreferredSize()

• getSize

  public Dimension getSize()

  Overridden to allow full - page printing.

  Overrides:

  getSize in class Component

  See Also:

  • Component.getSize()

• getSynchronizedXStartChart

  public final Chart2D getSynchronizedXStartChart()

  Returns the chart that will be synchronized for finding the start coordinate of this chart to draw in x dimension ( getXChartStart() ).

  This feature is used to allow two separate charts to be painted stacked in y dimension (one below the other) that have different x start coordinates (because of different y labels that shift that value) with an equal starting x value (thus be comparable visually if their x values match).

  Returns:

  the chart that will be synchronized for finding the start coordinate of this chart to draw in x dimension ( getXChartStart()).

• getToolTipText

  public final String getToolTipText(MouseEvent event)

  Overrides:

  getToolTipText in class JComponent

  See Also:

  • JComponent.getToolTipText(java.awt.event.MouseEvent)

• getToolTipType

  public IToolTipType getToolTipType()

  Returns the type of tool tip shown.

  Returns:

  the type of tool tip shown.

  See Also:

  • Chart2D.ToolTipType.DATAVALUES
  • Chart2D.ToolTipType.NONE
  • Chart2D.ToolTipType.PIXEL
  • Chart2D.ToolTipType.VALUE_SNAP_TO_TRACEPOINTS

• getTracePointProvider

  public ITracePointProvider getTracePointProvider()

  Returns the trace point creator of this chart.

  Returns:

  the trace point creator of this chart.

• getTraces

  public final SortedSet<ITrace2D> getTraces()

  Returns the set of traces that are currently rendered by this instance.

  The instances are collected from all underlying axes. The resulting Set is not an original set. Therefore modification methods like Set.add(Object) or Set.clear() will not have any effect on the setup of this chart.

  Returns:

  the set of traces that are currently rendered by this instance.

• getWidth

  public int getWidth()

  Overrides:

  getWidth in class JComponent

  See Also:

  • JComponent.getWidth()

• getXAxisWidth

  public final int getXAxisWidth()

  Returns the width of the X axis in px.

  Returns:

  Returns the width of the X axis in px.

• getXChartEnd

  public final int getXChartEnd()

  Returns the x coordinate of the chart's right edge in px.

  Returns:

  the x coordinate of the chart's right edge in px.

• getXChartStart

  public final int getXChartStart()

  Returns the x coordinate of the chart's left edge in px.

  Returns:

  Returns the x coordinate of the chart's left edge in px.

• getYChartEnd

  public final int getYChartEnd()

  Returns the y coordinate of the upper edge of the chart's display area in px.

  Pixel coordinates in awt / swing start from top and increase towards the bottom.

  Returns:

  The y coordinate of the upper edge of the chart's display area in px.

• getYChartStart

  public int getYChartStart()

  Returns the y coordinate of the chart's lower edge in px.

  Pixel coordinates in awt / swing start from top and increase towards the bottom.

  Returns:

  Returns the y coordinate of the chart's lower edge in px.

• isEnabledPointHighlighting

  public boolean isEnabledPointHighlighting()

  Returns true if highlighting of the nearest point to the cursor is enabled.

  Returns:

  true if highlighting of the nearest point to the cursor is enabled.

• isPaintLabels

  public final boolean isPaintLabels()

  Returns true if labels for each chart are painted below it, false else.

  Returns:

  Returns if labels are painted.

• isRequestedRepaint

  protected boolean isRequestedRepaint()

  Returns the requestedRepaint.

  Returns:

  the requestedRepaint

• isToolTipCoords

  public final boolean isToolTipCoords()

  Returns true if chart coordinates are drawn as tool tips.

  Returns:

  true if chart coordinates are drawn as tool tips.

• isUseAntialiasing

  public final boolean isUseAntialiasing()

  Returns whether antialiasing is used.

  Returns:

  whether antialiasing is used.

• isVisible

  public boolean isVisible(ITracePoint2D point)

  Returns true if the given point is in the visible drawing area of the Chart2D.

  If the point is null false will be returned.

  This only works if the point argument has been scaled already.

  Parameters:

  point - the point to test.

  Returns:

  true if the given point is in the visible drawing area of the Chart2D.

• iterator

  public final Iterator<ITrace2D> iterator()

  Returns an Iterator over the contained ITrace2D instances.

  Specified by:

  iterator in interface Iterable<ITrace2D>

  Returns:

  an Iterator over the contained ITrace2D instances.

• paint

  public void paint(Graphics g)

  This method is just overridden to ensure a lock on this instance and then a lock on Component.getTreeLock() just as it has to be done in that order in addTrace(ITrace2D, IAxis, IAxis).

  More info: This lock is needed to ensure a lock on the tree is acquired before a lock to the chart. Method addTrace has a code path that might descend into ChartPanel where Container.getComponents() (in method containsTraceLabel()) will require the tree lock after having already acquired the chart lock -> deadlock between paint thread and addTrace thread when using ChartPanel.

  Overrides:

  paint in class JComponent

  See Also:

  • JComponent.paint(java.awt.Graphics)

• paintComponent

  protected void paintComponent(Graphics g)

  A basic rule of a JComponent is:
  Never invoke this method directly.
  See the description of JComponent.paintComponent(java.awt.Graphics) for details.

  If you do invoke this method you may encounter performance issues, flickering UI and even deadlocks.

  Overrides:

  paintComponent in class JComponent

  Parameters:

  g - the graphics context to use.

• print

  public int print(Graphics graphics, PageFormat pageFormat, int pageIndex) throws PrinterException

  Specified by:

  print in interface Printable

  Throws:

  PrinterException

  See Also:

  • Printable.print(java.awt.Graphics, java.awt.print.PageFormat, int)

• propertyChange

  public void propertyChange(PropertyChangeEvent evt)

  Receives all PropertyChangeEvent from all instances the chart registers itself as a PropertyChangeListener .

  Specified by:

  propertyChange in interface PropertyChangeListener

  Parameters:

  evt - the property change event that was fired.

  See Also:

  • PropertyChangeListener.propertyChange(java.beans.PropertyChangeEvent)

• removeAllTraces

  public Set<ITrace2D> removeAllTraces()

  Convenience method to remove all traces from this chart.

  This method is broken down to every axis contained in the trace and will fire a PropertyChangeEvent for the PropertyChangeEvent.getPropertyName() IAxis.PROPERTY_ADD_REMOVE_TRACE for every single trace removed to PropertyChangeListener of the corresponding axes.

  Returns:

  a non-original-backed set of distinct traces that was contained in this chart before.

• removeAxisXBottom

  public boolean removeAxisXBottom(IAxis<?> axisX)

  Removes the given x axis from the list of internal bottom x axes.

  The given axis should be contained before or false will be returned.

  Parameters:

  axisX - the bottom x axis to remove.

  Returns:

  true if the given axis was successfully removed or false if it was not configured as a bottom x axis before or could not be removed for another reason.

• removeAxisXTop

  public boolean removeAxisXTop(IAxis<?> axisX)

  Removes the given x axis from the list of internal top x axes.

  The given axis should be contained before or false will be returned.

  Parameters:

  axisX - the top x axis to remove.

  Returns:

  true if the given axis was successfully removed or false if it was not configured as a top x axis before or could not be removed for another reason.

• removeAxisYLeft

  public boolean removeAxisYLeft(IAxis<?> axisY)

  Removes the given y axis from the list of internal left y axes.

  The given axis should be contained before or false will be returned.

  Parameters:

  axisY - the left y axis to remove.

  Returns:

  true if the given axis was successfully removed or false if it was not configured as a left y axis before or could not be removed for another reason.

• removeAxisYRight

  public boolean removeAxisYRight(IAxis<?> axisY)

  Removes the given y axis from the list of internal right y axes.

  The given axis should be contained before or false will be returned.

  Parameters:

  axisY - the right y axis to remove.

  Returns:

  true if the given axis was successfully removed or false if it was not configured as a right y axis before or could not be removed for another reason.

• removeTrace

  public final boolean removeTrace(ITrace2D points)

  Removes the given instance from this Chart2D if it is contained.

  This method will trigger a PropertyChangeEvent being fired on all instances registered by Container.addPropertyChangeListener(java.lang.String, java.beans.PropertyChangeListener) (registered with String argument IAxis.PROPERTY_ADD_REMOVE_TRACE on the internal axes).

  Parameters:

  points - the trace to remove.

  Returns:

  true if the given trace was removed successfully, false else.

  See Also:

  • IAxis.PROPERTY_ADD_REMOVE_TRACE

• repaint

  @Deprecated public void repaint()

  Deprecated.

  use setRequestedRepaint(boolean).

  Overrides:

  repaint in class Component

  See Also:

  • Component.repaint()

• repaint

  @Deprecated public void repaint(int x, int y, int width, int height)

  Deprecated.

  use setRequestedRepaint(boolean).

  Overrides:

  repaint in class Component

  See Also:

  • Component.repaint(int, int, int, int)

• repaint

  @Deprecated public void repaint(long tm)

  Deprecated.

  use setRequestedRepaint(boolean).

  Overrides:

  repaint in class Component

  See Also:

  • Component.repaint(long)

• repaint

  @Deprecated public void repaint(long tm, int x, int y, int width, int height)

  Deprecated.

  use setRequestedRepaint(boolean).

  Overrides:

  repaint in class JComponent

  See Also:

  • JComponent.repaint(long, int, int, int, int)

• repaint

  @Deprecated public void repaint(Rectangle r)

  Deprecated.

  use setRequestedRepaint(boolean).

  Overrides:

  repaint in class JComponent

  See Also:

  • JComponent.repaint(java.awt.Rectangle)

• resetPrintMode

  public void resetPrintMode()

  Only intended for Chart2DActionPrintSingleton.

• setAxisTickPainter

  public void setAxisTickPainter(IAxisTickPainter tickPainter)

  Sets the axis tick painter.

  Parameters:

  tickPainter - The axis tick painter to set.

• setAxisX

  @Deprecated public List<IAxis<?>> setAxisX(AAxis<?> axisX)

  Deprecated.

  use setAxisXBottom(AAxis, int) instead.

  Sets the first bottom x axis to use.

  This is compatibility support for the API of jchart2d prior to 3.0.0 where only one x axis was supported.

  Parameters:

  axisX - the first bottom x axis to use.

  Returns:

  a copied List with the previous bottom x IAxis instance that was used at position 0.

  See Also:

  • setAxisXBottom(AAxis, int)

• setAxisXBottom

  public IAxis<?> setAxisXBottom(AAxis<?> axisX, int position)

  Sets the bottom x axis on the given position to use and replaces the old one on that place.

  This method delegates to addAxisXBottom(AAxis) and also uses removeAxisXBottom(IAxis) in case a bottom x axis was configured at the position. So the events PROPERTY_AXIS_X will be fired for remove and add.

  Furthermore this method uses "replace - semantics". The ITrace2D instances contained in the previous x bottom axis will be implanted to this new axis. Also the title and stuff like grid settings will be transferred. For this an event with property PROPERTY_AXIS_X_BOTTOM_REPLACE is fired.

  Note that PropertyChangeListeners of the axis will not be transferred silently to the new axis but have to handle their unregistering from the old axis / registering to the new axis from outside to give them the chance to manage their state transitions by themselves.
  Before the state of the old axis is transferred they will receive PropertyChangeListener.propertyChange(PropertyChangeEvent) with PROPERTY_AXIS_X_BOTTOM_REPLACE as code and the old and new axis as values and have the change to change their peer to listen on thus receiving the change events generated on the new axis. At the moment the replace event is sent they will already have received the event PROPERTY_AXIS_X event for the removal: So be careful not to react on that first event by removing your listener from the axis as you then will not receive the replace event!

  Parameters:

  axisX - the first bottom x axis to use.

  position - the index of the axis on bottom x dimension (starting from 0).

  Returns:

  the previous axis on that bottom x position or null.

• setAxisXTop

  public IAxis<?> setAxisXTop(AAxis<?> axisX, int position)

  Sets the top x axis on the given position to use and replaces the old one on that place.

  This method delegates to addAxisXBottom(AAxis) and also uses removeAxisXBottom(IAxis) in case a top x axis was configured on the position. So the events PROPERTY_AXIS_X will be fired for remove and add.

  Furthermore this method uses "replace - semantics". The ITrace2D instances contained in the previous x top axis will be implanted to this new axis. Also the title and stuff like grid settings will be transferred. For this an event with property PROPERTY_AXIS_Y_LEFT_REPLACE is fired.

  Note that PropertyChangeListeners of the axis will not be transferred silently to the new axis but have to handle their unregistering from the old axis / registering to the new axis from outside to give them the chance to manage their state transitions by themselves.
  Before the state of the old axis is transferred they will receive PropertyChangeListener.propertyChange(PropertyChangeEvent) with PROPERTY_AXIS_X_TOP_REPLACE as code and the old and new axis as values and have the change to change their peer to listen on thus receiving the change events generated on the new axis. At the moment the replace event is sent they will already have received the event PROPERTY_AXIS_X event for the removal: So be careful not to react on that first event by removing your listener from the axis as you then will not receive the replace event!

  Parameters:

  axisX - the top x axis to use.

  position - the index of the axis on top x dimension (starting from 0).

  Returns:

  the previous axis on that bottom x position.

• setAxisY

  @Deprecated public List<IAxis<?>> setAxisY(AAxis<?> axisY)

  Deprecated.

  use setAxisYLeft(AAxis, int) instead.

  Sets the first and only left y axis to use.

  This is compatibility support for the API of jchart2d prior to 3.0.0 where only one y axis was supported.

  Parameters:

  axisY - the first left y axis to use.

  Returns:

  a copied List with the previous left y AAxis instance that was used at position 0.

  See Also:

  • setAxisYLeft(AAxis, int)

• setAxisYLeft

  public IAxis<?> setAxisYLeft(AAxis<?> axisY, int position)

  Sets the left y axis on the given position to use and replaces the old one on that place.

  This method delegates to addAxisYLeft(AAxis) and also uses removeAxisYLeft(IAxis) in case an axis was configured on the position. So the events PROPERTY_AXIS_Y will be fired for remove and add.

  Furthermore this method uses "replace - semantics". The ITrace2D instances contained in the previous left y axis will be implanted to this new axis. Also the title and stuff like grid settings will be transferred. For this an event with property PROPERTY_AXIS_Y_LEFT_REPLACE is fired.

  Note that PropertyChangeListeners of the axis will not be transferred silently to the new axis but have to handle their unregistering from the old axis / registering to the new axis from outside to give them the chance to manage their state transitions by themselves.
  Before the state of the old axis is transferred they will receive PropertyChangeListener.propertyChange(PropertyChangeEvent) with PROPERTY_AXIS_Y_LEFT_REPLACE as code and the old and new axis as values and have the change to change their peer to listen on thus receiving the change events generated on the new axis. At the moment the replace event is sent they will already have received the event PROPERTY_AXIS_Y event for the removal: So be careful not to react on that first event by removing your listener from the axis as you then will not receive the replace event!

  Parameters:

  axisY - the left y axis to use.

  position - the index of the axis on left y dimension (starting from 0).

  Returns:

  the previous axis on that bottom x position.

• setAxisYRight

  public IAxis<?> setAxisYRight(AAxis<?> axisY, int position)

  Sets the right y axis on the given position to use and replaces the old one on that place.

  This method delegates to addAxisYRight(AAxis) and also uses removeAxisYRight(IAxis) in case an axis was configured on the position. So the events PROPERTY_AXIS_Y will be fired for remove and add.

  Furthermore this method uses "replace - semantics". The ITrace2D instances contained in the previous right y axis will be implanted to this new axis. Also the title and stuff like grid settings will be transferred. For this an event with property PROPERTY_AXIS_Y_RIGHT_REPLACE is fired.

  Note that PropertyChangeListeners of the axis will not be transferred silently to the new axis but have to handle their unregistering from the old axis / registering to the new axis from outside to give them the chance to manage their state transitions by themselves.
  Before the state of the old axis is transferred they will receive PropertyChangeListener.propertyChange(PropertyChangeEvent) with PROPERTY_AXIS_Y_RIGHT_REPLACE as code and the old and new axis as values and have the change to change their peer to listen on thus receiving the change events generated on the new axis. At the moment the replace event is sent they will already have received the event PROPERTY_AXIS_Y event for the removal: So be careful not to react on that first event by removing your listener from the axis as you then will not receive the replace event!

  Parameters:

  axisY - the right y axis to use.

  position - the index of the axis on right y dimension (starting from 0).

  Returns:

  the previous axis on that bottom x position.

• setGridColor

  public final void setGridColor(Color gridclr)

  Set the grid color to use.

  Parameters:

  gridclr - the grid color to use.

• setMinPaintLatency

  public void setMinPaintLatency(int minPaintLatency)

  Sets the ms to give a repaint operation time for collecting several repaint requests into one (performance vs. update speed).

  Parameters:

  minPaintLatency - the setting for the ms to give a repaint operation time for collecting several repaint requests into one (performance vs. update speed).

• setPaintLabels

  public void setPaintLabels(boolean paintLabels)

  Decide whether labels for each chart are painted below it. If set to true this will be done, else labels will be omitted.

  Parameters:

  paintLabels - the value for paintLabels to set.

• setPointFinder

  public void setPointFinder(IPointFinder pointFinder)

  Sets the point finder used to find the nearest point corresponding to a mouse event.

  Parameters:

  pointFinder - the point finder used to find the nearest point corresponding to a mouse event.

  See Also:

  • Chart2D.PointFinder.MANHATTAN
  • Chart2D.PointFinder.EUCLID

• setRequestedRepaint

  public final void setRequestedRepaint(boolean requestedRepaint)

  Sets the requestedRepaint.

  Internal method to request a repaint that guarantees that two invocations of will always have at least have an interval of getMinPaintLatency() ms.

  Methods repaint(), repaint(long), repaint(Rectangle), repaint(int, int, int, int) and repaint(long, int, int, int, int) must not be called from application code that has to inform the UI to update the chart directly or a performance problem may arise as java awt / swing implementation does not guarantee to collapse several repaint requests into a single one but prefers to issue many paint invocations causing a high CPU load in realtime scenarios (adding several 100 points per second to a chart).

  Only the internal timer may invoke the methods mentioned above.

  Parameters:

  requestedRepaint - the requestedRepaint to set.

• setSynchronizedXStartChart

  public void setSynchronizedXStartChart(Chart2D synchronizedXStartChart)

  Sets the chart that will be synchronized for finding the start coordinate of this chart to draw in x dimension ( getXChartStart() ).

  This feature is used to allow two separate charts to be painted stacked in y dimension (one below the other) that have different x start coordinates (because of different y labels that shift that value) with an equal starting x value (thus be comparable visually if their x values match).

  Parameters:

  synchronizedXStartChart - the chart that will be synchronized for finding the start coordinate of this chart to draw in x dimension ( getXChartStart()).

• setToolTipCoords

  @Deprecated public final void setToolTipCoords(boolean toolTipCoords)

  Deprecated.

  use setToolTipType(IToolTipType) with Chart2D.ToolTipType.DATAVALUES instead.

  Set whether this component should display the chart coordinates as a tool tip.

  This turns on tool tip support (like JComponent.setToolTipText(java.lang.String)) if neccessary.

  Parameters:

  toolTipCoords - The toolTipCoords to set.

• setToolTipType

  public final void setToolTipType(IToolTipType toolTipType)

  Sets the type of tool tip to use.

  Use Chart2D.ToolTipType.NONE to turn of tool tips.

  Parameters:

  toolTipType - one of the available Chart2D.ToolTipType constants.

  See Also:

  • Chart2D.ToolTipType.DATAVALUES
  • Chart2D.ToolTipType.NONE
  • Chart2D.ToolTipType.PIXEL
  • Chart2D.ToolTipType.VALUE_SNAP_TO_TRACEPOINTS

• setTracePointProvider

  public void setTracePointProvider(ITracePointProvider tracePointProvider)

  Sets the trace point creator of this chart.

  Null assignment attempts will raise an AssertionError.

  Parameters:

  tracePointProvider - the trace point creator of this chart to set.

• setUseAntialiasing

  public final void setUseAntialiasing(boolean useAntialiasing)

  Sets whether antialiasing is used.

  Parameters:

  useAntialiasing - true if antialiasing should be used.

• snapShot

  public BufferedImage snapShot()

  Returns a BufferedImage with the current width and height of the chart filled with the Chart2D's graphics that may be written to a file or OutputStream by using: ImageIO.write(java.awt.image.RenderedImage, java.lang.String, java.io.File) .

  If the width and height of this chart is zero (this happens when the chart has not been JComponent.setVisible(boolean), the chart was not integrated into layout correctly or the chart's dimenision was set to this value, a default of width 600 and height 400 will temporarily be set (syncrhonized), the image will be rendered, the old dimension will be reset and the image will be returned.
  If you want to paint offscreen images (without displayed chart) prefer invoke snapShot(int, int) instead.

  Returns:

  a BufferedImage of the Chart2D's graphics that may be written to a file or OutputStream.

  Since:

  1.03 - please download versions equal or greater than jchart2d-1.03.jar.

• snapShot

  public BufferedImage snapShot(int width, int height)

  Returns a BufferedImage with the given width and height that is filled with tChart2D's graphics that may be written to a file or OutputStream by using: ImageIO.write(java.awt.image.RenderedImage, java.lang.String, java.io.File) .

  Parameters:

  width - the width of the image to create.

  height - the height of the image to create.

  Returns:

  a BufferedImage of the Chart2D's graphics that may be written to a file or OutputStream.

  Since:

  1.03 - please download versions equal or greater than jchart2d-1.03.jar.

• toString

  public String toString()

  Overrides:

  toString in class Component

  See Also:

  • Object.toString()

• translateMousePosition

  @Deprecated public ITracePoint2D translateMousePosition(MouseEvent mouseEvent) throws IllegalArgumentException

  Deprecated.

  this method is a candidate for wrong behavior when using multiple axes.

  Returns the translation of the mouse event coordinates of the given mouse event to the value within the chart.

  Note that the mouse event has to be an event fired on this component!

  Note that the returned tracepoint is not a real trace point of a trace but just used as a container here.

  Parameters:

  mouseEvent - a mouse event that has been fired on this component.

  Returns:

  the translation of the mouse event coordinates of the given mouse event to the value within the chart or null if no calculations could be performed as the chart was not painted before.

  Throws:

  IllegalArgumentException - if the given mouse event does not belong to this component.