Train Graph View: Difference between revisions

From Planimate Knowledge Base
Jump to navigation Jump to search
m (First Cut)
 
No edit summary
Line 1: Line 1:
== Train Graph View ==
Many modellers, particularly those in the rail and transportation industries, use a time vs distance graph, which we call in Planimate® a Train Graph. This display is where time is shown along the x-axis, and distance of shown along the y-axis.
Many modellers, particularly those in the rail and transportation industries, use a time vs distance graph, which we call in Planimate® a Train Graph. This display is where time is shown along the x-axis, and distance of shown along the y-axis.


Lines are drawn between points that share a common ID index. Colours can be set for these lines, and the label is displayed alongside the line, half way between the two points. The Label colour is aligned to the bar colour. A line is drawn only when you have two points with the same ID.
Lines are drawn between points that share a common ID index. Colours can be set for these lines, and the label is displayed alongside the line, half way between the two points. The Label colour is aligned to the bar colour. A line is drawn only when you have two points with the same ID.


The initial Scroller width (upon load) can be specified.  
The initial Scroller width (upon load) can be specified.


A label list can be assigned as the left hand side to display location names – their indices must correspond to the distance values of each of these places, if they are to be displayed to scale.
A label list can be assigned as the left hand side to display location names – their indices must correspond to the distance values of each of these places, if they are to be displayed to scale.


Clicking on a line pops up a window with details of the values in cells of the second point. The table columns can optionally be included in this popup. Start/end times of event are always shown in the popup.
Clicking on a line pops up a window with details of the values in cells of the second point. The table columns can optionally be included in this popup. Start/end times of event are always shown in the popup.




== Train Graph View Required Columns ==
== Train Graph View Required Columns ==


Special Column Names are required for a Gantt View to Display correctly.
Special Column Names are required for a Train Graph View to Display correctly.


_time, _position, _state and _id are required to get a display, others are optional.
_time, _position, _state and _id are required to get a display, others are optional.


Column Name Description
{|  cellspacing="0" cellpadding="5" border="1"
!Column Name
!Description
|-
|_time
|Determines x axis, (must be ascending)
|-
|_position
|Determines Y-axis (Distance) value
|-
|_id
|Used to group sets of points together to make lines.
|-
|_label
|Shown half way along each line
|-
|_state
|0 = inactive, 1..15 map to system colours for now
|-
|_color
|Sets the line colour.
|-
|_style
|Sets the line Style.
|-
|_width
|Sets the line width.
|}
 
Min y value and max y value can be used to extend the graph range (e.g.: min y can go -ve to get more space for the lowest labels)


*_time Determines x axis, (must be ascending)
*_position Determines Y-axis (Distance) value
*_id Used to group sets of points together to make lines.
*_label Shown half way along each line
*_state 0 = inactive, 1..15 map to system colours for now
*_color Sets the line color.
*_style Sets the line Style.
*_width Sets the line width.
*Min y value and max y value can be used to extend the graph range (e.g.: min y can go -ve to get more space for the lowest labels)


Clicking on a line in the Train Graph pops up a window with details of the values in other cells. Table columns have an option item to flag inclusion in this popup. Start/end times of event are shown in the popup by default, but can be suppressed.
Clicking on a line in the Train Graph pops up a window with details of the values in other cells. Table columns have an option item to flag inclusion in this popup. Start/end times of event are shown in the popup by default, but can be suppressed.




== Train Graph View Options ==
== Train Graph View Options ==


Option Description
{|  cellspacing="0" cellpadding="5" border="1"
 
!Option
*Show Labels Show the _Label contents half-way along each line length.
!Description
*Don’t Hide Overlapping Labels Turn off the feature that repositions labels to avoid overlaps.
|-
*Hide Time Scroller Hides the Time interval zoom scroller.
|Show Labels
**Train Graph View Label Text Colour Set the colour to be applied to the Train Graph Labels.
|Show the _Label contents half-way along each line length.
 
|-
|Don’t Hide Overlapping Labels
|Turn off the feature that repositions labels to avoid overlaps.
|-
|Hide Time Scroller
|Hides the Time interval zoom scroller.
|-
|No Times In Click Popups
|Hides the start/end times in popup when clicking on a graph line.
|}




Line 50: Line 75:
The Properties Flyout provides access to a number of aspects of the View.
The Properties Flyout provides access to a number of aspects of the View.


