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 Histogram2D
extends Chart<Histogram2DData>
The chart that displays a collection of two-dimensional histograms. Each histogram is drawn as a number of rectangular color spots reflecting the PDF value or envelope at the corresponding (X,Y). The chart X and Y axis are always scaled to fit all histograms. The chart has a collection of Histogram2DData 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  Histogram2D.Appearance
Descriptor or histogram 2D 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 
Histogram2D​(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.GridPosition gridPositionX, Chart.GridPosition gridPositionY, java.awt.Color gridLineColor, java.awt.Color gridTextColor, boolean drawEnvelopes, java.util.List<Histogram2DData> data, java.util.List<java.lang.String> titles, java.util.List<Histogram2D.Appearance> appearances)
Creates a persistent Histogram2D.
Constructor Description

Method Summary

All Methods Instance Methods Concrete Methods 
void addHistogram2D​(Histogram2DData hist, java.lang.String title, java.awt.Color color)
Adds a histogram 2D data object to the chart with the specified visual appearance.
java.awt.Color getColor​(int i)
Returns the color of the 2D histogram item with the given index.
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 setColor​(int i, java.awt.Color c)
Sets the new color of the 2D histogram item with the given index.
Modifier and Type Method Description

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

Histogram2D

public Histogram2D​(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.GridPosition gridPositionX,
                   Chart.GridPosition gridPositionY,
                   java.awt.Color gridLineColor,
                   java.awt.Color gridTextColor,
                   boolean drawEnvelopes,
                   java.util.List<Histogram2DData> data,
                   java.util.List<java.lang.String> titles,
                   java.util.List<Histogram2D.Appearance> appearances)
Creates a persistent Histogram2D. If the collections of histogram 2D data 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)
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
drawEnvelopes - if true, histogram envelopes are drawn, otherwise individual PDF values
data - the collection of histogram 2D data objects to be displayed, or null
titles - the collection of histogram 2D data titles, or null
appearances - the collection of histogram visual appearance objects (Histogram2D.Appearance), or null

Method Detail

addHistogram2D

public void addHistogram2D​(Histogram2DData hist,
                           java.lang.String title,
                           java.awt.Color color)
Adds a histogram 2D data object to the chart with the specified visual appearance.
Parameters:
hist - the histogram 2D object to add
title - the histogram 2D data title
color - the color corresponding to the highest PDF

setColor

public void setColor​(int i,
                     java.awt.Color c)
Sets the new color of the 2D histogram item with the given index.
Overrides:
setColor in class Chart<Histogram2DData>
Parameters:
i - index of the item
c - the new color of the item
Since:
8.5

getColor

public java.awt.Color getColor​(int i)
Returns the color of the 2D histogram item with the given index.
Specified by:
getColor in class Chart<Histogram2DData>
Parameters:
i - index of the item
Returns:
the color of the item

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<Histogram2DData>
Parameters:
att - attribute names
val - attribute values
publicOnly - TODO
How can we improve this article?