Table Editor

From Planimate Knowledge Base
Revision as of 14:57, 3 October 2008 by Tony.Griffith (talk | contribs) (New page: == Column Context Menu == When you Right Click on a Column Title, these options are available for you to modify the properties of the column you have clicked on. Item Description *Colum...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Column Context Menu

When you Right Click on a Column Title, these options are available for you to modify the properties of the column you have clicked on.

Item Description

  • Column n Title This is the Title of the column - it is displayed in Table Views, and in the Column Title of the column. It can be different to the Tuple Name. When created for the first time, the Tuple name of the column is set to the Title (unless the column title is longer than the allowable number of characters in a Tuple name, in which case the Tuple name will be truncated).
  • Tuple Name This is the Name of the column that is used to reference the column in the Attribute Selection Dialog. It can be different to the column’s title.
  • Units Here you can set the Unit Display format for the column. There are a wide range of formats you can use. If you set value formatting for a column, then you will edit values using that format.Bear in mind that Planimate® always uses the underlying value in its calculations. Hence Labels may be shown, but Planimate® works with the Label Indices.Decimal Time may show values, and allow you to edit them as such, however a value like 2.5 minutes will be interpreted and used by Planimate® as a value of 180.
  • Width Set the column width.
  • Background Colour Set column Background colour.
  • Text Colour Set column Text colour.
  • Label Font Set the font for the Title of the Column.
  • Cell Font Sets the font for the cells in the Column.
  • Alignment Select whether the values in the cells of this column will be Left, Centre or Right justified.
  • Copy Format Enables you to apply the current column’s Display properties (and optionally its units format) to one or more other columns.
  • Options There are a lot of options for columns, described in detail in Column Options.
  • Clear/Default Value Here you set the default value that will be applied to this column when new rows are added, or when the Clear Selection, or Clear cell feature is applied, by a User, or by a routine.
  • Insert Insert a Column at the position of the column you have clicked on.
  • Duplicate Duplicate the column at the position of the column you have clicked on.
  • Append Append a column to the end of the Table.
  • Position Alter the position of the column to another location in the Table.
  • Show References Displays a References list for this column only, showing (if relevant): Source Object; Location; Modified Flag; Reference; Routine Line Number; Routine Operation. Right Click on a Source to switch to that object's panel and have it highlighted by a flashing box.
  • Delete Column Deletes this column from the Table. Note that this option cannot be undone.


Column Menu

Item Description

  • Select… Moves the cell focus to the column number selected. Stays on same row.
  • Insert Inserts a column at the column clicked on.
  • Append Appends a column to the end of the table.
  • Title Lines Sets the number of lines assigned to display the Column Title.
  • Title Font Set the Default Font to be used for title Columns. The default will be overridden by individual column Title (Label) Font settings.


Copy Formats between Table Columns

In this dialog you specify a range of columns to apply a format to. The format is copied from the table column you have just selected. This copies the alignment and, font and colour properties.

Select the Copy Value Format As Well checkbox to also copy the value format/label list property of the original column, otherwise this property is not copied.


Column Options

Here are the options you can set for an individual column.

Options Description

  • Clear Contents at Start Remove all Rows from the Table at the start of each Model Run.
  • Send Recalculate BC Enable this option if you want this column to transmit a "Send Recalculation" Broadcast if it changes during a model run. Tables have an (advanced) option to send a Broadcast whenever any cell in selected columns is modified by any means. The broadcast sent includes the _row and _col of the modified cell. The routine can use this information to update data, summaries etc.
  • Round Values in Views Specify that the Values in this column will be displayed as rounded, though their underlying values will remain double-precision. Once set, you can select the rounding level in the column's edit menu.
  • Protect from Edits Values in this column will not be able to be edited from Table Views. They can still be edited directly from the Table Editor window.
  • Include in Gantt Row info Set this option to include this column's information in the Gantt View window. In a Gantt View of this table, clicking on a bar in that view shows a window with some details of that row.
  • Reset Property on Edit This will cause cells that have a different cell property than the default, to revert to it once edited. Enables a user to track their edits visually.
  • Right Justify Title / Centre Title The Column Title is left justified by default. Change that with these options.
  • Don't Show Zeros Suppress the display of Zero values in cells in this column. Helps make some tables easier to read.
  • Write using Fixed Width When this option is turned on, the column is written/exported using fixed width formatting. With this option on the column width (if non zero) field and the column alignment (Left, Right, Centre) take effect when the data in that column is written. If shorter than "width", the column is padded with spaces. If wider than "width", the column is cropped.
  • Hide Repeated Values When this option is set, any cells immediately below an initial cell whose values are identical, will not be displayed, reducing clutter, making tables easier to read.
  • Keep Private This will keep the display of the column empty in a view and cause "*"s to be displayed for editing the value/label in a field. It does not affect the popup label list so it should be used with the "Edit Labels In Place" option. No protection is provided for copying the column into the clipboard (the option is intended to make password entry possible where you would start with an empty cell)
  • Edit Labels In-Place Use this option to enable the user to type existing or new label names, with the table cell indices being updated automatically to point to the newly referenced labels.
  • Rename instead of Adding Labels (Works in conjunction with Edit Labels in Place Option) Add the "Rename Instead of Adding Labels" option to enable the user to rename a number of existing indices, without the table indices being changed (as long as they are not 0).
  • Column Title Tool Tips Shows the Column Title as a Tool Tip when hovering over the Column Title in the Table Editor Window, or in a Table View.


Table Editor Menu Bar

Table Menu

Item Description

  • Resize [CxR] Enables you to resize your table. Additions and removals are always from the Right edge and bottom of the table.
  • Title Enter or edit the Title of your Table. This title is displayed in views of this table.
  • Name Enter or edit the name of the table, by which it will be referenced in Routines, and Attribute References. Table Names at each portal scope must be unique. We also advise that you keep all table names unique, except where they are siblings, scope-wise.
  • Comment You can add a comment here to guide those who will follow you.
  • Default Cell Font This is the default font that is applied to all cells in the table, It is overridden by individual, or column-based font assignments, but will be used to reset the fonts, if the defaults are reverted to.
  • Options There are a lot of options for Tables, described in detail in Table Options.
  • Sort Enables you or a Model User (where the Column Option enables this for them) to sort the Table, using up to eight criteria, with other Options. Refer to Table Sorting for more detail.
  • Show References Displays a References list showing (if relevant): Source Object; Location; Modified Flag; Reference; Routine Line Number; Routine Operation. Right Click on a Source to switch to that object's panel and have it highlighted by a flashing box.
  • Delete Table Deletes the Table. A warning appears if the table is being referenced, however you can proceed to delete it if you wish. Do so with caution though, as this action cannot be undone.


Row Menu

Item Description

  • Insert Inserts a row at the Row clicked on.
  • Append Appends a row to the end of the table.
  • Row Height Sets the row height in lines. Cell text will now wrap to the number of rows (specified by row height). Long text will be truncated (similar to long column names)
  • Label Source This provides the index to a column whose contents will be placed in the Row Title area to the left of the table.
  • Background Colour Source This provides the index to a column whose values will be used to set the Background color of the row.
  • Text Colour Source This provides the index to a column whose values will be used to set the Text color of the row.
  • Minimum Row Label Width Table row label minimum width is set (default is 3) to enable a minimum row label width to be guaranteed. Setting to 0 and disabling row label number display releases more space to the left of the table views.


Row Context Menu

When you Right Click on a Row number, Row Title, or just to the left of the first column of a Row the following options are available in a context menu.

Item Description

  • Name You can enter a Name for the Row Title manually here.
  • Insert Insert a Row at the position you clicked on.
  • Duplicate Duplicate the row you have clicked on, including all its cell values and Row title.
  • Append Add a row to the end of the table. Column Clear/Default values will be applied.
  • Delete Row Remove the Row at the position you clicked on.


View Menu

Item Description

  • Table Places a View of the Table on the currently visible panel.
  • Column Overlay Graph Places a <Column Overlay Graph View> of the Table on the currently visible panel.
  • Gantt Places a <Gantt View> on the currently visible panel.
  • Train Graph Places a <Train Graph View> on the currently visible panel.
  • Cell Places a View of the Currently-selected Cell on the currently visible panel. The cell being shown here can be changed by editing the View later if desired.
  • Grid Places a <Grid View> on the currently visible panel.
  • Allow Editor Behind Enables the Table Editor Window to go behind the Planimate® Main Window.
  • Zoom Zooms the view of the table inside the Table Editor. Views are unaffected by this.


View Options

The following options are available for Portal Attribute and Cell Views:

Option Description

  • Don't Show Names Suppresses the display of the Attribute’s name in the View. Enables more compact displays.
  • In Place Edit Enables a View to be edited by a Model User. Model Developers always have access to edit an Attribute’s value via a View.
  • Show Dial From a View you can choose to display a Dial for that view. Refer to Dials for more information.
  • Transparent to Clicks Renders the View Transparent to Mouse Clicks. This applies to Model Users - Model Developers always have access to edit an Attribute View.
  • Broadcast to View's Scope When the View’s value is edited, a Broadcast may be transmitted. Normally the Scope of the Broadcast is from the Portal at which the Attribute is defined. With this option, you can have the scope limited to the Subsystem panel on which the View is displayed, (or the Portal that is the owner of the View-Panel in which the View has been placed). This can assist to contain the scope of the responses to that Broadcast.
  • Can Edit When Events Pending When paused, if any current time events are pending AND the system is in InterDyne mode (or the model is being used by someone with a Model User licence), then attribute views and buttons will not respond to user interaction UNLESS their new option "Can Send When Events Pending" (for buttons); or "Can Edit When Events Pending" (for attribute views) are on.This builds on the premise that a model does not normally pause until all zero time events have been processed, but can be forced to pause using a "Pause-able 0 Delay" - in which case new broadcasts and attribute changes could impact badly on an incomplete process.By default, the platform now blocks these broadcasts/changes, for safety, but these options above allow the new behaviour to be overridden at which point the modeller takes the risk for ensuring integrity.
  • Can Edit During Simulation Enables Attribute and Cell Views to be clicked upon and edited while a model is running (as opposed to Paused). The Engine Option "Mouse Clicks While Running" must be on for this to work.


View Order

The view order of Attributes can be altered, but only in relation to other Attribute Views, not to Paint Objects or Planimate® Objects.


View Properties

The Properties Flyout provides access to a number of aspects of the View,.

Property Description

  • Graphics Displays the Graphics Configuration Dialog which enables you to Set Border Style; Border Colour; Background Colour; Text Colour.
  • Width Set the width of your View Display in here.
  • Font Choose a Font for the DATA of your display. (Title is unaffected).
  • Alignment Select the Alignment for the DATA of your display. (Title is unaffected).
  • Position Use this option to reposition the View. Alternatively just drag it around.
  • Make Hidden/Visible Toggles hiding or display of the View. The Panel menu bar item (with Show Advanced Menus set under Settings) has an item called Views… with which you can locate Views that are hidden. Selecting a View from this menu enables it to be edited so that it may be made visible again or deleted (If it is no longer required).


Visibility Control

The Run-Time visibility of an Attribute View can be managed by setting up conditions in the condition editor.

You can make references to the values of a range of other attributes.

Generally, you will need to enforce a refresh of the Screen display via a “Force Repaint” routine operation in a change object before a hidden attribute view that should now become visible will be seen.