Property Description
{|  cellspacing="0" cellpadding="5" border="1"
 
!Property
*Graphics Displays the Graphics Configuration Dialog which enables you to Set Border Style; Border Colour; Background Colour; Text Colour.
!Description
*Position Use this option to reposition the View. Alternatively just drag it around.
|-
*Initial X Width Acts as a width limit for the X axis of a View. You can still stretch the scroller past this but it will revert to the limit when the data is changed by the model.
|Graphics
*Min Update By default, a Graph View is updated each time the table is changed. Sometimes you may wish to have your graphs update at a lesser rate than these events. This will specify the time between updates of the graph, regardless of the number of events that have occurred in between.
|Displays the Graphics Configuration Dialog which enables you to Set Border Style; Border Colour; Background Colour; Text Colour.
*# of rows Select the number of rows that will be displayed on the Y axis of the Display.
|-
*Row Labels Select the Label list that will appear on the Y axis of the Display.
|Position
 
|Use this option to reposition the View. Alternatively just drag it around.
|-
|Anchor
|Specify Anchor points when displayed on a dynamically sized panel.
|-
|Initial X Width
|Acts as a width limit for the X axis of a View. You can still stretch the scroller past this but it will revert to the limit when the data is changed by the model.
|-
|Min Update
|By default, a Graph View is updated each time the table is changed. Sometimes you may wish to have your graphs update at a lesser rate than these events. This will specify the time between updates of the graph, regardless of the number of events that have occurred in between.
|-
|# Of Rows
|Select the number of rows that will be displayed on the Y axis of the Display.
|-
|Row Labels
|Select the Label list that will appear on the Y axis of the Display.
|}




== Train Graph View Scale Parameters ==
== Train Graph View Scale Parameters ==


There are many details you can choose to enhance the look of your View. Certain scale parameters are available here.  
There are many details you can choose to enhance the look of your View. Certain scale parameters are available here.
 




== Train Graph View Scale Options ==
== Train Graph View Scale Options ==


There are options you can choose to enhance the look of your View. Certain scale options are available here.
There are options you can choose to enhance the look of your View. Certain scale options are available here.
 
Option Description
 
*Show X Scales / Show Y Scales Hide/Show the scale values in the View.
*Show X Major Grid / Show Y Major Grid Shows a Major Grid line for the Scale, when the scale parameters are set appropriately.
*Show X Minor Grid / Show Y Minor Grid Shows a Minor Grid line for the Scale, when the scale parameters are set appropriately.


{|  cellspacing="0" cellpadding="5" border="1"
!Option
!Description
|-
|Show X Scales / Show Y Scales
|Hide/Show the scale values in the View.
|-
|Show X Major Grid / Show Y Major Grid
|Shows a Major Grid line for the Scale, when the scale parameters are set appropriately.
|-
|Show X Minor Grid / Show Y Minor Grid
|Shows a Minor Grid line for the Scale, when the scale parameters are set appropriately.
|}




== Train Graph View Broadcasts ==
== Train Graph View Broadcasts ==


Certain Model User interactions with Views can have Broadcasts associated with them. You can associate the Broadcast of your choice for the following.  
Certain Model User interactions with Views can have Broadcasts associated with them. You can associate the Broadcast of your choice for the following.


All View broadcasts are transmitted from the Scope of the Table, rather than the scope of the View itself.
All View broadcasts are transmitted from the Scope of the Table, rather than the scope of the View itself.


Broadcast Name Description of Event
{|  cellspacing="0" cellpadding="5" border="1"
 
!Broadcast Name
*Click Broadcast Transmitted when the user clicks on the graph.
!Description of Event
*Scroll Broadcast Transmitted when the user scrolls the View of the Gantt.
|-
 
|Click Broadcast
|Transmitted when the user clicks on the graph.
|-
|Scroll Broadcast
|Transmitted when the user scrolls the View of the Gantt.
|}




Line 95: Line 147:


Use this dialog to find out whether you have included all the columns that a gantt needs to respond and display properly. It indicates which labels are required, and which of those are missing.
Use this dialog to find out whether you have included all the columns that a gantt needs to respond and display properly. It indicates which labels are required, and which of those are missing.




Line 102: Line 153:
The Run-Time visibility of an Attribute View can be managed by setting up conditions in the condition editor.
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.  
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.
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.




Line 113: Line 163:


