Time Stack Chart

Time stack chart displays the history of contribution of a number of data items into a total during the latest time horizon as stacked areas. At each time moment the values are stacked one on top of the other with the first added data item at the bottom. Negative values are not allowed. The time axis is always horizontal and directed to the right.


Time stack chart

The area height in between two data samples is interpolated linearly.

To create a time stack chart

  1. Drag the Time Stack Chart element from the Analysis palette into the graphical editor.
  2. In the Data section of the chart's Properties add and configure data items you want to display on the chart.
    First, choose the source of data for a data item - Value or Data set.
  3. Specify the title for each data item in the Title box. This text will be shown in the chart legend.
  4. Specify the color for each 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 painted.
  5. Open the Appearance section of the chart's Properties. In the Time axis format field you can choose the format of time axis labels: whether you want Model time units (0, 10, 20, ..) or Model date (Jan 21, 2009, 11:00:48 PM, Jan 22, 2009, 01:00:28 AM, ..). ) to be displayed. All possible formats of date and time labels are described here.

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.

Data

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

Value – [Visible if the Value option is selected above] Expression that will be evaluated to obtain new value to be added onto the chart.

Data set – [Visible if the Data set option is selected above] Name of the data set that collects values you want to display on this chart.

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

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

Data update

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.

Display up to ... latest samples (applies to "Value" data items only) - Maximum number of the latest values that will be displayed for each data item with the Value option selected.

Scale

Time window - The time horizon displayed by the chart. In Advanced properties section, you can find the related option, Time window moves. There you can select whether the chart's time window moves according to the current model time (Continuously), or it moves only when new data point is added on the chart (As data becomes available).

Vertical scale - Here you can choose scale type for the vertical axis of the plot. Choose auto-scaling mode (Auto), or Fixed scale with maximum specified in to edit box.

Appearance

Horizontal axis labels – The control specifies the position of horizontal axis labels relative to the chart (Below or Above). Choose None, if you do not want labels to be displayed.

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.

Time axis format – Here you can choose the format of time axis: whether you want Model time units (0, 10, 20, ..) or Model date (Jan 21, 2009, 11:00:48 PM, Jan 22, 2009, 01:00:28 AM, ... ) to be displayed. All possible formats of time axis are described here.

Labels color – The control specifies the color of the chart labels.

Background color – Background color for the chart.

Border color – Color used to draw chart border.

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

LevelLevel 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).

Time window moves – Here you can choose whether the chart's time window moves according to the current model time (Continuously), or it moves only when new data point is added on the chart (As data becomes available).

Show name – If selected, the chart name is displayed on a presentation diagram.

Log to database – If selected, the data collected by the chart during the simulation will be saved in the model execution log datasets_log (if logging is turned on in the model's Database properties).

Adding/removing data items

To add a data item on a chart

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

  1. Select the chart in the graphical editor or in the Projects view.
  2. Go to the Data section of the Properties view.
  3. Click the Add data item button. New property section defining settings for one more data item appears above.
To remove a data item from a chart
  1. Select the chart in the graphical editor or in the Projects view.
  2. On the Data section of the Properties view, select the section defining the data item you want to remove.
  3. Click the button below all sections.

Functions

Data items

Function

Description

void addDataSet(DataSet ds)

Adds a DataSet to the chart with default title "Data set" and default royalBlue color.

Parameter:
ds - the data set to add

void addDataSet
(DataSet ds,
String title,
Color color)

Adds a DataSet with the specified title and color.

Parameters:
ds - the data set to add
title - the data set's title
color - the data set's color

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, 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, etc.) 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.

Parameter:
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 setFixedVerticalScale
(double maximum)

Sets fixed scale for vertical axis of the chart.

Parameter:
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

Scaling charts

Chart area

Chart legend

Chart grid and labels

Updating charts

Changing chart appearance at runtime

API reference: TimeStackChart class