com.xj.anylogic.engine.analysis
Class Histogram

java.lang.Object
  com.xj.anylogic.engine.presentation.Shape
      com.xj.anylogic.engine.presentation.ShapeControl
          com.xj.anylogic.engine.analysis.Chart
              com.xj.anylogic.engine.analysis.Histogram

All Implemented Interfaces:

com.xj.anylogic.engine.internal.Child, Locatable2D, java.awt.event.ActionListener, java.io.Serializable, java.lang.Cloneable, java.util.EventListener

public class Histogram
extends Chart

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:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Serialized Form

Nested Class Summary

static class

Histogram.Appearance Descriptor or a histogram appearance.

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

Chart.Properties

Field Summary

Fields inherited from class com.xj.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_FIXED, SOUTH, WEST

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

TYPE_DOUBLE, TYPE_INT, TYPE_STRING

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

UNKNOWN_NAME

Constructor Summary

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, int legendPos, int gridPositionX, int 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, int id, int index)
Creates a non-persistent Histogram.

Method Summary

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.
void	addHistogram(HistogramData hist, java.lang.String title, Histogram.Appearance appearance) 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.
void	refresh() Causes the chart to refresh its picture and legend based on the newest data values.

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

action, actionPerformed, clone, copyToClipboard, get, getCount, getJComponent, getPopupMenu, getSelectedItemIndices, getTitle, onItemRemoved, onSelectionChanged, remove, remove, removeAll, selectItem, setSelectedItemIndices, update, updateData

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

contains, draw, getHeight, getPresentable, getWidth, isEnabled, onClickAt, restoreOwner, setEnabled, setHeight, setValueToDefault, setWidth

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

canHandleClick, getGroup, getName, getRotation, getScaleX, getScaleY, getX, getY, isVisible, onClick, setPos, setRotation, setScale, setScale, setScaleX, setScaleY, setVisible, setX, setY

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Histogram

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,
                 int legendPos,
                 int gridPositionX,
                 int 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 backgroud 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

Histogram

public Histogram(Presentable p,
                 int id,
                 int index)

Creates a non-persistent Histogram.

Parameters:

p - the Presentable object owning this chart

id - the id of the chart

index - the index of the chart (for replicated charts)

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

refresh

public void refresh()

Causes the chart to refresh its picture and legend based on the newest data values.

Overrides:

refresh in class Chart