Alternatively, double click on the Title of the Table View to display this window.
Alternatively, double click on the Title of the Table View to display this window.




Line 119: Line 168:


Copies the View of this table and enables you to paste another View, with all the same settings, on another panel.
Copies the View of this table and enables you to paste another View, with all the same settings, on another panel.




== View Order ==
== 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.<br><br>
The view order of Attributes can be altered, but only in relation to other Attribute Views, not to Paint Objects or Planimate® Objects.


[[Category:Table]]
[[Category:Table]]
[[Category:Track]]
[[Category:Track]]
[[Category:View]]
[[Category:View]]

Revision as of 15:13, 11 May 2011

Many modellers, particularly those in the rail and transportation industries, use a time vs distance graph, which we call in Planimate® a Train Graph. This display is where time is shown along the x-axis, and distance of shown along the y-axis.

Lines are drawn between points that share a common ID index. Colours can be set for these lines, and the label is displayed alongside the line, half way between the two points. The Label colour is aligned to the bar colour. A line is drawn only when you have two points with the same ID.

The initial Scroller width (upon load) can be specified.

A label list can be assigned as the left hand side to display location names – their indices must correspond to the distance values of each of these places, if they are to be displayed to scale.

Clicking on a line pops up a window with details of the values in cells of the second point. The table columns can optionally be included in this popup. Start/end times of event are always shown in the popup.


Train Graph View Required Columns

Special Column Names are required for a Train Graph View to Display correctly.

_time, _position, _state and _id are required to get a display, others are optional.

Column Name Description
_time Determines x axis, (must be ascending)
_position Determines Y-axis (Distance) value
_id Used to group sets of points together to make lines.
_label Shown half way along each line
_state 0 = inactive, 1..15 map to system colours for now
_color Sets the line colour.
_style Sets the line Style.
_width Sets the line width.

Min y value and max y value can be used to extend the graph range (e.g.: min y can go -ve to get more space for the lowest labels)


Clicking on a line in the Train Graph pops up a window with details of the values in other cells. Table columns have an option item to flag inclusion in this popup. Start/end times of event are shown in the popup by default, but can be suppressed.


Train Graph View Options

Option Description
Show Labels Show the _Label contents half-way along each line length.
Don’t Hide Overlapping Labels Turn off the feature that repositions labels to avoid overlaps.
Hide Time Scroller Hides the Time interval zoom scroller.
No Times In Click Popups Hides the start/end times in popup when clicking on a graph line.


Train Graph 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.
Position Use this option to reposition the View. Alternatively just drag it around.
Anchor Specify Anchor points when displayed on a dynamically sized panel.
Initial X Width Acts as a width limit for the X axis of a View. You can still stretch the scroller past this but it will revert to the limit when the data is changed by the model.
Min Update By default, a Graph View is updated each time the table is changed. Sometimes you may wish to have your graphs update at a lesser rate than these events. This will specify the time between updates of the graph, regardless of the number of events that have occurred in between.
# Of Rows Select the number of rows that will be displayed on the Y axis of the Display.
Row Labels Select the Label list that will appear on the Y axis of the Display.


Train Graph View Scale Parameters

There are many details you can choose to enhance the look of your View. Certain scale parameters are available here.


Train Graph View Scale Options

There are options you can choose to enhance the look of your View. Certain scale options are available here.

Option Description
Show X Scales / Show Y Scales Hide/Show the scale values in the View.
Show X Major Grid / Show Y Major Grid Shows a Major Grid line for the Scale, when the scale parameters are set appropriately.
Show X Minor Grid / Show Y Minor Grid Shows a Minor Grid line for the Scale, when the scale parameters are set appropriately.


Train Graph View Broadcasts

Certain Model User interactions with Views can have Broadcasts associated with them. You can associate the Broadcast of your choice for the following.

All View broadcasts are transmitted from the Scope of the Table, rather than the scope of the View itself.

Broadcast Name Description of Event
Click Broadcast Transmitted when the user clicks on the graph.
Scroll Broadcast Transmitted when the user scrolls the View of the Gantt.


Train Graph View Table Column Check

Use this dialog to find out whether you have included all the columns that a gantt needs to respond and display properly. It indicates which labels are required, and which of those are missing.


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.


Edit Original

This is the option that displays the Table Editor Window.

Alternatively, double click on the Title of the Table View to display this window.


Copy

Copies the View of this table and enables you to paste another View, with all the same settings, on another panel.


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.