Histogram visualizes statistics collected by a number of Histogram Data objects. 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.
Histogram
PDF (probability distribution function) is displayed as a number of vertical bars each corresponding to a particular interval with heights proportional to the density (or number) of data samples within the interval. The bars may be setup to look as a solid block or distinct bars.
CDF (cumulative distribution function) is displayed as a polyline on top of PDF, and the mean value – as a vertical line at the corresponding value axis position.
If percentiles are calculated and both low and high confidence measures are specified, the bars corresponding to the lower and higher confidence measures are highlighted with the given colors. The bars that contain the exact “values at risk” (values satisfying the equation CDF(value) = low confidence measure or CDF(value) = 100 – high confidence measure) are drawn in the corresponding intermediate colors.
Name – The name of the histogram. The name is used to identify and access the histogram from code.
Ignore – If selected, the histogram is excluded from the model.
Visible on upper agent – If selected, the histogram is also visible on the upper agent where this agent lives.
Show PDF – If selected, PDF is shown on the histogram.
Show CDF – If selected, CDF is shown on the histogram.
Show mean – If selected, mean value is shown with a line.
– The button opens a new property section, which allows to configure one
more data item you want to visualize on this histogram:
Title – The title for this data item, which will be shown in the histogram legend.
Histogram – The name of the Histogram Data object, which will be displayed on this histogram.
PDF color – [Enabled if Show PDF is selected] Color, which will be used to draw PDF of this histogram data.
CDF color – [Enabled if Show CDF is selected] Color, which will be used to draw CDF of this histogram data.
Mean color – [Enabled if Show mean is selected] Color of line, which will visualize the mean value of this histogram data.
CDF & mean line width – [Enabled if Show CDF or Show mean is selected] Width of CDF and/or mean line.
Low % color – [Enabled if percentiles are collected for the histogram data] Color, which will be used to draw PDF to the left from low percentile.
High % color – [Enabled if percentiles are collected for the histogram data] Color, which will be used to draw PDF to the right from high percentile.
To remove a data item from the histogram, click the
button below the data item's property section. Use the arrows
and
to arrange the order of the data item sections.
Do not update data automatically - If selected, chart is not updated automatically with new data samples.
Update data automatically – If selected, new data samples are added automatically with the specified Recurrence time. Also, you can define here whether you want to Use model time or Use calendar dates. Depending on this choice, you can specify when updating begins with either First update time or Update date properties.
Bars relative width – The slider allows adjusting the thickness of the bars (100% - maximum, 50% - half, etc.)
Vertical axis labels – The control specifies the position of vertical axis labels relative to the chart (Left or Right). Choose None, if you do not want labels to be displayed.
Background color – Background color for the chart. Click inside the control and choose a color from the set of most used ones, or choose some custom color using the Colors dialog box.
Border color – Color used to draw chart border.
Labels color – The control specifies the color of the chart labels.
Grid color – The control specifies the color of the chart grid. Choose No fill, if you do not want grid to be displayed.
Level – Level where this chart belongs to.
X – The x-coordinate of the histogram's upper left corner.
Y – The y-coordinate of the histogram's upper left corner.
Width – The width of the histogram (in pixels).
Height – The height of the histogram (in pixels).
Show legend – If selected, the chart legend is displayed. You can control the legend position relative to the chart using the Position group of buttons. The size of the area allocated for the legend can be defined using either Width or Height control (depends on the legend's Position). Text color can also be adjusted.
This section defines visual properties of the chart area:
X Offset – The x-offset of the chart area relative to the whole area allocated for the chart and all its accompanying elements.
Y Offset – The y-offset of the chart area relative to the whole area allocated for the chart and all its accompanying elements.
Width – The width of the chart area (in pixels).
Height – The height of the chart area (in pixels).
Background color – Background color for the chart area.
Border color – Color used to draw the border of the chart area.
Visible – The chart visibility. The chart is visible when the specified expression evaluates to true, and not visible otherwise.
Replication – The replication factor of the chart. Here you specify how many copies of the chart will be created. If you leave this field empty, only one chart will be created.
On selection change
– The code executed when the user selects some particular data item(s).
This code is executed either when the user changes the selection by
clicking on items in the chart legend, and when the selection is
changed programmatically via the function selectItem().
You can use two variables here:
int[] selectedIndices
- the indices of currently selected data items.
boolean programmatically
- defines, whether items were selected programmatically (true), or not (false).
Show name – If selected, the name of the histogram is displayed on a presentation diagram.
Function |
Description |
void addHistogram |
Adds a histogram data object to the chart with the specified visual appearance. |
int getCount() |
Returns the number of data items currently displayed by this chart. |
ChartItem get(int i) |
Returns the chart's HistogramData item with the given index. |
String getTitle(int i) |
Returns the title of chart's HistogramData item with the given index. |
Color getColor(int i) |
Returns the PDF color of the histogram item with the given index.
Parameter: |
void setColor(int i, Color c) |
Sets the new PDF color of the histogram item with the given index.
Parameters: |
void remove(int i) |
Removes the HistogramData item with the given index from the chart. |
int remove(ChartItem ci) |
Removes the given HistogramData item from the chart. |
void removeAll() |
Removes all items from the chart. |
Function |
Description |
void selectItem(int itemIndex, boolean selected) |
Selects/deselects (depending on selected value) chart item with given index. |
void setSelectedItemIndices(int[] selectedIndices) |
Selects only chart items with the given indices.
|
int[] getSelectedItemIndices() |
Returns the number of chart items (data items or data sets) currently displayed by this chart. |
Function |
Description |
void updateData() |
Updates all data items displayed by this chart. |
Function |
Description |
double getX() |
Returns the X coordinate of the chart (namely, the X coordinate of its upper left corner). |
double getY() |
Returns the Y coordinate of the chart (namely, the Y coordinate of its upper left corner). |
void setX(double x) |
Sets the X coordinate of the chart.
|
void setY(double y) |
Sets the Y coordinate of the chart.
|
void setPos(double x, double y) |
Sets new coordinates for the chart shape.
Parameters: |
Function |
Description |
double getWidth() |
Returns the width of the chart shape. |
double getHeight() |
Returns the height of the chart shape. |
void setWidth(double w) |
Sets new width for the chart shape.
Parameter: |
void setHeight(double h) |
Sets new height for the chart shape.
Parameter: |
Function |
Description |
boolean isVisible() |
Checks the visibility of the chart. Returns true if the chart is visible, and false otherwise. |
void setVisible(boolean v) |
Sets the visibility of the chart.
Parameter: |
Function |
Description |
String copyToClipboard() |
Copies all chart data to the system clipboard in text form. Returns the text representation of all chart data. |