Package com.anylogic.engine.analysis
- 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
- Constructor Summary
- Method Summary
- 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
- Method Details
- java.lang.Object
- com.anylogic.engine.presentation.Shape
- com.anylogic.engine.presentation.ShapeControl
- com.anylogic.engine.analysis.Chart<DataSet>
- com.anylogic.engine.analysis.Chart2D
- com.anylogic.engine.analysis.TimeColorChart
- All Implemented Interfaces:
com.anylogic.engine.internal.Child,Locatable2D,AggregatableAnimationElement,HasLevel,LevelElement,SVGElement,UsdElement,Serializable,Cloneable
public class TimeColorChart extends Chart2D
The chart that displays a collection of data sets as a number of horizontal strips
with color varying along the X (time) axis. The data set X (time) values must be
non-decreasing. The time axis shows the data in the specified time window.
The correspondence of data set value and a color is defined euther in Presentable
by method getShapeChartColorFromDouble, or by the object ColorMap passed in the
constructor. The thickness of strips can be controlled. The chart may have X (time)
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
| Modifier and Type | Class | Description |
|---|---|---|
static class | TimeColorChart.ColorMap |
Deprecated.
|
Chart.Direction, Chart.GridPosition, Chart.InterpolationType, Chart.PointStyle, Chart.ScaleType, Chart.TimeWindowMovementTypeDEFAULT_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| Constructor | Description |
|---|---|
TimeColorChart |
Creates a persistent TimeColorChart.
|
| Modifier and Type | Method | Description |
|---|---|---|
void | addDataSet |
Adds a DataSet to the chart with default title "Data set".
|
void | addDataSet |
Adds a DataSet to the chart.
|
Color | getColor |
This method always return null for TimeColorChart
|
ColorMapping | getColorMapping |
Returns the color mapping - conditional expression the value to be checked against to determine the color.
This method is internal and shouldn't be called by user. it may be removed/renamed in future. |
int | getColorMappingsCount() |
Returns the number of color mappings - conditional expressions the value to be checked against to determine the color.
This method is internal and shouldn't be called by user. it may be removed/renamed in future. |
Color | getDefaultColor() |
Returns the color to be used when all the value doesn't match any of
colorMappings.This method is internal and shouldn't be called by user. it may be removed/renamed in future. |
void | postSVGShapeSpecificAttributes |
Posts general properties specific to a particular shape class.
|
void | refresh() |
Causes the chart to refresh its picture and legend based on the
newest data values.
|
void | restoreOwner |
Deprecated.
|
void | setColor |
This method has no effect on TimeColorChart
|
void | setIDEDrivenMode_xjal |
This method shouldn't be called by user
(is public due to technical reasons) |
action, clone, copyToClipboard, executeUserAction, get, getCount, getJComponent, getSelectedItemIndices, getTitle, onSelectionChanged_xjal, remove, remove, removeAll, selectItem, setSelectedItemIndices, update, updateDatacontains, executeAction, getHeight, getPresentable, getWidth, isEnabled, randomPointInside, setEnabled, setHeight, setValueToDefault, setWidthcanHandleClick, 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, updateSVGPropertiespublic TimeColorChart(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, double relativeBarWidth, Chart.GridPosition gridPositionT, Color gridLineColor, Color gridTextColor, List<DataSet> dataSets, List<String> titles, Color defaultValueColor, ColorMapping[] colorMappings)
Creates a persistent TimeColorChart. If the collection of DataSet
objects is null, new empty collection is created.
- Parameters:
p- the presentable object owning this chartispublic- iftrue, the chart is visible on container's presentationx- the x coordinate of the charty- the y coordinate of the chartwidth- the width of the whole chartheight- the height of the whole chartfillColor- the background color of the whole chartlineColor- the line border color of the whole chartpicOffsetX- the x offset of the picture from the top left corner of the picture areapicOffsetY- the y offset of the picture from the top left corner of the picture areapicWidth- the width of the picturepicHeight- the height of the picturepicBackgoundColor- the background color of the picture, null for none (transparent)picBorderColor- the border color of the picture, null for no borderlegendTextColor- the color of the legend textlegendSize- the size of the legend area: width if legendPos is EAST or WEST, height if NORTH or SOUTHlegendPos- the legend position (NONE, SOUTH, NORTH, EAST, WEST)timeWindow- the time window to be displayed (the range of X axis)movingTimeWindow- iftrue, then time window will (as well as labels on Time axis) will move along with time, even when there is no new datadateFormatPattern- if notnull, dates are shown on X axis (using this string as date/time format pattern), otherwise - model time units are shown on X axisrelativeBarWidth- the thickness of the color strips (1 - maximum, 0.5 - half, etc.)gridPositionT- the position of the scale text labels on time (X) axis (GRID_NONE for no none, GRID_DEFAULT or GRID_OPPOSITE)gridLineColor- the color of grid lines, which then becomes semitransparent, null for no linesgridTextColor- the color of scale text labels, null for no text labelsdataSets- the collection of data sets to be displayed, or nulltitles- the collection of data set titles, or nulldefaultValueColor- color to be used when all the value doesn't match any ofcolorMappingscolorMappings- conditional expressions the value to be checked against to determine the color
public void addDataSet(DataSet ds, String title)
Adds a DataSet to the chart.
- Parameters:
ds- the data set to addtitle- the data set title
public void addDataSet(DataSet ds)
Adds a DataSet to the chart with default title "Data set".
- Parameters:
ds- the data set to add
@AnyLogicInternalAPI public int getColorMappingsCount()
Returns the number of color mappings - conditional expressions the value to be checked against to determine the color.
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
@AnyLogicInternalAPI public ColorMapping getColorMapping(int index)
Returns the color mapping - conditional expression the value to be checked against to determine the color.
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
- Parameters:
index- index, from 0 togetColorMappingsCount()- 1
@AnyLogicInternalAPI public Color getDefaultColor()
Returns the color to be used when all the value doesn't match any of
This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
colorMappings.This method is internal and shouldn't be called by user.
it may be removed/renamed in future.
public void setColor(int i, Color c)
This method has no effect on TimeColorChart
public Color getColor(int i)
This method always return null for TimeColorChart
public void refresh()
Causes the chart to refresh its picture and legend based on the
newest data values.
@AnyLogicInternalAPI public void setIDEDrivenMode_xjal(Date modelStartDate, long modelTimeUnits)
This method shouldn't be called by user
(is public due to technical reasons)
(is public due to technical reasons)
@AnyLogicInternalCodegenAPI @Deprecated public void restoreOwner(Object owner)
Deprecated.
Description copied from class:
ShapeThis method normally should not be called by user
This method restores owner of this object
The method is used in snapshot saving/loading
This method restores owner of this object
The method is used in snapshot saving/loading
- Specified by:
restoreOwnerin interfacecom.anylogic.engine.internal.Child- Overrides:
restoreOwnerin classShapeControl- Parameters:
owner- owner of this object, usuallyAgent,ExperimentorShapeGroup
public void postSVGShapeSpecificAttributes(List<String> att, List<String> val, boolean publicOnly)
Description copied from class:
ShapePosts general properties specific to a particular shape class.
Is triggered by SVG_DIRTY_SHAPE flag.
Made public for occasional posting of additional SVG properties from outside engine
(e.g. from libraries)
- Overrides:
postSVGShapeSpecificAttributesin classChart2D- Parameters:
att- attribute namesval- attribute valuespublicOnly- TODO