AnyLogic AnyLogic
Expand
Font size
All Implemented Interfaces:
com.anylogic.engine.internal.Child, Locatable2D, AggregatableAnimationElement, HasLevel, LevelElement, SVGElement, java.io.Serializable, java.lang.Cloneable
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:
AnyLogic North America, LLC https://anylogic.com
See Also:
Serialized Form

Nested Class Summary

Nested Classes 
static class  Chart2DPlot.Appearance
Descriptor or a data set plot appearance.
Modifier and Type Class Description

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

Chart.Direction, Chart.GridPosition, Chart.InterpolationType, Chart.PointStyle, Chart.ScaleType, Chart.TimeWindowMovementType

Nested classes/interfaces inherited from class com.anylogic.engine.presentation.ShapeControl

ShapeControl.ValueType

Field Summary

Fields inherited from class com.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_AUTO_FROM_0, SCALE_FIXED, SHORT_DATE_PATTERN, SHORT_DATE_TIME_PATTERN, SHORT_TIME_PATTERN, SOUTH, WEST, WINDOW_MOVES_WITH_DATA, WINDOW_MOVES_WITH_TIME

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

TYPE_DOUBLE, TYPE_INT, TYPE_STRING

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

UNKNOWN_NAME

Constructor Summary

Constructors 
Chart2DPlot​(Presentable p, boolean ispublic, double x, double y, double width, double height, java.awt.Color fillColor, java.awt.Color lineColor, double picOffsetX, double picOffsetY, double picWidth, double picHeight, java.awt.Color picBackgoundColor, java.awt.Color picBorderColor, java.awt.Color legendTextColor, double legendSize, Chart.Direction legendPos, Chart.ScaleType scaleTypeY, double minimumY, double maximumY, Chart.GridPosition gridPositionX, Chart.GridPosition 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.
Constructor Description

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods 
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, boolean fillAreaUnderLine, Chart.InterpolationType interpolationType, double lineWidth, Chart.PointStyle pointStyle)
Deprecated.
this method will be removed in the next releases.
void addDataSet​(DataSet ds, java.lang.String title, java.awt.Color color, boolean drawLine, Chart.InterpolationType interpolationType, double lineWidth, Chart.PointStyle 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.
java.awt.Color getColor​(int i)
Returns the color of the chart item with the given index. it depends on the chart type, which color exactly is returned.
void setColor​(int i, java.awt.Color c)
Sets the new color of the chart item with the given index.
void setFixedVerticalScale​(double minimum, double maximum)
Sets fixed scale for vertical axis of chart
Modifier and Type Method Description

Methods inherited from class com.anylogic.engine.analysis.Chart2D

postSVGShapeSpecificAttributes

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

action, clone, copyToClipboard, executeUserAction, get, getCount, getJComponent, getSelectedItemIndices, getTitle, onSelectionChanged_xjal, refresh, remove, remove, removeAll, selectItem, setSelectedItemIndices, update, updateData

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

contains, executeAction, getHeight, getPresentable, getWidth, isEnabled, randomPointInside, restoreOwner, setEnabled, setHeight, setValueToDefault, setWidth

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

canHandleClick, findSVGElement, getDrawMode, getGroup, getLevel, getName, getRotation, getScaleX, getScaleY, getSVGId, getX, getY, isJava2DSwingPresentation, isPublic_xjal, isSVGPresentation, isVisible, onAggregatorVisibilityChanged, onClick, randomPointInside, removeSVGFromOwner, removeSVGImage, resetSVGState, setLevel, setPos, setPos, setPublic_xjal, setRotation, setScale, setScale, setScaleX, setScaleY, setVisible, setX, setY, updateDynamicProperties, updateDynamicPropertiesStructural, updateSVGProperties

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.anylogic.engine.markup.AggregatableAnimationElement

initializeInternal, postInitialize

Constructor Detail

Chart2DPlot

public Chart2DPlot​(Presentable p,
                   boolean ispublic,
                   double x,
                   double y,
                   double width,
                   double height,
                   java.awt.Color fillColor,
                   java.awt.Color lineColor,
                   double picOffsetX,
                   double picOffsetY,
                   double picWidth,
                   double picHeight,
                   java.awt.Color picBackgoundColor,
                   java.awt.Color picBorderColor,
                   java.awt.Color legendTextColor,
                   double legendSize,
                   Chart.Direction legendPos,
                   Chart.ScaleType scaleTypeY,
                   double minimumY,
                   double maximumY,
                   Chart.GridPosition gridPositionX,
                   Chart.GridPosition 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 background 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

Method Detail

addDataSet

public void addDataSet​(DataSet ds,
                       java.lang.String title,
                       java.awt.Color color,
                       boolean drawLine,
                       Chart.InterpolationType interpolationType,
                       double lineWidth,
                       Chart.PointStyle 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

@Deprecated
public void addDataSet​(DataSet ds,
                       java.lang.String title,
                       java.awt.Color color,
                       boolean drawLine,
                       boolean fillAreaUnderLine,
                       Chart.InterpolationType interpolationType,
                       double lineWidth,
                       Chart.PointStyle pointStyle)
Deprecated.
this method will be removed in the next releases. Please use methods without fillAreaUnderLine
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
fillAreaUnderLine - if true, the area under line must be filled. This setting works only for TimePlot.
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

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

setColor

public void setColor​(int i,
                     java.awt.Color c)
Description copied from class: Chart
Sets the new color of the chart item with the given index. The effect depends on the chart type.
Overrides:
setColor in class Chart<DataSet>
Parameters:
i - index of the item
c - the new color of the item

getColor

public java.awt.Color getColor​(int i)
Description copied from class: Chart
Returns the color of the chart item with the given index. it depends on the chart type, which color exactly is returned.
Specified by:
getColor in class Chart<DataSet>
Parameters:
i - index of the item
Returns:
the color of the item
How can we improve this article?