com.xj.anylogic.engine.analysis
Class Chart2DPlot

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.presentation.ShapeControl
          com.xj.anylogic.engine.analysis.Chart
              com.xj.anylogic.engine.analysis.Chart2D
                  com.xj.anylogic.engine.analysis.Chart2DPlot

All Implemented Interfaces:

com.xj.anylogic.engine.internal.Child, Locatable2D, java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

Plot, TimePlot

public abstract class Chart2DPlot
extends Chart2D

The base class for all charts that display a collection of two-dimensional data sets in the form of plots, like Plot, TimePlot. The chart has a collection of DataSet objects and the collection of associated visual appearance descriptions. The chart may have scale text labels and a grid.

Author:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Serialized Form

Nested Class Summary

static class

Chart2DPlot.Appearance Descriptor or a data set plot appearance.

Nested classes/interfaces inherited from class com.xj.anylogic.engine.analysis.Chart

Chart.Properties

Field Summary

Fields inherited from class com.xj.anylogic.engine.analysis.Chart

DEFAULT_DATE_PATTERN, DEFAULT_DATE_TIME_PATTERN, DEFAULT_TIME_PATTERN, EAST, GRID_DEFAULT, GRID_NONE, GRID_OPPOSITE, INTERPOLATION_LINEAR, INTERPOLATION_STEP, NONE, NORTH, POINT_CIRCLE, POINT_NONE, POINT_SQUARE, POINT_TRIANGLE, SCALE_100_PERCENT, SCALE_AUTO, SCALE_FIXED, SOUTH, WEST

Fields inherited from class com.xj.anylogic.engine.presentation.ShapeControl

TYPE_DOUBLE, TYPE_INT, TYPE_STRING

Fields inherited from class com.xj.anylogic.engine.presentation.Shape

UNKNOWN_NAME

Constructor Summary

Chart2DPlot(Presentable p, boolean ispublic, int x, int y, int width, int height, java.awt.Color fillColor, java.awt.Color lineColor, int picOffsetX, int picOffsetY, int picWidth, int picHeight, java.awt.Color picBackgoundColor, java.awt.Color picBorderColor, java.awt.Color legendTextColor, int legendSize, int legendPos, int scaleTypeY, double minimumY, double maximumY, int gridPositionX, int gridPositionY, java.awt.Color gridLineColor, java.awt.Color gridTextColor, java.util.List<DataSet> dataSets, java.util.List<java.lang.String> titles, java.util.List<Chart2DPlot.Appearance> appearances)
Creates a persistent Chart2DPlot.

Chart2DPlot(Presentable p, int id, int index)
Creates a non-persistent Chart2DPlot.

Method Summary

void	addDataSet(DataSet ds) Adds a DataSet to the chart with default title "Data set" and default visual appearance: royalBlue color, line of width 1 is drawn, points are not drawn, linear interpolation.
void	addDataSet(DataSet ds, java.lang.String title) Adds a DataSet to the chart a given title and default visual appearnce: royalBlue color, line of width 1 is drawn, points are not drawn, linear interpolation.
void	addDataSet(DataSet ds, java.lang.String title, Chart2DPlot.Appearance appearance) Adds a DataSet to the chart with the specified visual appearance.
void	addDataSet(DataSet ds, java.lang.String title, java.awt.Color color, boolean drawLine, int interpolationType, float lineWidth, int pointStyle) Adds a DataSet to the chart with the specified visual appearance.
Chart2DPlot.Appearance	getAppearance(int i) Returns the appearance of the chart item (DataSet) with the given index.
void	setFixedVerticalScale(double minimum, double maximum) Sets fixed scale for vertical axis of chart

Methods inherited from class com.xj.anylogic.engine.analysis.Chart

action, actionPerformed, clone, copyToClipboard, get, getCount, getJComponent, getPopupMenu, getSelectedItemIndices, getTitle, onItemRemoved, onSelectionChanged, refresh, remove, remove, removeAll, selectItem, setSelectedItemIndices, update, updateData

Methods inherited from class com.xj.anylogic.engine.presentation.ShapeControl

contains, draw, getHeight, getPresentable, getWidth, isEnabled, onClickAt, restoreOwner, setEnabled, setHeight, setValueToDefault, setWidth

Methods inherited from class com.xj.anylogic.engine.presentation.Shape

canHandleClick, getGroup, getName, getRotation, getScaleX, getScaleY, getX, getY, isVisible, onClick, setPos, setRotation, setScale, setScale, setScaleX, setScaleY, setVisible, setX, setY

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Chart2DPlot

