Stack Chart

Stack Chart displays the contribution of several data items into a total as bars stacked one on top of the other with the first added data item at the bottom. The bar sizes are proportional to the corresponding data item values. Negative values are not allowed and error will be thrown on attempt to provide a negative data item value.

Direction of the stack growth and its width can be adjusted using the Bars Direction and Bars Relative width properties correspondingly (located in the Appearance section).

Stack chart

To create a stack chart

1. Drag the Stack Chart element from the Analysis palette into the graphical editor.
2. in the Data section of the chart's Properties configure the data item.
3. Specify the title for this data item in the Title box. This text will be shown in the chart legend.
4. Enter the expression dynamically evaluated to obtain the current value of the data item in the Value box.
5. Specify the color the for this data item's sector. Click the arrow in the Color control and choose the color. If you choose No fill, the corresponding sector will not be filled.

When finished, successively specify data items you want to be displayed on the chart.

By default a new stack chart already has one data item. If you want to add another, follow these steps:

1. Select the stack chart in the graphical editor or in the Projects view.
2. Go to the Data section of the Properties view.
3. Click the button. New property section defining settings for one more data item appears above.

1. Select the stack chart in the graphical editor or in the Projects view.
2. In the Data section of the chart's Properties select the section defining the data item you want to remove and click the button below all sections.

Properties

General

Name – The name of the chart. The name is used to identify and access the chart from code.

Ignore – If selected, the chart is excluded from the model.

Visible on upper agent – If selected, the chart is also visible on the upper agent where this agent lives.

Scale - Here you can choose scale type for the stack chart. Choose auto-scaling mode (Auto), scaling to 100% mode, or Fixed scale with maximum specified in to edit box.

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.

Data

– The button opens new property section, which allows to configure one more data item you want to visualize on this chart:

Title – The title for this data item, which will be shown in the chart legend.

Value – The expression dynamically evaluating the data item value.

Color – Color, which will be used to draw this data item value on 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.

To remove data item from the chart, click the button below the data item's property section. Use the arrows and to arrange the order of the data item sections.

Appearance

Bars direction – The group of buttons defining the stack growth direction.

Bars relative width – The slider allows adjusting the thickness of the stack (100% - maximum, 50% - half, etc.)

Axis labels position – The control specifies the position of 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.

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.

Position and size

Level – Level to which this chart belongs.

X – The x-coordinate of the chart's upper left corner.

Y – The y-coordinate of the chart's upper left corner.

Width – The width of the chart shape (in pixels).

Height – The height of the chart shape (in pixels).

Legend

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.

Chart area

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.

Advanced

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 chart name is displayed on a presentation diagram.

Functions

Data items

Function	Description
void addDataItem(DataItem di)	Adds a DataItem to the chart with default title and color. Parameter: di - the data item to add
void addDataItem (DataItem di, String title, Color color)	Adds a data item to the chart. Parameters: di - the data item to add title - the data item title color - the color that will be associated with this data item
int getCount()	Returns the number of chart items (data items or data sets) currently displayed by this chart.
ChartItem get(int i)	Returns the chart item (DataItem, DataSet, HistogramData, etc.) with the given index.
String getTitle(int i)	Returns the title of chart item (DataItem, DataSet, etc.) with the given index.
Color getColor(int i)	Returns the color of the chart item (DataItem, DataSet) with the given index. Parameter: i - index of the item
void setColor(int i, Color c)	Sets the new color of the chart item (DataItem, DataSet) with the given index. Parameters: i - index of the item; c - the new color of the item.
void remove(int i)	Removes the item (DataItem, DataSet, etc.) with the given index from the chart.
int remove(ChartItem ci)	Removes the given item (DataItem, DataSet) from the chart.
void removeAll()	Removes all items from the chart.

Selecting data items

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. Parameters: selectedIndices - an array with indices of chart items to be selected (other chart items will be deselected), may be null - this clears selection
int[] getSelectedItemIndices()	Returns the number of chart items (data items or data sets) currently displayed by this chart.

Setting chart's axis scale

Function	Description
void setFixedScale(double maximum)	Sets fixed scale for the chart Parameters: maximum - maximum of chart axis scale

Updating chart data manually

Function	Description
void updateData()	Updates all data items displayed by this chart.

Location

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. Parameter: x - the new value of X coordinate
void setY(double y)	Sets the Y coordinate of the chart. Parameter: y - the new value of Y coordinate
void setPos(double x, double y)	Sets new coordinates for the chart shape. Parameters: x - the new value of x coordinate y - the new value of y coordinate

Size

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: w - new value of the chart width
void setHeight(double h)	Sets new height for the chart shape. Parameter: h - new value of the chart height

Visibility

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: v - visibility: if true - the chart is set to be visible, if false - not visible.

Copying chart data to the Clipboard

Function	Description
String copyToClipboard()	Copies all chart data to the system clipboard in text form. Returns the text representation of all chart data.

Related topics

API reference: StackChart class