Package com.anylogic.engine.analysis
- Nested Class Summary
- Nested classes/interfaces inherited from class com.anylogic.engine.analysis.Chart
- Nested classes/interfaces inherited from class com.anylogic.engine.presentation.ShapeControl
- Field Summary
- Constructor Summary
- Method Summary
- Methods inherited from class com.anylogic.engine.analysis.Chart
- Methods inherited from class com.anylogic.engine.presentation.ShapeControl
- Methods inherited from class com.anylogic.engine.presentation.Shape
- Methods inherited from class java.lang.Object
- Methods inherited from interface com.anylogic.engine.markup.AggregatableAnimationElement
- Constructor Details
- Method Details
- java.lang.Object
- com.anylogic.engine.presentation.Shape
- com.anylogic.engine.presentation.ShapeControl
- com.anylogic.engine.analysis.Chart<HistogramData>
- com.anylogic.engine.analysis.Histogram
- All Implemented Interfaces:
com.anylogic.engine.internal.Child,Locatable2D,AggregatableAnimationElement,HasLevel,LevelElement,SVGElement,UsdElement,Serializable,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
| Modifier and Type | Class | Description |
|---|---|---|
static class | Histogram.Appearance |
Descriptor or a histogram appearance.
|
Chart.Direction, Chart.GridPosition, Chart.InterpolationType, Chart.PointStyle, Chart.ScaleType, Chart.TimeWindowMovementTypeDEFAULT_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| Constructor | Description |
|---|---|
Histogram |
Creates a persistent Histogram.
|
Histogram |
Deprecated.
Will be removed in the next release.
|
| Modifier and Type | Method | Description |
|---|---|---|
void | addHistogram |
Adds a histogram data object to the chart with the specified visual appearance.
|
void | addHistogram |
Adds a histogram data object to the chart with the specified visual appearance.
|
Histogram.Appearance | getAppearance |
Returns the appearance of the chart item (HistogramData) with the given index.
|
Color | getColor |
Returns the PDF color of the histogram item with the given index.
|
void | postSVGShapeSpecificAttributes |
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 |
Sets the new PDF color of the histogram item with the given index.
|
action, clone, copyToClipboard, executeUserAction, get, getCount, getJComponent, getSelectedItemIndices, getTitle, onSelectionChanged_xjal, remove, remove, removeAll, selectItem, setSelectedItemIndices, update, updateDatacontains, executeAction, getHeight, getPresentable, getWidth, isEnabled, randomPointInside, restoreOwner, setEnabled, setHeight, setValueToDefault, setWidthcanHandleClick, findSVGElement, getDrawMode, getGroup, getLevel, getName, getOrGenerateUSDId, getRotation, getScaleX, getScaleY, getSVGId, getUsdVersion, getX, getY, isJava2DSwingPresentation, isPublic_xjal, isSVGPresentation, isVisible, isVisibleCurrently, onAggregatorVisibilityChanged, onClick, randomPointInside, removeSVGFromOwner, removeSVGImage, resetSVGState, setChangedUsdVersion, setLevel, setNextChangedUsdVersion, setPos, setPos, setPublic_xjal, setRotation, setScale, setScale, setScaleX, setScaleY, setVisible, setX, setY, updateDynamicProperties, updateDynamicPropertiesStructural, updateSVGProperties@Deprecated public Histogram(Presentable p, boolean ispublic, int x, int y, int width, int height, Color fillColor, Color lineColor, int picOffsetX, int picOffsetY, int picWidth, int picHeight, Color picBackgoundColor, Color picBorderColor, Color legendTextColor, int legendSize, Chart.Direction legendPos, Chart.GridPosition gridPositionX, Chart.GridPosition gridPositionY, Color gridLineColor, Color gridTextColor, boolean showPDF, boolean showCDF, boolean showMean, double relativeBarWidth, List<HistogramData> data, List<String> titles, List<Histogram.Appearance> appearances)
Deprecated.
Will be removed in the next release. Please use another constructor with coordinates of
double typepublic Histogram(Presentable p, boolean ispublic, double x, double y, double width, double height, Color fillColor, Color lineColor, double picOffsetX, double picOffsetY, double picWidth, double picHeight, Color picBackgoundColor, Color picBorderColor, Color legendTextColor, double legendSize, Chart.Direction legendPos, Chart.GridPosition gridPositionX, Chart.GridPosition gridPositionY, Color gridLineColor, Color gridTextColor, boolean showPDF, boolean showCDF, boolean showMean, double relativeBarWidth, List<HistogramData> data, List<String> titles, 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 chartispublic- iftrue, the chart is visible on container's presentationx- the x coordinate of the charty- the y coordinate of the chartwidth- the width of the whole chartheight- the height of the whole chartfillColor- the background color of the whole chartlineColor- the line border color of the whole chartpicOffsetX- the x offset of the picture from the top left corner of the picture areapicOffsetY- the y offset of the picture from the top left corner of the picture areapicWidth- the width of the picturepicHeight- the height of the picturepicBackgoundColor- the background color of the picture, null for none (transparent)picBorderColor- the border color of the picture, null for no borderlegendTextColor- the color of the legend textlegendSize- the size of the legend area: width if legendPos is EAST or WEST, height if NORTH or SOUTHlegendPos- 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 linesgridTextColor- the color of scale text labels, null for no text labelsshowPDF- iftrue, the PDF bars will be shown for all histogramsshowCDF- iftrue, the CDF line will be shown for all histograms that calculate CDFshowMean- iftrue, the mean vertical line will be shown for all histogramsrelativeBarWidth- the thickness of the PDF bars (1 - maximum, 0.5 - half, etc.)data- the collection of histogram data objects to be displayed, or nulltitles- the collection of histogram data titles, or nullappearances- the collection of histogram visual appearance objects (Histogram.Appearance), or null
public void addHistogram(HistogramData hist, String title, Color colorLowPercent, Color colorHighPercent, Color colorPDF, Color colorCDF, float lineWidthCDF, Color colorMean)
Adds a histogram data object to the chart with the specified visual appearance.
- Parameters:
hist- the histogram data object to addtitle- the histogram data titlecolorLowPercent- the color to draw the PDF bars of the low percentilecolorHighPercent- the color to draw the PDF bars of the high percentilecolorPDF- the color to draw the PDF barscolorCDF- the color to draw the CDF linelineWidthCDF- the CDF line width, 0 for thinnest possiblecolorMean- the color to draw the mean line
public void addHistogram(HistogramData hist, 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 addtitle- the histogram data titleappearance- the appearance of the histogram data
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
public void setColor(int i, Color c)
Sets the new PDF color of the histogram item with the given index.
- Overrides:
setColorin classChart<HistogramData>- Parameters:
i- index of the itemc- the new color of the item- Since:
- 8.5
public Color getColor(int i)
Returns the PDF color of the histogram item with the given index.
- Specified by:
getColorin classChart<HistogramData>- Parameters:
i- index of the item- Returns:
- the color of the item
public void refresh()
Causes the chart to refresh its picture and legend based on the
newest data values.
- Overrides:
refreshin classChart<HistogramData>
public void postSVGShapeSpecificAttributes(List<String> att, List<String> val, boolean publicOnly)
Description copied from class:
ShapePosts 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:
postSVGShapeSpecificAttributesin classChart<HistogramData>- Parameters:
att- attribute namesval- attribute valuespublicOnly- TODO