public Chart2DPlot(Presentable p,
                   boolean ispublic,
                   int x,
                   int y,
                   int width,
                   int height,
                   java.awt.Color fillColor,
                   java.awt.Color lineColor,
                   int picOffsetX,
                   int picOffsetY,
                   int picWidth,
                   int picHeight,
                   java.awt.Color picBackgoundColor,
                   java.awt.Color picBorderColor,
                   java.awt.Color legendTextColor,
                   int legendSize,
                   int legendPos,
                   int scaleTypeY,
                   double minimumY,
                   double maximumY,
                   int gridPositionX,
                   int gridPositionY,
                   java.awt.Color gridLineColor,
                   java.awt.Color gridTextColor,
                   java.util.List<DataSet> dataSets,
                   java.util.List<java.lang.String> titles,
                   java.util.List<Chart2DPlot.Appearance> appearances)

Creates a persistent Chart2DPlot. The collection of DataSet objects and collection of their visual appearances objects should be provided. If they are null, new empty collections are created.

Parameters:

p - the presentable object owning this chart

ispublic - if true, the chart is visible on container's presentation

x - the x coordinate of the chart

y - the y coordinate of the chart

width - the width of the whole chart

height - the height of the whole chart

fillColor - the backgroud color of the whole chart

lineColor - the line border color of the whole chart

picOffsetX - the x offset of the picture from the top left corner of the picture area

picOffsetY - the y offset of the picture from the top left corner of the picture area

picWidth - the width of the picture

picHeight - the height of the picture

picBackgoundColor - the background color of the picture, null for none (transparent)

picBorderColor - the border color of the picture, null for no border

legendTextColor - the color of the legend text

legendSize - the size of the legend area: width if legendPos is EAST or WEST, height if NORTH or SOUTH

legendPos - the legend position (NONE, SOUTH, NORTH, EAST, WEST)

scaleTypeY - the scale type for Y axis (SCALE_100_PERCENT, SCALE_AUTO or SCALE_FIXED)

minimumY - the minimum scale value for Y axis (for SCALE_FIXED only)

maximumY - the maximum scale value for Y axis (for SCALE_FIXED only)

gridPositionX - the position of the scale text labels on X axis (GRID_NONE for no none, GRID_DEFAULT or GRID_OPPOSITE)

gridPositionY - the position of the scale text labels on Y axis (GRID_NONE for no none, GRID_DEFAULT or GRID_OPPOSITE)

gridLineColor - the color of grid lines, which then becomes semitransparent, null for no lines

gridTextColor - the color of scale text labels, null for no text labels

dataSets - the collection of data sets to be displayed, or null

titles - the collection of data set titles, or null

appearances - the collection of data set visual appearance objects (Chart2DPlot.DataSetPlotAppearance), or null

Chart2DPlot

public Chart2DPlot(Presentable p,
                   int id,
                   int index)

Creates a non-persistent Chart2DPlot.

Parameters:

p - the Presentable object owning this chart

id - the id of the chart

index - the index of the chart (for replicated charts)

Method Detail

addDataSet

public void addDataSet(DataSet ds,
                       java.lang.String title,
                       java.awt.Color color,
                       boolean drawLine,
                       int interpolationType,
                       float lineWidth,
                       int pointStyle)

Adds a DataSet to the chart with the specified visual appearance.

Parameters:

ds - the data set to add

title - the data set title

color - the color of the data set plot

drawLine - if true, the plot line is drawn

interpolationType - interpolation type between two data points: INTERPOLATION_LINEAR or INTERPOLATION_STEP

lineWidth - the width of the line (0 for thinnest possible)

pointStyle - what to draw at data points: POINT_NONE, POINT_SQUARE, POINT_CIRCLE, or POINT_TRIANGLE

addDataSet

public void addDataSet(DataSet ds,
                       java.lang.String title,
                       Chart2DPlot.Appearance appearance)

Adds a DataSet to the chart with the specified visual appearance.

Parameters:

ds - the data set to add

title - the data set title

appearance - the appearance of the data set plot

addDataSet

public void addDataSet(DataSet ds,
                       java.lang.String title)

Adds a DataSet to the chart a given title and default visual appearnce: royalBlue color, line of width 1 is drawn, points are not drawn, linear interpolation.

Parameters:

ds - the data set to add

title - the data set title

addDataSet

public void addDataSet(DataSet ds)

Adds a DataSet to the chart with default title "Data set" and default visual appearance: royalBlue color, line of width 1 is drawn, points are not drawn, linear interpolation.

Parameters:

ds - the data set to add

setFixedVerticalScale

public void setFixedVerticalScale(double minimum,
                                  double maximum)

Sets fixed scale for vertical axis of chart

Parameters:

minimum - minimum of chart axis scale

maximum - maximum of chart axis scale

getAppearance

public Chart2DPlot.Appearance getAppearance(int i)

Returns the appearance of the chart item (DataSet) with the given index.

Parameters:

i - index of the item

Returns:

the appearance of the chart item with the given index