AnyLogic
Expand
Font size
All Implemented Interfaces:
com.anylogic.engine.internal.Child, Locatable2D, AggregatableAnimationElement, HasLevel, LevelElement, SVGElement, java.io.Serializable, java.lang.Cloneable

public class TimePlot
extends Chart2DPlot
The chart that displays a collection of data sets as plots - polylines with point at each data point and straight lines in between. The data set X (time) values must be non-decreasing. The time axis shows the data in the specified time window. 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 for both axes.

Chart may display date labels on the time axis (model date instead of model time). To turn on this mode please provide not null dateFormatPattern using one of available constants (DEFAULT_TIME_PATTERN, DEFAULT_DATE_PATTERN or DEFAULT_DATE_TIME_PATTERN) or the following
Format Pattern Syntax:
(see also SimpleDateFormat)

Text can be quoted using single quotes (') to avoid interpretation. "''" represents a single quote.
The following pattern letters are defined (all other characters from 'A' to 'Z' and from 'a' to 'z' are reserved):

Letter Date or Time Component Presentation Examples
G Era designator Text AD
y Year Year 1996; 96
M Month in year Month July; Jul; 07
w Week in year Number 27
W Week in month Number 2
D Day in year Number 189
d Day in month Number 10
F Day of week in month Number 2
E Day in week Text Tuesday; Tue
a Am/pm marker Text PM
H Hour in day (0-23) Number 0
k Hour in day (1-24) Number 24
K Hour in am/pm (0-11) Number 0
h Hour in am/pm (1-12) Number 12
m Minute in hour Number 30
s Second in minute Number 55
S Millisecond Number 978
Pattern letters are usually repeated, as their number determines the exact presentation:
  • Text: If the number of pattern letters is 4 or more, the full form is used; otherwise a short or abbreviated form is used if available.
  • Number: The number of pattern letters is the minimum number of digits, and shorter numbers are zero-padded to this amount.
  • Year: If the number of pattern letters is 2, the year is truncated to 2 digits; otherwise it is interpreted as a number.
  • Month: If the number of pattern letters is 3 or more, the month is interpreted as text; otherwise, it is interpreted as a number.
Examples
Date and Time Pattern Result
"dd.MM.yyyy HH:mm:ss" 07.05.2008 14:49:57
"EEE, MMM d, ''yy" Fri, May 7, '08
"h:mm a" 2:49 PM
"yyyy-MM-dd HH:mm:ss.SSS" 2008-05-07 14:49:57.304
Author:
AnyLogic North America, LLC https://anylogic.com
See Also:
Serialized Form

Nested Class Summary

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

Chart2DPlot.Appearance

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 
TimePlot​(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, double timeWindow, Chart.TimeWindowMovementType timeWindowMovementType, java.lang.String dateFormatPattern, Chart.ScaleType scaleTypeY, double minimumY, double maximumY, Chart.GridPosition gridPositionT, 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 TimePlot.
TimePlot​(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, double timeWindow, java.lang.String dateFormatPattern, Chart.ScaleType scaleTypeY, double minimumY, double maximumY, Chart.GridPosition gridPositionT, 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 TimePlot.
Constructor Description

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods 
void addDataSet​(DataSet ds, java.lang.String title, java.awt.Color color, boolean drawLine, boolean fillAreaUnderLine, Chart.InterpolationType interpolationType, double lineWidth, Chart.PointStyle pointStyle)
Adds a DataSet to the chart with the specified visual appearance.
void refresh()
Causes the chart to refresh its picture and legend based on the newest data values.
void restoreOwner​(java.lang.Object owner)
Deprecated.
void setFixedVerticalScale​(double minimum, double maximum)
Sets fixed scale for vertical axis of chart
void setIDEDrivenMode_xjal​(java.util.Date modelStartDate, long modelTimeUnits)
This method shouldn't be called by user
(is public due to technical reasons)
Modifier and Type Method Description

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

addDataSet, addDataSet, addDataSet, addDataSet, getAppearance, getColor, setColor

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, remove, remove, removeAll, selectItem, setSelectedItemIndices, update, updateData

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

contains, executeAction, getHeight, getPresentable, getWidth, isEnabled, randomPointInside, 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

TimePlot

@AnyLogicLegacyAPI
public TimePlot​(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,
                double timeWindow,
                java.lang.String dateFormatPattern,
                Chart.ScaleType scaleTypeY,
                double minimumY,
                double maximumY,
                Chart.GridPosition gridPositionT,
                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 TimePlot. If the collection of DataSet objects and collection of their visual appearances objects 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)
timeWindow - the time window to be displayed (the range of X axis)
dateFormatPattern - if not null, dates are shown on X axis (using this string as date/time format pattern), otherwise - model time units are shown on X axis
scaleTypeY - the scale type for Y axis (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)
gridPositionT - 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.Appearance), or null

TimePlot

public TimePlot​(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,
                double timeWindow,
                Chart.TimeWindowMovementType timeWindowMovementType,
                java.lang.String dateFormatPattern,
                Chart.ScaleType scaleTypeY,
                double minimumY,
                double maximumY,
                Chart.GridPosition gridPositionT,
                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 TimePlot. If the collection of DataSet objects and collection of their visual appearances objects 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)
timeWindow - the time window to be displayed (the range of X axis)
movingTimeWindow - if true, then time window will (as well as labels on Time axis) will move along with time, even when there is no new data
dateFormatPattern - if not null, dates are shown on X axis (using this string as date/time format pattern), otherwise - model time units are shown on X axis
scaleTypeY - the scale type for Y axis (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)
gridPositionT - 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.Appearance), or null

Method Detail

addDataSet

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)
Adds a DataSet to the chart with the specified visual appearance.
Overrides:
addDataSet in class Chart2DPlot
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
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

setFixedVerticalScale

public void setFixedVerticalScale​(double minimum,
                                  double maximum)
Description copied from class: Chart2DPlot
Sets fixed scale for vertical axis of chart
Overrides:
setFixedVerticalScale in class Chart2DPlot
Parameters:
minimum - minimum of chart axis scale
maximum - maximum of chart axis scale

refresh

public void refresh()
Causes the chart to refresh its picture and legend based on the newest data values.
Overrides:
refresh in class Chart<DataSet>

setIDEDrivenMode_xjal

@AnyLogicInternalAPI
public void setIDEDrivenMode_xjal​(java.util.Date modelStartDate,
                                  long modelTimeUnits)
This method shouldn't be called by user
(is public due to technical reasons)

restoreOwner

@AnyLogicInternalCodegenAPI
@Deprecated
public void restoreOwner​(java.lang.Object owner)
Deprecated.
Description copied from class: Shape
This method normally should not be called by user
This method restores owner of this object
The method is used in snapshot saving/loading
Specified by:
restoreOwner in interface com.anylogic.engine.internal.Child
Overrides:
restoreOwner in class ShapeControl
Parameters:
owner - owner of this object, usually Agent, Experiment or ShapeGroup
How can we improve this article?