com.anylogic.engine.analysis.TimeStackChart

All Implemented Interfaces:: com.anylogic.engine.internal.Child, Locatable2D, AggregatableAnimationElement, HasLevel, LevelElement, SVGElement, UsdElement, Serializable, Cloneable

public class TimeStackChart
extends Chart2D

The chart that displays a collection of data sets in the form of a timed stack, i.e. a each data set is shown as a horizontal strip with height proportional to the fraction of its value in the total of all data sets at each time moment. The data set X (time) values must be non-decreasing. The time axis shows the data in the specified time window. A color is associated with each data set. Data set Y values must be non-negative. The stack may be scaled to 100%, SCALE_100_PERCENT, in which case it always occupies the full picture height), SCALE_AUTO, when stack is fitted into the best grid, or SCALE_FIXED, when the user specifies the maximum total. The chart may have scale text labels and a grid.

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 custom date/time format pattern

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.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

Fields inherited from interface com.anylogic.engine.presentation.UsdElement

ID_NOT_SET

Constructor Summary

Constructor	Description
TimeStackChart(Presentable p, boolean ispublic, double x, double y, double width, double height, Color fillColor, Color lineColor, double picOffsetX, double picOffsetY, double picWidth, double picHeight, Color picBackgoundColor, Color picBorderColor, Color legendTextColor, double legendSize, Chart.Direction legendPos, double timeWindow, Chart.TimeWindowMovementType timeWindowMovementType, String dateFormatPattern, Chart.ScaleType scaleTypeY, double maximumY, Chart.GridPosition gridPositionT, Chart.GridPosition gridPositionY, Color gridLineColor, Color gridTextColor, List<DataSet> dataSets, List<String> titles, List<Color> colors)	Creates a persistent TimeStackChart.
TimeStackChart(Presentable p, boolean ispublic, double x, double y, double width, double height, Color fillColor, Color lineColor, double picOffsetX, double picOffsetY, double picWidth, double picHeight, Color picBackgoundColor, Color picBorderColor, Color legendTextColor, double legendSize, Chart.Direction legendPos, double timeWindow, String dateFormatPattern, Chart.ScaleType scaleTypeY, double maximumY, Chart.GridPosition gridPositionT, Chart.GridPosition gridPositionY, Color gridLineColor, Color gridTextColor, List<DataSet> dataSets, List<String> titles, List<Color> colors)	Creates a persistent TimeStackChart.
TimeStackChart(Presentable p, boolean ispublic, int x, int y, int width, int height, Color fillColor, Color lineColor, int picOffsetX, int picOffsetY, int picWidth, int picHeight, Color picBackgoundColor, Color picBorderColor, Color legendTextColor, int legendSize, Chart.Direction legendPos, double timeWindow, String dateFormatPattern, Chart.ScaleType scaleTypeY, double maximumY, Chart.GridPosition gridPositionT, Chart.GridPosition gridPositionY, Color gridLineColor, Color gridTextColor, List<DataSet> dataSets, List<String> titles, List<Color> colors)	Deprecated. Will be removed in the next release.

Method Summary

Modifier and Type	Method	Description
`void`	`addDataSet(DataSet ds)`	Adds a DataSet to the chart with default title "Data set" and defalt color royalBlue.
`void`	`addDataSet(DataSet ds, String title, Color color)`	Adds a DataSet to the chart with the specified title and color.
`Color`	`getColor(int i)`	Returns the color of the chart item with the given index.
`void`	`refresh()`	Causes the chart to refresh its picture and legend based on the newest data values.
`void`	`restoreOwner(Object owner)`	Deprecated.
`void`	`setColor(int i, Color c)`	Sets the new color of the chart item with the given index.
`void`	`setFixedVerticalScale(double maximum)`	Sets fixed scale for vertical axis of chart
`void`	`setIDEDrivenMode_xjal(Date modelStartDate, long modelTimeUnits)`	This method shouldn't be called by user (is public due to technical reasons)

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, getOrGenerateUSDId, getRotation, getScaleX, getScaleY, getSVGId, getUsdVersion, getX, getY, isJava2DSwingPresentation, isPublic_xjal, isSVGPresentation, isVisible, isVisibleCurrently, onAggregatorVisibilityChanged, onClick, randomPointInside, removeSVGFromOwner, removeSVGImage, resetSVGState, setChangedUsdVersion, setLevel, setNextChangedUsdVersion, 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 Details

TimeStackChart

