com.anylogic.engine.analysis

Class StackChart

java.lang.Object

com.anylogic.engine.presentation.Shape

com.anylogic.engine.presentation.ShapeControl

com.anylogic.engine.analysis.Chart<DataItem>

com.anylogic.engine.analysis.Chart1D

com.anylogic.engine.analysis.Chart1DSum

com.anylogic.engine.analysis.StackChart

All Implemented Interfaces:

com.anylogic.engine.internal.Child, Locatable2D, AggregatableAnimationElement, HasLevel, LevelElement, SVGElement, java.io.Serializable, java.lang.Cloneable

public class StackChart
extends Chart1DSum

The chart that displays a number of data items in the form of a stack where each data item has a bar with dimension proportional to its fraction the total sum of the data items. The data items in this chart cannot take negative values. The legend values of data items are set to [data item name]: [data item value] ([data item fraction]%).
The orientation of the stack may be arbitrary (NORTH, SOUTH, EAST, WEST). The stack may be scaled to 100%, SCALE_100_PERCENT, in which case it always occupies the full picture), SCALE_AUTO, when stack is fitted into the best grid, or SCALE_FIXED, when the user specifies the maximum total. The thickness of stack bars can be controlled. 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/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

Constructor and Description

StackChart(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.Direction barDirection, Chart.ScaleType scaleType, double maximum, double relativeBarWidth, Chart.GridPosition gridPosition, java.awt.Color gridLineColor, java.awt.Color gridTextColor, java.util.List<DataItem> dataItems, java.util.List<java.lang.String> titles, java.util.List<java.awt.Color> colors) Creates a persistent StackChart If the collection of DataItem objects and a collection of their colors are null, new empty collections are created.

Method Summary

Modifier and Type	Method and Description
void	postSVGShapeSpecificAttributes(java.util.List<java.lang.String> att, java.util.List<java.lang.String> val, boolean publicOnly) 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	setFixedScale(double maximum) Sets fixed scale for the chart

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

addDataItem

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

addDataItem, getColor, setColor

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

StackChart

public StackChart(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.Direction barDirection,
                  Chart.ScaleType scaleType,
                  double maximum,
                  double relativeBarWidth,
                  Chart.GridPosition gridPosition,
                  java.awt.Color gridLineColor,
                  java.awt.Color gridTextColor,
                  java.util.List<DataItem> dataItems,
                  java.util.List<java.lang.String> titles,
                  java.util.List<java.awt.Color> colors)

Creates a persistent StackChart If the collection of DataItem objects and a 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)

barDirection - the orientation of bars (SOUTH, NORTH, EAST, WEST)

scaleType - the stack scale type (SCALE_100_PERCENT, SCALE_AUTO, SCALE_FIXED)

maximum - the maximum scale value (for SCALE_FIXED only)

relativeBarWidth - the thickness of the bars (1 - maximum, 0.5 - half, etc.)

gridPosition - the position of the scale text labels (GRID_NONE for 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

dataItems - the collection of data items to be displayed, or null

titles - the collection of data item titles, or null

colors - the collection of data item colors, or null

Method Detail

setFixedScale

public void setFixedScale(double maximum)

Sets fixed scale for the chart

Parameters:

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

postSVGShapeSpecificAttributes

public void postSVGShapeSpecificAttributes(java.util.List<java.lang.String> att,
                                           java.util.List<java.lang.String> val,
                                           boolean publicOnly)

Description copied from class: Shape

Posts 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:

postSVGShapeSpecificAttributes in class Chart<DataItem>

Parameters:

att - attribute names

val - attribute values

publicOnly - TODO