com.xj.anylogic.engine.analysis
Class Histogram2D

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.Histogram2D

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 Histogram2D
extends Chart

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:

XJ Technologies Company Ltd. www.anylogic.com

See Also:

Serialized Form

Nested Class Summary

static class

Histogram2D.Appearance Descriptor or histogram 2D 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

Histogram2D(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 drawEnvelopes, java.util.List<Histogram2DData> data, java.util.List<java.lang.String> titles, java.util.List<Histogram2D.Appearance> appearances)
Creates a persistent Histogram2D.

Histogram2D(Presentable p, int id, int index)
Creates a non-persistent Histogram2D.

Method Summary

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 chart item (Histogram2DData) with the given index.

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

action, actionPerformed, clone, copyToClipboard, get, getCount, getJComponent, getPopupMenu, getSelectedItemIndices, getTitle, onItemRemoved, onSelectionChanged, refresh, 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

Histogram2D

public Histogram2D(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 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 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

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

Histogram2D

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

Creates a non-persistent Histogram2D.

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

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

getColor

public java.awt.Color getColor(int i)

Returns the color of the chart item (Histogram2DData) with the given index.

Parameters:

i - index of the item

Returns:

the color of the chart item with the given index