<< Click to Display Table of Contents >>
Pens Tab |
The Pen Collection object represents a set of Pens on an E3Chart. Each Pen is configured to display data according to the configuration executed on the Data tab of the Properties Window.
The Pens tab allows adding or removing Pens from the Collection of Pens, as well as configuring their main properties, individually or through Pen's multiple selection.
Pens tab
The available options on the Pens tab are described on the next table.
Available options on the Pens tab
Option |
Description |
---|---|
Add Pen |
Adds a Pen. Displays a menu to select a type of Pen to create. The available options are Realtime , Historic , Historic and Realtime , or Automatic |
Remove Pen |
Removes the selected Pens |
Properties |
Opens the selected Pen's Properties Window. This operation is only allowed if only one Pen is selected |
Move Pen up |
Moves the selected Pen one position up. This operation is only allowed if only one Pen is selected |
Move Pen down |
Moves the selected Pen one position down. This operation is only allowed if only one Pen is selected |
NOTE |
To use Automatic-type Pens, there is no need to create or configure a Query. Real-time and historical data are automatically returned on demand by the server, according to the period of time defined in the horizontal axis. |
The list of E3Chart Pens allows copying and pasting Pens on the same E3Chart, as well as among different E3Charts. Right-click a Pen, or the selected Pens in case of a multiple selection, and select the Copy (CTRL + C) option. On the destination E3Chart, open the Properties Window and, on the Pens tab, right-click the list of Pens and select the Paste (CTRL + V) option. The Cut (CTRL + X) option is also available. If the destination E3Chart already contains a Pen with the same name of the one currently copied, its name is automatically incremented.
NOTE |
All options of the selected Pens that are available via contextual menu (by using the right mouse button) are also available by using the shortcut key SHIFT + F10, which corresponds to the application or menu key . |
Some Pen properties can be directly configured on the list displayed on the Pens tab. On the Style column, when clicking , the window on the next figure is then displayed.
Pen style
The available options on this window are described on the next table.
Available options on the Pen Style window
Option |
Description |
---|---|
Main color |
Defines a Pen's line color. This option is equivalent to Pen's Color property |
Background Color |
Defines a background color used on an Area-type Pen. This option is equivalent to Pen's BkColor property |
Drawing style |
Defines a Pen's drawing type. The available options are Lines, Points, Lines and Points, or Area. This option is equivalent to Pen's PenType property |
Dash style |
Defines a Pen's line type. The available options are Solid, Dashed, Dotted, Dash-Dot, Dash-Dot-Dot, or No Line. This option is equivalent to Pen's PenLineStyle property |
Line thickness |
Defines a line width. This option is equivalent to Pen's Width property |
Sample |
Displays an example of how a Pen is drawn on an E3Chart |
Right-click a Pen and select the Configure Pen option or select a Pen and click on the toolbar to open the Properties Window. This window contains the tabs described next.
This tab contains information that identifies a Pen in an E3Chart.
General tab
Each option on the General tab has a corresponding property. The available options are described on the next table.
Available options on the General tab
Option |
Description |
---|---|
Pen name |
Indicates a Pen's name. This option is equivalent to Pen's Name property |
Main color |
Determines a Pen's line color. This option is equivalent to Pen's Color property |
Visible |
Indicates a Pen's visibility status on a chart. This option is equivalent to Pen's Visible property |
Engineering Unit |
Indicates the engineering unit used by a Pen. This option is equivalent to Pen's EU property |
This tab contains information according to a Pen's type.
Data tab
Each option on the Data tab has a corresponding property. The available options are described on the next table.
Available options on the Data tab
Option |
Description |
---|---|
Pen type |
Determines the type of Pen in use. This option is equivalent to Pen's DataSourceType property |
Vertical axis link |
Name of a Link used to plot data on a vertical scale. This option is equivalent to Pen's YLink property |
Horizontal axis link |
Name of a Link used to plot data on a horizontal scale. This option is equivalent to Pen's XLink property |
Number of samples kept in memory |
Specifies the number of samples in real-time Pens. This option is equivalent to Pen's BufferSize property |
Use TimeStamp |
Enables or disables a timestamp. A timestamp is a time value that accompanies a Tag value, indicating the moment when this value was changed. This option is equivalent to Pen's UseTimeStamp property. If this option is enabled, the Horizontal axis link option remains inactive |
Local query |
Determines a Query linked to this E3Chart that is used on Axis data. This option is equivalent to Pen's QueryName property |
External query |
Determines an external query, that is, data received from a query outside this E3Chart |
Vertical axis field |
Name of a Query field used to plot data on a vertical scale. This option is equivalent to Pen's YField property |
Horizontal axis field |
Name of a Query field used to plot data on a horizontal scale. This option is equivalent to Pen's XField property |
Use automatic query |
Indicates whether this Pen must use an automatic query. An automatic query is not used if E3Chart uses a user-customized SQL code, if it is using a Storage, or if it contains several tables. This option is equivalent to Pen's AutoQuery property |
Vertical axis |
Specifies a vertical Axis. This option is equivalent to Pen's ScaleY property |
Horizontal Axis |
Specifies a horizontal Axis. This option is equivalent to Pen's ScaleX property |
Use automatic axes |
When this option is selected, this Pen is plotted using an automatic Axis, which receives the maximum and minimum limits of configurations of a Tag's engineering unit on the server. NOTE: This option is only available for Automatic-type Pens and, when selected, disables the Vertical axis and Horizontal Axis options |
This tab specifies a Pen's style.
Style tab
Each option on the Style tab has a corresponding property. The available options are described on the next table.
Available options on the Style tab
Option |
Description |
---|---|
Drawing style |
Specifies a Pen's drawing type. This option is equivalent to Pen's PenType property |
Dash style |
Specifies a Pen's dash style. This option is equivalent to Pen's PenLineStyle property |
Line thickness |
Determines a line thickness, in pixels. This option is equivalent to Pen's Width property |
Background Color |
Specifies a line's background color. This option is equivalent to Pen's BkColor property |
Documentation |
Specifies a documentation that can be displayed on this Legend. This option is equivalent to Pen's DocString property |
Enable high alarm |
Enables a check on a high alarm. This option is equivalent to Pen's EnableHighLimit property. Its text box enables users to establish a limit for this alarm. This option is equivalent to Pen's HighLimit property |
Enable low alarm |
Enables a check on a low alarm. This option is equivalent to Pen's EnableLowLimit property. Its text box enables users to establish a limit for this alarm. This option is equivalent to Pen's LowLimit property |
Alarm color |
This Pen's color when in alarm. This option is equivalent to Pen's LimitPenColor property |
Alarm background color |
This Pen's background color when in alarm. This option is equivalent to Pen's LimitPenBkColor property |
The appearance of a Pen, according to its configured options, can be viewed on the following figures.
Analog connection mode between points
Digital connection mode between points
The way a Pen is displayed when considering its scan appears in green, and when it is disabled appears in blue.
Display mode of a Pen considering the scan
This tab defines a connection style between historical and real-time parts of a Pen.
Connection Type tab
The available options on the Connection Type tab are described on the following table.
Available options on the Connection Type tab
Option |
Description |
---|---|
Use automatic connection type |
Enables an automatic mode of connection of points of a Pen. This option is only available for Pens of type Automatic. This option is equivalent to Pen's EnableAutoPenMode property. Please check the next note for more information about this option's behavior |
Digital or Analog |
Defines the way points between historical and real-time parts are connected. This option is equivalent to Pen's DigitalData property. Available options are Digital, where its drawing is always based on horizontal and vertical straight lines, suggesting instantaneous variation, or Analog, where its drawing seeks a straight line joining each point on the chart. This option is not available when the Use automatic connection type option is selected |
Value used for scan (ms) |
Defines the expected reading time of a real-time Pen's Tag. If this value is equal to 0 (zero), an E3Chart draws only points actually received from a source (Tag). For values different from 0 (zero), an E3Chart can create virtual points while not receiving a value from its source and the scan time is exceeded. This option is equivalent to Pen's ScanValue property |
Show bad quality points |
Defines whether bad quality points are displayed. This option is equivalent to Pen's ShowBadPoints property |
Maximum interval to connect historic to real-time data (s) |
Specifies a limit time to consider for a visual connection between historical and real-time parts of a Historic and Realtime-type of Pen. This option is equivalent to Pen's MaxGapTime property |
Highlight line when MaxGapTime is being used |
Highlights a connection line between historical and real-time parts. This option is equivalent to Pen's HighlightMaxGapTime property |
Color of the line with MaxGapTime |
Specifies a color for a connection line. This option is equivalent to Pen's MaxGapTimeColor property |
Style of the line with MaxGapTime |
Specifies a style for a connection line. This option is equivalent to Pen's MaxGapTimeStyle property |
The Use automatic connection type option is disabled for Real Time-, Historic-, and Historic and Realtime-type Pens. This option is enabled by default for Automatic-type Pens, indicating that data is received unchanged from a server. Users can force this connection type to Digital or Analog by clearing the selection of this option. |
This tab enables statistical data calculations.
Statistical Data tab
Each option on the Statistical Data tab has a corresponding property. The available options are displayed on the next table.
Available options on the Statistical Data tab
Option |
Description |
---|---|
Calculate statistical data |
Enables statistical data calculation. This option is equivalent to Pen's EnableCalc property |
Show average line |
Displays an average line for statistical data. This option is equivalent to Pen's ShowAverage property. Please check the note further on this topic for more information about this option |
Show minimum and maximum |
Displays minimum and maximum values for statistical data. This option is equivalent to Pen's ShowMinMax property |