@Deprecated
public TimeStackChart(Presentable p,
 boolean ispublic,
 int x,
 int y,
 int width,
 int height,
 Color fillColor,
 Color lineColor,
 int picOffsetX,
 int picOffsetY,
 int picWidth,
 int picHeight,
 Color picBackgoundColor,
 Color picBorderColor,
 Color legendTextColor,
 int legendSize,
 Chart.Direction legendPos,
 double timeWindow,
 String dateFormatPattern,
 Chart.ScaleType scaleTypeY,
 double maximumY,
 Chart.GridPosition gridPositionT,
 Chart.GridPosition gridPositionY,
 Color gridLineColor,
 Color gridTextColor,
 List<DataSet> dataSets,
 List<String> titles,
 List<Color> colors)

Deprecated.

Will be removed in the next release. Please use another constructor with coordinates of double type

TimeStackChart

@AnyLogicLegacyAPI
public TimeStackChart(Presentable p,
 boolean ispublic,
 double x,
 double y,
 double width,
 double height,
 Color fillColor,
 Color lineColor,
 double picOffsetX,
 double picOffsetY,
 double picWidth,
 double picHeight,
 Color picBackgoundColor,
 Color picBorderColor,
 Color legendTextColor,
 double legendSize,
 Chart.Direction legendPos,
 double timeWindow,
 String dateFormatPattern,
 Chart.ScaleType scaleTypeY,
 double maximumY,
 Chart.GridPosition gridPositionT,
 Chart.GridPosition gridPositionY,
 Color gridLineColor,
 Color gridTextColor,
 List<DataSet> dataSets,
 List<String> titles,
 List<Color> colors)

Creates a persistent TimeStackChart. If the collection of DataSet objects and collection of their colors 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_100_PERCENT, SCALE_AUTO or SCALE_FIXED); maximumY - the maximum scale value for Y axis (for SCALE_FIXED only); gridPositionT - the position of the scale text labels on time (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; colors - the collection of data set colors, or null

TimeStackChart

public TimeStackChart(Presentable p,
 boolean ispublic,
 double x,
 double y,
 double width,
 double height,
 Color fillColor,
 Color lineColor,
 double picOffsetX,
 double picOffsetY,
 double picWidth,
 double picHeight,
 Color picBackgoundColor,
 Color picBorderColor,
 Color legendTextColor,
 double legendSize,
 Chart.Direction legendPos,
 double timeWindow,
 Chart.TimeWindowMovementType timeWindowMovementType,
 String dateFormatPattern,
 Chart.ScaleType scaleTypeY,
 double maximumY,
 Chart.GridPosition gridPositionT,
 Chart.GridPosition gridPositionY,
 Color gridLineColor,
 Color gridTextColor,
 List<DataSet> dataSets,
 List<String> titles,
 List<Color> colors)

Creates a persistent TimeStackChart. If the collection of DataSet objects and collection of their colors 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_100_PERCENT, SCALE_AUTO or SCALE_FIXED); maximumY - the maximum scale value for Y axis (for SCALE_FIXED only); gridPositionT - the position of the scale text labels on time (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; colors - the collection of data set colors, or null

Method Details

addDataSet

public void addDataSet(DataSet ds,
 String title,
 Color color)

Adds a DataSet to the chart with the specified title and color.

Parameters:: ds - the data set to add; title - the data set title; color - the color of the data set

addDataSet

public void addDataSet(DataSet ds)

Adds a DataSet to the chart with default title "Data set" and defalt color royalBlue.

Parameters:: ds - the data set to add

setFixedVerticalScale

public void setFixedVerticalScale(double maximum)

Sets fixed scale for vertical axis of chart

Parameters:: maximum - maximum of chart axis scale

setColor

public void setColor(int i,
 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 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

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(Date modelStartDate,
 long modelTimeUnits)

This method shouldn't be called by user
(is public due to technical reasons)

restoreOwner

@AnyLogicInternalCodegenAPI
@Deprecated
public void restoreOwner(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

Class TimeStackChart

Nested Class Summary

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

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

Field Summary

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

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

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

Fields inherited from interface com.anylogic.engine.presentation.UsdElement

Constructor Summary

Method Summary

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

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

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

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

Methods inherited from class java.lang.Object

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

Constructor Details

TimeStackChart

TimeStackChart

TimeStackChart

Method Details

addDataSet

addDataSet

setFixedVerticalScale

setColor

getColor

refresh

setIDEDrivenMode_xjal

restoreOwner