AnyLogic 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 Histogram
extends Chart<HistogramData>
The chart that displays a collection of histograms. The X axis always is scaled to fit all histogram data ranges. The histograms are also scaled along the Y axis so that the highest bar of each histogram occupies the full height of the picture. The PDF bars, the CDF line and the mean location can be shown optionally. The chart has a collection of HistogramData 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  Histogram.Appearance
Descriptor or a histogram 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 
Histogram​(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 showPDF, boolean showCDF, boolean showMean, double relativeBarWidth, java.util.List<HistogramData> data, java.util.List<java.lang.String> titles, java.util.List<Histogram.Appearance> appearances)
Creates a persistent Histogram.
Histogram​(Presentable p, boolean ispublic, int x, int y, int width, int height, java.awt.Color fillColor, java.awt.Color lineColor, int picOffsetX, int picOffsetY, int picWidth, int picHeight, java.awt.Color picBackgoundColor, java.awt.Color picBorderColor, java.awt.Color legendTextColor, int legendSize, Chart.Direction legendPos, Chart.GridPosition gridPositionX, Chart.GridPosition gridPositionY, java.awt.Color gridLineColor, java.awt.Color gridTextColor, boolean showPDF, boolean showCDF, boolean showMean, double relativeBarWidth, java.util.List<HistogramData> data, java.util.List<java.lang.String> titles, java.util.List<Histogram.Appearance> appearances)
Deprecated.
Will be removed in the next release.
Constructor Description

Method Summary

All Methods Instance Methods Concrete Methods 
void addHistogram​(HistogramData hist, java.lang.String title, Histogram.Appearance appearance)
Adds a histogram data object to the chart with the specified visual appearance.
void addHistogram​(HistogramData hist, java.lang.String title, java.awt.Color colorLowPercent, java.awt.Color colorHighPercent, java.awt.Color colorPDF, java.awt.Color colorCDF, float lineWidthCDF, java.awt.Color colorMean)
Adds a histogram data object to the chart with the specified visual appearance.
Histogram.Appearance getAppearance​(int i)
Returns the appearance of the chart item (HistogramData) with the given index.
java.awt.Color getColor​(int i)
Returns the PDF color of the 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 refresh()
Causes the chart to refresh its picture and legend based on the newest data values.
void setColor​(int i, java.awt.Color c)
Sets the new PDF color of the 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, 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

Histogram

@Deprecated
public Histogram​(Presentable p,
                 boolean ispublic,
                 int x,
                 int y,
                 int width,
                 int height,
                 java.awt.Color fillColor,
                 java.awt.Color lineColor,
                 int picOffsetX,
                 int picOffsetY,
                 int picWidth,
                 int picHeight,
                 java.awt.Color picBackgoundColor,
                 java.awt.Color picBorderColor,
                 java.awt.Color legendTextColor,
                 int legendSize,
                 Chart.Direction legendPos,
                 Chart.GridPosition gridPositionX,
                 Chart.GridPosition gridPositionY,
                 java.awt.Color gridLineColor,
                 java.awt.Color gridTextColor,
                 boolean showPDF,
                 boolean showCDF,
                 boolean showMean,
                 double relativeBarWidth,
                 java.util.List<HistogramData> data,
                 java.util.List<java.lang.String> titles,
                 java.util.List<Histogram.Appearance> appearances)
Deprecated.
Will be removed in the next release. Please use another constructor with coordinates of double type

Histogram

public Histogram​(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 showPDF,
                 boolean showCDF,
                 boolean showMean,
                 double relativeBarWidth,
                 java.util.List<HistogramData> data,
                 java.util.List<java.lang.String> titles,
                 java.util.List<Histogram.Appearance> appearances)
Creates a persistent Histogram. If the collections of histogram 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
showPDF - if true, the PDF bars will be shown for all histograms
showCDF - if true, the CDF line will be shown for all histograms that calculate CDF
showMean - if true, the mean vertical line will be shown for all histograms
relativeBarWidth - the thickness of the PDF bars (1 - maximum, 0.5 - half, etc.)
data - the collection of histogram data objects to be displayed, or null
titles - the collection of histogram data titles, or null
appearances - the collection of histogram visual appearance objects (Histogram.Appearance), or null

Method Detail

addHistogram

public void addHistogram​(HistogramData hist,
                         java.lang.String title,
                         java.awt.Color colorLowPercent,
                         java.awt.Color colorHighPercent,
                         java.awt.Color colorPDF,
                         java.awt.Color colorCDF,
                         float lineWidthCDF,
                         java.awt.Color colorMean)
Adds a histogram data object to the chart with the specified visual appearance.
Parameters:
hist - the histogram data object to add
title - the histogram data title
colorLowPercent - the color to draw the PDF bars of the low percentile
colorHighPercent - the color to draw the PDF bars of the high percentile
colorPDF - the color to draw the PDF bars
colorCDF - the color to draw the CDF line
lineWidthCDF - the CDF line width, 0 for thinnest possible
colorMean - the color to draw the mean line

addHistogram

public void addHistogram​(HistogramData hist,
                         java.lang.String title,
                         Histogram.Appearance appearance)
Adds a histogram data object to the chart with the specified visual appearance.
Parameters:
hist - the histogram data object to add
title - the histogram data title
appearance - the appearance of the histogram data

getAppearance

public Histogram.Appearance getAppearance​(int i)
Returns the appearance of the chart item (HistogramData) with the given index.
Parameters:
i - index of the item
Returns:
the appearance of the chart item with the given index

setColor

public void setColor​(int i,
                     java.awt.Color c)
Sets the new PDF color of the histogram item with the given index.
Overrides:
setColor in class Chart<HistogramData>
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 PDF color of the histogram item with the given index.
Specified by:
getColor in class Chart<HistogramData>
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<HistogramData>

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